diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 906438f..9b768f6 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -55,24 +55,22 @@ jobs: if: ${{ github.event.inputs.zowe-version && github.event.inputs.zowe-version != '' }} run: | curl -s https://raw.githubusercontent.com/zowe/zowe-cli-standalone-package/${{ github.event.inputs.zowe-version }}/master/zowe-versions.yaml > __zowe__version__ - npm install -g @zowe/cli@$(yq '.packages.cli."zowe-v2-lts"' __zowe__version__ | tr -d '"') - zowe plugins install @zowe/cics-for-zowe-cli@$(yq '.packages."cics-for-zowe-cli"."zowe-v2-lts"' __zowe__version__ | tr -d '"') - zowe plugins install @zowe/db2-for-zowe-cli@$(yq '.packages."db2-for-zowe-cli"."zowe-v2-lts"' __zowe__version__ | tr -d '"') - zowe plugins install @zowe/ims-for-zowe-cli@$(yq '.packages."ims-for-zowe-cli"."zowe-v2-lts"' __zowe__version__ | tr -d '"') - zowe plugins install @zowe/mq-for-zowe-cli@$(yq '.packages."mq-for-zowe-cli"."zowe-v2-lts"' __zowe__version__ | tr -d '"') - zowe plugins install @zowe/zos-ftp-for-zowe-cli@$(yq '.packages."zos-ftp-for-zowe-cli"."zowe-v2-lts"' __zowe__version__ | tr -d '"') + npm install -g @zowe/cli@$(yq '.packages.cli."zowe-v3-lts"' __zowe__version__ | tr -d '"') + zowe plugins install @zowe/cics-for-zowe-cli@$(yq '.packages."cics-for-zowe-cli"."zowe-v3-lts"' __zowe__version__ | tr -d '"') + zowe plugins install @zowe/db2-for-zowe-cli@$(yq '.packages."db2-for-zowe-cli"."zowe-v3-lts"' __zowe__version__ | tr -d '"') + zowe plugins install @zowe/mq-for-zowe-cli@$(yq '.packages."mq-for-zowe-cli"."zowe-v3-lts"' __zowe__version__ | tr -d '"') + zowe plugins install @zowe/zos-ftp-for-zowe-cli@$(yq '.packages."zos-ftp-for-zowe-cli"."zowe-v3-lts"' __zowe__version__ | tr -d '"') rm __zowe__version__ - name: Set Up Zowe id: setup-zowe if: ${{ steps.get-version-from-workflow.outcome == 'skipped' }} run: | - npm install -g @zowe/cli@zowe-v2-lts - zowe plugins install @zowe/cics-for-zowe-cli@zowe-v2-lts - zowe plugins install @zowe/db2-for-zowe-cli@zowe-v2-lts - zowe plugins install @zowe/ims-for-zowe-cli@zowe-v2-lts - zowe plugins install @zowe/mq-for-zowe-cli@zowe-v2-lts - zowe plugins install @zowe/zos-ftp-for-zowe-cli@zowe-v2-lts + npm install -g @zowe/cli@zowe-v3-lts + zowe plugins install @zowe/cics-for-zowe-cli@zowe-v3-lts + zowe plugins install @zowe/db2-for-zowe-cli@zowe-v3-lts + zowe plugins install @zowe/mq-for-zowe-cli@zowe-v3-lts + zowe plugins install @zowe/zos-ftp-for-zowe-cli@zowe-v3-lts - name: Get Zowe version id: get-version @@ -86,7 +84,7 @@ jobs: zowe --version || true npm run build:local -- ${{ github.event.inputs.zowe-version || steps.get-version.outputs.number }} export margin="0.4in" - puppeteer print ./generatedWebHelp/docs/all.html ./zowe.pdf --margin-top $margin --margin-right $margin --margin-bottom $margin --margin-left $margin --no-sandbox + puppeteer print ./generatedWebHelp/docs/all.html ./zowe.pdf --margin-top $margin --margin-right $margin --margin-bottom $margin --margin-left $margin --no-sandbox - name: Archive Results id: upload diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 6200c8c..fad9d55 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -27,19 +27,18 @@ jobs: - name: Install Node Package Dependencies id: install-node - run: | + run: | npm i --prod npm install -g puppeteer-cli - name: Set Up Zowe id: setup-zowe run: | - npm install -g @zowe/cli@zowe-v2-lts - zowe plugins install @zowe/cics-for-zowe-cli@zowe-v2-lts - zowe plugins install @zowe/db2-for-zowe-cli@zowe-v2-lts - zowe plugins install @zowe/ims-for-zowe-cli@zowe-v2-lts - zowe plugins install @zowe/mq-for-zowe-cli@zowe-v2-lts - zowe plugins install @zowe/zos-ftp-for-zowe-cli@zowe-v2-lts + npm install -g @zowe/cli@zowe-v3-lts + zowe plugins install @zowe/cics-for-zowe-cli@zowe-v3-lts + zowe plugins install @zowe/db2-for-zowe-cli@zowe-v3-lts + zowe plugins install @zowe/mq-for-zowe-cli@zowe-v3-lts + zowe plugins install @zowe/zos-ftp-for-zowe-cli@zowe-v3-lts - name: Get Zowe version id: get-version @@ -50,9 +49,8 @@ jobs: id: setup run: | jq '.commandGroups=["cics","db2","ims","mq","zos-ftp"]' zowe.template.json > zowe.json - echo "$(jq '.profiles=["cics", "db2","ims","mq","zftp"]' zowe.json)" > zowe.json npm run contribute - + - name: Teardown Zowe Plugins id: teardown-zowe run: | @@ -69,7 +67,7 @@ jobs: zowe --version || true npm run build:local -- ${{ steps.get-version.outputs.number }} export margin="0.4in" - puppeteer print ./generatedWebHelp/docs/all.html ./zowe.pdf --margin-top $margin --margin-right $margin --margin-bottom $margin --margin-left $margin --no-sandbox + puppeteer print ./generatedWebHelp/docs/all.html ./zowe.pdf --margin-top $margin --margin-right $margin --margin-bottom $margin --margin-left $margin --no-sandbox - name: Archive Results id: upload diff --git a/.github/workflows/verify.yml b/.github/workflows/verify.yml index 84c37e6..c0e69c0 100644 --- a/.github/workflows/verify.yml +++ b/.github/workflows/verify.yml @@ -20,5 +20,5 @@ jobs: readarray -t all_files <<<"$(jq -r '.[]' <<<'${{ steps.files.outputs.all_changed_files }}')" for file in ${all_files[@]}; do [[ ''${file}'' == *.jsonc ]] || (echo "Not a JSON file: ${file}" && exit 1) - [[ ''${file}'' == commandGroups/* ]] || [[ ''${file}'' == profiles/* ]] || (echo "Wrong location: ${file}" && exit 1) + [[ ''${file}'' == commandGroups/* ]] || (echo "Wrong location: ${file}" && exit 1) done diff --git a/README.md b/README.md index ab75b5f..230f975 100644 --- a/README.md +++ b/README.md @@ -38,14 +38,13 @@ To add your conformant plug-in's commands, perform the following steps: If it is not already installed, see Step 3 in the [Installing](#installing) section. -2. Define command groups and profiles that your plug-in contributes. +2. Define command groups that your plug-in contributes. - Copy the template file `zowe.template.json` to a new file named `zowe.json`. This file will be ignored by git. - - Customize this file to include the full names of command group(s) of your plug-in(s), and the name(s) of your plug-in's profile(s), like the following: + - Customize this file to include the full names of command group(s) of your plug-in(s), like the following: ```json { - "commandGroups": ["zowe-cli-sample"], - "profiles": ["sample"] + "commandGroups": ["zowe-cli-sample"] } ``` > **Note:** No @zowe scoped plug-ins should be included in this repository, and the above is merely for demonstration purposes. @@ -63,7 +62,7 @@ To add your conformant plug-in's commands, perform the following steps: ```bash npm run contribute ``` - This will retrieve the CLI command tree from Zowe CLI and all installed plug-ins, and extract the above command group(s) and profile(s) to `.jsonc` files in the "commandGroups" and "profiles" directories. + This will retrieve the CLI command tree from Zowe CLI and all installed plug-ins, and extract the above command group(s) to `.jsonc` files in the "commandGroups" directory. 5. Commit new files back to the GitHub repository. diff --git a/commandGroups/ca7.jsonc b/commandGroups/ca7.jsonc deleted file mode 100644 index 0961bea..0000000 --- a/commandGroups/ca7.jsonc +++ /dev/null @@ -1,22929 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "ca7", - "description": "Welcome to the CA 7 Zowe CLI!", - "type": "group", - "children": [ - { - "name": "commands", - "aliases": [ - "cmds" - ], - "summary": "All the CA 7 commands", - "description": "All the available commands are listed in the COMMANDS section.", - "type": "group", - "children": [ - { - "name": "addrq", - "aliases": [ - "ar" - ], - "summary": "Adds temporary user or predecessor job requirements", - "description": "Manually adds temporary, one-time, preexecution user or predecessor job requirements", - "examples": [ - { - "options": "--ca7num 0016", - "description": "Adds the job requirement ca7 number, 0016 from CA 7" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "ca7num", - "description": "ca7num=0016\n\nDefines the job to which you want to add the job requirement.\nThe job must be in the request queue.\nDefines the CA 7 job number to which you want to add the requirement for this run of the job.\nLimits: 1 to 4 numeric characters", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "depjob", - "description": "example: PAYJOB\n\nDefines a temporary one-time job dependency requirement.\nThe DEPJOB value specifies the job name that must complete execution\nor must be manually posted complete before the job identified by JOB is eligible for submission.\n\nDEPJOB is required unless USR is used, in which case, omit DEPJOB.\nThis requirement is satisfied automatically when the predecessor job completes.\nOnly in unusual situations would this requirement must be satisfied manually.\nThat is, any time that a normal completion did not occur.\n\n Required: Yes, unless USR is used.\n\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "usr", - "description": "example: USER WILL CALL TO RELEASE\n\nDefines the description of a temporary, one-time user requirement.\nThis requirement must be manually satisfied before the job identified by JOB is eligible for submission.\nIf any commas are included as part of the text, enclose the entire requirements text in parentheses.\nThis requirement is satisfied automatically when the predecessor job completes.\nOnly in unusual situations would this requirement must be satisfied manually.\nThat is, any time that a normal completion did not occur.\nRequired: USR is required unless DEPJOB is used, in which case, omit USR.\n\nLimits: 1 to 36 alphanumeric characters", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "rmtjob", - "description": "example: RMT_JOB\n\nNames the job in the remote scheduler that is required by the job specified in the JOB field.\nLimits: RMTJOB should accept up to 64 characters\nvalid characters are a-z, A-Z, 0-9, period (.), underscore (_), hyphen (-),\ncolon (:), and pound (#); do not include embedded spaces or tabs.\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "rmtschd", - "description": "example: AP1\n\nNames the remote scheduler where the predecessor job runs.\nBefore adding this requirement, the remote scheduler must be defined.\nThe remote scheduler defined as type LOCAL cannot be specified.\nLimits: 1 to 3 alphanumeric characters; generic specification not supported.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "cancel", - "aliases": [ - "c" - ], - "summary": "Cancels a job request to CA 7", - "description": "For CPU jobs, the CANCEL command only removes the job from the queues.\nFor XPJOB jobs, the CANCEL command removes the job from the queues.\nFor agent definition jobs (AGJOBs), the CANCEL command sends a request to the agent and removes the job from the queues.", - "examples": [ - { - "options": "--ca7num 0016", - "description": "Cancel ca7 number, 0016" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "ca7num", - "description": "ca7num=0016\n\nDefines the unique CA 7 job number (leading zeros are not required) for the job to cancel.\nLimits: 1 to 4 numeric characters", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "force", - "description": "Specifies to force the cancellation of the job.\nUse of this option can potentially cause CA WA CA 7 Edition to abend; therefore, only use it as a last resort.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "reason", - "description": "Defines the reason for the job cancellation.\n\nLimits: 1 to 40 alphanumeric characters\nRequired: No (depending on initialization options)", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "demand", - "aliases": [ - "d" - ], - "summary": "Demand a CA 7 job", - "description": "The demanded jobs are placed in the request queue and assigned a unique CA 7 job number.\nJOB and JOBL are mutually exclusive.", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "job", - "description": "job=PAYROLL\n\nThe demanded jobs are placed in the request queue and assigned a unique CA 7 job number.\n1-8 alphanumeric (mutually exclusive w/ jobl", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "jobl", - "description": "jobl=payrollSW123\n\nDefines the long name of the job being demanded.\nThe demanded jobs are placed in the request queue and assigned a unique CA 7 job number.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "arfset", - "aliases": [ - "as" - ], - "description": "arfset={arfsetname|**NONE**}\n\nDefines the ARF set name that is used for this run of the job.\nIf you specify **NONE**, no ARF processing is performed for this run of the job.\n\nLimits: 1 to 8 alphanumeric characters or **NONE**", - "type": "string", - "group": "Options" - }, - { - "name": "cc", - "description": "cc=1234\n\nDefines, with RO (relational operator), the job-level condition codes that are used to determine whether a job executes successfully.\n\nIf specified, this value overrides the RO defined for the job in the CA WA CA 7 Edition database. RO is required when CC is specified.\n\nDefault: The job definition panel COND-CODE value when the job is defined to CA WA CA 7 Edition; otherwise 0.\nLimits: 1 to 4 numeric characters from 0 to 4095. Invalid with agent jobs.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "class", - "description": "class=n\n\nDefines the workload balancing class for resource checking.\n\nLimits: 1 alphanumeric character", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "count", - "description": "count=nnnn\n\nDefines the maximum number of times to repeat the job. COUNT is ignored if INTERVAL is not specified.\n\nDefault: None. The job continues repeating until the STOP time is reached.\nLimits: 1 to 4 numeric characters from 0 to 1439. The leading zeros can be discarded.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "date", - "description": "date={+nn|yyddd}\n\nDefines due-out and submit dates.\nLimits: If used, specify DOTM or TIME.\n+nn\n\nDefines the number of days after the current date.\nLimits: 1 to 2 numeric characters from 1 to 99\nyyddd\n\nDefines the Julian date to run the job.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "depjob", - "aliases": [ - "dj" - ], - "description": "depjob=jobname2\n\nDefines a single predecessor job that must complete while the demanded job is waiting.\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "group": "Options" - }, - { - "name": "dotm", - "description": "dotm=hhmm\n\nDefines the due-out time-of-day for the job in hours (hh) and minutes (mm).\nIf DOTM is specified on the DEMAND/DEMANDH command and the value that is given is earlier than the current time, the due-out day is assumed to be the following day.\n\nIf DOTM and LEADTM are both omitted, then deadline start time is assumed to be the current time plus the LEADTM.\n\nLimits: hh= 2 numeric characters from 0 to 24\nmm= 2 numeric characters from 00 to 59\n\nRequired: No (unless DATE is used, if so, DOTM or TIME must be specified)", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "exec", - "aliases": [ - "e" - ], - "description": "exec={NO|YES}\n\nSpecifies whether to execute the job (YES/NO).\nIf NO (N) is used, the job does not run but shows a normal completion as if it did run. The value that is specified here overrides the value that is coded on the job definition EXEC field.\n\nDefault: The job definition panel EXEC value if the job is defined to CA WA CA 7 Edition; otherwise YES.", - "type": "string", - "group": "Options" - }, - { - "name": "interval", - "aliases": [ - "i" - ], - "description": "interval=hhmm\n\nIdentifies that the job is repeated (executed more than once) and defines the amount of time between each iteration.\n\nIf INTERVAL is specified, the TIME and TYPE keywords are required. If both INTERVAL and COUNT are specified, the INTERVAL value times the COUNT value must total less than 24 hours.\n\nLimits: hh=2 numeric characters from 0 to 23\nmm=2 numeric characters from 00 to 59", - "type": "string", - "group": "Options" - }, - { - "name": "jclid", - "aliases": [ - "ji" - ], - "description": "jclid=10\n\nDefines the JCL data set that contains the execution JCL to be submitted.\n\nIf used, the value must be a numeric INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).\n\nIf the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 1 to 3 numeric characters from 0 through 254 and from 256 through 999. 255 is reserved.", - "type": "string", - "conflictsWith": [ - "jcllib" - ], - "group": "Options" - }, - { - "name": "jcllib", - "aliases": [ - "jl" - ], - "description": "jcllib=&SPECIAL\n\nDefines the JCL data set that contains the execution JCL to be submitted.\n\nIf used, the value must be a symbolic INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).\n\nIf the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 2 to 16 alphanumeric characters beginning with ampersand (&)", - "type": "string", - "group": "Options" - }, - { - "name": "late", - "description": "late={NO|YES}\n\nSpecifies whether a notification occurs when the job becomes late.\nSpecify YES (Y) to make the job eligible to be marked LATE. If NO (N) is used, the job is never marked LATE. The value that is specified here overrides the value that is coded on the job definition PROMPTS field.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "leadtm", - "aliases": [ - "lt" - ], - "description": "leadtm={0100|hhmm}\n\nSpecifies the lead (processing) time that is required for the job to run.\nIf omitted, 1 hour is usedFormat: hhmm\nLimits: hh= 2 numeric characters from 0 to 24\nmm= 2 numeric characters from 00 to 59You can omit leading zeros.", - "type": "string", - "group": "Options" - }, - { - "name": "mainid", - "aliases": [ - "mi" - ], - "description": "mainid={ALL|SYn|/SYn|-SYn}\n\nSpecifies the MAINID, as defined in the initialization file CPU statement, to which you want to redirect the job.\nThe value that is specified here overrides the value that is coded on the job definition MAINID field. The name must be one of the following values:\n\nALL\nSpecifies all CPUs are acceptable for executing the job.\n\nSYn\nn defines the CPU to which the job is being redirected. The value of n can range from 1 to 7.\n\n/SYn\nn defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.\n\n-SYn\nn defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.\n\nLimits: Invalid for internal cross-platform jobs.", - "type": "string", - "group": "Options" - }, - { - "name": "prty", - "description": "prty=nnn\nDefines the initial workload balancing priority\n\nLimits: 1-3 numeric (1-255).", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "rms", - "description": "rms={NO|YES}\n\nSpecifies whether CA WA CA 7 Edition inserts the CA Workload Automation Restart Option for z/OS Schedulers RMS step.\n\nSpecify YES (Y) to insert the step with the CA Workload Automation Restart Option for z/OS Schedulers processing code of P. Enter NO (N) to indicate that the RMS step is not inserted.\n\nThe value that is specified here overrides the value that is coded on the job definition INSERT-RMS field.\nDefault: The job definition panel INSERT-RMS value if job defined to CA WA CA 7 Edition; otherwise NO.\nLimits: Invalid for internal cross-platform jobs.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "ro", - "description": "ro={EQ|LT|GT|GE|LE|NE|#S|IG|0}\n\nSpecifies the relational operator of the condition code (CC) or if the step level #SCC statements are being used in the JCL of the job.\n\nEQ\nEqual to\n\nLT\nLess than\n\nGT\nGreater than\n\nGE\nGreater than or equal to\n\nLE\nLess than or equal to\n\nNE\nNot equal to\n\n#S\nStep condition code tests to be made based on a #SCC statement.\n\nIG\nNo evaluation of the job is done. CA WA CA 7 Edition always assumes that the job completes successfully, regardless of condition codes, abend codes, or run-time JCL errors.\n\nLimits: Invalid with agent jobs.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "schid", - "aliases": [ - "si" - ], - "description": "schid={1|nnn}\n\nIndicates the schedule ID to be used for evaluating JCL overrides that are scheduled with the #Jx or #Xx commands.\n\nDefault: 1\nLimits: 1 to 3 numeric characters from 1 to 999 (See Note)\n\nNo (unless the SCHEDULE statement in the initialization file specifies SCHID=YES, then this parameter is required)", - "type": "string", - "group": "Options" - }, - { - "name": "set", - "description": "set={NDB|NTR|SKP}\n\nSpecifies skip the next scheduled cycle for the job (SKP), disable triggering (NTR), or bypass the database updating at the job completion.\n\nSKP\nSpecifies this run of the job takes the place of the next scheduled run. This value has the same effect as entering NXTCYC,SET=SKP. It is reflected on output from LJOB and LLOCK commands as if NXTCYC,SET=SKP was used. This parameter is invalid if the job has no schedule. SET=SKP has no impact on repeating jobs that are already in the queues.\n\nNTR\nSpecifies normal triggering is disabled only for this run of the job.\n\nNDB\nAllows a job to bypass all load processing at the job completion, but allows other processing to proceed typically.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "stop", - "description": "stop=hhmm\n\nDefines the clock time after which the job is not repeated. STOP is ignored if INTERVAL is not specified.\n\nDefault: 1439 minutes (24 hours minus 1 minute) after the submit time\nLimits: hh=1 through 2 numeric characters from 0 to 23\nmm=2 numeric characters from 00 to 59", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "time", - "description": "time={hhmm|+hhmm}\n\nEstablishes a submit time-of-day requirement for the job.\n\nFormat: hhmm\nDefines the time-of-day where hh is hours (0 through 23) and mm is minutes (00 through 59).\nLeading zeros are not required\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "type", - "description": "type={CLOCK|END|RES|START}\n\nIndicates that the job is being scheduled for rerun.\nThe value must be specified as shown.\n\nTYPE=RES is optional.If used, a restart requirement is placed on the job, and the job has to be manually restarted.Limits: RES, CLOCK, START, or END", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": "--job PAYROLL", - "description": "Demand job, PAYROLL to CA 7" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "demandh", - "aliases": [ - "dh" - ], - "summary": "Defines the name of the job being demanded and hold", - "description": "The demanded jobs are placed in the request queue and assigned a unique CA 7 job number.", - "examples": [ - { - "options": "--job PAYROLL", - "description": "Demand and hold job, PAYROLL" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "job", - "description": "job=PAYROLL\n\nDefines the name of the job being demanded.\nThe demanded jobs are placed in the request queue and assigned a unique CA 7 job number.", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "jobl", - "description": "jobl=payrollSW123\n\nDefines the long name of the job being demanded.\nThe demanded jobs are placed in the request queue and assigned a unique CA 7 job number.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "arfset", - "aliases": [ - "as" - ], - "description": "arfset={arfsetname|**NONE**}\n\nDefines the ARF set name that is used for this run of the job.\nIf you specify **NONE**, no ARF processing is performed for this run of the job.\n\nLimits: 1 to 8 alphanumeric characters or **NONE**", - "type": "string", - "group": "Options" - }, - { - "name": "cc", - "description": "cc=1234\n\nDefines, with RO (relational operator), the job-level condition codes that are used to determine whether a job executes successfully.\n\nIf specified, this value overrides the RO defined for the job in the CA WA CA 7 Edition database. RO is required when CC is specified.\n\nDefault: The job definition panel COND-CODE value when the job is defined to CA WA CA 7 Edition; otherwise 0.\nLimits: 1 to 4 numeric characters from 0 to 4095. Invalid with agent jobs.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "class", - "description": "class=n\n\nDefines the workload balancing class for resource checking.\n\nLimits: 1 alphanumeric character", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "count", - "description": "count=nnnn\n\nDefines the maximum number of times to repeat the job. COUNT is ignored if INTERVAL is not specified.\n\nDefault: None. The job continues repeating until the STOP time is reached.\nLimits: 1 to 4 numeric characters from 0 to 1439. The leading zeros can be discarded.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "date", - "description": "date={+nn|yyddd}\n\nDefines due-out and submit dates.\nLimits: If used, specify DOTM or TIME.\n+nn\n\nDefines the number of days after the current date.\nLimits: 1 to 2 numeric characters from 1 to 99\nyyddd\n\nDefines the Julian date to run the job.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "depjob", - "aliases": [ - "dj" - ], - "description": "depjob=jobname2\n\nDefines a single predecessor job that must complete while the demanded job is waiting.\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "group": "Options" - }, - { - "name": "dotm", - "description": "dotm=hhmm\n\nDefines the due-out time-of-day for the job in hours (hh) and minutes (mm).\nIf DOTM is specified on the DEMAND/DEMANDH command and the value that is given is earlier than the current time, the due-out day is assumed to be the following day.\n\nIf DOTM and LEADTM are both omitted, then deadline start time is assumed to be the current time plus the LEADTM.\n\nLimits: hh= 2 numeric characters from 0 to 24\nmm= 2 numeric characters from 00 to 59\n\nRequired: No (unless DATE is used, if so, DOTM or TIME must be specified)", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "exec", - "aliases": [ - "e" - ], - "description": "exec={NO|YES}\n\nSpecifies whether to execute the job (YES/NO).\nIf NO (N) is used, the job does not run but shows a normal completion as if it did run. The value that is specified here overrides the value that is coded on the job definition EXEC field.\n\nDefault: The job definition panel EXEC value if the job is defined to CA WA CA 7 Edition; otherwise YES.", - "type": "string", - "group": "Options" - }, - { - "name": "interval", - "aliases": [ - "i" - ], - "description": "interval=hhmm\n\nIdentifies that the job is repeated (executed more than once) and defines the amount of time between each iteration.\n\nIf INTERVAL is specified, the TIME and TYPE keywords are required. If both INTERVAL and COUNT are specified, the INTERVAL value times the COUNT value must total less than 24 hours.\n\nLimits: hh=2 numeric characters from 0 to 23\nmm=2 numeric characters from 00 to 59", - "type": "string", - "group": "Options" - }, - { - "name": "jclid", - "aliases": [ - "ji" - ], - "description": "jclid=10\n\nDefines the JCL data set that contains the execution JCL to be submitted.\n\nIf used, the value must be a numeric INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).\n\nIf the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 1 to 3 numeric characters from 0 through 254 and from 256 through 999. 255 is reserved.", - "type": "string", - "conflictsWith": [ - "jcllib" - ], - "group": "Options" - }, - { - "name": "jcllib", - "aliases": [ - "jl" - ], - "description": "jcllib=&SPECIAL\n\nDefines the JCL data set that contains the execution JCL to be submitted.\n\nIf used, the value must be a symbolic INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).\n\nIf the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 2 to 16 alphanumeric characters beginning with ampersand (&)", - "type": "string", - "group": "Options" - }, - { - "name": "late", - "description": "late={NO|YES}\n\nSpecifies whether a notification occurs when the job becomes late.\nSpecify YES (Y) to make the job eligible to be marked LATE. If NO (N) is used, the job is never marked LATE. The value that is specified here overrides the value that is coded on the job definition PROMPTS field.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "leadtm", - "aliases": [ - "lt" - ], - "description": "leadtm={0100|hhmm}\n\nSpecifies the lead (processing) time that is required for the job to run.\nIf omitted, 1 hour is usedFormat: hhmm\nLimits: hh= 2 numeric characters from 0 to 24\nmm= 2 numeric characters from 00 to 59You can omit leading zeros.", - "type": "string", - "group": "Options" - }, - { - "name": "mainid", - "aliases": [ - "mi" - ], - "description": "mainid={ALL|SYn|/SYn|-SYn}\n\nSpecifies the MAINID, as defined in the initialization file CPU statement, to which you want to redirect the job.\nThe value that is specified here overrides the value that is coded on the job definition MAINID field. The name must be one of the following values:\n\nALL\nSpecifies all CPUs are acceptable for executing the job.\n\nSYn\nn defines the CPU to which the job is being redirected. The value of n can range from 1 to 7.\n\n/SYn\nn defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.\n\n-SYn\nn defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.\n\nLimits: Invalid for internal cross-platform jobs.", - "type": "string", - "group": "Options" - }, - { - "name": "prty", - "description": "prty=nnn\nDefines the initial workload balancing priority\n\nLimits: 1-3 numeric (1-255).", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "rms", - "description": "rms={NO|YES}\n\nSpecifies whether CA WA CA 7 Edition inserts the CA Workload Automation Restart Option for z/OS Schedulers RMS step.\n\nSpecify YES (Y) to insert the step with the CA Workload Automation Restart Option for z/OS Schedulers processing code of P. Enter NO (N) to indicate that the RMS step is not inserted.\n\nThe value that is specified here overrides the value that is coded on the job definition INSERT-RMS field.\nDefault: The job definition panel INSERT-RMS value if job defined to CA WA CA 7 Edition; otherwise NO.\nLimits: Invalid for internal cross-platform jobs.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "ro", - "description": "ro={EQ|LT|GT|GE|LE|NE|#S|IG|0}\n\nSpecifies the relational operator of the condition code (CC) or if the step level #SCC statements are being used in the JCL of the job.\n\nEQ\nEqual to\n\nLT\nLess than\n\nGT\nGreater than\n\nGE\nGreater than or equal to\n\nLE\nLess than or equal to\n\nNE\nNot equal to\n\n#S\nStep condition code tests to be made based on a #SCC statement.\n\nIG\nNo evaluation of the job is done. CA WA CA 7 Edition always assumes that the job completes successfully, regardless of condition codes, abend codes, or run-time JCL errors.\n\nLimits: Invalid with agent jobs.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "schid", - "aliases": [ - "si" - ], - "description": "schid={1|nnn}\n\nIndicates the schedule ID to be used for evaluating JCL overrides that are scheduled with the #Jx or #Xx commands.\n\nDefault: 1\nLimits: 1 to 3 numeric characters from 1 to 999 (See Note)\n\nNo (unless the SCHEDULE statement in the initialization file specifies SCHID=YES, then this parameter is required)", - "type": "string", - "group": "Options" - }, - { - "name": "set", - "description": "set={NDB|NTR|SKP}\n\nSpecifies skip the next scheduled cycle for the job (SKP), disable triggering (NTR), or bypass the database updating at the job completion.\n\nSKP\nSpecifies this run of the job takes the place of the next scheduled run. This value has the same effect as entering NXTCYC,SET=SKP. It is reflected on output from LJOB and LLOCK commands as if NXTCYC,SET=SKP was used. This parameter is invalid if the job has no schedule. SET=SKP has no impact on repeating jobs that are already in the queues.\n\nNTR\nSpecifies normal triggering is disabled only for this run of the job.\n\nNDB\nAllows a job to bypass all load processing at the job completion, but allows other processing to proceed typically.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "stop", - "description": "stop=hhmm\n\nDefines the clock time after which the job is not repeated. STOP is ignored if INTERVAL is not specified.\n\nDefault: 1439 minutes (24 hours minus 1 minute) after the submit time\nLimits: hh=1 through 2 numeric characters from 0 to 23\nmm=2 numeric characters from 00 to 59", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "time", - "description": "time={hhmm|+hhmm}\n\nEstablishes a submit time-of-day requirement for the job.\n\nFormat: hhmm\nDefines the time-of-day where hh is hours (0 through 23) and mm is minutes (00 through 59).\nLeading zeros are not required\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "type", - "description": "type={CLOCK|END|RES|START}\n\nIndicates that the job is being scheduled for rerun.\nThe value must be specified as shown.\n\nTYPE=RES is optional.If used, a restart requirement is placed on the job, and the job has to be manually restarted.Limits: RES, CLOCK, START, or END", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "hold", - "aliases": [ - "h" - ], - "summary": "Holds a job from moving forward to the next queue", - "description": "This function is available on the QM.1 panel with a FILL value of H.\nDepending on the timing and whether you have any other \npredecessor situations, the QM.3 panel can sometimes accomplish this process.\nFor more information on HOLD command, see the techdocs folder in this project.", - "examples": [ - { - "options": "--q RDY", - "description": "Holds the entire RDYQ" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "q", - "description": "example: RDY\nSpecifies to hold the contents of an entire queue.\nPossible values:\nREQ\nSpecifies to hold all jobs currently in the request queue.\nRDY\nSpecifies to hold all jobs currently in the ready queue.\nRequired: Yes, unless job number is used.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "ca7num", - "description": "ca7num=0016\n\nDefines the individual job number to hold. Omit if Q is specified.\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "jclovrd", - "aliases": [ - "jo" - ], - "summary": "Adds a permanent JCL override requirement for a CPU job", - "description": "The JCLOVRD command establishes or satisfies JCL override requirements.", - "examples": [ - { - "options": "--ca7num 0016 --set ON", - "description": "Satisfies JCL override ca7 number 0016" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "ca7num", - "description": "ca7num=0016\n\nDefines the CA 7 job number of the job in the request queue for which to establish or\nremove the override requirement.\nLimits: 1 to 4 numeric characters", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "set", - "description": "example: ON\nSpecifies to establish or satisfy JCL override requirements.\nWhen a job fails with a JCL error, the JCL override requirement is automatically\nset to ON when the job returns to the request queue.\n\nON\nEstablishes a JCL override requirement for the specified job.\nThe SET=ON option is used for jobs in the request queue to indicate that \nan override is needed before execution is to occur.\nOFF\nSatisfies a JCL override requirement for the specified job. The SET=OFF option indicates that a previously defined\nneed (requirement) for overrides has been satisfied and execution can be safely attempted.\nWhen a JCL override requirement is set to OFF,\nthat requirement no longer appears on a requirements list for the job\nWhen a REPL is done from the QM.5 panel, the JCL override requirement is automatically set to OFF.\nWLM\nSets job to allow the insertion of SCHENV= keyword on the JOB \nstatement at submission time when these conditions are true:\nThe scheduling environment insertion feature is activated.\nA scheduling Environment VRM definition is attached to the job (or SCHENV global default).\nNOWLM\nSets job to suppress the insertion of a SCHENV= keyword on the JOB statement at submission\ntime even when one is typically associated with the job.\nThis option can be used when the validation of an associated IBM WLM scheduling environment \nhas failed causing the job to be requeued (see Browse message SSM0-42).\nFSetting the NOWLM option lets you submit the job without SCHENV= keyword insertion.", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "post", - "aliases": [ - "po" - ], - "summary": "Posts the requirement for a job", - "description": "The POST command indicates to the CA Workload Automation CA 7 Editionsystem that a preexecution requirement for a job in the request queue is satisfied", - "examples": [ - { - "options": "--ca7num 0016", - "description": "The requirement for ca7 number 0016 in the request queue is satisfied" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "ca7num", - "description": "ca7num=0016\n\nIndicates the job number in up to four digits, for which requirements are posted.", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "usr", - "description": "example: USER WILL CALL TO RELEASE\n(Optional) Identifies a user-defined description of a requirement to post as satisfied.\nMutually exclusive with DEPJOB and DSN.\nWhen used, must match the text that is used to define the requirement on the DB.6 panel or with the ADDRQ command.\n\nLimits: 1 to 36 alphanumeric characters", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "depjob", - "description": "example: PAYJOB\n(Optional) Identifies a predecessor job dependency requirement to post as satisfied.\nValue must be a specific job name.\nMutually exclusive with DSN and USR.\n\nIn normal situations, CA WA CA 7 Edition automatically posts this type of requirement when the predecessor job completes its execution successfully.\nA manual posting is only necessary if a job defined as a requirement was not to be run,\nor ran unsuccessfully and a successor job is to be run.The DEPJOB must be posted if it is not currently defined to CA WA CA 7 Edition\n(an external job).\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "dsn", - "description": "example: CA7.DSN1\n(Optional) Identifies a data set requirement to post as satisfied.\nValue can be a specific data set name or a CA WA CA 7 Edition data set number.\nIf you are using a number, only the number can be specified without the DS prefix.\n\nMutually exclusive with DEPJOB and USR.\ndsname\nIndicates a specific data set name.\nLimits: 1 to 44 alphanumeric characters\ndsnumber\nIndicates a specific data set number. \nLimits: 1 to 8 numeric characters", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "internal", - "description": "example: YES\n(Optional) Valid only with DSN to indicate that the data set being posted is internal to the CA WA CA 7 Edition workload.\nYES is the only acceptable value.\nMutually exclusive with USR, DEPJOB, and PREQ.\nIn normal situations, CA WA CA 7 Edition automatically posts requirements for internal data sets.\nLimits: YES is the only acceptable value.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "preq", - "description": "example: (17,19,20,32)\n(Optional) Valid only with DSN to identify up to 11 numeric values to include\nwith other CA WA CA 7 Edition log data logged as a result of the POST command being issued.\nMutually exclusive with USR, DEPJOB, and INTERNAL.\nCode values in sublist form, within parentheses.\nYou can code up to 11 values that are separated by commas between the parentheses.\nEach value cannot exceed 4 numeric digits.\nThis optional field can be useful for logging any meaningful numbers, such as batch numbers, which can later be reviewed in the log data set.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "rmtjob", - "description": "example: RMT_JOB\n\nNames the job in the remote scheduler that is required by the job specified in the JOB field.\nLimits: RMTJOB should accept up to 64 characters\nvalid characters are a-z, A-Z, 0-9, period (.), underscore (_), hyphen (-),\ncolon (:), and pound (#); do not include embedded spaces or tabs.\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "rmtschd", - "description": "example: AP1\n\nNames the remote scheduler where the predecessor job runs.\nBefore adding this requirement, the remote scheduler must be defined.\nThe remote scheduler defined as type LOCAL cannot be specified.\nLimits: 1 to 3 alphanumeric characters; generic specification not supported.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "prscf", - "aliases": [ - "pc" - ], - "summary": "Frees a shared resource that belongs to a job", - "description": "The PRSCF command frees a shared, exclusive, or RCT resource that is connected to a job", - "examples": [ - { - "options": "--job 1234 --rsrc ZOWECRM1", - "description": "Frees a shared resource name, ZOWECRM1 that attached to the job 1234" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "job", - "description": "example: 1234\n\nSpecifies the CA Workload Automation CA 7 Edition job name or number to which the resource is attached.\njobnumber\nIndicates a specific CA 7 job number.\nLimits: 1 to 4 numeric characters", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "rsrc", - "description": "example: RESOURCE.TYPE2.EXEC\n\nSpecifies the fully qualified resource name to free.\nYou can optionally specify * to indicate to free all resources that are connected to the job.\nLimits: 1 to 44 alphanumeric characters", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "force", - "description": "example: YES\n\n(Optional) FORCE=YES indicates that CA WA CA 7 Edition is not to evaluate\n\nthe availability of the named resources for this run of the job only.\nThis run of the job does not use the named resources.\nThis keyword can be used on an exception basis to let a job in a \nW-RSRC status bypass VRM checking for one or more resources defined for it on the RM.1 panel.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "prsqa", - "aliases": [ - "pq" - ], - "summary": "Activates a co-requisite resource", - "description": "The PRSQA command activates a corequisite resource", - "type": "command", - "handler": "", - "examples": [ - { - "options": "--rsrc CICSREG8", - "description": "Activates a corequisite resource name CICSREG8" - } - ], - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "rsrc", - "description": "example: CICSREG8\n\nSpecifies a fully qualified corequisite resource name.\nLimits: 1 to 44 alphanumeric characters", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "internal", - "description": "example: YES\n\n(Optional) If YES or Y is specified, the command is not forwarded to other CA 7 instances\n\neven if VRM Corequisite Propagation is enabled and the resource name matches the selection criteria.\n\nDefault: NO", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "release", - "aliases": [ - "rl" - ], - "summary": "Release or resumed for jobs or queues on hold", - "description": "Release a single job to CA 7.", - "examples": [ - { - "options": "--ca7num 0016", - "description": "Release ca7 number 0016 from CA 7" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "q", - "description": "Q={REQ|RDY}\n\nIndicates to release the contents of an entire queue. Omit Q when JOB or JOBL is specified.\n\nREQ\nRelease the contents of the request queue.\n\nRDY\nRelease the contents of the ready queue.", - "type": "string", - "conflictsWith": [ - "ca7num" - ], - "group": "Options", - "aliases": [] - }, - { - "name": "ca7num", - "description": "ca7num=0016\n\nDefines the name of the job number to release.\nIndicates the individual job to release. JOB is required to release a specific job. Omit JOB when JOBL or Q is specified.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "requeue", - "aliases": [ - "rq" - ], - "summary": "Re-queues CA 7 jobs", - "description": "Re-queues jobs from the ready or active queues back to the request queue.", - "examples": [ - { - "options": "--q RDY", - "description": "Requeues jobs in the ready queue back to the request queue" - } - ], - "type": "command", - "handler": "", - "options": [ - { - "name": "agent", - "description": "example: UXAGENT\n(Optional) Indicates the agent name or mask that an agent name must match for an agent job\n\nbefore it is moved back to the request queue, is given a restart requirement, and is flagged as having been requeued.\nAGENT cannot be used with CPU, MAINID, or NODE.\nFor any agent job that is requeued, a cancel request is sent to the agent running the job.\nThe status of the agent or the computer on which the agent is running determines whether the request is honored.\nLimits: 1 to 16 alphanumeric charactersDefault: * (all agent names)", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "cpu", - "description": "example: 34\n(Optional) Used with JOB to specify the CPU ID of active queue jobs that are to be requeued.\nThe value identifies the CPU and corresponds to the CPU field displayed on the LQ command (the SMF identifier).\nCPU cannot be used with MAINID, NODE, or AGENT.\nThe CPU parameter is ignored if used with a JOB parameter that references a specific job name or job number, but not if a job mask is specified.\nLimits:\n1 to 4 numeric characters", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "force", - "description": "example: CMP\n(Optional) Resumes job completion for stranded jobs.\nWhen a job finishes executing, it must move to the request queue so that CA WA CA 7 Edition\ncan process the database and queue updates that are required for job completion.\nBut, if a job cannot be moved because of an I/O error or an out-of-space condition on the request queue,\nthe job may be stranded in the ready or active queue, unable to complete\nOnce the request queue error is corrected, you can use REQUEUE with FORCE=CMP to resume job completion for these jobs.\nLimits: CMP is the only value", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "ca7num", - "description": "example: 0029\n(Optional) Indicates the job number\nmust match before it is moved back to the request queue, is given a restart requirement, and is flagged as having been requeued.\nIf JOB is used alone, both the active and ready queues are searched for the specified job number.\nIf JOB is used with Q, the search is restricted to the indicated queue. jobname,jobnumber and longjobname are mutually exclusive\nDefault:\n* (all jobs)Limits:\n1 to 8 alphanumeric characters", - "type": "string", - "conflictsWith": [ - "jobname", - "longjobname" - ], - "group": "Options", - "aliases": [] - }, - { - "name": "jobname", - "aliases": [ - "jn" - ], - "description": "example: PAYROLL\n(Optional) Indicates the job name, or mask that a job name\nmust match before it is moved back to the request queue, is given a restart requirement, and is flagged as having been requeued.\nIf JOB is used alone, both the active and ready queues are searched for the specified job.\nIf JOB is used with Q, the search is restricted to the indicated queue. jobname,jobnumber and longjobname are mutually exclusive.\nDefault:\n* (all jobs)Limits:\n1 to 8 alphanumeric characters", - "type": "string", - "group": "Options" - }, - { - "name": "longjobname", - "aliases": [ - "ljn" - ], - "description": "example: ALONGJOBNAME\n(Optional) Indicates the long job name or mask that a long job name must match before\nit is moved back to the request queue, is given a restart requirement, and is flagged as having been requeued.\nIf JOBL is used alone, both the active and ready queues are searched for the specified long job name.\nIf JOBL is used with Q, the search is restricted to the indicated queue.jobname,jobnumber and longjobname are mutually exclusive\nLimits: 1 to 64 alphanumeric characters", - "type": "string", - "group": "Options" - }, - { - "name": "mainid", - "description": "example: ALL|SY2|/SY3\n(Optional) Used with JOB to indicate that only those jobs in the ready queue with this MAINID are to be requeued.\nValue must be specified as a single MAINID name.\nMAINID cannot be used with CPU, NODE, or AGENT.\nThe MAINID parameter is ignored if used with a JOB parameter that references a specific job name or job number, but not if a job mask is specifie_\nThe name must be one of the following values:\nALL Indicates that all MAINIDs are considered.\nSYn Where n indicates a CPU assigned number as defined in the initialization file CPU statement.\nThe value of n can range from 1 to 7.\n/SYn\nWhere n indicates a CPU assigned number. The / indicates “not this MAINID.\nThe value of n can range from 1 to 7.\nLimits: 1 to 4 alphanumeric characters", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "node", - "description": "example: NODEXP\n(Optional) Indicates the node name or mask that a node name must match for an XPJOB job,\nbefore it is moved back to the request queue, is given a restart requirement, and is flagged as having been requeued.\nNODE cannot be used with CPU, MAINID, or AGENT.\nFor any XPJOB that is requeued, a cancel request is sent to the node where the job is running\n(assuming the initialization file XPDEF statement parameter XPKILL=NO is not set).\nThe status of the node or the computer that the node points to, determines whether the request is honored.\nLimits:\n1 to 8 alphanumeric characters", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "q", - "description": "q=RDY\n\nUsed with JOB to indicate in which queue the job search is to occur\nACT The active queue. RDY The ready queue.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "type", - "description": "(Optional) Flags the job after it returns to the request queue with a status of JCLERR instead of REQUE.\nIf not coded, the status reflects REQUE.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [] - } - ], - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "resolv", - "aliases": [ - "rslv" - ], - "summary": "The RESOLV command creates or modifies processing schedules for jobs that are to be scheduled on a date/time basis.", - "description": "Work that is scheduled by a trigger or on-request work that is DEMANDed or RUN has no direct relationship to a base calendar and therefore does not require the use of this function.", - "examples": [ - { - "options": "--job AJOB", - "description": "Creates or modifies processing schedules for jobs, AJOB from CA 7" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "job", - "description": "example: AJOB*\n\nLimits selection for resolution to the jobs specified. If omitted, all job schedules are candidates for resolution. Value can be a specific job name or a generic name that identifies multiple jobs beginning with the specified characters.\nAn asterisk (*) must be used to delimit the generic job name. The asterisk can appear in any of the eight positions but must immediately follow the last significant character of the job name requested.\nFor example: \nAB* causes all jobs beginning with AB to be selected for resolution.\n* causes all job schedules to be selected for resolution.\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "duplicateDate", - "aliases": [ - "ddate" - ], - "description": "example: NO\n\nIndicates whether to produce specific duplicate day messages (SRC1-137) each time that two or more schedule IDs for the same job schedule a given day.\nThe default is NO unless the extended resolve message option is set in the user profile by the /PROF command.\n\n", - "type": "string", - "group": "Options" - }, - { - "name": "oldYear", - "aliases": [ - "oyr" - ], - "description": "example: 22\n\nSpecifies the year that is defined in the schedule member data (the value that is supplied by YEAR in the previous resolution that updated the schedule member).\nOnly those candidate schedule members whose year data matches the OLDYR value are selected for resolution.\nIf used, use one of the following values:\nempty: It is default, if omitted, only those schedule members that have not previously been resolved or whose schedules have expired are selected.\nyy: Indicates a specific year.\n*: Indicates all years and all schedules.\n", - "type": "string", - "group": "Options" - }, - { - "name": "print", - "description": "example: YES\n\nSpecifies whether to display a month-by-month schedule day calendar after resolution of the defined member is complete.\nIf used, value must be YES or NO (default).\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "scal", - "description": "example: 22\n\nValue is the xx portion of the base calendar name, SCALyyxx.\nThe SCAL value must also match the base calendar identifier (SCAL) specified in any SCHID of the schedule definition for the individual jobs.\nThis value is used during the selection process of resolution to determine which schedule members to resolve.\nRequired: No (unless JOB is omitted)\n*: Indicates all SCALs.\nxx: Indicates a specific SCAL.\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "test", - "description": "example: NO\n\nIndicates whether schedule members are updated because of the resolution process. YES and NO are the only allowable values.\nYES: Normal resolution occurs and all messages are printed, but no updating of the database occurs.This option can be used at a year-end or whenever a base calendar is changed to see the results of the resolution activity, without actually changing the schedule mask or affecting the current schedule process. YES is the default.\nNO: Normal resolution occurs and all messages are printed, and updating of the database occurs.\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "year", - "description": "example: 20\n\nIdentifies the year of the base calendars against which the schedule is resolved. The value is the number that is the yy portion of the base calendar name, SCALyyxx.\nWhen a schedule is successfully updated, the YEAR value becomes part of the schedule data (see OLDYR). If the YEAR parameter is not specified, the current year is assumed to be the year from the system internal date and time.\nAlso, if YEAR is not coded on the RESOLV, a determination is made to see whether the RESOLV is made within the period January 1 through June 30 as determined from system date and time.\nIf so, the schedule is resolved against January through December of the current year. If a RESOLV is done within the period July 1 through December 31, the schedule is resolved against July 1 through December 31 of the current year and January 1 through June 30 of the next year.\nThis behavior requires the existence of base calendars for calendar years involved. If a required base calendar is not available, an error message is issued. The schedule member is unresolved, unless a perpetual calendar is defined for this SCALyyXX. In that case, the calendar is generated from the PCALYYXX member in the perpetual calendar data set. YEAR is optional. If YEAR is specified, the resolution is made against January through December of the year specified.\nDefault: Current year\nLimits: 2 numeric characters\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "restart", - "aliases": [ - "rs" - ], - "summary": "Restart a job awaiting in the request queue", - "description": "Restart a single job to CA 7.", - "examples": [ - { - "options": "--ca7num 0016", - "description": "Restart ca7 number, 0016 from CA 7" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "ca7num", - "description": "ca7num=0016\n\nDefines the name of the job to Restart.\nIndicates the individual job to Restart, and the value must be a CA 7 job number.", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "bypgdg", - "aliases": [ - "bp" - ], - "description": "bypgdg={NO|YES|VER|CAT}\n\nIndicates whether CA Workload Automation Restart Option for z/OS Schedulers bypasses GDG logic on a restart/rerun.\nValue can be NO, YES, VER, or CAT.\n\nDefault: CA Workload Automation Restart Option for z/OS Schedulers default value", - "type": "string", - "group": "Options" - }, - { - "name": "condcd", - "aliases": [ - "cc" - ], - "description": "condcd=nnnn\n\nIndicates an optional CA Workload Automation Restart Option for z/OS Schedulers condition code\nthat the CA Workload Automation Restart Option for z/OS Schedulers step sets when the rerun is executed.\n\nThis option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use\nand CA Workload Automation CA 7® Edition is inserting the RMS step.\nSee the INSERT-RMS field on the DB.1 panel.\n\nLimits: 1 to 4 numeric characters from 0 to 4095", - "type": "string", - "group": "Options" - }, - { - "name": "forcecomp", - "aliases": [ - "fc" - ], - "description": "forcecomp={NO|YES}\n\nIndicates whether to flag the job as a normal completion.\nIf FORCECOMP=YES, the previous abnormal status of the job is ignored.\n\nNormal job completion processing is performed instead of a restart.\nValue can be NO or YES. NO is the default.", - "type": "string", - "group": "Options" - }, - { - "name": "lcc", - "description": "lc=nnnn\n\nIndicates an optional condition code value that replaces the last \ncondition code value for the step that the LSTP references and, optionally, LPSTP keywords.\n\nThis option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.\n\nDefault: 0\nLimits: 1 to 4 numeric characters from 0 to 4095", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "lstp", - "description": "lstp=JS050\n\nIndicates an optional step name that has its last condition code value reset in the\nCA Workload Automation Restart Option for z/OS Schedulers CMT.\n\nCode LSTP and LCC when LPSTP is specified.\nLSTP requires that an STPSTRT value is specified and that the LSTP step name occurs in the JCL of the job before the STPSTRT step name.\n\nThis option is honored only when CA Workload Automation Restart Option for z/OS Schedulers is in use.\n\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "lpstp", - "description": "lpstp=COPY010\n\nIndicates an optional step name referencing a procedure that has its last condition code value reset\nin the CA Workload Automation Restart Option for z/OS Schedulers CMT.\n\nIf LPSTP is used, also code LSTP and LCC.\nThis option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.\n\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "procstrt", - "aliases": [ - "ps" - ], - "description": "procstrt=procname\n\nIndicates an optional step name referencing a procedure where processing is to start.\nIf PROCESS=R and PROCSTRT are used, also code STPSTRT.\n\nThis option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.\n\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "group": "Options" - }, - { - "name": "procend", - "aliases": [ - "pe" - ], - "description": "procend=procname\n\nIndicates an optional step name referencing a procedure where processing is to end.\n\n If PROCESS=R and PROCEND are used, code STPEND.\nThis option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.\n\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "group": "Options" - }, - { - "name": "process", - "description": "process=code\n\nIndicates an optional CA Workload Automation Restart Option for z/OS Schedulers processing function code character to use in the restart/rerun.\n\nThis option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use\nand CA WA CA 7 Edition is inserting the RMS step.\n\nSee the INSERT-RMS field on the DB.1 panel. Value can be F, P, S, N, O, or R.\n\nDefault: P\nLimits: 1 alphabetic character", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "reason", - "aliases": [ - "r" - ], - "description": "reason=text\n\nSpecifies a reason for the restart.\nIf the CA Workload Automation Restart Option for z/OS Schedulers Reason-for-Rerun module is available,\na code of up to four characters can be input and it is expanded.\n\nAny reason input or expanded is copied to the run log.\n\nThis field is optional unless CA Workload Automation Restart Option for z/OS Schedulers requires a reason or\nREASON=YES was specified in the RESTART statement in the initialization file.\n\nLimits: 1 to 40 alphanumeric characters", - "type": "string", - "group": "Options" - }, - { - "name": "stpend", - "aliases": [ - "se" - ], - "description": "stpend=stepname\n\nIndicates an optional step name or number at which processing is to end.\nIf not specified, the last step of the job is assumed to be the ending step.\n\nCode STPEND when PROCEND is specified.\nThis option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.\n\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "group": "Options" - }, - { - "name": "stpstrt", - "aliases": [ - "ss" - ], - "description": "stpstrt={stepname|*CMT*|*RERUN*|*RESUBP*}\n\nIndicates an optional step name or number at which processing is to start.\nIf STPSTRT is not coded, the first step of the job is assigned to be the starting step.\n\nCode STPSTRT when PROCSTRT is specified. This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.\nIt can be one of\n\nstepname\nSpecifies the step name or number at which processing is to start.\n\n*CMT*\nIndicates that the job is to restart with the step values currently on the CMT record.\n\n*RERUN*\nIndicates to rerun t the total job. If there are no restartable steps, specify RERUN.\n\n*RESUBP*\nIndicates that the CMT record of the job is set to production, and then the job is submitted.", - "type": "string", - "group": "Options" - }, - { - "name": "sup11stp", - "aliases": [ - "su" - ], - "description": "sup11stp={NO|YES}\n\nIndicates whether to suppress the insertion of the CA Workload Automation Restart Option for z/OS Schedulers RMS step.\n\nIf the job is resubmitted with SUP11STP=YES, the CA Workload Automation Restart Option for z/OS Schedulers step is not inserted.\n\nOnly valid if CA WA CA 7 Edition is inserting the CA Workload Automation Restart Option for z/OS Schedulers step.\n\nSee the INSERT-RMS field on the DB.1 panel.\nValue can be NO or YES. NO is the default.", - "type": "string", - "group": "Options" - }, - { - "name": "usage", - "description": "usage=code\n\nIndicates an optional CA Workload Automation Restart Option for z/OS Schedulers\nusage code of the character to use in the restart/rerun.\n\nFor the values, see the CA Workload Automation Restart Option for z/OS Schedulers documentation.\n\nThis option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use and\nCA WA CA 7 Edition is inserting the RMS step.\n\nSee the INSERT-RMS field on the DB.1 panel.\nLimits: 1 alphanumeric character", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "ca11rstp", - "aliases": [ - "c" - ], - "description": "ca11rstp={Y|YES}\n\nDisplays the CA11 restart step. Value can be Y or YES.", - "type": "string", - "group": "Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "run", - "aliases": [ - "r" - ], - "summary": "Run a CA 7 job", - "description": "Run a single job to CA 7.", - "examples": [ - { - "options": "--job PAYROLL", - "description": "Run a job, PAYROLL to CA 7" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "job", - "description": "job=PAYROLL\n\nDefines the long name of the job to run.\nThe ran jobs are placed in the request queue and assigned a unique CA 7 job number.", - "type": "string", - "conflictsWith": [ - "jobl" - ], - "group": "Options", - "aliases": [] - }, - { - "name": "jobl", - "description": "job=payrollSW123\n\nIdentifies the job to submit.\nThe value must be a long job name.\nIf the job has not been defined in the database, use JOB instead.\nSee also JCLID. JOB and JOBL are mutually exclusive.\nLimits:\n1 to 64 alphanumeric characters\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "arfset", - "aliases": [ - "as" - ], - "description": "arfset={arfsetname|**NONE**}\n\nDefines the ARF set name that is used for this run of the job.\nIf you specify **NONE**, no ARF processing is performed for this run of the job.\n\nLimits: 1 to 8 alphanumeric characters or **NONE**", - "type": "string", - "group": "Options" - }, - { - "name": "class", - "description": "class=n\n\nDefines the workload balancing class for resource checking.\n\nLimits: 1 alphanumeric character", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "dotm", - "description": "dotm=hhmm\n\nDefines the due-out time-of-day for the job in hours (hh) and minutes (mm).\nIf DOTM is specified on the DEMAND/DEMANDH command and the value that is given is earlier than the current time, the due-out day is assumed to be the following day.\n\nIf DOTM and LEADTM are both omitted, then deadline start time is assumed to be the current time plus the LEADTM.\n\nLimits: hh= 2 numeric characters from 0 to 24\nmm= 2 numeric characters from 00 to 59\n\nRequired: No (unless DATE is used, if so, DOTM or TIME must be specified)", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "exec", - "aliases": [ - "e" - ], - "description": "exec={NO|YES}\n\nSpecifies whether to execute the job (YES/NO).\nIf NO (N) is used, the job does not run but shows a normal completion as if it did run. The value that is specified here overrides the value that is coded on the job definition EXEC field.\n\nDefault: The job definition panel EXEC value if the job is defined to CA WA CA 7 Edition; otherwise YES.", - "type": "string", - "group": "Options" - }, - { - "name": "jclid", - "aliases": [ - "ji" - ], - "description": "jclid=10\n\nDefines the JCL data set that contains the execution JCL to be submitted.\n\nIf used, the value must be a numeric INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).\n\nIf the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 1 to 3 numeric characters from 0 through 254 and from 256 through 999. 255 is reserved.", - "type": "string", - "conflictsWith": [ - "jcllib" - ], - "group": "Options" - }, - { - "name": "jcllib", - "aliases": [ - "jl" - ], - "description": "jcllib=&SPECIAL\n\nDefines the JCL data set that contains the execution JCL to be submitted.\n\nIf used, the value must be a symbolic INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).\n\nIf the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 2 to 16 alphanumeric characters beginning with ampersand (&)", - "type": "string", - "group": "Options" - }, - { - "name": "late", - "description": "late={NO|YES}\n\nSpecifies whether a notification occurs when the job becomes late.\nSpecify YES (Y) to make the job eligible to be marked LATE. If NO (N) is used, the job is never marked LATE. The value that is specified here overrides the value that is coded on the job definition PROMPTS field.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "leadtm", - "aliases": [ - "lt" - ], - "description": "leadtm={0100|hhmm}\n\nSpecifies the lead (processing) time that is required for the job to run.\nIf omitted, 1 hour is usedFormat: hhmm\nLimits: hh= 2 numeric characters from 0 to 24\nmm= 2 numeric characters from 00 to 59You can omit leading zeros.", - "type": "string", - "group": "Options" - }, - { - "name": "mainid", - "aliases": [ - "mi" - ], - "description": "mainid={ALL|SYn|/SYn|-SYn}\n\nSpecifies the MAINID, as defined in the initialization file CPU statement, to which you want to redirect the job.\nThe value that is specified here overrides the value that is coded on the job definition MAINID field. The name must be one of the following values:\n\nALL\nSpecifies all CPUs are acceptable for executing the job.\n\nSYn\nn defines the CPU to which the job is being redirected. The value of n can range from 1 to 7.\n\n/SYn\nn defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.\n\n-SYn\nn defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.\n\nLimits: Invalid for internal cross-platform jobs.", - "type": "string", - "group": "Options" - }, - { - "name": "rms", - "description": "rms={NO|YES}\n\nSpecifies whether CA WA CA 7 Edition inserts the CA Workload Automation Restart Option for z/OS Schedulers RMS step.\n\nSpecify YES (Y) to insert the step with the CA Workload Automation Restart Option for z/OS Schedulers processing code of P. Enter NO (N) to indicate that the RMS step is not inserted.\n\nThe value that is specified here overrides the value that is coded on the job definition INSERT-RMS field.\nDefault: The job definition panel INSERT-RMS value if job defined to CA WA CA 7 Edition; otherwise NO.\nLimits: Invalid for internal cross-platform jobs.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "schid", - "aliases": [ - "si" - ], - "description": "schid={1|nnn}\n\nIndicates the schedule ID to be used for evaluating JCL overrides that are scheduled with the #Jx or #Xx commands.\n\nDefault: 1\nLimits: 1 to 3 numeric characters from 1 to 999 (See Note)\n\nNo (unless the SCHEDULE statement in the initialization file specifies SCHID=YES, then this parameter is required)", - "type": "string", - "group": "Options" - }, - { - "name": "time", - "description": "time={hhmm|+hhmm}\n\nEstablishes a submit time-of-day requirement for the job.\n\nFormat: hhmm\nDefines the time-of-day where hh is hours (0 through 23) and mm is minutes (00 through 59).\nLeading zeros are not required\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "type", - "description": "type={CLOCK|END|RES|START}\n\nIndicates that the job is being scheduled for rerun.\nThe value must be specified as shown.\n\nTYPE=RES is optional.If used, a restart requirement is placed on the job, and the job has to be manually restarted.Limits: RES, CLOCK, START, or END", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "runh", - "aliases": [ - "rh" - ], - "summary": "Run a CA 7 job and place the job in hold status", - "description": "Run and hold a single job to CA 7.", - "examples": [ - { - "options": "--job PAYROLL", - "description": "Run and holds a job, PAYROLL to CA 7" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "job", - "description": "job=PAYROLL\n\nDefines the long name of the job to run.\nThe ran jobs are placed in the request queue and assigned a unique CA 7 job number.", - "type": "string", - "conflictsWith": [ - "jobl" - ], - "group": "Options", - "aliases": [] - }, - { - "name": "jobl", - "description": "job=payrollSW123\n\nIdentifies the job to submit.\nThe value must be a long job name.\nIf the job has not been defined in the database, use JOB instead.\nSee also JCLID. JOB and JOBL are mutually exclusive.\nLimits:\n1 to 64 alphanumeric characters\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "arfset", - "aliases": [ - "as" - ], - "description": "arfset={arfsetname|**NONE**}\n\nDefines the ARF set name that is used for this run of the job.\nIf you specify **NONE**, no ARF processing is performed for this run of the job.\n\nLimits: 1 to 8 alphanumeric characters or **NONE**", - "type": "string", - "group": "Options" - }, - { - "name": "class", - "description": "class=n\n\nDefines the workload balancing class for resource checking.\n\nLimits: 1 alphanumeric character", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "dotm", - "description": "dotm=hhmm\n\nDefines the due-out time-of-day for the job in hours (hh) and minutes (mm).\nIf DOTM is specified on the DEMAND/DEMANDH command and the value that is given is earlier than the current time, the due-out day is assumed to be the following day.\n\nIf DOTM and LEADTM are both omitted, then deadline start time is assumed to be the current time plus the LEADTM.\n\nLimits: hh= 2 numeric characters from 0 to 24\nmm= 2 numeric characters from 00 to 59\n\nRequired: No (unless DATE is used, if so, DOTM or TIME must be specified)", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "exec", - "aliases": [ - "e" - ], - "description": "exec={NO|YES}\n\nSpecifies whether to execute the job (YES/NO).\nIf NO (N) is used, the job does not run but shows a normal completion as if it did run. The value that is specified here overrides the value that is coded on the job definition EXEC field.\n\nDefault: The job definition panel EXEC value if the job is defined to CA WA CA 7 Edition; otherwise YES.", - "type": "string", - "group": "Options" - }, - { - "name": "jclid", - "aliases": [ - "ji" - ], - "description": "jclid=10\n\nDefines the JCL data set that contains the execution JCL to be submitted.\n\nIf used, the value must be a numeric INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).\n\nIf the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 1 to 3 numeric characters from 0 through 254 and from 256 through 999. 255 is reserved.", - "type": "string", - "conflictsWith": [ - "jcllib" - ], - "group": "Options" - }, - { - "name": "jcllib", - "aliases": [ - "jl" - ], - "description": "jcllib=&SPECIAL\n\nDefines the JCL data set that contains the execution JCL to be submitted.\n\nIf used, the value must be a symbolic INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).\n\nIf the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 2 to 16 alphanumeric characters beginning with ampersand (&)", - "type": "string", - "group": "Options" - }, - { - "name": "late", - "description": "late={NO|YES}\n\nSpecifies whether a notification occurs when the job becomes late.\nSpecify YES (Y) to make the job eligible to be marked LATE. If NO (N) is used, the job is never marked LATE. The value that is specified here overrides the value that is coded on the job definition PROMPTS field.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "leadtm", - "aliases": [ - "lt" - ], - "description": "leadtm={0100|hhmm}\n\nSpecifies the lead (processing) time that is required for the job to run.\nIf omitted, 1 hour is usedFormat: hhmm\nLimits: hh= 2 numeric characters from 0 to 24\nmm= 2 numeric characters from 00 to 59You can omit leading zeros.", - "type": "string", - "group": "Options" - }, - { - "name": "mainid", - "aliases": [ - "mi" - ], - "description": "mainid={ALL|SYn|/SYn|-SYn}\n\nSpecifies the MAINID, as defined in the initialization file CPU statement, to which you want to redirect the job.\nThe value that is specified here overrides the value that is coded on the job definition MAINID field. The name must be one of the following values:\n\nALL\nSpecifies all CPUs are acceptable for executing the job.\n\nSYn\nn defines the CPU to which the job is being redirected. The value of n can range from 1 to 7.\n\n/SYn\nn defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.\n\n-SYn\nn defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.\n\nLimits: Invalid for internal cross-platform jobs.", - "type": "string", - "group": "Options" - }, - { - "name": "rms", - "description": "rms={NO|YES}\n\nSpecifies whether CA WA CA 7 Edition inserts the CA Workload Automation Restart Option for z/OS Schedulers RMS step.\n\nSpecify YES (Y) to insert the step with the CA Workload Automation Restart Option for z/OS Schedulers processing code of P. Enter NO (N) to indicate that the RMS step is not inserted.\n\nThe value that is specified here overrides the value that is coded on the job definition INSERT-RMS field.\nDefault: The job definition panel INSERT-RMS value if job defined to CA WA CA 7 Edition; otherwise NO.\nLimits: Invalid for internal cross-platform jobs.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "schid", - "aliases": [ - "si" - ], - "description": "schid={1|nnn}\n\nIndicates the schedule ID to be used for evaluating JCL overrides that are scheduled with the #Jx or #Xx commands.\n\nDefault: 1\nLimits: 1 to 3 numeric characters from 1 to 999 (See Note)\n\nNo (unless the SCHEDULE statement in the initialization file specifies SCHID=YES, then this parameter is required)", - "type": "string", - "group": "Options" - }, - { - "name": "time", - "description": "time={hhmm|+hhmm}\n\nEstablishes a submit time-of-day requirement for the job.\n\nFormat: hhmm\nDefines the time-of-day where hh is hours (0 through 23) and mm is minutes (00 through 59).\nLeading zeros are not required\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "type", - "description": "type={CLOCK|END|RES|START}\n\nIndicates that the job is being scheduled for rerun.\nThe value must be specified as shown.\n\nTYPE=RES is optional.If used, a restart requirement is placed on the job, and the job has to be manually restarted.Limits: RES, CLOCK, START, or END", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "submit", - "aliases": [ - "sm" - ], - "summary": "Modifies and expedites the jobs already residing in the queues", - "description": "The SUBMIT top line command modifies and expedites the process of job submission for jobs already residing in the queues", - "examples": [ - { - "options": "--ca7num 0016", - "description": "Submit ca7 number, 0016 to CA 7" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "ca7num", - "description": "ca7num=0016\n\nDefines the name of the job to Submit.\nIndicates the individual job to Submit, and the value must be a CA 7 job number.", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "express", - "aliases": [ - "ex" - ], - "description": "example: YES\n\n(Optional) Indicates to place the job ahead of all other jobs (those jobs without EXPRESS=YES) for submission.\n\nThe value must be coded as shown. Not valid if workload balancing is being used.\n\nUse of EXPRESS=YES does not establish an increased execution priority for a job.\n\nRather, it ensures that nonexpress jobs are not submitted ahead of a job that is flagged as an express job.", - "type": "string", - "group": "Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "subtm", - "aliases": [ - "st" - ], - "summary": "Modifies the required submit time-of-day for a job in the request queue", - "description": "SUBTM modifies the required submit time-of-day for a job in the request queue", - "examples": [ - { - "options": "--ca7num 0016", - "description": "Modifies the required submit time for a ca7 number, 0016" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "ca7num", - "description": "ca7num=0016\n\nSpecifies the CA 7 job number of the job or which you want to add, modify, or remove a submit time-of-day requirement.\n\nLimits: 1 to 4 alphanumeric characters", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "time", - "aliases": [ - "tm" - ], - "description": "example: 1830\n\n(Optional) Specifies the new submit time-of-day in hours and minutes.\n\nTIME is required to add a submit time-of-day requirement when none exists or to change an existing requirement.\n\nIf TIME is omitted, an existing submit time-of-day restriction is removed. Format:hhmm\n\nDefines the time-of-day where hh is hours (0 through 24) and \n\nmm is minutes (00 through 59). Maximum is 2400.\n\nIf the value given is less than the current time (when the command is processed), the submit day is incremented by one.", - "type": "string", - "group": "Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "verify", - "aliases": [ - "v" - ], - "summary": "Set the manual verification requirement for a job in the request queue", - "description": "The VERIFY command establishes or satisfies a manual verification requirement for a currently scheduled run of the job in the request queue before its execution. ", - "examples": [ - { - "options": "--ca7num 0016", - "description": "Specifies a verification requirement for ca7 number, 0016" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "ca7num", - "description": "ca7num=0016\n\nSpecifies the CA 7 job number of the job or which you want to add, modify, or remove a submit time-of-day requirement.\n\nLimits: 1 to 4 alphanumeric characters", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "set", - "description": "example: ON\n\nSets the verification requirement.\n\nON\n\nEstablishes a manual verification requirement that did not previously exist.\n\nOFF\n\nIndicates that a previously established manual verification requirement is satisfied and can be\n\nremoved. A verification requirement no longer appears on the requirements list in the request queue.", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "rmtsub", - "aliases": [ - "rsub" - ], - "summary": "Remote Subscribe to a CA 7 job", - "description": "The RMTSUB command is used by a scheduling product that has a remote job dependency on a CA 7 job.\n", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "job", - "description": "job=0123\n\nSpecifies the CA Workload Automation CA 7 Edition job name or number to which the resource is attached.\n1-4 numeric characters, specifies the CA7 job number", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "rmtschd", - "description": "example: AP1\n\nNames the remote scheduler where the predecessor job runs.\nBefore adding this requirement, the remote scheduler must be defined.\nThe remote scheduler defined as type LOCAL cannot be specified.\nLimits: 1 to 3 alphanumeric characters; generic specification not supported.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": "--job 0123", - "description": "Rmtsub job, 0123 to CA 7" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "rmttrk", - "aliases": [ - "rtrk" - ], - "summary": "Defines a dependency on a remote CA 7 job.", - "description": "The RMTTRK defines a dependency on a job in a remote CA 7 workload.", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "remote-sched", - "aliases": [ - "rs" - ], - "description": "remote-sched=AS1\n\nThe name of publishing scheduler that issues this RMTTRK command.\nMust be defined to receiving CA7ONL using XN.7.\nThis name is provided to the remote scheduler at subscription time.\nLimists: 1-4 alphanumeric characters", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "job-name", - "aliases": [ - "jn" - ], - "description": "job-name=PAYJOB\n\nThe name of job running in the publishing scheduler that invokes this command.\nLimits: Autosys job names can be up to 64 characters.Valid characters are a-z, A-Z, 0-9, period (.),underscore (_), hyphen (-), colon (:), and pound (#).Do not include embedded spaces or tabs.", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "status", - "description": "status=FAILURE\n\nThe status of job named on job-name.\nThe analogue of this service in AutoSys is change-status-job which supports these values:\nFAILURE, INACTIVE, RUNNING, STARTING, SUCCESS, TERMINATED\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "date-time-status-changed", - "aliases": [ - "dtsc" - ], - "description": "date-time-status-changed=2021-08-12T10:12:13.680000-04:00\n\nDate/time remote scheduler detected status change reported by the STATUS keyword.\nLimits: ISO8601 character format.", - "type": "string", - "group": "Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": "--jn JOB123", - "description": "Rmttrk job name JOB123 to CA 7" - } - ], - "positionals": [], - "passOn": [], - "children": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": [] - }, - { - "name": "dataset", - "aliases": [ - "ds" - ], - "summary": "Dataset management", - "description": "All the available commands listed in the Dataset section.", - "type": "group", - "children": [ - { - "name": "delete-dataset", - "aliases": [ - "dds" - ], - "summary": "Delete a dataset definition", - "description": "Delete Dataset", - "examples": [ - { - "options": "--dname DATA.SET.NAME", - "description": "Delete the definition of a dataset named DATA.SET.NAME" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "dataset-name", - "aliases": [ - "dname" - ], - "description": "(Required if dataset-number is omitted) Specifies the data set and must be the fully qualified data set name.\nLimits: 1 to 44 alphanumeric characters\nNote: dataset-name is not required to conform to MVS data set name standards. Embedded blanks and special characters such as slashes, dashes, and underscores are permitted. All alphabetic characters are uppercased.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "dataset-number", - "aliases": [ - "dnum" - ], - "description": "(Required if dataset-name is omitted) Specifies the data set to use. The value must be the numeric value that CA 7 already assigned.\nLimits: 1 to 8 numeric characters", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "create-dataset", - "aliases": [ - "cds" - ], - "summary": "Create a new dataset definition", - "description": "Create Dataset", - "examples": [ - { - "options": "--dname DATASET.NAME.TEST --type NORM --gdg N", - "description": "Create a new dataset named DATASET.NAME.TEST of type NORM and data set is not a generation data group" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "dataset-name", - "aliases": [ - "dname" - ], - "description": "Specifies the data set and must be the fully qualified data set name.\nLimits: 1 to 44 alphanumeric characters\nNote: dataset-name is not required to conform to MVS data set name standards. Embedded blanks and special characters such as slashes, dashes, and underscores are permitted. All alphabetic characters are uppercased.", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "type", - "description": "(Optional) Specifies the data set type.\nValid values are:\nNORM = Internal means both the creating-job and using-jobs for this data set are known to CA 7.\nExternal means the creating-job, using-jobs, or both for this data set are not known to CA 7.PERM = Specifies this data set is always available for inputDefault: NORM\nNote: When a data set is marked PERM, no SMF records are captured. PERM means no data set triggering can occur with this type of data set", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "gdg", - "description": "(Optional) Specifies whether this data set is a generation data group.\nValid values are:\nY = The data set is a generation data groupN = The data set is not a generation data groupDefault: N\nNote: The specific GDG creations cannot be used for posting requirements or for triggering jobs. Posting and triggering are done based on the creation/updating (SMF 15 record) of any generation of the GDG.", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "smf-feedback-required", - "aliases": [ - "sfr" - ], - "description": "(Optional) Specifies whether the interface to System Management Facility (SMF) inserts the values for DSORG, RECFM, LRECL, and BLKSIZE when this data set is next used. Unless the value is reset, this insertion is only done once.\nValid values are:\nY = SMF inserts the values when the data set is next usedN = SMF does not insert the values when the data set is next usedDefault: Y\nNote: After the first time the job that creates this data set runs under CA 7, this field is reset to N. If the data set attributes change, this field must be reset to Y. The changed attribute field (that is, DSORG, RECFM) must be zeroed (if numeric) or blanked out. This process causes CA 7 to record the new values when the job is run again.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "post-at-close-time", - "aliases": [ - "pact" - ], - "description": "(Optional) Specifies when to post the creation or update of a data set to the database and queues. This process does not ensure successful step or job termination.\nValid values are:\nY = The action takes place when the SMF data set creation record is received (when the data set is closed)N = Causes triggering or posting action to take place at the job terminationDefault: N", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "device", - "description": "(Optional) Specifies a device type.\nValid values are:\nTAPEDASD", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "dsorg", - "description": "(Optional) Specifies the data set organization. This value is the same as the DSORG specified in the DCB subparameter in the JCL.\nLimits: 1 to 3 alphanumeric characters", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "recfm", - "description": "(Optional) Specifies the record format of the data set. This value is the same as the RECFM specified in the DCB subparameter in the JCL.\nLimits: 1 to 5 alphanumeric characters", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "lrecl", - "description": "(Optional) Specifies the logical record length of the data set. This value is the same as the LRECL specified in the DCB subparameter in the JCL.\nLimits: 1 to 5 numeric characters", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "blksize", - "description": "(Optional) Specifies the block size of the data set. This value is the same as the BLKSIZE specified in the DCB subparameter in the JCL.\nLimits: 1 to 5 numeric characters", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "update-dataset", - "aliases": [ - "uds" - ], - "summary": "Modify a dataset definition", - "description": "Modify Dataset", - "examples": [ - { - "options": "--dname DATASET.NAME.TEST --type NORM --gdg N --sfr Y --pact N --blksize 11111", - "description": "Updates the dataset with specified information" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "dataset-name", - "aliases": [ - "dname" - ], - "description": "(Required if dataset-number is omitted) Specifies the data set and must be the fully qualified data set name.\nLimits: 1 to 44 alphanumeric characters\nNote: dataset-name is not required to conform to MVS data set name standards. Embedded blanks and special characters such as slashes, dashes, and underscores are permitted. All alphabetic characters are uppercased.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "dataset-number", - "aliases": [ - "dnum" - ], - "description": "(Required if dataset-name is omitted) Specifies the data set to use. The value must be the numeric value that CA 7 already assigned.\nLimits: 1 to 8 numeric characters", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "type", - "description": "(Optional) Specifies the data set type.\nValid values are:\nNORM = Internal means both the creating-job and using-jobs for this data set are known to CA 7.\nExternal means the creating-job, using-jobs, or both for this data set are not known to CA 7.PERM = Specifies this data set is always available for inputDefault: NORM\nNote: When a data set is marked PERM, no SMF records are captured. PERM means no data set triggering can occur with this type of data set", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "gdg", - "description": "(Optional) Specifies whether this data set is a generation data group.\nValid values are:\nY = The data set is a generation data groupN = The data set is not a generation data groupDefault: N\nNote: The specific GDG creations cannot be used for posting requirements or for triggering jobs. Posting and triggering are done based on the creation/updating (SMF 15 record) of any generation of the GDG.", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "smf-feedback-required", - "aliases": [ - "sfr" - ], - "description": "(Optional) Specifies whether the interface to System Management Facility (SMF) inserts the values for DSORG, RECFM, LRECL, and BLKSIZE when this data set is next used. Unless the value is reset, this insertion is only done once.\nValid values are:\nY = SMF inserts the values when the data set is next usedN = SMF does not insert the values when the data set is next usedDefault: Y\nNote: After the first time the job that creates this data set runs under CA 7, this field is reset to N. If the data set attributes change, this field must be reset to Y. The changed attribute field (that is, DSORG, RECFM) must be zeroed (if numeric) or blanked out. This process causes CA 7 to record the new values when the job is run again.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "post-at-close-time", - "aliases": [ - "pact" - ], - "description": "(Optional) Specifies when to post the creation or update of a data set to the database and queues. This process does not ensure successful step or job termination.\nValid values are:\nY = The action takes place when the SMF data set creation record is received (when the data set is closed)N = Causes triggering or posting action to take place at the job terminationDefault: N", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "device", - "description": "(Optional) Specifies a device type.\nValid values are:\nTAPEDASD", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "dsorg", - "description": "(Optional) Specifies the data set organization. This value is the same as the DSORG specified in the DCB subparameter in the JCL.\nLimits: 1 to 3 alphanumeric characters", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "recfm", - "description": "(Optional) Specifies the record format of the data set. This value is the same as the RECFM specified in the DCB subparameter in the JCL.\nLimits: 1 to 5 alphanumeric characters", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "lrecl", - "description": "(Optional) Specifies the logical record length of the data set. This value is the same as the LRECL specified in the DCB subparameter in the JCL.\nLimits: 1 to 5 numeric characters", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "blksize", - "description": "(Optional) Specifies the block size of the data set. This value is the same as the BLKSIZE specified in the DCB subparameter in the JCL.\nLimits: 1 to 5 numeric characters", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "rename-dataset", - "aliases": [ - "rds" - ], - "summary": "Change the name of a dataset", - "description": "Rename a existing Dataset", - "examples": [ - { - "options": "--dname DATASET.NAME.TEST --ndname NEW.DATASET.NAME.TEST ", - "description": "Renames Dataset with name DATASET.NAME.TEST to NEW.DATASET.NAME.TEST" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "dataset-name", - "aliases": [ - "dname" - ], - "description": "(Required if dataset-number is omitted) Specifies the data set and must be the fully qualified data set name.\nLimits: 1 to 44 alphanumeric characters\nNote: dataset-name is not required to conform to MVS data set name standards. Embedded blanks and special characters such as slashes, dashes, and underscores are permitted. All alphabetic characters are uppercased.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "dataset-number", - "aliases": [ - "dnum" - ], - "description": "(Required if dataset-name is omitted) Specifies the data set to use. The value must be the numeric value that CA 7 already assigned.\nLimits: 1 to 8 numeric characters", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "new-dataset-name", - "aliases": [ - "ndname" - ], - "description": "Specifies the new, fully qualified data set name.\nLimits: 1 to 44 alphanumeric characters\nNote: new-dataset-name is not required to conform to MVS data set name standards. Embedded blanks and special characters such as slashes, dashes, and underscores are permitted. All alphabetic characters are uppercased.", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "delete-dataset-trigger", - "aliases": [ - "ddt" - ], - "summary": "Delete Dataset Trigger definition", - "description": "Delete Dataset Trigger", - "examples": [ - { - "options": "--dname DATA.SET.NAME --schid 42 --tj JOBA", - "description": "Delete a Dataset Trigger definition DATA.SET.NAME with schid 42 for Triggered job JOBA" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "dataset-name", - "aliases": [ - "dname" - ], - "description": "(Required if dataset-number is omitted) Specifies the data set name whose creation/update causes triggering of a job.\nNote: For VSAM files, specify the cluster name.\nLimits: 1 to 44 alphanumeric characters", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "dataset-number", - "aliases": [ - "dnum" - ], - "description": "(Required if dataset-name is omitted) Specifies the existing data set number whose creation causes triggering. The number is the value that CA 7 assigned to the data set.\nLimits: 1 to 8 numeric characters", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "schid", - "description": "(Optional) Specifies for which schedule ID of the triggering dataset the triggered-job is scheduled.\nNote: If the data set is one that is tracked with use of SASSXDSN (externally tracked data sets), the schid field must be 000 for the trigger to work\nDefault: 0 (all schedule IDs)\nLimits: 1 to 3 numeric characters from 0 through 999", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "triggered-job", - "aliases": [ - "tj" - ], - "description": "Specifies the job name that the completion of the triggering dataset triggers.\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "create-dataset-trigger", - "aliases": [ - "cdt" - ], - "summary": "Create Dataset Trigger definition", - "description": "Create Dataset Trigger", - "examples": [ - { - "options": "--dname DATA.SET.NAME --schid 42 --tj JOBA --tjdot 0830", - "description": "Create a Dataset Trigger definition DATA.SET.NAME with schid 42 for Triggered job JOBA" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "dataset-name", - "aliases": [ - "dname" - ], - "description": "(Required if dataset-number is omitted) Specifies the data set name whose creation/update causes triggering of a job.\nNote: For VSAM files, specify the cluster name.\nLimits: 1 to 44 alphanumeric characters", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "dataset-number", - "aliases": [ - "dnum" - ], - "description": "(Required if dataset-name is omitted) Specifies the existing data set number whose creation causes triggering. The number is the value that CA 7 assigned to the data set.\nLimits: 1 to 8 numeric characters", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "schid", - "description": "(Optional) Specifies for which schedule ID of the triggering dataset the triggered-job is scheduled.\nNote: If the data set is one that is tracked with use of SASSXDSN (externally tracked data sets), the schid field must be 000 for the trigger to work\nDefault: 0 (all schedule IDs)\nLimits: 1 to 3 numeric characters from 0 through 999", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "triggered-job", - "aliases": [ - "tj" - ], - "description": "Specifies the job name that the completion of the triggering dataset triggers.\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "triggered-job-schid", - "aliases": [ - "tjs" - ], - "description": "(Optional) Denotes a replacement schedule ID to use when the triggered-job is placed into the request queue.\nDefault: 0 (no replacement)\nLimits: 1 to 3 numeric characters from 0 through 999\nNote: If triggered-job-schid is used, it replaces the schid value of the triggered job. Any jobs triggered (by triggered-job or data sets it creates) use this triggered-job-schid for their schedule ID unless they also have a triggered-job-schid value.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "triggered-job-due-out-time", - "aliases": [ - "tjdot" - ], - "description": "(Required if triggered-job-queue-time is omitted) Specifies the due-out time of day of the triggered-job rounded down to 10-minute increments.\nIf this parameter is used, triggered-job-queue-time must be omitted.\nLimits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400. If specified, the lowest value is 10.\nNote: If used and the due-out-time of the triggering job is after the triggered-job-due-out-time, the following calendar day is assumed.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "triggered-job-queue-time", - "aliases": [ - "tjqt" - ], - "description": "(Required if triggered-job-due-out-time is omitted) Specifies the elapsed queue time of triggered-job rounded down to 10-minute increments.\nIf this parameter is used, triggered-job-due-out-time must be omitted because due-out time is then calculated as deadline time plus runtime.\nDeadline time is calculated as current date/time plus queue time.\nLimits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24.\nThe mm can be 00 through 59, the highest value being 2400.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "triggered-job-lead-time", - "aliases": [ - "tjlt" - ], - "description": "(Optional) Specifies the elapsed lead time for triggered-job rounded to 10-minute increments. This parameter specifies the lead or processing time necessary to ensure triggered-job meets its due-out time.\nDefault: 0000\nLimits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24.\nThe mm can be 00 through 59, the highest value being 2400.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "triggered-job-submit-time", - "aliases": [ - "tjst" - ], - "description": "(Optional) Imposes a submit time of day requirement on triggered-job. When used, the job is not submitted before this time.\nThe triggered-job-submit-time is always rounded down to 15-minute increments.\nDefault: 0 (no specific submit time requirement)\nLimits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400.\nNote: If triggered-job-queue-time is used, the date for the submit time requirement is the same as the deadline start date.\n\nIf triggered-job-due-out-time is used and the triggered-job-submit-time is less than the triggered-job-due-out-time, the date for the triggered-job-submit-time is the same as the deadline start date. Otherwise, the triggered-job-submit-time date is the previous day.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "update-dataset-trigger", - "aliases": [ - "udt" - ], - "summary": "Modify Dataset Trigger definition", - "description": "Modify Dataset Trigger", - "examples": [ - { - "options": "--dname DATA.SET.NAME --schid 42 --tj JOBA --tjdot 0830 --tjlt 0030 --tjst 1030", - "description": "Update a Dataset Trigger definition DATA.SET.NAME with schid 42 for Triggered job JOBA" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "dataset-name", - "aliases": [ - "dname" - ], - "description": "(Required if dataset-number is omitted) Specifies the data set name whose creation/update causes triggering of a job.\nNote: For VSAM files, specify the cluster name.\nLimits: 1 to 44 alphanumeric characters", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "dataset-number", - "aliases": [ - "dnum" - ], - "description": "(Required if dataset-name is omitted) Specifies the existing data set number whose creation causes triggering. The number is the value that CA 7 assigned to the data set.\nLimits: 1 to 8 numeric characters", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "schid", - "description": "(Optional) Specifies for which schedule ID of the triggering dataset the triggered-job is scheduled.\nNote: If the data set is one that is tracked with use of SASSXDSN (externally tracked data sets), the schid field must be 000 for the trigger to work\nDefault: 0 (all schedule IDs)\nLimits: 1 to 3 numeric characters from 0 through 999", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "triggered-job", - "aliases": [ - "tj" - ], - "description": "Specifies the job name that the completion of the triggering dataset triggers.\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "triggered-job-schid", - "aliases": [ - "tjs" - ], - "description": "(Optional) Denotes a replacement schedule ID to use when the triggered-job is placed into the request queue.\nDefault: 0 (no replacement)\nLimits: 1 to 3 numeric characters from 0 through 999\nNote: If triggered-job-schid is used, it replaces the schid value of the triggered job. Any jobs triggered (by triggered-job or data sets it creates) use this triggered-job-schid for their schedule ID unless they also have a triggered-job-schid value.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "triggered-job-due-out-time", - "aliases": [ - "tjdot" - ], - "description": "(Required if triggered-job-queue-time is omitted) Specifies the due-out time of day of the triggered-job rounded down to 10-minute increments.\nIf this parameter is used, triggered-job-queue-time must be omitted.\nLimits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400. If specified, the lowest value is 10.\nNote: If used and the due-out-time of the triggering job is after the triggered-job-due-out-time, the following calendar day is assumed.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "triggered-job-queue-time", - "aliases": [ - "tjqt" - ], - "description": "(Required if triggered-job-due-out-time is omitted) Specifies the elapsed queue time of triggered-job rounded down to 10-minute increments.\nIf this parameter is used, triggered-job-due-out-time must be omitted because due-out time is then calculated as deadline time plus runtime.\nDeadline time is calculated as current date/time plus queue time.\nLimits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24.\nThe mm can be 00 through 59, the highest value being 2400.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "triggered-job-lead-time", - "aliases": [ - "tjlt" - ], - "description": "(Optional) Specifies the elapsed lead time for triggered-job rounded to 10-minute increments. This parameter specifies the lead or processing time necessary to ensure triggered-job meets its due-out time.\nDefault: 0000\nLimits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24.\nThe mm can be 00 through 59, the highest value being 2400.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "triggered-job-submit-time", - "aliases": [ - "tjst" - ], - "description": "(Optional) Imposes a submit time of day requirement on triggered-job. When used, the job is not submitted before this time.\nThe triggered-job-submit-time is always rounded down to 15-minute increments.\nDefault: 0 (no specific submit time requirement)\nLimits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400.\nNote: If triggered-job-queue-time is used, the date for the submit time requirement is the same as the deadline start date.\n\nIf triggered-job-due-out-time is used and the triggered-job-submit-time is less than the triggered-job-due-out-time, the date for the triggered-job-submit-time is the same as the deadline start date. Otherwise, the triggered-job-submit-time date is the previous day.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": [] - }, - { - "name": "delete-job-definition", - "aliases": [ - "djd" - ], - "summary": "Deletes requirements of a job", - "description": "All the available commands are listed in the COMMANDS section.", - "type": "group", - "children": [ - { - "name": "req-predecessor", - "aliases": [ - "rp" - ], - "summary": "Delete requirement definition fo a job", - "description": "Delete predecessor requirement for a job.", - "examples": [ - { - "options": "--job ZOWECRM1 --schid 0004 --predtype USER --nextrun ONLY --predobject USER101", - "description": "Delete a job requirement predecessor of a CA 7 job using the options" - } - ], - "type": "command", - "handler": "", - "options": [ - { - "name": "job", - "description": "The name of the job that requires the predecessor\n\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "schid", - "description": "The schedule id of requiring job\n\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "predtype", - "description": "The predecessor type\n\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "nextrun", - "description": "The status of predecessor for next run of job\n[ YES, ONLY, SKIP ]\n\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "predobject", - "description": "The predecessor. Values vary with predtype.\nThe predecessor. Values vary with predtype.\nWhen “predtype”:”DSN”,”predobject” is 1-44 name of required dataset.\nWhen “predtype”:”USER” then “predobject” is 1-44 character user requirement text.\n\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "leadtime", - "description": "The satisfaction lead time in hours.\nThis may be honored when “predtype” is “job or “DSN”\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "permanent", - "description": "Indicates that this predecessor is permanent, that is always considered satisfied.\nThis parameter only applies when “predtype” is “DSN”\n[ Y, N ]\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [] - } - ], - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "schedule", - "aliases": [ - "s" - ], - "summary": "Delete an existing date/time schedule (remove a schedule ID) for a CA7 job", - "description": "Delete an existing date/time schedule", - "examples": [ - { - "options": "--job ZOWECRM1 --schid 0004", - "description": "Delete an existing date/time schedule (remove a schedule ID) for a CA7 job" - } - ], - "type": "command", - "handler": "", - "options": [ - { - "name": "job", - "description": "The name of the job\n\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "schid", - "description": "Specifies the numeric schedule ID on which the user wants to perform the specified action.\nLimits:\n1 to 3 numeric characters from 1 through 999\n\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [] - } - ], - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "positionals": [], - "passOn": [], - "children": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": [] - }, - { - "name": "delete-resource-definition", - "aliases": [ - "drd" - ], - "summary": "Deletes a Resource Count", - "description": "All the available commands are listed in the COMMANDS section.", - "type": "group", - "children": [ - { - "name": "resource-count-resource", - "aliases": [ - "rcr" - ], - "summary": "Delete a Resource Count resource", - "description": "Delete a Resource Count resource", - "examples": [ - { - "options": "--rn PAYROLL.RCT", - "description": "Delete Resource Count Resource parameters" - } - ], - "type": "command", - "handler": "", - "options": [ - { - "name": "resource-name", - "aliases": [ - "rn" - ], - "description": "Specifies the name of the Resource Count Resource to delete.\nLimits: 1 to 39 alphanumeric characters and periods\n\n", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [] - } - ], - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "positionals": [], - "passOn": [], - "children": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": [] - }, - { - "name": "event-manager-requests", - "aliases": [ - "emr" - ], - "summary": "Retrieves a status of a job from CA 7", - "description": "All the available commands are listed in the COMMANDS section.", - "type": "group", - "children": [ - { - "name": "job-status", - "aliases": [ - "js" - ], - "summary": "Retrieves a status of a job from CA 7", - "description": "Available request is listed below.", - "examples": [ - { - "options": "--jnum 0016", - "description": "Gets the status of jobnumber 0016 from CA 7" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "jobnumber", - "aliases": [ - "jnum" - ], - "description": "jnum=0016\n\nDefines the name of the job to retrieve.\nIndicates the individual job to retrieve, and the value must be a CA 7 job number.", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": [] - }, - { - "name": "list-job-definition", - "aliases": [ - "ljd" - ], - "summary": "Retrieves the job definition", - "description": "All the available commands are listed in the COMMANDS section.", - "type": "group", - "children": [ - { - "name": "job", - "aliases": [ - "j" - ], - "summary": "Get basic definition for one or more jobs", - "description": "Get a list of the job definitions for one or more jobs.", - "examples": [ - { - "options": "--all true --db CA7DB --jobname TESTJOB", - "description": "List the job defintion information of a job, CA7DB which defined in the CA7DB database" - } - ], - "type": "command", - "handler": "", - "options": [ - { - "name": "all", - "description": "all=false\n\nFetch all the available properties\n", - "type": "string", - "defaultValue": false, - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "db", - "description": "db=TESTJOB01\n\nThe CA 7 database name\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "jobname", - "description": "jobname=TESTJOB01\n\nThe CA 7 job name\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [] - } - ], - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "prose", - "aliases": [ - "p" - ], - "summary": "Get prose information for a job", - "description": "Get a list of the prose information for one or more jobs.", - "examples": [ - { - "options": "--jobname TESTJOB --database TESTDB", - "description": "List of the prose information for jobname, TESTJOB01 and database, TESTDB01" - } - ], - "type": "command", - "handler": "", - "options": [ - { - "name": "jobname", - "aliases": [ - "j" - ], - "description": "jobname=TESTJOB01\n\nDefines the name of the jobname for the prose command\n", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "database", - "aliases": [ - "db" - ], - "description": "db=CA7DB01\n\nDefines the name of the database for the prose command\n", - "type": "string", - "group": "Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [] - } - ], - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "requirement-predecessor", - "aliases": [ - "rp" - ], - "summary": "Get predecessors for one or more jobs", - "description": "Get a list of the predecessors for one or more jobs.", - "examples": [ - { - "options": "--db CA7DB --jobname TESTJOB", - "description": "List the predecessor of a job, TESTJOBwhich defined in the CA7DB database" - } - ], - "type": "command", - "handler": "", - "options": [ - { - "name": "db", - "description": "db=TESTJOB01\n\nThe CA 7 database name\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "jobname", - "description": "jobname=TESTJOB01\n\nThe CA 7 job name\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [] - } - ], - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "requirement-successor", - "aliases": [ - "rs" - ], - "summary": "Get successor jobs for one or more jobs", - "description": "Get a list of the successor jobs for one or more jobs.", - "examples": [ - { - "options": "--db CA7DB --jobname TESTJOB", - "description": "List the successor of a job, which defined in the CA7DB database" - } - ], - "type": "command", - "handler": "", - "options": [ - { - "name": "db", - "description": "db=TESTJOB01\n\nThe CA 7 database name\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "jobname", - "description": "jobname=TESTJOB01\n\nThe CA 7 job name\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [] - } - ], - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "resource", - "aliases": [ - "r" - ], - "summary": "Get job resources for one or more jobs", - "description": "Get a list of the job resources for one or more jobs.", - "examples": [ - { - "options": "--db CA7DB --jobname TESTJOB", - "description": "List the resources of a job, TESTJOB which defined in the CA7DB database" - } - ], - "type": "command", - "handler": "", - "options": [ - { - "name": "db", - "description": "db=TESTJOB01\n\nThe CA 7 database name\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "jobname", - "description": "jobname=TESTJOB01\n\nThe CA 7 job name\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [] - } - ], - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "schedule", - "aliases": [ - "s" - ], - "summary": "Get job schedules for one or more jobs", - "description": "Get a list of the job schedules for one or more jobs.", - "examples": [ - { - "options": "--db CA7DB --jobname TESTJOB", - "description": "List the schedule information of a job, TSETJOB which defined in the CA7DB database" - } - ], - "type": "command", - "handler": "", - "options": [ - { - "name": "db", - "description": "db=TESTJOB01\n\nThe CA 7 database name\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "jobname", - "description": "jobname=TESTJOB01\n\nThe CA 7 job name\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [] - } - ], - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "step-dd", - "aliases": [ - "sd" - ], - "summary": "Get job STEP and DD information for one or more jobs", - "description": "Get a list of the job STEP and DD information for one or more jobs.", - "examples": [ - { - "options": "--db CA7TDB --jobname TESTJOB", - "description": "List the SETP and DD statments of a job, TESTJOB which defined in the CA7DB database" - } - ], - "type": "command", - "handler": "", - "options": [ - { - "name": "db", - "description": "db=TESTJOB01\n\nThe CA 7 database name\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "jobname", - "description": "jobname=TESTJOB01\n\nThe CA 7 job name\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [] - } - ], - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "trigger-predecessor", - "aliases": [ - "tp" - ], - "summary": "Get trigger objects for one or more jobs", - "description": "Get a list of the trigger objects for one or more jobs.", - "examples": [ - { - "options": "--db CA7DB --jobname TESTJOB", - "description": "List the trigger predecessor of a job, TESTJOB which defined in the CA7DB database" - } - ], - "type": "command", - "handler": "", - "options": [ - { - "name": "db", - "description": "db=TESTJOB01\n\nThe CA 7 database name\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "jobname", - "description": "jobname=TESTJOB01\n\nThe CA 7 job name\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [] - } - ], - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "trigger-successor", - "aliases": [ - "ts" - ], - "summary": "Get triggered jobs for one or more jobs", - "description": "Get a list of the triggered jobs for one or more jobs.", - "examples": [ - { - "options": "--db CA7DB --jobname TESTJOB", - "description": "List the trigger successor of a job, TESTJOB which defined in the CA7DB database" - } - ], - "type": "command", - "handler": "", - "options": [ - { - "name": "db", - "description": "db=TESTJOB01\n\nThe CA 7 database name\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "jobname", - "description": "jobname=TESTJOB01\n\nThe CA 7 job name\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [] - } - ], - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "positionals": [], - "passOn": [], - "children": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": [] - }, - { - "name": "list-job-history", - "aliases": [ - "ljh" - ], - "summary": "Retrieves job history information", - "description": "All the available commands are listed in the COMMANDS section.", - "type": "group", - "children": [ - { - "name": "prior-run", - "aliases": [ - "pr" - ], - "summary": "Retrieves job information from the prior-run queue", - "description": "Get a list one or more jobs from the prior-run queue.", - "examples": [ - { - "options": "--db CA7DB --jobname TEST%", - "description": "Retrieve any job(s) from the prior-runqueue based on these two parameters" - } - ], - "type": "command", - "handler": "", - "options": [ - { - "name": "db", - "description": "db=TESTJOB01\n\nThe CA 7 database name\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "jobname", - "description": "jobname=TESTJOB01\n\nThe CA 7 job name\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [] - } - ], - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "positionals": [], - "passOn": [], - "children": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": [] - }, - { - "name": "list-job-instance", - "aliases": [ - "lji" - ], - "summary": "Retrieves the instance definition for a job", - "description": "All the available commands are listed in the COMMANDS section.", - "type": "group", - "children": [ - { - "name": "jcl", - "aliases": [ - "jcl" - ], - "summary": "Retrieves JCL for a job in the active workload", - "description": "Displays JCL for a job in the active workload.", - "examples": [ - { - "options": "--ca7no 7777 --db CA7DB --showNo true", - "description": "Retreives JCL of a CA7 job, CA75TEST (7777) which resided in CA7DB database" - } - ], - "type": "command", - "handler": "", - "options": [ - { - "name": "ca7no", - "description": "ca7no=0231\n\nThe CA 7 job number\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "db", - "description": "db=TESTJOB01\n\nThe CA 7 database name\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "showNo", - "description": "showNo=true\n\nShow line numbers in JCL\n", - "type": "boolean", - "group": "Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [] - } - ], - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "list", - "aliases": [ - "l" - ], - "summary": "Retrieves information about jobs in the active workload", - "description": "Displays information about jobs in the active workload.", - "examples": [ - { - "options": "--all false --ca7no 7777 --db CA7DB --jobname TESTCA7", - "description": "List a CA 7 job (7777) information which resided in CA7DB database " - } - ], - "type": "command", - "handler": "", - "options": [ - { - "name": "all", - "description": "all=False\n\nFetch all the available properties\nIf the job number is provided, all the properties will be returned\n", - "type": "boolean", - "defaultValue": false, - "group": "Options", - "aliases": [] - }, - { - "name": "ca7no", - "description": "ca7no=0231\n\nThe CA 7 job number\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "databasename", - "aliases": [ - "db" - ], - "description": "databasename=TESTJOB01\n\nThe CA 7 database name\n", - "type": "string", - "group": "Options" - }, - { - "name": "jobname", - "description": "jobname=CA7TEST\n\nThe CA 7 job name\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [] - } - ], - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "requirements", - "aliases": [ - "r" - ], - "summary": "Retrieves information about requirements for jobs in the active workload", - "description": "Displays information about requirements for jobs in the active workload.", - "examples": [ - { - "options": "--ca7no 7777 --db CA7DB", - "description": "Retrieves the job requirements of a CA 7 job (7777) which resided in CA7DB database" - } - ], - "type": "command", - "handler": "", - "options": [ - { - "name": "ca7no", - "description": "ca7no=0231\n\nThe CA 7 job number\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "databasename", - "aliases": [ - "db" - ], - "description": "databasename=TESTJOB01\n\nThe CA 7 database name\n", - "type": "string", - "group": "Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [] - } - ], - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "active-resource", - "aliases": [ - "ar" - ], - "summary": "Display active resources by job. The jobs can be listed generically or with fully qualified job names.", - "description": "Display active resources by job.", - "examples": [ - { - "options": "--job RMTESTA1 --rn A", - "description": "Display active resources by job RMTESTA1 along with other parameters" - } - ], - "type": "command", - "handler": "", - "options": [ - { - "name": "job", - "description": "Specifies a fully qualified or generic job name.1. Specifies all jobs.\n2. Specifies a fully qualified job name. Limits:: 1 to 8 alphanumeric characters\n3. Specifies multiple jobs that a generic job name specifies. Limits:: 1 to 7 alphanumeric characters that are terminated with an asterisk.\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "resource-name", - "aliases": [ - "rn" - ], - "description": "Specifies a fully qualified or generic resource name. An asterisk indicates a generic request.1. Specifies all resources.\n2. Specifies a fully qualified resource name. Limits::1 to 44 alphanumeric characters\n3. Specifies multiple resources that a generic resource name specifies. Limits:: 1 to 43 alphanumeric characters that are terminated with an asterisk\n\n", - "type": "string", - "group": "Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [] - } - ], - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "listCustom", - "aliases": [ - "lc" - ], - "summary": "Retrieves custom information about jobs in the active workload", - "description": "Displays information about jobs in the active workload.", - "examples": [ - { - "options": "--ca7no 7777 --db CA7DB --jobname TESTCA7", - "description": "List a CA 7 job (7777) information which resided in CA7DB database " - } - ], - "type": "command", - "handler": "", - "options": [ - { - "name": "ca7no", - "description": "ca7no=0231\n\nThe CA 7 job number\n", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "name": "databasename", - "aliases": [ - "db" - ], - "description": "databasename=TESTDB01\n\nThe CA 7 database name\n", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "jobname", - "description": "jobname=CA7TEST\n\nThe CA 7 job name\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "description": "job=true/false\n\nThe job name for this job in the active workload\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "queueName", - "description": "queueName=true/false\n\nThe name of the queue in which this job is currently located. \n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "ca7Num", - "description": "ca7Num=true/false\n\nThe job number for this job in the active workload\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "status", - "description": "status=true/false\n\nThe job status\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "entryMode", - "description": "entryMode=true/false\n\nIdentifies how the job was brought into the queue.\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "abended", - "description": "abended=true/false\n\nY if job abended, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "agentIntervention", - "description": "agentIntervention=true/false\n\nY if INTERVENTION REQUIRED condition exists for this agent job, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "agentJobNumber", - "description": "agentJobNumber=true/false\n\nThe job number/PID for this agent job\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "agentName", - "description": "agentName=true/false\n\nThe name of the agent where this job will execute\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "agentStatus", - "description": "agentStatus=true/false\n\nThe status for this agent job\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "agentStatusData", - "description": "agentStatusData=true/false\n\nY if status data is available for this agent job,N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "agentSubmitted", - "description": "agentSubmitted=true/false\n\nY if agent job has been submitted to the agent, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "agentType", - "description": "agentType=true/false\n\nAgent job type, zero if this is not an agent job\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "agentUser", - "description": "agentUser=true/false\n\nThe userid with which this agent job will execute\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "ajbBuildError", - "description": "ajbBuildError=true/false\n\nY if an error occurred while building an XPJOB job AJB or an agent job AFM, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "arf", - "description": "arf=true/false\n\nY if this job is monitored by ARF, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "arfAttachErr", - "description": "arfAttachErr=true/false\n\nY if this job had an ARF attach error, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "arfCompMatched", - "description": "arfCompMatched=true/false\n\nSet to Y if an ARF JOB completion rule matched for this job\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "arfDate", - "description": "arfDate=true/false\n\nY if the job uses ARF\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "arfErrorCond", - "description": "arfErrorCond=true/false\n\nSet to Y if there was an error during ARF condition detection, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "arfjJob", - "description": "arfjJob=true/false\n\nY if job is an ARF recovery job, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "arfJobComplete", - "description": "arfJobComplete=true/false\n\nSet to Y if this job's completion has been posted to ARF, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "arfRecovery", - "description": "arfRecovery=true/false\n\nY if job is in ARF recovery, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "arfRecoveryErr", - "description": "arfRecoveryErr=true/false\n\nY if this job had an error in ARF recovery, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "arfset", - "description": "arfset=true/false\n\nThe collection of ARF definitions that apply to this job\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "arfTime", - "description": "arfTime=true/false\n\nThe date and time that the ARFSET was attached to this job\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "autofDone", - "description": "autofDone=true/false\n\nY if job performed AUTO F, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "ca11JesNode", - "description": "ca11JesNode=true/false\n\nThe JES node where this job executes\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "ca11RestartStep", - "description": "ca11RestartStep=true/false\n\nThe relative CA 11 restart step number\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "ca11RmsCc", - "description": "ca11RmsCc=true/false\n\nThe CA 11 U11RMS step condition code\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "ca11Subsystem", - "description": "ca11Subsystem=true/false\n\nThe CA 11 subsystem name\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "ca7System", - "description": "ca7System=true/false\n\nThe user-defined application system associated with this job\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "compCode", - "description": "compCode=true/false\n\nThe job completion code in number format\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "cpmJfm", - "description": "cpmJfm=true/false\n\nY if JFM is used to track CPM, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "cpuTableIndex", - "description": "cpuTableIndex=true/false\n\nIndex to the CPU Table entry\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "cputime", - "description": "cputime=true/false\n\nThis Job's average CPU time\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "currStepNum", - "description": "currStepNum=true/false\n\nThe number of the step that is currently executing\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "defNotFound", - "description": "defNotFound=true/false\n\nY if job defintion not found on database, N if not found\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "doNotPrompt", - "description": "doNotPrompt=true/false\n\nY if prompts are bypassed for the job, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "drclass", - "description": "drclass=true/false\n\nThe job's disaster recovery class\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "drmode", - "description": "drmode=true/false\n\nY if this job entered the queues when disaster recovery mode was active, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "dueOutExists", - "description": "dueOutExists=true/false\n\nDetermines if a zero value in DUE_OUT_TIME indicates midnight (Y) or no due out time (N)\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "dueOutTime", - "description": "dueOutTime=true/false\n\nThe date and time this job is expected to complete\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "dupJob", - "description": "dupJob=true/false\n\nY if a job with the same name is waiting on this job to complete, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "dupJobWait", - "description": "dupJobWait=true/false\n\nY if this job is waiting on a job with the same name to complete, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "elapsedTime", - "description": "elapsedTime=true/false\n\nThis Job's average elapsed time\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "endTime", - "description": "endTime=true/false\n\nThe date and time this job ended\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "executable", - "description": "executable=true/false\n\nY if job is executable, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "express", - "description": "express=true/false\n\nY if submission of this job has been expedited by use of the SUBMIT,EXPRESS=YES command, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "externalInput", - "description": "externalInput=true/false\n\nY if we job has external input, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "externalJob", - "description": "externalJob=true/false\n\nY if this is an externally tracked job, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "externalSatisfied", - "description": "externalSatisfied=true/false\n\nThe number of satisfied external requirements for this job\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "externalTotal", - "description": "externalTotal=true/false\n\nThe total number of external requirements for this job\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "forcedComplete", - "description": "forcedComplete=true/false\n\nY if job was force completed, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "forcedSubmit", - "description": "forcedSubmit=true/false\n\nY if all input requirements have been marked as satisfied by use of the SUBMIT command, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "fromXpRequest", - "description": "fromXpRequest=true/false\n\nY if scheduling request for this job came from an XPS client, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "hasCa11", - "description": "hasCa11=true/false\n\nY if job has a CA11 segment, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "hasCpuTime", - "description": "hasCpuTime=true/false\n\nY if we have non-zero CPU time for this job, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "hasJo", - "description": "hasJo=true/false\n\nY if the JCL or PARM DATA contains a #JO card, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "hasStepTime", - "description": "hasStepTime=true/false\n\nY if job has non-zero step CPU time, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "held", - "description": "held=true/false\n\nY if job is held, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "heldByJob", - "description": "heldByJob=true/false\n\nY if job was held on entry to the queues, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "heldSkeleton", - "description": "heldSkeleton=true/false\n\nY if job is held and in skeleton status, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "skeleton", - "description": "skeleton=true/false\n\nY if job is in skeleton status, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "holdOnEntry", - "description": "holdOnEntry=true/false\n\nY if job marked HOLD=YES, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "hostName", - "description": "hostName=true/false\n\nThe SMF Id of the system where this is executing\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "inCpmFlow", - "description": "inCpmFlow=true/false\n\nY if job is part of a CPM flow, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "insertRms", - "description": "insertRms=true/false\n\nY if an RMS step will be inserted into this job's JCL, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "jclAllocErr", - "description": "jclAllocErr=true/false\n\nY if JCL or PARM DATA library could not be allocated, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "jclCount", - "description": "jclCount=true/false\n\nThe number of non-# records in the JCL or PARM DATA members associated with this job\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "jclError", - "description": "jclError=true/false\n\nY if job marked with JCL error, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "jclFromAltlib", - "description": "jclFromAltlib=true/false\n\nY if JCL or PARM DATA was retrieved from an alternate library, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "jclLibrary", - "description": "jclLibrary=true/false\n\nContains either a 3 digit JCL index value or a JCL variable beginning with an ampersand\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "jesHi", - "description": "jesHi=true/false\n\nJES supports ID > 99999\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "loadOnly", - "description": "loadOnly=true/false\n\nY if this is a LOAD only job, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "loadStepDone", - "description": "loadStepDone=true/false\n\nY if LOAD step ran OK for this job, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "locked", - "description": "locked=true/false\n\nY if job is locked, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "longName", - "description": "longName=true/false\n\nAn alias name for this job. This name may be used by scheduling engines on other platforms, such as AutoSys\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "lterm", - "description": "lterm=true/false\n\nLogical terminal name from job definition\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "mainid", - "description": "mainid=true/false\n\nIf positive, the CPU number on which the job may execute. If negative, the CPU number on which the job may not execute\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "maint", - "description": "maint=true/false\n\nY if job ignores requirements, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "manualRequeue", - "description": "manualRequeue=true/false\n\nY if job has been re-queued to REQUEST queue, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "memberName", - "description": "memberName=true/false\n\nThe JCL or PARM DATA library member name\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "mustStartExists", - "description": "mustStartExists=true/false\n\nDetermines if a zero value in MUST_START_TIME indicates midnight (Y) or no deadline time (N)\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "needsAutof", - "description": "needsAutof=true/false\n\nY if a job changed and requires 'F' in CA11, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "nextRunReq", - "description": "nextRunReq=true/false\n\nY if job has temporary requirements for the next execution, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "nodeFailed", - "description": "nodeFailed=true/false\n\nY if this is an XPJOB job and at the time of it last submit its node was down, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "nodeOffline", - "description": "nodeOffline=true/false\n\nY if this is an XPJOB job and at the time of its last submit its node was offline, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "nodeStopped", - "description": "nodeStopped=true/false\n\nY if this is an XPJOB job and at the time of it last submit its node was stopped, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "noUserId", - "description": "noUserId=true/false\n\nY if there is not a valid security id for this job, N if there is\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "noXpsiParmlib", - "description": "noXpsiParmlib=true/false\n\nY if this is an XPJOB job and has no PARMLIB, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "noXpsiXpsparm", - "description": "noXpsiXpsparm=true/false\n\nY if this is an XPJOB job and has no PARM, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "override", - "description": "override=true/false\n\nY if JCL/PARM DATA override is required, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "overrideApplied", - "description": "overrideApplied=true/false\n\nY if JCL overrides have been applied for this job, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "prompt", - "description": "prompt=true/false\n\nY if job should have LATE PROMPTS, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "promptAck", - "description": "promptAck=true/false\n\nY if user has acknowledged the prompt, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "prompted", - "description": "prompted=true/false\n\nY if user has been prompted, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "qjclUpdated", - "description": "qjclUpdated=true/false\n\nY if JCL or PARM DATA updated through QJCL, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "queueJcl", - "description": "queueJcl=true/false\n\nY if a QJCL command is in progress for this job N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "repeatCount", - "description": "repeatCount=true/false\n\nThe number of times to repeat this job\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "repeatDiff", - "description": "repeatDiff=true/false\n\n\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "ca7No", - "description": "ca7No=true/false\n\nThe difference between the original dueout time and the original submit time, used by repeating jobs\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "repeatInterval", - "description": "repeatInterval=true/false\n\nThe interval between repetitions of the job\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "repeatLeadTime", - "description": "repeatLeadTime=true/false\n\nThe lead time for this repeat job. This is the amount of time to ensure it completes before it due out time\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "repeatStopExists", - "description": "repeatStopExists=true/false\n\nDetermines if a zero value in REPEAT_STOP_TIME indicates midnight (Y) or no repeat stop time (N)\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "repeatStopTime", - "description": "repeatStopTime=true/false\n\nThe date and time on or after which a repeating job will not be repeated\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "repeatType", - "description": "repeatType=true/false\n\nThe type of repeat job. This field determines how the submit time requierement is calculated for repeating jobs\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "restartStep", - "description": "restartStep=true/false\n\nThe step name in which the job was restarted\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "retainJcl", - "description": "retainJcl=true/false\n\nY if JCL or XPJOB information will be retained in the prior run queue, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "rqmtCount", - "description": "rqmtCount=true/false\n\nThe master requirement count for this job. The number includes unsatisfied requirements, submit time, and other reasons preventing the job from being submitted\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "schdAdjusted", - "description": "schdAdjusted=true/false\n\nY if job's schedule has been adjusted, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "nosecurity", - "description": "nosecurity=true/false\n\nY if there was an error retrieving security data,N if no\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "setNdb", - "description": "setNdb=true/false\n\nY if job will bypass LOAD processing at completion and not update the database, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "smfNeeded", - "description": "smfNeeded=true/false\n\nY if SMF feedback is needed for this job, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "startTime", - "description": "startTime=true/false\n\nThe date and time this job started executing on its most recent submission\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "submitted", - "description": "submitted=true/false\n\nY if this job has been submitted to the host, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "submitTime", - "description": "submitTime=true/false\n\nThe date and time this job was submitted\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "triggered", - "description": "triggered=true/false\n\nY if job triggered by another job, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "uid", - "description": "uid=true/false\n\nThe CA 7 internal user security designation\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "verify", - "description": "verify=true/false\n\nY if job has a manual verification requirement, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "waitSubmitTime", - "description": "waitSubmitTime=true/false\n\nY if this job has a submit time requirement, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "xpAltNode", - "description": "xpAltNode=true/false\n\nThe alternate node where this XPJOB job was routed\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "xpPrimaryNode", - "description": "xpPrimaryNode=true/false\n\nThe primary node associated with this XPJOB job\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "xpsJob", - "description": "xpsJob=true/false\n\nY if this is an XPJOB job, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "xpStatus", - "description": "xpStatus=true/false\n\nThe status of the node associated with this XPJOB job. A: Active F: Failed CCI send O: Offline S:Stopped\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "xtrackerInact", - "description": "xtrackerInact=true/false\n\nY if at time of submission, the XTRACKER task is not active for an XPJOB job or IAS is not active for an agent job, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "xplatNode", - "description": "xplatNode=true/false\n\nCross platform long node name\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "responseError", - "description": "responseError=true/false\n\n\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "ca11FailingStepNum", - "description": "ca11FailingStepNum=true/false\n\nCA 11 Failing Step Number\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "completeOk", - "description": "completeOk=true/false\n\nY if job completed normally, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "jesNum", - "description": "jesNum=true/false\n\nThe JES job number for this job. A value of -1 indicates NA\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "needsLoad", - "description": "needsLoad=true/false\n\nY if LOAD processing will be done for this job, Nif not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "deadline", - "description": "deadline=true/false\n\nThe date and time a job must be started by in order to meet its due out time\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "jclfrom254", - "description": "jclfrom254=true/false\n\nY if JCL or XPJOB information will be retained in the prior run queue, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "proseNum", - "description": "proseNum=true/false\n\nNumber of the prose text associated with this job, or zero\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "scheduleId", - "description": "scheduleId=true/false\n\nThe schedule id for this execution\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "triggeringJobNum", - "description": "triggeringJobNum=true/false\n\nThe CA 7 internal job number of the job that triggered this job or job that created the data set that triggered this job\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "triggers", - "description": "triggers=true/false\n\nY if job can trigger other jobs, N if not\n", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [] - } - ], - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "positionals": [], - "passOn": [], - "children": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": [] - }, - { - "name": "list-resource-definition", - "aliases": [ - "lrd" - ], - "summary": "Retrieves a Resource Count Resource Information", - "description": "All the available commands are listed in the COMMANDS section.", - "type": "group", - "children": [ - { - "name": "resource-count-resource", - "aliases": [ - "rcr" - ], - "summary": "Retrieves a Resource Count Resource Information", - "description": "Retrieves a Resource Count Resource Information", - "examples": [ - { - "options": "--rn PAYROLL.RCT", - "description": "Retrieves a Resource Count Resource" - } - ], - "type": "command", - "handler": "", - "options": [ - { - "name": "resource-name", - "aliases": [ - "rn" - ], - "description": "Specifies the name of the Resource Count Resource to delete.\nLimits: 1 to 39 alphanumeric characters and periods\n\n", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [] - } - ], - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "positionals": [], - "passOn": [], - "children": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": [] - }, - { - "name": "job-definition", - "aliases": [ - "jd" - ], - "summary": "All methods of a job definitions", - "description": "All the available commands listed in the Job Definition section.", - "type": "group", - "children": [ - { - "name": "delete-job", - "aliases": [ - "dj" - ], - "summary": "Delete a job definition", - "description": "Delete Job Definition", - "examples": [ - { - "options": "--job JOBA --type DELETE", - "description": "Delete Job named JOBA" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "job", - "description": "The name of the job", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "type", - "description": "The type of deletion.\nValid values are:\nDELETE\nDeletes a job and its associated data from the database (documentation, schedules, and so forth).DD\nSame as DELETE, but deletes any data sets that this job references if the data sets have no users and\nno documentation, and do not cause job triggering.\nThis includes all virtual resources that are connected to the job.PURGE\nSame as DD, but also deletes job trigger definitions that trigger the job being deleted,\njob requirement definitions that require the job being deleted;\nand, if the WA Restart Option interface is active, deletes the WA Restart Option\nCMT member for the job being deleted.", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "list-job", - "aliases": [ - "lj" - ], - "summary": "Get basic definition for one or more jobs", - "description": "List Job Definiton", - "examples": [ - { - "options": "--jobname JOBA --all true", - "description": "Lists details of job named JOBA" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "jobname", - "aliases": [ - "jn" - ], - "description": "The CA 7 job name", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "databasename", - "aliases": [ - "db" - ], - "description": "The CA 7 database name", - "type": "string", - "group": "Options" - }, - { - "name": "all", - "description": "Fetch all the available properties\n", - "type": "boolean", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "create-job", - "aliases": [ - "cj" - ], - "summary": "Create a new job definition", - "description": "Create Job Definition", - "examples": [ - { - "options": "--job JOBA --job-type CPU --execute Y --use-jcl-override-library Y --do-not-schedule-before-date 11032 --do-not-schedule-before-time 1100 --do-not-schedule-after-date 11365 --do-not-schedule-after-time 1359", - "description": "creates a job named JOBA" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "job", - "description": "The name of the job", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "job-type", - "aliases": [ - "jt" - ], - "description": "The type of job.\nValid values are:\nCPU = A CPU jobXPJOB = A cross-platform jobAGENT = An Agent job", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "long-name", - "aliases": [ - "ln" - ], - "description": "(Optional) Defines the long job name.\nLimits: 1 to 64 alphanumeric characters, case sensitive", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "system", - "description": "(Optional) Specifies the user-defined application system name of which this job is a part.\nLimits: 1 to 8 alphanumeric characters. This field cannot contain a comma", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "uid", - "description": "(Optional) Specifies the CA 7 user security identification.\nDefault: 0 (no internal security protection)\nLimits: 1 to 3 numeric characters from 0 through 999", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "jobnet", - "description": "(Optional) Specifies the name of a CPU job network of which this job is a part.\nLimits: 1 to 8 alphanumeric characters. This field cannot contain a comma", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "owner", - "description": "(Optional) Specifies the ID identifying ownership of this job. Depending on the startup options taken, the external security product being used and contents of the JCL, this value can be offered to the external security package by CA 7 at job submission time as the authority for this job to be executed.\nLimits: 1 to 8 alphanumeric characters. Although this field supports up to 8 characters, some external security packages only accept up to 7 characters. This field must not exceed any such limit that exists", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "jcl-member", - "aliases": [ - "jm" - ], - "description": "(Optional) Specifies the JCL library member name and required when the member name and job name are different.\nValid when: job-type is CPU\nDefault: Job name\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "id", - "description": "(Optional) Specifies a numeric index value that is associated with a JCL library where the JCL member is located. NOTE: the id and lib properties are mutually exclusive.\nValid when: job-type is CPU\nDefault: 0\nLimits: 1 to 3 numeric characters in the range 0-253 or 256-999", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "lib", - "description": "(Optional) Specifies a JCL library identification consisting of a symbolic INDEX assigned to a JCL statement. NOTE: the id and lib properties are mutually exclusive.\nValid when: job-type is CPU\nLimits: 2 to 16 alphanumeric characters beginning with ampersand (&)", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "reload", - "description": "(Optional) Specifies whether to reload the JCL of this job. When a job comes into the request queue, it is either flagged for load processing or it is not flagged.\nValid when: job-type is CPU\nDefault: N\nValid values are:\nY = The job is flagged for load processing. The reload flag is automatically reset to N once the load completes successfullyN = The job is not flagged for load processing unless it is the first time it has run in CA 7X = The job is only flagged for load processing when the LOAD command is used and is never automatically changed even if the LOAD command is used", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "execute", - "description": "(Optional) Indicates whether to execute this job.\nDefault: Y\nValid values are:\nY = The job will be executedN = The job does not run but shows a normal completion as if it did run. JCL is not required for non-executable jobs", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "retain", - "description": "(Optional) Specifies whether to retain the execution JCL in the trailer queue after a successful run.\nValid when: job-type is CPU or XPJOB\nDefault: N\nValid values are:\nY = Retain the JCL in the trailer queue after a successful run.N = Do not retain the JCL in the trailer queue after a successful run", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "hold", - "description": "(Optional) Specifies whether to place this job in a hold status when it enters the request queue.\nDefault: N\nValid values are:\nY = The job will be heldN = The job will not be held", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "jcl-override", - "aliases": [ - "jo" - ], - "description": "(Optional) Specifies whether this job needs manual JCL overrides before it can be submitted. Similar to the JCLOVRD command.\nValid when: job-type is CPU\nDefault: N\nValid values are:\nY = The job needs manual JCL overrides before it can be submittedN = The job does not need manual JCL overrides before it can be submitted", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "use-jcl-override-library", - "aliases": [ - "ujol" - ], - "description": "(Optional) Specifies whether to retrieve the JCL from the JCL Override library (JCLID=254) for the next run only. This field is automatically set back to N the next time the job comes into the request queue.\nDefault: N\nValid values are:\nY = The JCL is retrieved from the JCL Override library for the next runN = The JCL is not retrieved from the JCL Override library for the next run", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "verify", - "description": "(Optional) Specifies whether this job requires any pre-submission manual verification. Similar to VERIFY command.\nDefault: N\nValid values are:\nY = The job requires any pre-submission manual verificationN = The job does not require any pre-submission manual verification", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "maintenance", - "aliases": [ - "maint" - ], - "description": "(Optional) Specifies whether this job is a maintenance job (for example, a system utility) with no production data set requirements. If Y is specified, all input data set requirements are ignored. None of the output data sets created by this job is posted back to CA 7.\nMarking a job as maintenance enables job triggering but not data set triggering.\nAlso, if the LOADDSNS keyword is used on the DBASE statement in the initialization file, the LOAD process does not build any DD or data set information for jobs that are marked as maintenance. This means that there are not any data set connections for these jobs unless added manually.\nValid when: job-type is CPU\nDefault: N\nValid values are:\nY = The job is a maintenance jobN = The job is not a maintenance job", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "job-requirement-lead-time", - "aliases": [ - "jrlt" - ], - "description": "(Optional) Specifies the number of hours to be considered when satisfying job-dependent requirements.\nDefault: 0\nValid values are:\n0 = No lead time is considered when satisfying this job's requirements99 = Specifies the requirement is never considered as already satisfied when the job enters the queues. Each predecessor job must complete typically while this job is in the request queuenn = Since the last run of this job, specifies that each predecessor job must have run within the last nn hours. Values for nn can be from 1 to 98", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "dataset-requirement-lead-time", - "aliases": [ - "drlt" - ], - "description": "(Optional) Specifies the number of hours to be considered when satisfying data set requirements.\nValid when: job-type is CPU\nDefault: 0\nValid values are:\n0 = No lead time is considered when satisfying this job's requirements99 = Specifies the requirement is never considered as already satisfied when the job enters the queues. Each data set requirement must be satisfied typically while this job is in the request queuenn = Since the last run of this job, specifies that each data set requirement must be satisfied within the last nn hours. Values for nn can be from 1 to 98", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "arfset", - "description": "(Optional) Names the collection of ARF definitions that apply to this job. Remember that ARF recovery is not invoked for non-executable jobs.\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "mainid", - "description": "(Optional) Specifies on which CPU the job can or cannot be scheduled. If the job requirements impose CPU restrictions, specify SYn or /SYn where n is the system number and / indicates not this system. System numbers must be consistent with the initialization file CPU statement MAINIDS parameters.\nValid when: job-type is CPU\nDefault: ALL (lets the job run on any CPU)\nLimits: 1 to 4 alphanumeric characters", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "insert-ca11-rms", - "aliases": [ - "icr" - ], - "description": "(Optional) Specifies whether to insert the WA Restart Option RMS step automatically at execution time by CA 7.\nValid when: job-type is CPU\nDefault: N\nValid values are:\nY = Inserts the step with the WA Restart Option processing code of PN = Does not insert the RMS step", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "condition-code", - "aliases": [ - "cc" - ], - "description": "(Optional) Used with relational-operator property to define the job-level condition codes used to determine whether a job executes successfully.\nValid when: job-type is CPU or XPJOB\nNote: All condition codes that are returned from an XPJOB job are treated as positive values. Any negative value returned is converted to an absolute (positive) value\nDefault: 0\nLimits: For job-type = CPU: 1 to 4 numeric characters in the range 0-4095\nFor job-type = \"XPJOB\": 1 to 4 numeric characters in the range 0-9999", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "relational-operator", - "aliases": [ - "ro" - ], - "description": "(Optional) Specifies the relational operator of the condition-code property or if the step level #SCC statements are being used in the job's JCL.\nValid when: job-type is CPU or XPJOB\nDefault: 0\nValid values are:\nEQ = Equal toLT = Less thanGT = Greater thanGE = Greater than or equal toLE = Less than or equal toNE = Not equal to#S = Make step condition code tests based on #SCC statements in the JCLIG = Make no evaluation of the job. CA 7 always assumes the job completes successfully, regardless of condition codes, abend codes, or runtime JCL errors. When this is used, the insert-ca11-rms property should be N0 = No condition test will be madeNOTE: If 0 is used, no test is made on the job's condition code. The highest condition code that this job generates is tested by this pair of parameters. For example, if condition-code is set at 8 and RO is set at LT, the job is marked as completing abnormally if 8 is less than the job's highest condition code", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "do-not-schedule-before-date", - "aliases": [ - "dnsbd" - ], - "description": "(Optional) Specifies not to schedule this job before this date (in YYDDD format, or 00000)", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "do-not-schedule-before-time", - "aliases": [ - "dnsbt" - ], - "description": "(Optional) Specifies not to schedule this job before this time (in HHMM format)", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "do-not-schedule-after-date", - "aliases": [ - "dnsad" - ], - "description": "(Optional) Specifies not to schedule this job after this date (in YYDDD format, or 99999)", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "do-not-schedule-after-time", - "aliases": [ - "dnsat" - ], - "description": "(Optional) Specifies not to schedule this job after this time (in HHMM format)", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "lterm", - "description": "(Optional) Routes the messages about this job to this logical terminal name.\nDefault: If not entered, the LTERM associated with the JCL library in the initialization file JCL statement is used. If LTERM is not specified on the JCL statement, the default is MASTER\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "list-requirements", - "aliases": [ - "lr" - ], - "description": "(Optional) Specifies whether to list pre-execution requirements for this job when it enters the request queue.\nDefault: Y\nValid values are:\nY = The pre-execution requirements will be listedN = The pre-execution requirements will not be listed", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "prompts", - "description": "(Optional) Specifies whether to issue prompt messages when this job is late.\nDefault: Y\nValid values are:\nY = Prompt messages will be issued when the job is lateN = Prompt messages will not be issued when the job is late", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "requirements-not-used", - "aliases": [ - "rnu" - ], - "description": "(Optional) Specifies whether to issue error messages for job requirements not used.\nDefault: Y\nValid values are:\nY = Messages will be issued if requirements are not usedN = Messages will not be issued if requirements are not used", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "dsn-not-found", - "aliases": [ - "dnf" - ], - "description": "(Optional) Specifies whether to list error messages for data sets used at execution time but not found in the CA 7 database.\nValid when: job-type is CPU\nDefault: Y\nValid values are:\nY = Messages will be issued if data sets used are not found in the CA 7 databaseN = Messages will not be issued if data sets used are not found in the CA 7 database", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "job-region", - "aliases": [ - "jr" - ], - "description": "(Optional) Specifies the region size that is required by this job (information only).\nValid when: job-type is CPU\nDefault: 0\nLimits: 1 to 4 numeric characters", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "elapsed-time", - "aliases": [ - "et" - ], - "description": "(Optional) CA 7 maintains certain SMF feedback data in its database, including a weighted average elapsed runtime. If the database is updated with a time of 0000, the counters for number of runs, number of times late, and number of restarts are also reset to 0000. One use of this value is deadline prompting. If 2359 is specified, deadline prompt time is not adjusted. It remains due-out time minus lead time.\nDefault: 0000\nLimits: 4 numeric characters in HHMM format where HH can be 00 - 23 and MM can be from 00 - 59", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "average-cpu-time", - "aliases": [ - "act" - ], - "description": "(Optional) CA 7 maintains weighted average CPU time usage values for each job in its database. If the database is updated with a time of 0000, the counters for number of runs, number of times late, and number of restarts are also reset to 0000. One use of this value is deadline prompting. If 2359 is specified, deadline prompt time is not adjusted. It remains due-out time minus lead time.\nValid when: job-type is CPU\nDefault: 0000\nLimits: 4 numeric characters in HHMM format where HH can be 00 - 23 and MM can be from 00 - 59", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "wlb-job-class", - "aliases": [ - "wjc" - ], - "description": "(Optional) Specifies the CA 7 WLB job class. If not specified, a WLB class of A is automatically assigned. This value does not have to match the JOB statement CLASS value.\n\nNOTE: The value specified here does not apply when the job enters the queue as a result of a RUN(H) command. Class 9 is assigned by default. To override class 9, use the RUNCLASS keyword on the OPTIONS statement in the initialization file.\n\nNOTE: The value specified here does not apply when the job enters the queue as a result of a LOAD(H) command. Class 8 is assigned by default. To override class 8, use the LOADCLASS keyword on the OPTIONS statement in the initialization file\nDefault: A space\nLimits: 1 alphanumeric character", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "wlb-priority", - "aliases": [ - "wp" - ], - "description": "(Optional) Specifies the CA 7 WLB job priority. A value of 255 indicates an express priority used to bypass WLB priority scheduling criteria. If using WLB, any job without a specified priority is automatically assigned a priority of 100 unless the default is changed\nDefault: 0\nLimits: 1 to 3 numeric characters in the range 0 - 255", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "message-class", - "aliases": [ - "mc" - ], - "description": "(Optional) Specifies the job's message class. This field is informational only. Even though this field can be changed, it does not cause the JCL to be changed. Also, no validity checking is done on this field.\nValid when: job-type is CPU\nDefault: A space\nLimits: 1 alphanumeric character", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "drclass", - "aliases": [ - "dc" - ], - "description": "(Optional) Specifies the job's disaster recovery class. This field has no impact on processing during normal execution. When running in disaster recovery mode, the disaster recovery class is used to determine whether the job should execute.\nLimits: 1 to 8 alphanumeric characters. Disaster recovery class values must start with a letter, #, or $ (not @) and can include letters, #, $, @, and numbers. Disaster recovery classes cannot contain embedded blanks", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "number-1-tape-man", - "aliases": [ - "n1tm" - ], - "description": "(Optional) Specifies a manual override value for the number of TYPE1 tape drives needed for the job. Normally this field is only used to update a job where tape drive requirements have been changed, higher or lower, and the job has not been reloaded after the change. A value of 255 can be used to specify that the job uses 0 TYPE1 tape drives.\nValid when: job-type is CPU\nDefault: 0\nLimits: 1 to 3 numeric characters in the range 0 - 255", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "number-2-tape-man", - "aliases": [ - "n2tm" - ], - "description": "(Optional) Specifies a manual override value for the number of TYPE2 tape drives needed for the job. Normally this field is only used to update a job where tape drive requirements have been changed, higher or lower, and the job has not been reloaded after the change. A value of 255 can be used to specify that the job uses 0 TYPE2 tape drives.\nValid when: job-type is CPU\nDefault: 0\nLimits: 1 to 3 numeric characters in the range 0 - 255", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "xp-node", - "aliases": [ - "xn" - ], - "description": "(Required when job-type is XPJOB) Defines the CAICCI node to which the execution of this job is targeted. This field should state the primary node. If this node is unavailable and the node definition has alternate nodes defined, the execution of this job can be directed to an alternate node.\nValid when: job-type is XPJOB\nLimits: 1 to 44 alphanumeric characters, although current z/OS CAICCI restricts this name to eight characters", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "xp-exec", - "aliases": [ - "xe" - ], - "description": "(Required when job-type is XPJOB) Defines the executable (file, command) to execute at the targeted cross-platform node. If the targeted platform is a mainframe scheduling system such as CA 7, this value indicates the job name to execute on that platform. If the targeted platform is Workload Automation AE system, this value indicates a job that is defined in the Workload Automation AE system. If this field begins and ends in single quote (') marks, these marks are removed before being passed in the transmission data. Otherwise, the field is passed to the target system as-is and in its entirety. This value includes any embedded blanks and quotation marks.\nValid when: job-type is XPJOB\nLimits: Up to 244 alphanumeric characters, and file delimiters of forward slash (/) and backward slash (\\) signs. Note: Each backward slash character must be escaped by specifying (\\\\)", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "xp-parm", - "aliases": [ - "xp" - ], - "description": "(Optional) Defines up to 128 bytes of parameter data to pass to the file or command being executed on the alternate platform. This data is supplied as PARM1 to the data being transmitted to the alternate platform. If this field begins and ends in single quote (') marks, these marks are removed before being passed in the transmission data. This value may be overridden if the PARMLIB/MEMBER field PARM1 is coded.\nValid when: job-type is XPJOB\nLimits: Up to 128 EBCDIC characters", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "parmlib", - "aliases": [ - "pl" - ], - "description": "(Optional) Defines extra, optional indexed, or symbolic (PDS) library from where execution data to be associated with this job can be found. This information is typically PARM1 through PARM64 keywords but can vary based on CA 7 system configuration options. If the PARM1 field is found within this file, it overrides the data that is specified in the XP PARM field that is listed on the panel.\nValid when: job-type is XPJOB or AGENT\nLimits: 1 to 16 alphanumeric characters. If this field starts with a numeric value, the value is treated as a JCL Index value (0 - 253 or 256 - 999), and the associated numbered JCL library, as defined in the initialization file JCL statement, is used. If the first character is not numeric, the field must start with an ampersand (&) and must denote the library variable as defined using a /JCL command.\nNote: Specifying data in the PARMLIB/MEMBER fields is in addition to anything specified in the XPPARM field. If XPPARM is coded, and if the PARMLIB/Member contains a PARM1 statement, the PARMLIB specification overrides the XP PARM field. Thus, if both XPPARM and PARMLIB PARM1 fields contain data, the data that is obtained from the PARMLIB/MEMBER is used in the data that is transmitted to the target node", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "member", - "description": "(Optional) Indicates the PDS member name in the parmlib library where the parameters for this job reside.\nValid when: job-type is XPJOB or AGENT\nDefault: Same as the job property\nLimits: 1 to 8 alphanumeric characters, beginning with an alphabetic character", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "sutype", - "description": "(Optional) Specifies the type of \"switch user\" command to execute at the UNIX target node.\nValid when: job-type is XPJOB\nDefault: Y\nValid values are:\nY = Executes an \"SU -\" causing the environment setup to include execution of the \".PROFILE\" for the target userN = Executes an \"SU\" command without the profile option", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "xp-trace", - "aliases": [ - "xt" - ], - "description": "(Optional) Indicates whether to trace the activity that is associated with this job as it moves through the queues.\nValid when: job-type is XPJOB\nDefault: N\nValid values are:\nY = Issue WTOs as the job enters into the submission process. Retain up to 256 characters of the data that is sent for inclusion in a log recordN = Do not activate tracing for this job", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "agent-job-type", - "aliases": [ - "ajt" - ], - "description": "(Required when job-type is AGENT) Defines the type of agent job. For more information about the Agent job types see:\n[CA 7 Documentation](https://techdocs.broadcom.com/us/en/ca-mainframe-software/automation/ca-workload-automation-ca-7-edition/12-1/configuring/interfaces/cross-platform-scheduling/ca-workload-automation-agents/ca-7-agent-job-types.html/)\nValid when: job-type is AGENT\nDefault: There is no default value\nValid values are:\nUNIX_JOB - Generic UNIXNT_JOB - Microsoft WindowsFILE_TRIGGER - File TriggerFTP_JOB - FTPSCP_JOB - Secure CopySFTP_JOB - Secure File TransferBDC_JOB - SAP Batch Input SessionBWIP_JOB - SAP Business Warehouse InfoPackageBWPC_JOB - SAP Business Warehouse Process ChainSAP_JOB - SAP GenericSAPA_JOB - SAP ArchiveSAPE_JOB - SAP Event MonitorSAPM_JOB - SAP Process MonitorPS_JOB - PeopleSoftOA_JOB - Oracle RequestOAC_JOB - Oracle CopyCPU_MON - CPU MonitorDISK_MON - Disk MonitorIP_MON - IP MonitorPROCESS_MON - Process MonitorTEXT_MON - Text File MonitorEVENTLOG_MON - Event Log MonitorSERVICE_MON - Service MonitorSQL_JOB - Database SQLDBSP_JOB - Database Stored ProcedureDB_MON - Database MonitorDB_TRIG - Database TriggerAS400_JOB - AS400/OS400JMSP_JOB - J2EE JMS PublishJMSS_JOB - J2EE JMS SubscribeEJBE_JOB - J2EE Entity BeanHTTP_JOB - J2EE HTTP/ServletPOJO_JOB - J2EE POJORMI_JOB - J2EE RMIEJB_JOB - J2EE Session BeanJMXB_JOB - JMX-Mbean Attribute GetJMXA_JOB - JMX-Mbean Attribute SetJMXO_JOB - JMX-Mbean OperationJMXS_JOB - JMX-Mbean SubscribeJMXN_JOB - JMX-Mbean Create InstanceJMXR_JOB - JMX-Mbean Remove InstanceSNPG_JOB - SNMP Get AttributeSNPS_JOB - SNMP Set AttributeSNPC_JOB - SNMP SubscribeSNPE_JOB - SNMP TrapSendWEB_SERV - Web ServicesWOL_JOB - Wake-On-LANPROXY_JOB - Remote ExecutionNONSTOP_JOB - HP Integrity NonStop", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "agent", - "description": "(Required when job-type is AGENT) Identifies the explicit distributed platform where the job is to run.\nValid when: job-type is AGENT\nLimits: 1 to 16 alphanumeric characters. The value must be defined to CA 7 using the IASAGENT DD statement", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "agent-user", - "aliases": [ - "au" - ], - "description": "(Optional) Defines the user ID that is passed to the distributed platform where the job is to run.\nValid when: job-type is AGENT\nLimits: 1 to 128 alphanumeric characters", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "update-job", - "aliases": [ - "uj" - ], - "summary": "Update the definition of a job", - "description": "JobDefinition", - "examples": [ - { - "options": "--job JOBAB --long-name NewJob --job-type CPU", - "description": "updates long name of a job named JOBA to NewJob" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "job", - "description": "The name of the job", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "job-type", - "aliases": [ - "jt" - ], - "description": "The type of job.\nValid values are:\nCPU = A CPU jobXPJOB = A cross-platform jobAGENT = An Agent job", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "long-name", - "aliases": [ - "ln" - ], - "description": "(Optional) Defines the long job name.\nLimits: 1 to 64 alphanumeric characters, case sensitive", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "system", - "description": "(Optional) Specifies the user-defined application system name of which this job is a part.\nLimits: 1 to 8 alphanumeric characters. This field cannot contain a comma", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "uid", - "description": "(Optional) Specifies the CA 7 user security identification.\nDefault: 0 (no internal security protection)\nLimits: 1 to 3 numeric characters from 0 through 999", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "jobnet", - "description": "(Optional) Specifies the name of a CPU job network of which this job is a part.\nLimits: 1 to 8 alphanumeric characters. This field cannot contain a comma", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "owner", - "description": "(Optional) Specifies the ID identifying ownership of this job. Depending on the startup options taken, the external security product being used and contents of the JCL, this value can be offered to the external security package by CA 7 at job submission time as the authority for this job to be executed.\nLimits: 1 to 8 alphanumeric characters. Although this field supports up to 8 characters, some external security packages only accept up to 7 characters. This field must not exceed any such limit that exists", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "jcl-member", - "aliases": [ - "jm" - ], - "description": "(Optional) Specifies the JCL library member name and required when the member name and job name are different.\nValid when: job-type is CPU\nDefault: Job name\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "id", - "description": "(Optional) Specifies a numeric index value that is associated with a JCL library where the JCL member is located. NOTE: the id and lib properties are mutually exclusive.\nValid when: job-type is CPU\nDefault: 0\nLimits: 1 to 3 numeric characters in the range 0-253 or 256-999", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "lib", - "description": "(Optional) Specifies a JCL library identification consisting of a symbolic INDEX assigned to a JCL statement. NOTE: the id and lib properties are mutually exclusive.\nValid when: job-type is CPU\nLimits: 2 to 16 alphanumeric characters beginning with ampersand (&)", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "reload", - "description": "(Optional) Specifies whether to reload the JCL of this job. When a job comes into the request queue, it is either flagged for load processing or it is not flagged.\nValid when: job-type is CPU\nDefault: N\nValid values are:\nY = The job is flagged for load processing. The reload flag is automatically reset to N once the load completes successfullyN = The job is not flagged for load processing unless it is the first time it has run in CA 7X = The job is only flagged for load processing when the LOAD command is used and is never automatically changed even if the LOAD command is used", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "execute", - "description": "(Optional) Indicates whether to execute this job.\nDefault: Y\nValid values are:\nY = The job will be executedN = The job does not run but shows a normal completion as if it did run. JCL is not required for non-executable jobs", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "retain", - "description": "(Optional) Specifies whether to retain the execution JCL in the trailer queue after a successful run.\nValid when: job-type is CPU or XPJOB\nDefault: N\nValid values are:\nY = Retain the JCL in the trailer queue after a successful run.N = Do not retain the JCL in the trailer queue after a successful run", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "hold", - "description": "(Optional) Specifies whether to place this job in a hold status when it enters the request queue.\nDefault: N\nValid values are:\nY = The job will be heldN = The job will not be held", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "jcl-override", - "aliases": [ - "jo" - ], - "description": "(Optional) Specifies whether this job needs manual JCL overrides before it can be submitted. Similar to the JCLOVRD command.\nValid when: job-type is CPU\nDefault: N\nValid values are:\nY = The job needs manual JCL overrides before it can be submittedN = The job does not need manual JCL overrides before it can be submitted", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "use-jcl-override-library", - "aliases": [ - "ujol" - ], - "description": "(Optional) Specifies whether to retrieve the JCL from the JCL Override library (JCLID=254) for the next run only. This field is automatically set back to N the next time the job comes into the request queue.\nDefault: N\nValid values are:\nY = The JCL is retrieved from the JCL Override library for the next runN = The JCL is not retrieved from the JCL Override library for the next run", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "verify", - "description": "(Optional) Specifies whether this job requires any pre-submission manual verification. Similar to VERIFY command.\nDefault: N\nValid values are:\nY = The job requires any pre-submission manual verificationN = The job does not require any pre-submission manual verification", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "maintenance", - "aliases": [ - "maint" - ], - "description": "(Optional) Specifies whether this job is a maintenance job (for example, a system utility) with no production data set requirements. If Y is specified, all input data set requirements are ignored. None of the output data sets created by this job is posted back to CA 7.\nMarking a job as maintenance enables job triggering but not data set triggering.\nAlso, if the LOADDSNS keyword is used on the DBASE statement in the initialization file, the LOAD process does not build any DD or data set information for jobs that are marked as maintenance. This means that there are not any data set connections for these jobs unless added manually.\nValid when: job-type is CPU\nDefault: N\nValid values are:\nY = The job is a maintenance jobN = The job is not a maintenance job", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "job-requirement-lead-time", - "aliases": [ - "jrlt" - ], - "description": "(Optional) Specifies the number of hours to be considered when satisfying job-dependent requirements.\nDefault: 0\nValid values are:\n0 = No lead time is considered when satisfying this job's requirements99 = Specifies the requirement is never considered as already satisfied when the job enters the queues. Each predecessor job must complete typically while this job is in the request queuenn = Since the last run of this job, specifies that each predecessor job must have run within the last nn hours. Values for nn can be from 1 to 98", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "dataset-requirement-lead-time", - "aliases": [ - "drlt" - ], - "description": "(Optional) Specifies the number of hours to be considered when satisfying data set requirements.\nValid when: job-type is CPU\nDefault: 0\nValid values are:\n0 = No lead time is considered when satisfying this job's requirements99 = Specifies the requirement is never considered as already satisfied when the job enters the queues. Each data set requirement must be satisfied typically while this job is in the request queuenn = Since the last run of this job, specifies that each data set requirement must be satisfied within the last nn hours. Values for nn can be from 1 to 98", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "arfset", - "description": "(Optional) Names the collection of ARF definitions that apply to this job. Remember that ARF recovery is not invoked for non-executable jobs.\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "mainid", - "description": "(Optional) Specifies on which CPU the job can or cannot be scheduled. If the job requirements impose CPU restrictions, specify SYn or /SYn where n is the system number and / indicates not this system. System numbers must be consistent with the initialization file CPU statement MAINIDS parameters.\nValid when: job-type is CPU\nDefault: ALL (lets the job run on any CPU)\nLimits: 1 to 4 alphanumeric characters", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "insert-ca11-rms", - "aliases": [ - "icr" - ], - "description": "(Optional) Specifies whether to insert the WA Restart Option RMS step automatically at execution time by CA 7.\nValid when: job-type is CPU\nDefault: N\nValid values are:\nY = Inserts the step with the WA Restart Option processing code of PN = Does not insert the RMS step", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "condition-code", - "aliases": [ - "cc" - ], - "description": "(Optional) Used with relational-operator property to define the job-level condition codes used to determine whether a job executes successfully.\nValid when: job-type is CPU or XPJOB\nNote: All condition codes that are returned from an XPJOB job are treated as positive values. Any negative value returned is converted to an absolute (positive) value\nDefault: 0\nLimits: For job-type = CPU: 1 to 4 numeric characters in the range 0-4095\nFor job-type = \"XPJOB\": 1 to 4 numeric characters in the range 0-9999", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "relational-operator", - "aliases": [ - "ro" - ], - "description": "(Optional) Specifies the relational operator of the condition-code property or if the step level #SCC statements are being used in the job's JCL.\nValid when: job-type is CPU or XPJOB\nDefault: 0\nValid values are:\nEQ = Equal toLT = Less thanGT = Greater thanGE = Greater than or equal toLE = Less than or equal toNE = Not equal to#S = Make step condition code tests based on #SCC statements in the JCLIG = Make no evaluation of the job. CA 7 always assumes the job completes successfully, regardless of condition codes, abend codes, or runtime JCL errors. When this is used, the insert-ca11-rms property should be N0 = No condition test will be madeNOTE: If 0 is used, no test is made on the job's condition code. The highest condition code that this job generates is tested by this pair of parameters. For example, if condition-code is set at 8 and RO is set at LT, the job is marked as completing abnormally if 8 is less than the job's highest condition code", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "do-not-schedule-before-date", - "aliases": [ - "dnsbd" - ], - "description": "(Optional) Specifies not to schedule this job before this date (in YYDDD format, or 00000)", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "do-not-schedule-before-time", - "aliases": [ - "dnsbt" - ], - "description": "(Optional) Specifies not to schedule this job before this time (in HHMM format)", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "do-not-schedule-after-date", - "aliases": [ - "dnsad" - ], - "description": "(Optional) Specifies not to schedule this job after this date (in YYDDD format, or 99999)", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "do-not-schedule-after-time", - "aliases": [ - "dnsat" - ], - "description": "(Optional) Specifies not to schedule this job after this time (in HHMM format)", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "lterm", - "description": "(Optional) Routes the messages about this job to this logical terminal name.\nDefault: If not entered, the LTERM associated with the JCL library in the initialization file JCL statement is used. If LTERM is not specified on the JCL statement, the default is MASTER\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "list-requirements", - "aliases": [ - "lr" - ], - "description": "(Optional) Specifies whether to list pre-execution requirements for this job when it enters the request queue.\nDefault: Y\nValid values are:\nY = The pre-execution requirements will be listedN = The pre-execution requirements will not be listed", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "prompts", - "description": "(Optional) Specifies whether to issue prompt messages when this job is late.\nDefault: Y\nValid values are:\nY = Prompt messages will be issued when the job is lateN = Prompt messages will not be issued when the job is late", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "requirements-not-used", - "aliases": [ - "rnu" - ], - "description": "(Optional) Specifies whether to issue error messages for job requirements not used.\nDefault: Y\nValid values are:\nY = Messages will be issued if requirements are not usedN = Messages will not be issued if requirements are not used", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "dsn-not-found", - "aliases": [ - "dnf" - ], - "description": "(Optional) Specifies whether to list error messages for data sets used at execution time but not found in the CA 7 database.\nValid when: job-type is CPU\nDefault: Y\nValid values are:\nY = Messages will be issued if data sets used are not found in the CA 7 databaseN = Messages will not be issued if data sets used are not found in the CA 7 database", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "job-region", - "aliases": [ - "jr" - ], - "description": "(Optional) Specifies the region size that is required by this job (information only).\nValid when: job-type is CPU\nDefault: 0\nLimits: 1 to 4 numeric characters", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "elapsed-time", - "aliases": [ - "et" - ], - "description": "(Optional) CA 7 maintains certain SMF feedback data in its database, including a weighted average elapsed runtime. If the database is updated with a time of 0000, the counters for number of runs, number of times late, and number of restarts are also reset to 0000. One use of this value is deadline prompting. If 2359 is specified, deadline prompt time is not adjusted. It remains due-out time minus lead time.\nDefault: 0000\nLimits: 4 numeric characters in HHMM format where HH can be 00 - 23 and MM can be from 00 - 59", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "average-cpu-time", - "aliases": [ - "act" - ], - "description": "(Optional) CA 7 maintains weighted average CPU time usage values for each job in its database. If the database is updated with a time of 0000, the counters for number of runs, number of times late, and number of restarts are also reset to 0000. One use of this value is deadline prompting. If 2359 is specified, deadline prompt time is not adjusted. It remains due-out time minus lead time.\nValid when: job-type is CPU\nDefault: 0000\nLimits: 4 numeric characters in HHMM format where HH can be 00 - 23 and MM can be from 00 - 59", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "wlb-job-class", - "aliases": [ - "wjc" - ], - "description": "(Optional) Specifies the CA 7 WLB job class. If not specified, a WLB class of A is automatically assigned. This value does not have to match the JOB statement CLASS value.\n\nNOTE: The value specified here does not apply when the job enters the queue as a result of a RUN(H) command. Class 9 is assigned by default. To override class 9, use the RUNCLASS keyword on the OPTIONS statement in the initialization file.\n\nNOTE: The value specified here does not apply when the job enters the queue as a result of a LOAD(H) command. Class 8 is assigned by default. To override class 8, use the LOADCLASS keyword on the OPTIONS statement in the initialization file\nDefault: A space\nLimits: 1 alphanumeric character", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "wlb-priority", - "aliases": [ - "wp" - ], - "description": "(Optional) Specifies the CA 7 WLB job priority. A value of 255 indicates an express priority used to bypass WLB priority scheduling criteria. If using WLB, any job without a specified priority is automatically assigned a priority of 100 unless the default is changed\nDefault: 0\nLimits: 1 to 3 numeric characters in the range 0 - 255", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "message-class", - "aliases": [ - "mc" - ], - "description": "(Optional) Specifies the job's message class. This field is informational only. Even though this field can be changed, it does not cause the JCL to be changed. Also, no validity checking is done on this field.\nValid when: job-type is CPU\nDefault: A space\nLimits: 1 alphanumeric character", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "drclass", - "aliases": [ - "dc" - ], - "description": "(Optional) Specifies the job's disaster recovery class. This field has no impact on processing during normal execution. When running in disaster recovery mode, the disaster recovery class is used to determine whether the job should execute.\nLimits: 1 to 8 alphanumeric characters. Disaster recovery class values must start with a letter, #, or $ (not @) and can include letters, #, $, @, and numbers. Disaster recovery classes cannot contain embedded blanks", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "number-1-tape-man", - "aliases": [ - "n1tm" - ], - "description": "(Optional) Specifies a manual override value for the number of TYPE1 tape drives needed for the job. Normally this field is only used to update a job where tape drive requirements have been changed, higher or lower, and the job has not been reloaded after the change. A value of 255 can be used to specify that the job uses 0 TYPE1 tape drives.\nValid when: job-type is CPU\nDefault: 0\nLimits: 1 to 3 numeric characters in the range 0 - 255", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "number-2-tape-man", - "aliases": [ - "n2tm" - ], - "description": "(Optional) Specifies a manual override value for the number of TYPE2 tape drives needed for the job. Normally this field is only used to update a job where tape drive requirements have been changed, higher or lower, and the job has not been reloaded after the change. A value of 255 can be used to specify that the job uses 0 TYPE2 tape drives.\nValid when: job-type is CPU\nDefault: 0\nLimits: 1 to 3 numeric characters in the range 0 - 255", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "xp-node", - "aliases": [ - "xn" - ], - "description": "(Required when job-type is XPJOB) Defines the CAICCI node to which the execution of this job is targeted. This field should state the primary node. If this node is unavailable and the node definition has alternate nodes defined, the execution of this job can be directed to an alternate node.\nValid when: job-type is XPJOB\nLimits: 1 to 44 alphanumeric characters, although current z/OS CAICCI restricts this name to eight characters", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "xp-exec", - "aliases": [ - "xe" - ], - "description": "(Required when job-type is XPJOB) Defines the executable (file, command) to execute at the targeted cross-platform node. If the targeted platform is a mainframe scheduling system such as CA 7, this value indicates the job name to execute on that platform. If the targeted platform is Workload Automation AE system, this value indicates a job that is defined in the Workload Automation AE system. If this field begins and ends in single quote (') marks, these marks are removed before being passed in the transmission data. Otherwise, the field is passed to the target system as-is and in its entirety. This value includes any embedded blanks and quotation marks.\nValid when: job-type is XPJOB\nLimits: Up to 244 alphanumeric characters, and file delimiters of forward slash (/) and backward slash (\\) signs. Note: Each backward slash character must be escaped by specifying (\\\\)", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "xp-parm", - "aliases": [ - "xp" - ], - "description": "(Optional) Defines up to 128 bytes of parameter data to pass to the file or command being executed on the alternate platform. This data is supplied as PARM1 to the data being transmitted to the alternate platform. If this field begins and ends in single quote (') marks, these marks are removed before being passed in the transmission data. This value may be overridden if the PARMLIB/MEMBER field PARM1 is coded.\nValid when: job-type is XPJOB\nLimits: Up to 128 EBCDIC characters", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "parmlib", - "aliases": [ - "pl" - ], - "description": "(Optional) Defines extra, optional indexed, or symbolic (PDS) library from where execution data to be associated with this job can be found. This information is typically PARM1 through PARM64 keywords but can vary based on CA 7 system configuration options. If the PARM1 field is found within this file, it overrides the data that is specified in the XP PARM field that is listed on the panel.\nValid when: job-type is XPJOB or AGENT\nLimits: 1 to 16 alphanumeric characters. If this field starts with a numeric value, the value is treated as a JCL Index value (0 - 253 or 256 - 999), and the associated numbered JCL library, as defined in the initialization file JCL statement, is used. If the first character is not numeric, the field must start with an ampersand (&) and must denote the library variable as defined using a /JCL command.\nNote: Specifying data in the PARMLIB/MEMBER fields is in addition to anything specified in the XPPARM field. If XPPARM is coded, and if the PARMLIB/Member contains a PARM1 statement, the PARMLIB specification overrides the XP PARM field. Thus, if both XPPARM and PARMLIB PARM1 fields contain data, the data that is obtained from the PARMLIB/MEMBER is used in the data that is transmitted to the target node", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "member", - "description": "(Optional) Indicates the PDS member name in the parmlib library where the parameters for this job reside.\nValid when: job-type is XPJOB or AGENT\nDefault: Same as the job property\nLimits: 1 to 8 alphanumeric characters, beginning with an alphabetic character", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "sutype", - "description": "(Optional) Specifies the type of \"switch user\" command to execute at the UNIX target node.\nValid when: job-type is XPJOB\nDefault: Y\nValid values are:\nY = Executes an \"SU -\" causing the environment setup to include execution of the \".PROFILE\" for the target userN = Executes an \"SU\" command without the profile option", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "xp-trace", - "aliases": [ - "xt" - ], - "description": "(Optional) Indicates whether to trace the activity that is associated with this job as it moves through the queues.\nValid when: job-type is XPJOB\nDefault: N\nValid values are:\nY = Issue WTOs as the job enters into the submission process. Retain up to 256 characters of the data that is sent for inclusion in a log recordN = Do not activate tracing for this job", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "agent-job-type", - "aliases": [ - "ajt" - ], - "description": "(Required when job-type is AGENT) Defines the type of agent job. For more information about the Agent job types see:\n[CA 7 Documentation](https://techdocs.broadcom.com/us/en/ca-mainframe-software/automation/ca-workload-automation-ca-7-edition/12-1/configuring/interfaces/cross-platform-scheduling/ca-workload-automation-agents/ca-7-agent-job-types.html/)\nValid when: job-type is AGENT\nDefault: There is no default value\nValid values are:\nUNIX_JOB - Generic UNIXNT_JOB - Microsoft WindowsFILE_TRIGGER - File TriggerFTP_JOB - FTPSCP_JOB - Secure CopySFTP_JOB - Secure File TransferBDC_JOB - SAP Batch Input SessionBWIP_JOB - SAP Business Warehouse InfoPackageBWPC_JOB - SAP Business Warehouse Process ChainSAP_JOB - SAP GenericSAPA_JOB - SAP ArchiveSAPE_JOB - SAP Event MonitorSAPM_JOB - SAP Process MonitorPS_JOB - PeopleSoftOA_JOB - Oracle RequestOAC_JOB - Oracle CopyCPU_MON - CPU MonitorDISK_MON - Disk MonitorIP_MON - IP MonitorPROCESS_MON - Process MonitorTEXT_MON - Text File MonitorEVENTLOG_MON - Event Log MonitorSERVICE_MON - Service MonitorSQL_JOB - Database SQLDBSP_JOB - Database Stored ProcedureDB_MON - Database MonitorDB_TRIG - Database TriggerAS400_JOB - AS400/OS400JMSP_JOB - J2EE JMS PublishJMSS_JOB - J2EE JMS SubscribeEJBE_JOB - J2EE Entity BeanHTTP_JOB - J2EE HTTP/ServletPOJO_JOB - J2EE POJORMI_JOB - J2EE RMIEJB_JOB - J2EE Session BeanJMXB_JOB - JMX-Mbean Attribute GetJMXA_JOB - JMX-Mbean Attribute SetJMXO_JOB - JMX-Mbean OperationJMXS_JOB - JMX-Mbean SubscribeJMXN_JOB - JMX-Mbean Create InstanceJMXR_JOB - JMX-Mbean Remove InstanceSNPG_JOB - SNMP Get AttributeSNPS_JOB - SNMP Set AttributeSNPC_JOB - SNMP SubscribeSNPE_JOB - SNMP TrapSendWEB_SERV - Web ServicesWOL_JOB - Wake-On-LANPROXY_JOB - Remote ExecutionNONSTOP_JOB - HP Integrity NonStop", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "agent", - "description": "(Required when job-type is AGENT) Identifies the explicit distributed platform where the job is to run.\nValid when: job-type is AGENT\nLimits: 1 to 16 alphanumeric characters. The value must be defined to CA 7 using the IASAGENT DD statement", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "agent-user", - "aliases": [ - "au" - ], - "description": "(Optional) Defines the user ID that is passed to the distributed platform where the job is to run.\nValid when: job-type is AGENT\nLimits: 1 to 128 alphanumeric characters", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "create-variable-resource", - "aliases": [ - "cvr" - ], - "summary": "Add Variable resource to a job definition", - "description": "Add Variable Resource", - "examples": [ - { - "options": "--job JOBAA --schid 23 --rn SCHENV.VARNAME", - "description": "Creates a job named JOBAA with resource name SCHENV.VARNAME and schedule id 23" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "job", - "description": "Specifies the job name on which the indicated function is performed.\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "schid", - "description": "(Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.\nDefault: 0, which indicates that the requirement holds for all schedule IDs\nLimits: 1 to 3 numeric characters from 0 through 999", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "resource-name", - "aliases": [ - "rn" - ], - "description": "Specifies the resource name being connected to the job.\nLimits: \"SCHENV.\" followed by 1 to 16 alphanumeric and @, #, $, _ characters", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "delete-variable-resource", - "aliases": [ - "dvr" - ], - "summary": "Delete Variable resource from a job definition", - "description": "Delete Variable Resource", - "examples": [ - { - "options": "--job JOBAA --schid 23 --rn SCHENV.VARNAME", - "description": "Deletes a job named JOBAA with resource name SCHENV.VARNAME" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "job", - "description": "Specifies the job name on which the indicated function is performed.\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "schid", - "description": "(Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.\nDefault: 0, which indicates that the requirement holds for all schedule IDs\nLimits: 1 to 3 numeric characters from 0 through 999", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "resource-name", - "aliases": [ - "rn" - ], - "description": "Specifies the resource name being connected to the job.\nLimits: \"SCHENV.\" followed by 1 to 16 alphanumeric and @, #, $, _ characters", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "delete-shared-resource", - "aliases": [ - "dsr" - ], - "summary": "Delete Shared resource from a job definition", - "description": "Delete Shared Resource", - "examples": [ - { - "options": "--job JOBAA --schid 23 --rn SCHENV.VARNAME", - "description": "Deletes a job named JOBAA with resource name SCHENV.VARNAME" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "job", - "description": "Specifies the job name on which the indicated function is performed.\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "schid", - "description": "(Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.\nDefault: 0, which indicates that the requirement holds for all schedule IDs\nLimits: 1 to 3 numeric characters from 0 through 999", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "resource-name", - "aliases": [ - "rn" - ], - "description": "Specifies the resource name being connected to the job.\nLimits: 1 to 44 characters, the first character must be non-blank, and no embedded blanks", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "create-shared-resource", - "aliases": [ - "csr" - ], - "summary": "Add Shared resource to a job definition", - "description": "Post Shared Resource", - "examples": [ - { - "options": "--job JOBAA --rn SCHENV.VARNAME --free A", - "description": "Creates a job named JOBAA with resource name SCHENV.VARNAME" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "job", - "description": "Specifies the job name on which the indicated function is performed.\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "schid", - "description": "(Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.\nDefault: 0, which indicates that the requirement holds for all schedule IDs\nLimits: 1 to 3 numeric characters from 0 through 999", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "resource-name", - "aliases": [ - "rn" - ], - "description": "Specifies the resource name being connected to the job.\nLimits: 1 to 44 characters, the first character must be non-blank, and no embedded blanks", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "step-name", - "aliases": [ - "sn" - ], - "description": "(Optional) Specifies the resource is freed at the conclusion of the named job step.\nLimits: 1 to 8 alphanumeric characters\nNotes:The step-name parameter applies to the first occurrence of the stepname that is encountered in the job stream. This includes any reference to the stepname embedded in a PROCThe only valid stepname would be for steps with PGM= coded, not for stepnames executing a PROCIf a job is restarted in a step after this step-name, the resource does not go through free processing until the job completesA step flush condition does not post the step-name process", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "free", - "description": "Determines how VRM manages resource availability at job submission and job/step completion.\nValid values are:\nA = Specifies the resource is only freed if any step in the job abends (abend or condition code checking)F = Specifies the resource is freed when job ends, either successfully or unsuccessfully. If the step-name parameter is specified, free the resource when the specified step completes, either successfully or unsuccessfullyN = Specifies do not free the resource at successful job completion. The resource can be freed with the PRSCF command. A cancel of the job also frees the resourceY = Specifies to free the resource at successful job completion. If the step-name parameter is specified, free the resource when the specified step completes successfully (does not abend)", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "update-shared-resource", - "aliases": [ - "usr" - ], - "summary": "Modify Shared resource for a job definition", - "description": "Modify Shared Resource", - "examples": [ - { - "options": "--job JOBAA --rn SCHENV.VARNAME --free A", - "description": "Creates a job named JOBAA with resource name SCHENV.VARNAME" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "job", - "description": "Specifies the job name on which the indicated function is performed.\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "schid", - "description": "(Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.\nDefault: 0, which indicates that the requirement holds for all schedule IDs\nLimits: 1 to 3 numeric characters from 0 through 999", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "resource-name", - "aliases": [ - "rn" - ], - "description": "Specifies the resource name being connected to the job.\nLimits: 1 to 44 characters, the first character must be non-blank, and no embedded blanks", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "step-name", - "aliases": [ - "sn" - ], - "description": "(Optional) Specifies the resource is freed at the conclusion of the named job step.\nLimits: 1 to 8 alphanumeric characters\nNotes:The step-name parameter applies to the first occurrence of the stepname that is encountered in the job stream. This includes any reference to the stepname embedded in a PROCThe only valid stepname would be for steps with PGM= coded, not for stepnames executing a PROCIf a job is restarted in a step after this step-name, the resource does not go through free processing until the job completesA step flush condition does not post the step-name process", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "free", - "description": "Determines how VRM manages resource availability at job submission and job/step completion.\nValid values are:\nA = Specifies the resource is only freed if any step in the job abends (abend or condition code checking)F = Specifies the resource is freed when job ends, either successfully or unsuccessfully. If the step-name parameter is specified, free the resource when the specified step completes, either successfully or unsuccessfullyN = Specifies do not free the resource at successful job completion. The resource can be freed with the PRSCF command. A cancel of the job also frees the resourceY = Specifies to free the resource at successful job completion. If the step-name parameter is specified, free the resource when the specified step completes successfully (does not abend)", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "delete-exclusive-resource", - "aliases": [ - "der" - ], - "summary": "Delete Exclusive resource from a job definition", - "description": "Delete Exclusive Resource", - "examples": [ - { - "options": "--job JOBA --rn RESOURCE.NAME --schid 42", - "description": "Deletes a job named JOBA with resource name RESOURCE.NAME" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "job", - "description": "Specifies the job name on which the indicated function is performed.\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "schid", - "description": "(Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.\nDefault: 0, which indicates that the requirement holds for all schedule IDs\nLimits: 1 to 3 numeric characters from 0 through 999", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "resource-name", - "aliases": [ - "rn" - ], - "description": "Specifies the resource name being connected to the job.\nLimits: 1 to 44 characters, the first character must be non-blank, and no embedded blanks", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "create-exclusive-resource", - "aliases": [ - "cer" - ], - "summary": "Add Exclusive resource to a job definition", - "description": "Add Exclusive Resource", - "examples": [ - { - "options": "--job JOBAA --schid 23 --rn SCHENV.VARNAME --free F --sn JS010 ", - "description": "Creates a job named JOBAA with resource name SCHENV.VARNAME of free type F, step name JS010 and schedule id 23" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "job", - "description": "Specifies the job name on which the indicated function is performed.\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "schid", - "description": "(Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.\nDefault: 0, which indicates that the requirement holds for all schedule IDs\nLimits: 1 to 3 numeric characters from 0 through 999", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "resource-name", - "aliases": [ - "rn" - ], - "description": "Specifies the resource name being connected to the job.\nLimits: 1 to 44 characters, the first character must be non-blank, and no embedded blanks", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "step-name", - "aliases": [ - "sn" - ], - "description": "(Optional) Specifies the resource is freed at the conclusion of the named job step.\nLimits: 1 to 8 alphanumeric characters\nNotes:The step-name parameter applies to the first occurrence of the stepname that is encountered in the job stream. This includes any reference to the stepname embedded in a PROCThe only valid stepname would be for steps with PGM= coded, not for stepnames executing a PROCIf a job is restarted in a step after this step-name, the resource does not go through free processing until the job completesA step flush condition does not post the step-name process", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "free", - "description": "Determines how VRM manages resource availability at job submission and job/step completion.\nValid values are:\nA = Specifies the resource is only freed if any step in the job abends (abend or condition code checking)F = Specifies the resource is freed when job ends, either successfully or unsuccessfully. If the step-name parameter is specified, free the resource when the specified step completes, either successfully or unsuccessfullyN = Specifies do not free the resource at successful job completion. The resource can be freed with the PRSCF command. A cancel of the job also frees the resourceY = Specifies to free the resource at successful job completion. If the step-name parameter is specified, free the resource when the specified step completes successfully (does not abend)", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "update-exclusive-resource", - "aliases": [ - "uer" - ], - "summary": "Modify Exclusive resource for a job definition", - "description": "ExclusiveResource", - "examples": [ - { - "options": "--job JOBA --rn RESOURCE.NAME --free F --sn JS011 --schid 42", - "description": "Updates a job named JOBA with resource name RESOURCE.NAME, of free type F, and schedule id 42 to job with step name JS011" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "job", - "description": "Specifies the job name on which the indicated function is performed.\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "schid", - "description": "(Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.\nDefault: 0, which indicates that the requirement holds for all schedule IDs\nLimits: 1 to 3 numeric characters from 0 through 999", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "resource-name", - "aliases": [ - "rn" - ], - "description": "Specifies the resource name being connected to the job.\nLimits: 1 to 44 characters, the first character must be non-blank, and no embedded blanks", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "step-name", - "aliases": [ - "sn" - ], - "description": "(Optional) Specifies the resource is freed at the conclusion of the named job step.\nLimits: 1 to 8 alphanumeric characters\nNotes:The step-name parameter applies to the first occurrence of the stepname that is encountered in the job stream. This includes any reference to the stepname embedded in a PROCThe only valid stepname would be for steps with PGM= coded, not for stepnames executing a PROCIf a job is restarted in a step after this step-name, the resource does not go through free processing until the job completesA step flush condition does not post the step-name process", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "free", - "description": "Determines how VRM manages resource availability at job submission and job/step completion.\nValid values are:\nA = Specifies the resource is only freed if any step in the job abends (abend or condition code checking)F = Specifies the resource is freed when job ends, either successfully or unsuccessfully. If the step-name parameter is specified, free the resource when the specified step completes, either successfully or unsuccessfullyN = Specifies do not free the resource at successful job completion. The resource can be freed with the PRSCF command. A cancel of the job also frees the resourceY = Specifies to free the resource at successful job completion. If the step-name parameter is specified, free the resource when the specified step completes successfully (does not abend)", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "delete-resource-count-resource", - "aliases": [ - "drcr" - ], - "summary": "Delete Resource Count resource from a job definition", - "description": "Delete Resource Count Resource", - "examples": [ - { - "options": "--job JOBA --rn RESOURCE.NAME --schid 42", - "description": "Deletes a job named JOBA with resource name RESOURCE.NAME" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "job", - "description": "Specifies the job name on which the indicated function is performed.\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "schid", - "description": "(Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.\nDefault: 0, which indicates that the requirement holds for all schedule IDs\nLimits: 1 to 3 numeric characters from 0 through 999", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "resource-name", - "aliases": [ - "rn" - ], - "description": "Specifies the resource name being connected to the job.\nLimits: 1 to 39 characters, the first character must be non-blank, and no embedded blanks", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "create-resource-count-resource", - "aliases": [ - "crcr" - ], - "summary": "Add Resource Count resource to a job definition", - "description": "Add Resource Count Resource", - "examples": [ - { - "options": "--job JOBA --schid 23 --rn RESOURCE.NAME --free F --sn JS010 ", - "description": "Creates a job named JOBA with resource name RESOURCE.NAME of free type F, step name JS010 and schedule id 23" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "job", - "description": "Specifies the job name on which the indicated function is performed.\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "schid", - "description": "(Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.\nDefault: 0, which indicates that the requirement holds for all schedule IDs\nLimits: 1 to 3 numeric characters from 0 through 999", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "resource-name", - "aliases": [ - "rn" - ], - "description": "Specifies the resource name being connected to the job.\nLimits: 1 to 39 characters, the first character must be non-blank, and no embedded blanks", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "resource-count", - "aliases": [ - "rc" - ], - "description": "Specifies the number of occurrences of the resource that the job uses.\nLimits: 1 to 4 numeric characters from 0 through 9999", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "step-name", - "aliases": [ - "sn" - ], - "description": "(Optional) Specifies the resource is freed at the conclusion of the named job step.\nLimits: 1 to 8 alphanumeric characters\nNotes:The step-name parameter applies to the first occurrence of the stepname that is encountered in the job stream. This includes any reference to the stepname embedded in a PROCThe only valid stepname would be for steps with PGM= coded, not for stepnames executing a PROCIf a job is restarted in a step after this step-name, the resource does not go through free processing until the job completesA step flush condition does not post the step-name process", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "free", - "description": "Determines how VRM manages resource availability at job submission and job/step completion.\nValid values are:\nA = Specifies the resource count is only decremented when the job abendsF = Specifies the resource count is decremented when the job completes, either successfully or unsuccessfully. If the step-name parameter is specified, the resource count is decremented when the specified step completes, either successfully or unsuccessfullyN = Specifies the resource count is not decremented when the job completes. The PRSCF command can be used to decrement the resource count. A cancel of the job also decrements the resource countY = Specifies the resource count is decremented when the job or step ends successfully. If the step-name parameter is specified, the resource count is decremented when the specified step completes successfully (does not abend)", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "update-resource-count-resource", - "aliases": [ - "urcr" - ], - "summary": "Modify Resource Count resource for a job definition", - "description": "Modify Resource Count Resource", - "examples": [ - { - "options": "--job JOBA --rn RESOURCE.NAME --free F --sn JS011 --schid 42", - "description": "Updates a job named JOBA with resource name RESOURCE.NAME, of free type F, and schedule id 42 to job with step name JS011" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "job", - "description": "Specifies the job name on which the indicated function is performed.\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "schid", - "description": "(Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.\nDefault: 0, which indicates that the requirement holds for all schedule IDs\nLimits: 1 to 3 numeric characters from 0 through 999", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "resource-name", - "aliases": [ - "rn" - ], - "description": "Specifies the resource name being connected to the job.\nLimits: 1 to 39 characters, the first character must be non-blank, and no embedded blanks", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "step-name", - "aliases": [ - "sn" - ], - "description": "(Optional) Specifies the resource is freed at the conclusion of the named job step.\nLimits: 1 to 8 alphanumeric characters\nNotes:The step-name parameter applies to the first occurrence of the stepname that is encountered in the job stream. This includes any reference to the stepname embedded in a PROCThe only valid stepname would be for steps with PGM= coded, not for stepnames executing a PROCIf a job is restarted in a step after this step-name, the resource does not go through free processing until the job completesA step flush condition does not post the step-name process", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "free", - "description": "Determines how VRM manages resource availability at job submission and job/step completion.\nValid values are:\nA = Specifies the resource count is only decremented when the job abendsF = Specifies the resource count is decremented when the job completes, either successfully or unsuccessfully. If the step-name parameter is specified, the resource count is decremented when the specified step completes, either successfully or unsuccessfullyN = Specifies the resource count is not decremented when the job completes. The PRSCF command can be used to decrement the resource count. A cancel of the job also decrements the resource countY = Specifies the resource count is decremented when the job or step ends successfully. If the step-name parameter is specified, the resource count is decremented when the specified step completes successfully (does not abend)", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "delete-corequisite-resource", - "aliases": [ - "dcr" - ], - "summary": "Delete Corequisite resource from a job definition", - "description": "Delete Corequisite Resource", - "examples": [ - { - "options": "--jn JOBA --rn RESOURCE.NAME --schid 42", - "description": "Deletes a job named JOBA with resource name RESOURCE.NAME and schid 42" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "job-name", - "aliases": [ - "jn" - ], - "description": "Specifies the job name on which the indicated function is performed.\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "resource-name", - "aliases": [ - "rn" - ], - "description": "Specifies the resource name being connected to the job.\nLimits: 1 to 44 characters, the first character must be nonblank, and no embedded blanks\nException: If the resource connection is made to a resource count resource,\nthe resource name can be from 1 to 39 characters followed by a / (slash) and\n a 1 through 4 numeric value indicating the number of occurrences for the resource that the job uses.\n", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "schid", - "description": "(Optional) Specifies the schedule ID (of this job) for which a user requirement is applied.\nA zero default cannot be specified for one connection and a nonzero schedule ID used for\na subsequent connection to the same job with the same user requirement description.\n An attempt to make such a connection results in an error message that is issued.\nDefault: 0, which indicates that the requirement holds for all schedule IDs\nLimits: 1 to 3 numeric characters from 0 through 999", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "create-corequisite-resource", - "aliases": [ - "ccr" - ], - "summary": "Add Corequisite resource to a job definition", - "description": "Add Corequisite Resource", - "examples": [ - { - "options": "--jn JOBAA --schid 23 --rn SCHENV.VARNAME --rw I", - "description": "Creates a job named JOBAA with resource name SCHENV.VARNAME, schedule id 23 and job is submitted only if the resource is not active" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "job-name", - "aliases": [ - "jn" - ], - "description": "Specifies the job name on which the indicated function is performed.\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "resource-name", - "aliases": [ - "rn" - ], - "description": "Specifies the resource name being connected to the job.\nLimits: 1 to 44 characters, the first character must be nonblank, and no embedded blanks\nException: If the resource connection is made to a resource count resource,\nthe resource name can be from 1 to 39 characters followed by a / (slash) and\n a 1 through 4 numeric value indicating the number of occurrences for the resource that the job uses.\n", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "schid", - "description": "(Optional) Specifies the schedule ID (of this job) for which a user requirement is applied.\nA zero default cannot be specified for one connection and a nonzero schedule ID used for\na subsequent connection to the same job with the same user requirement description.\n An attempt to make such a connection results in an error message that is issued.\nDefault: 0, which indicates that the requirement holds for all schedule IDs\nLimits: 1 to 3 numeric characters from 0 through 999", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "ready-when", - "aliases": [ - "rw" - ], - "description": "Determines how VRM manages resource availability at job submission and job/step completion.\nDefault: A\nValid values are:\nA\nSpecifies the job is submitted only if the resource is active (as established by the PRSQA command).I\nSpecifies the job is submitted only if the resource is not active.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "update-corequisite-resource", - "aliases": [ - "ucr" - ], - "summary": "Modify Corequisite resource for a job definition", - "description": "Modify Corequisite Resource", - "examples": [ - { - "options": "--jn JOBA --rn RESOURCE.NAME --schid 42 --rw I", - "description": "Updates a job named JOBA with resource name RESOURCE.NAME, schedule id 42 and job is submitted only if the resource is not active" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "job-name", - "aliases": [ - "jn" - ], - "description": "Specifies the job name on which the indicated function is performed.\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "resource-name", - "aliases": [ - "rn" - ], - "description": "Specifies the resource name being connected to the job.\nLimits: 1 to 44 characters, the first character must be nonblank, and no embedded blanks\nException: If the resource connection is made to a resource count resource,\nthe resource name can be from 1 to 39 characters followed by a / (slash) and\n a 1 through 4 numeric value indicating the number of occurrences for the resource that the job uses.\n", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "schid", - "description": "(Optional) Specifies the schedule ID (of this job) for which a user requirement is applied.\nA zero default cannot be specified for one connection and a nonzero schedule ID used for\na subsequent connection to the same job with the same user requirement description.\n An attempt to make such a connection results in an error message that is issued.\nDefault: 0, which indicates that the requirement holds for all schedule IDs\nLimits: 1 to 3 numeric characters from 0 through 999", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "ready-when", - "aliases": [ - "rw" - ], - "description": "Determines how VRM manages resource availability at job submission and job/step completion.\nDefault: A\nValid values are:\nA\nSpecifies the job is submitted only if the resource is active (as established by the PRSQA command).I\nSpecifies the job is submitted only if the resource is not active.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "delete-address-space-resource", - "aliases": [ - "dasr" - ], - "summary": "Delete Address Space resource from a job definition", - "description": "Delete Address Space Resource", - "examples": [ - { - "options": "--job JOBA --rn RESOURCE.NAME --schid 42", - "description": "Deletes a job named JOBA with resource name RESOURCE.NAME" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "job", - "description": "Specifies the job name on which the indicated function is performed.\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "schid", - "description": "(Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.\nDefault: 0, which indicates that the requirement holds for all schedule IDs\nLimits: 1 to 3 numeric characters from 0 through 999", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "resource-name", - "aliases": [ - "rn" - ], - "description": "Specifies the resource name being connected to the job.\nLimits: 1 to 44 characters, the first character must be non-blank, and no embedded blanks", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "create-address-space-resource", - "aliases": [ - "casr" - ], - "summary": "Add Address Space resource to a job definition", - "description": "Add Address Space Resource", - "examples": [ - { - "options": "--job JOBAA --schid 23 --rn SCHENV.VARNAME --rw I", - "description": "Creates a job named JOBAA with resource name SCHENV.VARNAME, schedule id 23 and job is submitted only if the resource is not active" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "job", - "description": "Specifies the job name on which the indicated function is performed.\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "schid", - "description": "(Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.\nDefault: 0, which indicates that the requirement holds for all schedule IDs\nLimits: 1 to 3 numeric characters from 0 through 999", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "resource-name", - "aliases": [ - "rn" - ], - "description": "Specifies the resource name being connected to the job.\nLimits: 1 to 44 characters, the first character must be non-blank, and no embedded blanks", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "ready-when", - "aliases": [ - "rw" - ], - "description": "(Optional) Determines how VRM manages resource availability at job submission and job/step completion.\nDefault: A\nValid values are:\nA = Specifies the job is submitted only if the resource is active on the same system as CA 7. The resource name is assumed to be a jobname or started task name running on the systemI = Specifies the job is submitted only if the resource is not active on the same system as CA 7. The resource name is assumed to be a jobname or started task name running on the system", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "update-address-space-resource", - "aliases": [ - "uasr" - ], - "summary": "Modify Address Space resource for a job definition", - "description": "Modify Address Space Resource", - "examples": [ - { - "options": "--job JOBA --rn RESOURCE.NAME --rw I--schid 42", - "description": "Updates a job named JOBA with resource name RESOURCE.NAME, schedule id 42 and job is submitted only if the resource is not active" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "job", - "description": "Specifies the job name on which the indicated function is performed.\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "schid", - "description": "(Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.\nDefault: 0, which indicates that the requirement holds for all schedule IDs\nLimits: 1 to 3 numeric characters from 0 through 999", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "resource-name", - "aliases": [ - "rn" - ], - "description": "Specifies the resource name being connected to the job.\nLimits: 1 to 44 characters, the first character must be non-blank, and no embedded blanks", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "ready-when", - "aliases": [ - "rw" - ], - "description": "(Optional) Determines how VRM manages resource availability at job submission and job/step completion.\nDefault: A\nValid values are:\nA = Specifies the job is submitted only if the resource is active on the same system as CA 7. The resource name is assumed to be a jobname or started task name running on the systemI = Specifies the job is submitted only if the resource is not active on the same system as CA 7. The resource name is assumed to be a jobname or started task name running on the system", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "list-job-trigger-successor", - "aliases": [ - "ljts" - ], - "summary": "Get triggered jobs for one or more jobs", - "description": "Get Job Trigger Successor", - "examples": [ - { - "options": "--job JOBA", - "description": "Get a list of the triggered jobs for JOBA" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "jobname", - "aliases": [ - "job" - ], - "description": "The CA 7 job name", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "databasename", - "aliases": [ - "db" - ], - "description": "The CA 7 database name", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "create-job-trigger-successor", - "aliases": [ - "cjts" - ], - "summary": "Add Job Trigger to a job definition", - "description": "Add Job Trigger", - "examples": [ - { - "options": "--job JOBA --tj JOBB --tjdot 0830", - "description": "Updates the Job JOBA having Triggered JOBB with triggered-job-due-out-time" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "job", - "description": "Specifies the job name whose successful completion causes triggering.\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "schid", - "description": "(Optional) Specifies for which schedule ID of the triggering job the triggered-job is scheduled.\nDefault: 0 (all schedule IDs)\nLimits: 1 to 3 numeric characters from 0 through 999", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "triggered-job", - "aliases": [ - "tj" - ], - "description": "Specifies the job name that the completion of the triggering job triggers.\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "triggered-job-schid", - "aliases": [ - "tjs" - ], - "description": "(Optional) Denotes a replacement schedule ID to use when the triggered-job is placed into the request queue.\nDefault: 0 (no replacement)\nLimits: 1 to 3 numeric characters from 0 through 999\nNote: If triggered-job-schid is used, it replaces the schid value of the triggered job. Any jobs triggered (by triggered-job or data sets it creates) use this triggered-job-schid for their schedule ID unless they also have a triggered-job-schid value.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "triggered-job-due-out-time", - "aliases": [ - "tjdot" - ], - "description": "(Required if triggered-job-queue-time is omitted) Specifies the due-out time of day of the triggered-job rounded down to 10-minute increments.\nIf this parameter is used, triggered-job-queue-time must be omitted.\nLimits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400. If specified, the lowest value is 10.\nNote: If used and the due-out-time of the triggering job is after the triggered-job-due-out-time, the following calendar day is assumed.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "triggered-job-queue-time", - "aliases": [ - "tjqt" - ], - "description": "(Required if triggered-job-due-out-time is omitted) Specifies the elapsed queue time of triggered-job rounded down to 10-minute increments.\nIf this parameter is used, triggered-job-due-out-time must be omitted because due-out time is then calculated as deadline time plus runtime.\nDeadline time is calculated as current date/time plus queue time.\nLimits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24.\nThe mm can be 00 through 59, the highest value being 2400.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "triggered-job-lead-time", - "aliases": [ - "tjlt" - ], - "description": "(Optional) Specifies the elapsed lead time for triggered-job rounded to 10-minute increments. This parameter specifies the lead or processing time necessary to ensure triggered-job meets its due-out time.\nDefault: 0000\nLimits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24.\nThe mm can be 00 through 59, the highest value being 2400.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "triggered-job-submit-time", - "aliases": [ - "tjst" - ], - "description": "(Optional) Imposes a submit time of day requirement on triggered-job. When used, the job is not submitted before this time.\nThe triggered-job-submit-time is always rounded down to 15-minute increments.\nDefault: 0 (no specific submit time requirement)\nLimits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400.Note: If triggered-job-queue-time is used, the date for the submit time requirement is the same as the deadline start date.\n\nIf triggered-job-due-out-time is used and the triggered-job-submit-time is less than the triggered-job-due-out-time, the date for the triggered-job-submit-time is the same as the deadline start date. Otherwise, the triggered-job-submit-time date is the previous day.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "update-job-trigger-successor", - "aliases": [ - "ujts" - ], - "summary": "Modify Job Trigger Successor for a job definition", - "description": "Modify Job Trigger Successor", - "examples": [ - { - "options": "--job JOBA --tj JOBB --tjdot 0830 --tjlt 0030 --tjst 1030", - "description": "Updates the Job JOBA having Triggered JOBB with triggered-job-due-out-time with addition of triggered-job-lead-time to 0030 and triggered-job-submit-time to 1030" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "job", - "description": "Specifies the job name whose successful completion causes triggering.\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "schid", - "description": "(Optional) Specifies for which schedule ID of the triggering job the triggered-job is scheduled.\nDefault: 0 (all schedule IDs)\nLimits: 1 to 3 numeric characters from 0 through 999", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "triggered-job", - "aliases": [ - "tj" - ], - "description": "Specifies the job name that the completion of the triggering job triggers.\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "triggered-job-schid", - "aliases": [ - "tjs" - ], - "description": "(Optional) Denotes a replacement schedule ID to use when the triggered-job is placed into the request queue.\nDefault: 0 (no replacement)\nLimits: 1 to 3 numeric characters from 0 through 999\nNote: If triggered-job-schid is used, it replaces the schid value of the triggered job. Any jobs triggered (by triggered-job or data sets it creates) use this triggered-job-schid for their schedule ID unless they also have a triggered-job-schid value.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "triggered-job-due-out-time", - "aliases": [ - "tjdot" - ], - "description": "(Required if triggered-job-queue-time is omitted) Specifies the due-out time of day of the triggered-job rounded down to 10-minute increments.\nIf this parameter is used, triggered-job-queue-time must be omitted.\nLimits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400. If specified, the lowest value is 10.\nNote: If used and the due-out-time of the triggering job is after the triggered-job-due-out-time, the following calendar day is assumed.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "triggered-job-queue-time", - "aliases": [ - "tjqt" - ], - "description": "(Required if triggered-job-due-out-time is omitted) Specifies the elapsed queue time of triggered-job rounded down to 10-minute increments.\nIf this parameter is used, triggered-job-due-out-time must be omitted because due-out time is then calculated as deadline time plus runtime.\nDeadline time is calculated as current date/time plus queue time.\nLimits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24.\nThe mm can be 00 through 59, the highest value being 2400.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "triggered-job-lead-time", - "aliases": [ - "tjlt" - ], - "description": "(Optional) Specifies the elapsed lead time for triggered-job rounded to 10-minute increments. This parameter specifies the lead or processing time necessary to ensure triggered-job meets its due-out time.\nDefault: 0000\nLimits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24.\nThe mm can be 00 through 59, the highest value being 2400.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "triggered-job-submit-time", - "aliases": [ - "tjst" - ], - "description": "(Optional) Imposes a submit time of day requirement on triggered-job. When used, the job is not submitted before this time.\nThe triggered-job-submit-time is always rounded down to 15-minute increments.\nDefault: 0 (no specific submit time requirement)\nLimits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400.Note: If triggered-job-queue-time is used, the date for the submit time requirement is the same as the deadline start date.\n\nIf triggered-job-due-out-time is used and the triggered-job-submit-time is less than the triggered-job-due-out-time, the date for the triggered-job-submit-time is the same as the deadline start date. Otherwise, the triggered-job-submit-time date is the previous day.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - }, - { - "name": "delete-job-trigger-successor", - "aliases": [ - "djts" - ], - "summary": "Delete Job Trigger from a job definition", - "description": "Delete Job Trigger", - "examples": [ - { - "options": "--job JOBA --tj JOBB", - "description": "Delete a Job Trigger JOBB from the definition of JOBA" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "job", - "description": "Specifies the job name whose successful completion causes triggering.\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "schid", - "description": "(Optional) Specifies for which schedule ID of the triggering job the triggered-job is scheduled.\nDefault: 0 (all schedule IDs)\nLimits: 1 to 3 numeric characters from 0 through 999", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "triggered-job", - "aliases": [ - "tj" - ], - "description": "Specifies the job name that the completion of the triggering job triggers.\nLimits: 1 to 8 alphanumeric characters", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": [] - }, - { - "name": "job-instance", - "aliases": [ - "ji" - ], - "summary": "All methods of a Job Instances", - "description": "All the available commands listed in the Job Instance section.", - "type": "group", - "children": [ - { - "name": "list-waiting-resource", - "aliases": [ - "lwr" - ], - "summary": "Display jobs waiting for resources.", - "description": "List waiting Resource", - "examples": [ - { - "options": "TODO", - "description": "TODO" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "options": [ - { - "name": "job", - "description": "(Optional) Specifies a fully qualified or generic job name.\n * - Specifies all jobs.\n job - Specifies a fully qualified job name\n Limits:: 1 to 8 alphanumeric characters\n job - Specifies multiple jobs that a generic job name specifies.\n Limits:: 1 to 7 alphanumeric characters that are terminated with an asterisk.", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "schid", - "description": "(Optional) A SCHID value of 0 applies to connections for all schedules and\ntherefore is listed with connections for any schedule ID requested. Default:: Null (causes connections for all schedule IDs to appear)Limits:: 1 to 3 numeric characters from 0 through 999", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [], - "passOn": [], - "children": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": [] - }, - { - "name": "create-job-definition", - "aliases": [ - "cjd" - ], - "summary": "Creates requirements of a job", - "description": "All the available commands are listed in the COMMANDS section.", - "type": "group", - "children": [ - { - "name": "req-predecessor", - "aliases": [ - "rp" - ], - "summary": "Creates requirement definition for a job", - "description": "Creates predecessor requirement for a job.", - "examples": [ - { - "options": "--job TESJOB1 --schid 0009 --predtype USER --nextrun ONLY --predobject CA7USER", - "description": "Create requirement predecessor for job TESJOB1 with the parameters" - } - ], - "type": "command", - "handler": "", - "options": [ - { - "name": "job", - "description": "The name of the job that requires the predecessor\n\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "schid", - "description": "The schedule id of requiring job\n\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "predtype", - "description": "The predecessor type\n\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "nextrun", - "description": "The status of predecessor for next run of job\n[ YES, ONLY, SKIP ]\n\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "predobject", - "description": "The predecessor. Values vary with predtype.\nThe predecessor. Values vary with predtype.\nWhen “predtype”:”DSN”,”predobject” is 1-44 name of required dataset.\nWhen “predtype”:”USER” then “predobject” is 1-44 character user requirement text.\n\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "leadtime", - "description": "The satisfaction lead time in hours.\nThis may be honored when “predtype” is “job or “DSN”\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "permanent", - "description": "Indicates that this predecessor is permanent, that is always considered satisfied.\nThis parameter only applies when “predtype” is “DSN”\n[ Y, N ]\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [] - } - ], - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "schedule", - "aliases": [ - "s" - ], - "summary": "Define schedules for jobs that are run on a date and time basis.", - "description": "Create schedule parameters", - "examples": [ - { - "options": "--job TESTJOB1 --schid 01 --dscal 03", - "description": "Create schedule for job TESTJOB1 with the parameters" - } - ], - "type": "command", - "handler": "", - "options": [ - { - "name": "job", - "description": "The name of the job\n\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "schid", - "description": "Specifies the numeric schedule ID on which the user wants to perform the specified action.\nLimits: 1 to 3 numeric characters from 1 through 999\n\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "scal", - "description": "Specifies the override of the default SCAL for this SCHID. Specify scal if you want to override the default scal.\nLimits: 2 alphanumeric characters\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "default-scal", - "aliases": [ - "dscal" - ], - "description": "Specifies the default SCAL for this job. If this is not specified, an LJOB will be issued to fetch the SCAL\nLimits: 2 alphanumeric characters\n\n", - "type": "string", - "group": "Options" - }, - { - "name": "due-out-time", - "aliases": [ - "dot" - ], - "description": "Specifies the due-out time of day for this schedule ID.\nLimits: 4 numeric characters that are specified as hhmm\nwhere hh can be 00 through 24 and mm can be 00 through 59. Must be greater than 0000.\n\n", - "type": "string", - "group": "Options" - }, - { - "name": "lead-time", - "aliases": [ - "lt" - ], - "description": "Specifies the due-out time of day for this schedule ID.\nLimits: 4 numeric characters that are specified as hhmm\nwhere hh can be 00 through 24 and mm can be 00 through 59. Must be greater than 0000.\n\n", - "type": "string", - "group": "Options" - }, - { - "name": "submit-time", - "aliases": [ - "st" - ], - "description": "Specifies the submit time of day for this schedule ID.\nIf specified, the job is not submitted before this time.\nIf the submit time is before deadline start time,\nthe submit time requirement is automatically satisfied when the job enters the queue.\nA submit time of zeros is the same as not specifying it, and no submit time is set up.\nNote:If the submit time is after the due-out time, the submit day value is set to the previous day.\nLimits: 4 numeric characters that are specified as hhmm\nwhere hh can be 00 through 24 and mm can be 00 through 59. Must be greater than 0000.\n\n", - "type": "string", - "group": "Options" - }, - { - "name": "daily", - "description": "Specifies that the user wants to define a daily schedule.\nDaily means every available processing day as defined by the Base Calendar.\nIf DAILY is used, the ROLL has no effect.\nLimits: One of Y or N\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "roll", - "description": "Specifies the action to take when a schedule day falls on a base calendar non available processing day.\nThis value is not used if the DAILY option is used\nIf DAILY is used, the ROLL has no effect.\nIf used, the value must be one of the following values:\nB: Roll the schedule back to the previous available processing day in the Base Calendar.\nF: Roll forward the schedule to the next available processing day.\nN: Do not roll. Schedule day must stand.\nD: Do not roll and do not schedule.\nDefault:D\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "index", - "description": "Specifies an adjustment to schedule days.\nAfter you exercise the ROLL option, the schedule is adjusted,\nforward for plus or backward for minus, by the number of working days entered.\nLimits:4 numeric characters that are specified as Innn where I can be plus (unsigned) or minus (-) and nnn can be 0 to 365 daysUsage:\nUse this field with the RDAY field to schedule a job to run three workdays before the 15th of the month:\nspecify -3 in the INDEX field, X in the MONTHLY field, and 15 in the RDAY field.\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "interval", - "description": "Specifies that the job should be repeated (executed more than once) and\nspecifies the amount of time between each iteration.\nIf INTERVAL is specified, the SBTM (submit time requirement) and TYPE fields are required.\nIf both INTERVAL and COUNT are specified, the INTERVAL value times the COUNT value must total less than 24 hours.\nLimits:4 numeric characters in hhmm format where hh can be from 0 to 23 and mm can be from 00 to 59\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "type", - "description": "Determines how the submit time requirement is calculated for repeating jobs.\nA TYPE of CLOCK indicates that the INTERVAL is added to the previous iteration's\nsubmit time requirement to determine the new submit time requirement.\nA TYPE of START and END indicates that the INTERVAL is added to the previous iteration's\nlast (most recent) start and end times,respectively, to determine the new submit time requirement.\nTYPE is required if INTERVAL is specified.\nTYPE is discarded if INTERVAL is not specifiedLimits:CLOCK, START, or END\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "count", - "description": "Specifies the maximum number of times to repeat the job.\nCOUNT is discarded if INTERVAL is not specified.\nIf both COUNT and STOP are specified, the job stops repeating when the COUNT reaches zero or the STOP time is reached, whichever comes first.\nIf COUNT is not specified, the job repeats until the STOP time is reached.TYPE is required if INTERVAL is specified. TYPE is discarded if INTERVAL is not specifiedLimits:1 to 4 numeric characters from 0 to 1439. Leading zeros can be discarded.\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "weekly", - "description": "Specifies that the user wants to define a weekly schedule.\nIf WEEKLY is used, the run days of the week must be specified using DAYS field\nLimits:Y or N\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "days", - "description": "Defines specific days of the week on which to run the job.\nas comma separated list of day name abbreviations.\nLimits: A comma separated list of Sun,Mon,Tue,Wed,Thu,Fri,Sat\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "monthly", - "description": "Specifies that the user wants to define a monthly schedule.\nIf this field is used, the user can optionally specify on which particular months the job is to run.\nIf specific months are not specified in the months property, all months are assumed.Limits: Y or N\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "months", - "description": "Defines specific months on which to run the job.\nas comma separated list of month name abbreviations.\nLimits: A comma separated list of Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov,Dec\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "weeks-of-month", - "aliases": [ - "wom" - ], - "description": "Specifies the weeks of the month to run the job.\nThe values that are specified can be positive (unsigned), negative (-) or slash (/).\nPositive values 1, 2, 3, 4, or 5 are used to indicate the week relative to the beginning of the month.\nNegative values -0, -1, and -2 are used to indicate occurrence of week relative to the end of the month.\nSlashes indicate the job will not run the following value.\nLimits: 1 to 14 numeric characters and required if MONTHLY and DAY-OF-WEEK are used.\nThe values are separated by comma\n\n", - "type": "string", - "group": "Options" - }, - { - "name": "day-of-week", - "aliases": [ - "dow" - ], - "description": "Specifies which days of the week to run the job.\nIf used, each day must be the first three letters of the wanted run days.\nIf you want to specify multiple days, use a comma separated list for example MON,TUE,FRI.\nLimits: A comma separated list of SUN, MON, TUE, WED, THU, FRI, SAT, case insensitive\n\n", - "type": "string", - "group": "Options" - }, - { - "name": "relative-day", - "aliases": [ - "rd" - ], - "description": "Specifies relative days of the month on which the job is to run. Used with MONTHLY.\nA day relative to the beginning or end of the month is specified.\nIf a positive (unsigned) value is used, the job runs that day relative to the first of the month.\nAlso, if you have days of the month when this job is not to run,a slash (/) can be used with the unsigned or negative values.\nValid positive values range from 1 to 31.\nValid negative values range from -0 to -30.\nLimits:1 to 60 numeric characters, separated by comma.\nNote:relative-day(s) represents calendar days, unless the base calendar was generated with OPTIONS=SCHDYONLY,\nin which case relative-day(s) represents processing days.\n\n", - "type": "string", - "group": "Options" - }, - { - "name": "annual", - "description": "Defines an annual schedule.\nLimits: If annual is used, day is required. One of Y, N\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "day-of-year", - "aliases": [ - "doy" - ], - "description": "Specifies on which days of the annual schedule the user wants to run the job.\nDays are entered as 1 through 366 and are prefixed by positive (unsigned) or slash (/) values.\nSlash indicates the job will not run this day.\nFor example, if a job is to run on days 121, 132, 240, and 241, but is not to run on days 122, 242, and 1,the user would specify: /1,121,/122,132,240,241,/242\nLimits: 1 to 55 numeric characters and required if annual is used.\nThe numbers will be separated by comma\n\n", - "type": "string", - "group": "Options" - }, - { - "name": "symmetric", - "description": "Used with the START and SPAN fields, defines a symmetric schedule.\nWith this option, schedules are defined as beginning on the date specified with\nthe START field and recurring every nnn days as specified with the SPAN field.\nLimits: One of Y, N\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "start", - "description": "This field is required when the SYMETRIC option is taken.\nValue must be specified as the Julian day of the year on which the symmetric schedule is to begin.\nThis value should be evaluated yearly before schedule resolution and may need to be changed each year.\nIf the schedule will be resolved on a July-June basis, the start date must be within\nthe first of the two years in which the schedule overlaps.\nFor January-December schedules, it is simply relative to January 1 of the year specified on a RESOLV command.\nIf the calendar against which this SCHID will be resolved does not have the OPTIONS=SCHDYONLY,\nthe START day is adjusted each year to maintain the job's symmetric schedule from the job's original specified START day.\nIf the calendar against which the SCHID will be resolved was generated with overall available processing days only (OPTIONS=SCHDYONLY)\nthe start date must specify the first day on which the job would actually run.\nThis requires manually setting (verifying) the START value each year before the RESOLV.\nIf a nonprocessing day is specified, the start day is the next processing day found in the calendar.\nFor example, if January 1 is a nonprocessing day and the calendar was generated with OPTIONS=SCHDYONLY,\nand 1 is specified as the START day, January 2 is the actual START day (provided it is an available processing day).\nSPAN is based from January 2 in this example rather than January 1.\nFor other types of calendars, the start date is determined at RESOLV time based on the ROLL and INDEX options taken.\nLimits: 3 numeric characters specified as Julian day of the year from 1 to 365\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "span", - "description": "Used with SYMETRIC and START, defines symmetric schedules.\nThis field is required if the SYMETRIC option is taken.\nWhen used, specifies the number of days between scheduled processing cycles.\nIf the calendar against which the SCHID will be resolved was generated with processing days\nonly (OPTIONS=SCHDYONLY), the SPAN value is specified as the number of available processing days\nbetween and including the next processing date as opposed to the actual number of days.\nWith this type of calendar, the ROLL and INDEX options serve no practical purpose.\nFor other calendar types, the SPAN value is specified as the number of calendar days\nbetween processing cycles and the ROLL and INDEX options can be used as necessary.\nLimits: 1 to 3 numeric characters from 1 to 255\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [] - } - ], - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "positionals": [], - "passOn": [], - "children": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": [] - }, - { - "name": "create-resource-definition", - "aliases": [ - "crd" - ], - "summary": "Create a Resource Count resource", - "description": "All the available commands are listed in the COMMANDS section.", - "type": "group", - "children": [ - { - "name": "resource-count-resource", - "aliases": [ - "rcr" - ], - "summary": "Create Resource Count Resource parameters", - "description": "Create Resource Count Resource parameters", - "examples": [ - { - "options": "--rn PAYROLL.RCT --tc 125", - "description": "Add Resource named PAYROLL.RCT to count 125" - } - ], - "type": "command", - "handler": "", - "options": [ - { - "name": "resource-name", - "aliases": [ - "rn" - ], - "description": "Specifies the name of the Resource Count Resource to add.\nLimits: 1 to 39 alphanumeric characters and periods\n\n", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "total-count", - "aliases": [ - "tc" - ], - "description": "Specifies the total number of available occurrences for this Resource Count Resource.\nLimits: 1 to 4 numeric characters in the range 0-9999\n\n", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [] - } - ], - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "positionals": [], - "passOn": [], - "children": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": [] - }, - { - "name": "update-job-definition", - "aliases": [ - "ujd" - ], - "summary": "Updates the requirement definition for a job", - "description": "All the available commands are listed in the COMMANDS section.", - "type": "group", - "children": [ - { - "name": "requirement-predecessor", - "aliases": [ - "rp" - ], - "summary": "Use the following two required parameters", - "description": "Update requirement definition for a job", - "examples": [ - { - "options": "TESJOB1 0009 USER ONLY \"APCDAL.TESTDB01.TEST\"", - "description": "post TESJOB1 0009 USER ONLY \"APCDAL.TESTDB01.TEST\"" - } - ], - "type": "command", - "handler": "", - "options": [ - { - "name": "job", - "description": "The name of the job that requires the predecessor\n\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "schid", - "description": "The schedule id of requiring job\n\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "predtype", - "description": "The predecessor type\n\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "nextrun", - "description": "The status of predecessor for next run of job\n[ YES, ONLY, SKIP ]\n\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "predobject", - "description": "The predecessor. Values vary with predtype.\nThe predecessor. Values vary with predtype.\nWhen “predtype”:”DSN”,”predobject” is 1-44 name of required dataset.\nWhen “predtype”:”USER” then “predobject” is 1-44 character user requirement text.\n\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "leadtime", - "description": "The satisfaction lead time in hours.\nThis may be honored when “predtype” is “job or “DSN”\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "permanent", - "description": "Indicates that this predecessor is permanent, that is always considered satisfied.\nThis parameter only applies when “predtype” is “DSN”\n[ Y, N ]\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [] - } - ], - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "job", - "summary": "Use the options to update the definition of a job", - "description": "Update requirement definition for a job", - "examples": [ - { - "options": "--job TESTJOB1 --job-type CPU --execute Y", - "description": "Update a CPU type job, TESTJOB1 to be executable" - } - ], - "type": "command", - "handler": "", - "options": [ - { - "name": "job", - "description": "The name of the job to update\n\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "job-type", - "aliases": [ - "jt" - ], - "description": "The type of job. Valid values are: CPU|XPJOB|AGENT\n\n", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "execute", - "description": "Indicates whether to execute this job.\nValid values are: Y/N\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "use-jcl-override-library", - "aliases": [ - "ujol" - ], - "description": "Specifies whether to retrieve the JCL from the JCL Override library (JCLID=254) for the next run only (Y or N). \nThis field is automatically set back to N the next time the job comes into the request queue\n\n", - "type": "string", - "group": "Options" - }, - { - "name": "do-not-schedule-before-date", - "aliases": [ - "dnsbd" - ], - "description": "Specifies not to schedule this job before this date (in YYDDD format, or 00000)\n\n", - "type": "string", - "group": "Options" - }, - { - "name": "do-not-schedule-before-time", - "aliases": [ - "dnsbt" - ], - "description": "Specifies not to schedule this job before this time (in HHMM format)\n", - "type": "string", - "group": "Options" - }, - { - "name": "do-not-schedule-after-date", - "aliases": [ - "dnsad" - ], - "description": "Specifies not to schedule this job after this date (in YYDDD format, or 99999)\n", - "type": "string", - "group": "Options" - }, - { - "name": "do-not-schedule-after-time", - "aliases": [ - "dnsat" - ], - "description": "Specifies not to schedule this job after this time (in HHMM format)\n", - "type": "string", - "group": "Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [] - } - ], - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "aliases": [], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "schedule", - "aliases": [ - "s" - ], - "summary": "Modify schedules for jobs that are run on a date and time basis.", - "description": "Modify schedule parameters", - "examples": [ - { - "options": "--job TESTJOB1 --schid 01 --dscal 03", - "description": "Modify a schedule for job TESTJOB1 with the parameters" - } - ], - "type": "command", - "handler": "", - "options": [ - { - "name": "job", - "description": "The name of the job\n\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "schid", - "description": "Specifies the numeric schedule ID on which the user wants to perform the specified action.\nLimits: 1 to 3 numeric characters from 1 through 999\n\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "scal", - "description": "Specifies the override of the default SCAL for this SCHID. Specify scal if you want to override the default scal.\nLimits: 2 alphanumeric characters\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "default-scal", - "aliases": [ - "dscal" - ], - "description": "Specifies the default SCAL for this job. If this is not specified, an LJOB will be issued to fetch the SCAL\nLimits: 2 alphanumeric characters\n\n", - "type": "string", - "group": "Options" - }, - { - "name": "due-out-time", - "aliases": [ - "dot" - ], - "description": "Specifies the due-out time of day for this schedule ID.\nLimits: 4 numeric characters that are specified as hhmm\nwhere hh can be 00 through 24 and mm can be 00 through 59. Must be greater than 0000.\n\n", - "type": "string", - "group": "Options" - }, - { - "name": "lead-time", - "aliases": [ - "lt" - ], - "description": "Specifies the due-out time of day for this schedule ID.\nLimits: 4 numeric characters that are specified as hhmm\nwhere hh can be 00 through 24 and mm can be 00 through 59. Must be greater than 0000.\n\n", - "type": "string", - "group": "Options" - }, - { - "name": "submit-time", - "aliases": [ - "st" - ], - "description": "Specifies the submit time of day for this schedule ID.\nIf specified, the job is not submitted before this time.\nIf the submit time is before deadline start time,\nthe submit time requirement is automatically satisfied when the job enters the queue.\nA submit time of zeros is the same as not specifying it, and no submit time is set up.\nNote:If the submit time is after the due-out time, the submit day value is set to the previous day.\nLimits: 4 numeric characters that are specified as hhmm\nwhere hh can be 00 through 24 and mm can be 00 through 59. Must be greater than 0000.\n\n", - "type": "string", - "group": "Options" - }, - { - "name": "daily", - "description": "Specifies that the user wants to define a daily schedule.\nDaily means every available processing day as defined by the Base Calendar.\nIf DAILY is used, the ROLL has no effect.\nLimits: One of Y or N\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "roll", - "description": "Specifies the action to take when a schedule day falls on a base calendar non available processing day.\nThis value is not used if the DAILY option is used\nIf DAILY is used, the ROLL has no effect.\nIf used, the value must be one of the following values:\nB: Roll the schedule back to the previous available processing day in the Base Calendar.\nF: Roll forward the schedule to the next available processing day.\nN: Do not roll. Schedule day must stand.\nD: Do not roll and do not schedule.\nDefault:D\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "index", - "description": "Specifies an adjustment to schedule days.\nAfter you exercise the ROLL option, the schedule is adjusted,\nforward for plus or backward for minus, by the number of working days entered.\nLimits:4 numeric characters that are specified as Innn where I can be plus (unsigned) or minus (-) and nnn can be 0 to 365 daysUsage:\nUse this field with the RDAY field to schedule a job to run three workdays before the 15th of the month:\nspecify -3 in the INDEX field, X in the MONTHLY field, and 15 in the RDAY field.\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "interval", - "description": "Specifies that the job should be repeated (executed more than once) and\nspecifies the amount of time between each iteration.\nIf INTERVAL is specified, the SBTM (submit time requirement) and TYPE fields are required.\nIf both INTERVAL and COUNT are specified, the INTERVAL value times the COUNT value must total less than 24 hours.\nLimits:4 numeric characters in hhmm format where hh can be from 0 to 23 and mm can be from 00 to 59\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "type", - "description": "Determines how the submit time requirement is calculated for repeating jobs.\nA TYPE of CLOCK indicates that the INTERVAL is added to the previous iteration's\nsubmit time requirement to determine the new submit time requirement.\nA TYPE of START and END indicates that the INTERVAL is added to the previous iteration's\nlast (most recent) start and end times,respectively, to determine the new submit time requirement.\nTYPE is required if INTERVAL is specified.\nTYPE is discarded if INTERVAL is not specifiedLimits:CLOCK, START, or END\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "count", - "description": "Specifies the maximum number of times to repeat the job.\nCOUNT is discarded if INTERVAL is not specified.\nIf both COUNT and STOP are specified, the job stops repeating when the COUNT reaches zero or the STOP time is reached, whichever comes first.\nIf COUNT is not specified, the job repeats until the STOP time is reached.TYPE is required if INTERVAL is specified. TYPE is discarded if INTERVAL is not specifiedLimits:1 to 4 numeric characters from 0 to 1439. Leading zeros can be discarded.\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "weekly", - "description": "Specifies that the user wants to define a weekly schedule.\nIf WEEKLY is used, the run days of the week must be specified using DAYS field\nLimits:Y or N\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "days", - "description": "Defines specific days of the week on which to run the job.\nas comma separated list of day name abbreviations.\nLimits: A comma separated list of Sun,Mon,Tue,Wed,Thu,Fri,Sat\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "monthly", - "description": "Specifies that the user wants to define a monthly schedule.\nIf this field is used, the user can optionally specify on which particular months the job is to run.\nIf specific months are not specified in the months property, all months are assumed.Limits: Y or N\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "months", - "description": "Defines specific months on which to run the job.\nas comma separated list of month name abbreviations.\nLimits: A comma separated list of Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov,Dec\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "weeks-of-month", - "aliases": [ - "wom" - ], - "description": "Specifies the weeks of the month to run the job.\nThe values that are specified can be positive (unsigned), negative (-) or slash (/).\nPositive values 1, 2, 3, 4, or 5 are used to indicate the week relative to the beginning of the month.\nNegative values -0, -1, and -2 are used to indicate occurrence of week relative to the end of the month.\nSlashes indicate the job will not run the following value.\nLimits: 1 to 14 numeric characters and required if MONTHLY and DAY-OF-WEEK are used.\nThe values are separated by comma\n\n", - "type": "string", - "group": "Options" - }, - { - "name": "day-of-week", - "aliases": [ - "dow" - ], - "description": "Specifies which days of the week to run the job.\nIf used, each day must be the first three letters of the wanted run days.\nIf you want to specify multiple days, use a comma separated list for example MON,TUE,FRI.\nLimits: A comma separated list of SUN, MON, TUE, WED, THU, FRI, SAT, case insensitive\n\n", - "type": "string", - "group": "Options" - }, - { - "name": "relative-day", - "aliases": [ - "rd" - ], - "description": "Specifies relative days of the month on which the job is to run. Used with MONTHLY.\nA day relative to the beginning or end of the month is specified.\nIf a positive (unsigned) value is used, the job runs that day relative to the first of the month.\nAlso, if you have days of the month when this job is not to run,a slash (/) can be used with the unsigned or negative values.\nValid positive values range from 1 to 31.\nValid negative values range from -0 to -30.\nLimits:1 to 60 numeric characters, separated by comma.\nNote:relative-day(s) represents calendar days, unless the base calendar was generated with OPTIONS=SCHDYONLY,\nin which case relative-day(s) represents processing days.\n\n", - "type": "string", - "group": "Options" - }, - { - "name": "annual", - "description": "Defines an annual schedule.\nLimits: If annual is used, day is required. One of Y, N\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "day-of-year", - "aliases": [ - "doy" - ], - "description": "Specifies on which days of the annual schedule the user wants to run the job.\nDays are entered as 1 through 366 and are prefixed by positive (unsigned) or slash (/) values.\nSlash indicates the job will not run this day.\nFor example, if a job is to run on days 121, 132, 240, and 241, but is not to run on days 122, 242, and 1,the user would specify: /1,121,/122,132,240,241,/242\nLimits: 1 to 55 numeric characters and required if annual is used.\nThe numbers will be separated by comma\n\n", - "type": "string", - "group": "Options" - }, - { - "name": "symmetric", - "description": "Used with the START and SPAN fields, defines a symmetric schedule.\nWith this option, schedules are defined as beginning on the date specified with\nthe START field and recurring every nnn days as specified with the SPAN field.\nLimits: One of Y, N\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "start", - "description": "This field is required when the SYMETRIC option is taken.\nValue must be specified as the Julian day of the year on which the symmetric schedule is to begin.\nThis value should be evaluated yearly before schedule resolution and may need to be changed each year.\nIf the schedule will be resolved on a July-June basis, the start date must be within\nthe first of the two years in which the schedule overlaps.\nFor January-December schedules, it is simply relative to January 1 of the year specified on a RESOLV command.\nIf the calendar against which this SCHID will be resolved does not have the OPTIONS=SCHDYONLY,\nthe START day is adjusted each year to maintain the job's symmetric schedule from the job's original specified START day.\nIf the calendar against which the SCHID will be resolved was generated with overall available processing days only (OPTIONS=SCHDYONLY)\nthe start date must specify the first day on which the job would actually run.\nThis requires manually setting (verifying) the START value each year before the RESOLV.\nIf a nonprocessing day is specified, the start day is the next processing day found in the calendar.\nFor example, if January 1 is a nonprocessing day and the calendar was generated with OPTIONS=SCHDYONLY,\nand 1 is specified as the START day, January 2 is the actual START day (provided it is an available processing day).\nSPAN is based from January 2 in this example rather than January 1.\nFor other types of calendars, the start date is determined at RESOLV time based on the ROLL and INDEX options taken.\nLimits: 3 numeric characters specified as Julian day of the year from 1 to 365\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "span", - "description": "Used with SYMETRIC and START, defines symmetric schedules.\nThis field is required if the SYMETRIC option is taken.\nWhen used, specifies the number of days between scheduled processing cycles.\nIf the calendar against which the SCHID will be resolved was generated with processing days\nonly (OPTIONS=SCHDYONLY), the SPAN value is specified as the number of available processing days\nbetween and including the next processing date as opposed to the actual number of days.\nWith this type of calendar, the ROLL and INDEX options serve no practical purpose.\nFor other calendar types, the SPAN value is specified as the number of calendar days\nbetween processing cycles and the ROLL and INDEX options can be used as necessary.\nLimits: 1 to 3 numeric characters from 1 to 255\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [] - } - ], - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "positionals": [], - "passOn": [], - "children": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": [] - }, - { - "name": "update-job-instance", - "aliases": [ - "uji" - ], - "summary": "Updates the instance definition", - "description": "All the available commands are listed in the COMMANDS section.", - "type": "group", - "children": [ - { - "name": "jcl", - "summary": "Use the following two required parameters", - "description": "Update JCL for a job", - "examples": [ - { - "options": "TESJOB1 0009 USER ONLY \"APCDAL.TESTDB01.TEST\"", - "description": "Update JCL for a job TESJOB1 along with other parameters" - } - ], - "type": "command", - "handler": "", - "options": [ - { - "name": "ca7no", - "description": "The CA 7 job number\n\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "postjclovrd", - "description": "Indicates whether to post the JCL override requirement when the JCL is updated\n\n", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "sourcedataset", - "description": "The source data set name containing the new JCL\n\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "sourcemember", - "description": "The source data set member name containing the new JCL\n\n", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "sourcetype", - "description": "The source type containing the new JCL\n\ncurrently: dataset is by the default and the only option", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [] - } - ], - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "aliases": [], - "positionals": [], - "passOn": [], - "children": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": [] - }, - { - "name": "update-resource-definition", - "aliases": [ - "urd" - ], - "summary": "Updates the resource count definition", - "description": "All the available commands are listed in the COMMANDS section.", - "type": "group", - "children": [ - { - "name": "resource-count-resource", - "aliases": [ - "rcr" - ], - "summary": "Modify Resource Count Resource parameters", - "description": "Modify Resource Count Resource parameters", - "examples": [ - { - "options": "--rn PAYROLL.RCT --tc 125", - "description": "Modify Resource named PAYROLL.RCT to count 125" - } - ], - "type": "command", - "handler": "", - "options": [ - { - "name": "resource-name", - "aliases": [ - "rn" - ], - "description": "Specifies the name of the Resource Count Resource to update.\nLimits: 1 to 39 alphanumeric characters and periods\n\n", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "total-count", - "aliases": [ - "tc" - ], - "description": "Specifies the total number of available occurrences for this Resource Count Resource.\nLimits: 1 to 4 numeric characters in the range 0-9999\n\n", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "ca7-profile", - "aliases": [ - "ca7-p" - ], - "group": "Profile Options", - "description": "The name of a (ca7) 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": "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": [] - } - ], - "profile": { - "optional": [ - "ca7", - "base" - ] - }, - "positionals": [], - "passOn": [], - "children": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 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": "CA7 Plugin for ZOWE CLI", - "aliases": [ - "7" - ], - "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/caview.jsonc b/commandGroups/caview.jsonc deleted file mode 100644 index 5f2b3ec..0000000 --- a/commandGroups/caview.jsonc +++ /dev/null @@ -1,4605 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "caview", - "description": "Access View data and perform related tasks.", - "type": "group", - "children": [ - { - "name": "download", - "aliases": [ - "dl" - ], - "summary": "Download View report data to local folder.", - "description": "Download View report data to local folder.", - "type": "group", - "children": [ - { - "name": "report", - "aliases": [ - "r" - ], - "summary": "Download report data.", - "description": "Download report data.\nOptionally convert text report to PDF.", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "repositoryId", - "type": "number", - "description": "Repository identifier.", - "required": true - }, - { - "name": "reportHandle", - "type": "string", - "description": "Report handle.", - "required": true - }, - { - "name": "fileTarget", - "type": "string", - "description": "Local file path.\nIf the path represents a directory location, the report will be downloaded into that directory using a default file name.\nIf the path does not represent a directory location, the report will be downloaded into the specified path.\nIf the path is not specified, the file will be saved to the current working directory using the default file name.\nAny missing directories will be created. If the target file already exists, the file will be overwritten.", - "required": false - } - ], - "options": [ - { - "name": "convert-to-pdf", - "aliases": [ - "to-pdf" - ], - "type": "boolean", - "description": "Converts text report to PDF.", - "defaultValue": false, - "group": "Options" - }, - { - "name": "page-orientation", - "aliases": [ - "orientation" - ], - "type": "string", - "description": "Page orientation for converted PDF.", - "allowableValues": { - "values": [ - "^PORTRAIT$", - "^LANDSCAPE$" - ], - "caseSensitive": false - }, - "defaultValue": "PORTRAIT", - "impliesOneOf": [ - "convert-to-pdf" - ], - "group": "Options" - }, - { - "name": "font-size", - "aliases": [ - "font" - ], - "type": "number", - "description": "Font size for converted PDF.", - "numericValueRange": [ - 1, - 1.7976931348623157e+308 - ], - "defaultValue": 12, - "impliesOneOf": [ - "convert-to-pdf" - ], - "group": "Options" - }, - { - "name": "green-bar", - "type": "boolean", - "description": "Include green-bar background in converted PDF.", - "defaultValue": false, - "impliesOneOf": [ - "convert-to-pdf" - ], - "group": "Options", - "aliases": [] - }, - { - "name": "pages", - "type": "string", - "description": "Include the specified page numbers (or page ranges). Separate page numbers (or page ranges) with commas.\nSeparate boundaries of a page range with a dash (-). If you do not specify this option, all the pages of the report are downloaded.", - "allowableValues": { - "values": [ - "^(\\d+(-\\d+)?)(,(\\d+(-\\d+)?))*$" - ], - "caseSensitive": false - }, - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "content-filter", - "aliases": [ - "filter" - ], - "type": "string", - "description": "Filter text report content using a permanent filter definition.\nIf the product instance does not support this feature, this option is ignored.", - "stringLengthRange": [ - 1, - 8 - ], - "group": "Options" - }, - { - "type": "string", - "name": "host", - "aliases": [ - "hostname" - ], - "description": "Hostname or ip address of the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "number", - "name": "port", - "description": "Port of the target View REST API instance.", - "numericValueRange": [ - 0, - 65535 - ], - "required": false, - "defaultValue": 443, - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "user", - "aliases": [ - "username" - ], - "description": "User name used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "string", - "name": "password", - "description": "Password used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "base-path", - "description": "Context name of the target View REST API instance.", - "required": false, - "defaultValue": "web-viewer", - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "protocol", - "description": "Protocol of the target View REST API instance.", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "defaultValue": "https", - "group": "View Connection Options", - "aliases": [] - }, - { - "name": "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": "caview-profile", - "aliases": [ - "caview-p" - ], - "group": "Profile Options", - "description": "The name of a (caview) 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": "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": [] - } - ], - "profile": { - "optional": [ - "caview", - "base" - ] - }, - "passOn": [], - "children": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "type": "string", - "name": "host", - "aliases": [ - "hostname" - ], - "description": "Hostname or ip address of the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "number", - "name": "port", - "description": "Port of the target View REST API instance.", - "numericValueRange": [ - 0, - 65535 - ], - "required": false, - "defaultValue": 443, - "group": "View Connection Options" - }, - { - "type": "string", - "name": "user", - "aliases": [ - "username" - ], - "description": "User name used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "string", - "name": "password", - "description": "Password used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "string", - "name": "base-path", - "description": "Context name of the target View REST API instance.", - "required": false, - "defaultValue": "web-viewer", - "group": "View Connection Options" - }, - { - "type": "string", - "name": "protocol", - "description": "Protocol of the target View REST API instance.", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "defaultValue": "https", - "group": "View Connection Options" - } - ], - "merge": true, - "ignoreNodes": [ - { - "type": "group" - } - ] - } - ], - "options": [ - { - "name": "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": "export", - "aliases": [ - "exp" - ], - "summary": "Export View text report file to local folder.", - "description": "Export View text report file to local folder.", - "type": "group", - "children": [ - { - "name": "report", - "aliases": [ - "r" - ], - "summary": "Export text report to spreadsheet.", - "description": "Export text report to spreadsheet using a predefined export rule.", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "repositoryId", - "type": "number", - "description": "Repository identifier.", - "required": true - }, - { - "name": "reportHandle", - "type": "string", - "description": "Report handle.", - "required": true - }, - { - "name": "ruleId", - "type": "number", - "description": "Export rule identifier.", - "required": true - }, - { - "name": "fileTarget", - "type": "string", - "description": "Local file path.\nIf the path represents a directory location, the report will be exported into that directory using a default file name.\nIf the path does not represent a directory location, the report will be exported into the specified path.\nIf the path is not specified, the file will be saved to the current working directory using the default file name.\nAny missing directories will be created. If the target file already exists, the file will be overwritten.", - "required": false - } - ], - "options": [ - { - "name": "pages", - "type": "string", - "description": "Include the specified page numbers (or page ranges). Separate page numbers (or page ranges) with commas.\nSeparate boundaries of a page range with a dash (-). If you do not specify this option, all the pages of the report are exported.", - "allowableValues": { - "values": [ - "^(\\d+(-\\d+)?)(,(\\d+(-\\d+)?))*$" - ], - "caseSensitive": false - }, - "required": false, - "group": "Options", - "aliases": [] - }, - { - "type": "string", - "name": "host", - "aliases": [ - "hostname" - ], - "description": "Hostname or ip address of the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "number", - "name": "port", - "description": "Port of the target View REST API instance.", - "numericValueRange": [ - 0, - 65535 - ], - "required": false, - "defaultValue": 443, - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "user", - "aliases": [ - "username" - ], - "description": "User name used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "string", - "name": "password", - "description": "Password used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "base-path", - "description": "Context name of the target View REST API instance.", - "required": false, - "defaultValue": "web-viewer", - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "protocol", - "description": "Protocol of the target View REST API instance.", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "defaultValue": "https", - "group": "View Connection Options", - "aliases": [] - }, - { - "name": "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": "caview-profile", - "aliases": [ - "caview-p" - ], - "group": "Profile Options", - "description": "The name of a (caview) 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": "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": [] - } - ], - "profile": { - "optional": [ - "caview", - "base" - ] - }, - "passOn": [], - "children": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "type": "string", - "name": "host", - "aliases": [ - "hostname" - ], - "description": "Hostname or ip address of the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "number", - "name": "port", - "description": "Port of the target View REST API instance.", - "numericValueRange": [ - 0, - 65535 - ], - "required": false, - "defaultValue": 443, - "group": "View Connection Options" - }, - { - "type": "string", - "name": "user", - "aliases": [ - "username" - ], - "description": "User name used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "string", - "name": "password", - "description": "Password used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "string", - "name": "base-path", - "description": "Context name of the target View REST API instance.", - "required": false, - "defaultValue": "web-viewer", - "group": "View Connection Options" - }, - { - "type": "string", - "name": "protocol", - "description": "Protocol of the target View REST API instance.", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "defaultValue": "https", - "group": "View Connection Options" - } - ], - "merge": true, - "ignoreNodes": [ - { - "type": "group" - } - ] - } - ], - "options": [ - { - "name": "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": "get", - "summary": "Get information from View repository.", - "description": "Get information from View repository.", - "type": "group", - "children": [ - { - "name": "user", - "summary": "Get user information from repository.", - "description": "Get user information from repository.", - "type": "group", - "children": [ - { - "name": "settings", - "summary": "Get current user settings from repository.", - "description": "Get current user settings from repository.", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "repositoryId", - "type": "number", - "description": "Repository identifier.", - "required": true - } - ], - "options": [ - { - "name": "output-format", - "aliases": [ - "output" - ], - "type": "string", - "description": "Output format. This option is ignored if '--response-format-json' is specified.", - "allowableValues": { - "values": [ - "^tabular$", - "^csv$", - "^json$", - "^xml$" - ], - "caseSensitive": false - }, - "defaultValue": "tabular", - "group": "Options" - }, - { - "name": "output-header", - "aliases": [ - "header" - ], - "type": "boolean", - "description": "Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.\nThis option is ignored when you specify any other output format.", - "defaultValue": true, - "group": "Options" - }, - { - "name": "output-field", - "aliases": [ - "f" - ], - "type": "array", - "description": "Field to include in the output. Multiple fields can be specified.\nFields appear in the order you specify.\n\nAllowed values: Mode,DistId,ModeAccess,DistMask,Banner,Language,MasterAuthority,Printer,UserId", - "defaultValue": [ - "Mode", - "DistId", - "ModeAccess", - "DistMask" - ], - "group": "Options" - }, - { - "type": "string", - "name": "host", - "aliases": [ - "hostname" - ], - "description": "Hostname or ip address of the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "number", - "name": "port", - "description": "Port of the target View REST API instance.", - "numericValueRange": [ - 0, - 65535 - ], - "required": false, - "defaultValue": 443, - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "user", - "aliases": [ - "username" - ], - "description": "User name used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "string", - "name": "password", - "description": "Password used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "base-path", - "description": "Context name of the target View REST API instance.", - "required": false, - "defaultValue": "web-viewer", - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "protocol", - "description": "Protocol of the target View REST API instance.", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "defaultValue": "https", - "group": "View Connection Options", - "aliases": [] - }, - { - "name": "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": "caview-profile", - "aliases": [ - "caview-p" - ], - "group": "Profile Options", - "description": "The name of a (caview) 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": "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": [] - } - ], - "profile": { - "optional": [ - "caview", - "base" - ] - }, - "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": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "type": "string", - "name": "host", - "aliases": [ - "hostname" - ], - "description": "Hostname or ip address of the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "number", - "name": "port", - "description": "Port of the target View REST API instance.", - "numericValueRange": [ - 0, - 65535 - ], - "required": false, - "defaultValue": 443, - "group": "View Connection Options" - }, - { - "type": "string", - "name": "user", - "aliases": [ - "username" - ], - "description": "User name used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "string", - "name": "password", - "description": "Password used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "string", - "name": "base-path", - "description": "Context name of the target View REST API instance.", - "required": false, - "defaultValue": "web-viewer", - "group": "View Connection Options" - }, - { - "type": "string", - "name": "protocol", - "description": "Protocol of the target View REST API instance.", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "defaultValue": "https", - "group": "View Connection Options" - } - ], - "merge": true, - "ignoreNodes": [ - { - "type": "group" - } - ] - } - ], - "options": [ - { - "name": "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": "list", - "aliases": [ - "ls" - ], - "summary": "List View repository, report, and user information.", - "description": "List View repository, report, and user information.", - "type": "group", - "children": [ - { - "name": "repositories", - "aliases": [ - "repos" - ], - "summary": "List repositories.", - "description": "List repositories.\nUse the returned 'Identifier' to reference a repository in other commands.\nFor example, use the 'Identifier' in the list reports' command to list reports in that repository.", - "type": "command", - "handler": "", - "options": [ - { - "name": "filter-name", - "aliases": [ - "n" - ], - "type": "string", - "description": "Filter (include) based on repository name. Use the percent sign (%) as a wildcard to represent a single character. Use the asterisk (*) as a wildcard to represent any number of characters.", - "defaultValue": null, - "group": "Options" - }, - { - "name": "filter-path", - "aliases": [ - "p" - ], - "type": "string", - "description": "Filter (include) based on repository path. Use the percent sign (%) as a wildcard to represent a single character. Use the asterisk (*) as a wildcard to represent any number of characters.", - "defaultValue": "*", - "group": "Options" - }, - { - "name": "output-format", - "aliases": [ - "output" - ], - "type": "string", - "description": "Output format. This option is ignored if '--response-format-json' is specified.", - "allowableValues": { - "values": [ - "^tabular$", - "^csv$", - "^json$", - "^xml$" - ], - "caseSensitive": false - }, - "defaultValue": "tabular", - "group": "Options" - }, - { - "name": "output-header", - "aliases": [ - "header" - ], - "type": "boolean", - "description": "Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.\nThis option is ignored when you specify any other output format.", - "defaultValue": true, - "group": "Options" - }, - { - "name": "output-field", - "aliases": [ - "f" - ], - "type": "array", - "description": "Field to include in the output. Multiple fields can be specified.\nFields appear in the order you specify.\n\nAllowed values: Identifier,Name,Description,Path,CharacterSet,ReportAccess,CreatedBy,DateCreated,ModifiedBy,ModifiedDate", - "defaultValue": [ - "Identifier", - "Name", - "Description", - "Path", - "CharacterSet" - ], - "group": "Options" - }, - { - "type": "string", - "name": "host", - "aliases": [ - "hostname" - ], - "description": "Hostname or ip address of the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "number", - "name": "port", - "description": "Port of the target View REST API instance.", - "numericValueRange": [ - 0, - 65535 - ], - "required": false, - "defaultValue": 443, - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "user", - "aliases": [ - "username" - ], - "description": "User name used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "string", - "name": "password", - "description": "Password used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "base-path", - "description": "Context name of the target View REST API instance.", - "required": false, - "defaultValue": "web-viewer", - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "protocol", - "description": "Protocol of the target View REST API instance.", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "defaultValue": "https", - "group": "View Connection Options", - "aliases": [] - }, - { - "name": "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": "caview-profile", - "aliases": [ - "caview-p" - ], - "group": "Profile Options", - "description": "The name of a (caview) 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": "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": [] - } - ], - "profile": { - "optional": [ - "caview", - "base" - ] - }, - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "reports", - "summary": "List reports in a repository.", - "description": "List reports in a repository.\nUse the returned 'ReportHandle' to reference a report in other commands.\nFor example, use the 'ReportHandle' in the 'download report' command to download that report.", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "repositoryId", - "type": "number", - "description": "Repository identifier.", - "required": true - } - ], - "options": [ - { - "name": "filter-name", - "aliases": [ - "n" - ], - "type": "string", - "description": "Filter (include) based on report name. Use the asterisk (*) as a wildcard to represent any number of characters.", - "defaultValue": "*", - "group": "Options" - }, - { - "name": "limit", - "aliases": [ - "l" - ], - "type": "number", - "description": "Limit (maximum number) of retrieved records.", - "defaultValue": 1000, - "group": "Options" - }, - { - "name": "latest-versions", - "aliases": [ - "latest-version", - "lv" - ], - "type": "number", - "numericValueRange": [ - 0, - 32767 - ], - "description": "Number of latest versions (of reports) to include. If not specified, all versions of reports are included.", - "defaultValue": 0, - "group": "Options" - }, - { - "name": "archival-since", - "aliases": [ - "since", - "archival-from", - "from" - ], - "type": "string", - "description": "Date of earliest archived reports to include based on archival date. Specify a value in the ISO-8601 format.", - "defaultValue": null, - "group": "Options" - }, - { - "name": "archival-until", - "aliases": [ - "until", - "archival-to", - "to" - ], - "type": "string", - "description": "Date of latest archived reports to include based on archival date. Specify a value in the ISO-8601 format.", - "defaultValue": null, - "group": "Options" - }, - { - "name": "output-header", - "aliases": [ - "header" - ], - "type": "boolean", - "description": "Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.\nThis option is ignored when you specify any other output format.", - "defaultValue": true, - "group": "Options" - }, - { - "name": "output-format", - "aliases": [ - "output" - ], - "type": "string", - "description": "Output format. This option is ignored if '--response-format-json' is specified.", - "allowableValues": { - "values": [ - "^tabular$", - "^csv$", - "^json$", - "^xml$" - ], - "caseSensitive": false - }, - "defaultValue": "tabular", - "group": "Options" - }, - { - "name": "output-field", - "aliases": [ - "f" - ], - "type": "array", - "description": "Field to include in the output. Multiple fields can be specified.\nFields appear in the order you specify.\n\nAllowed values: ReportName,Lines,Pages,Type,ArchivalDate,Description,UserComments,ReportHandle,TotalPages,OriginalType,Destination,JobName,Origin,Generation,SequenceNumber,SysoutClass,Status,JobID,Forms,XCode,UserID,ReadDate,PrintDate,OnDisk,OnTape,OnOptical,IndexOnDisk,Location,TapeSequence,TapePosition,TapeCount,ExtendedRetentionOptionID,RemainingDays,RemainingGenerations,RemainingCopy,RemainingDiskDays,RemainingDiskGeneration,RemainingDiskCopy,RemainingDisk2days", - "defaultValue": [ - "ReportName", - "Lines", - "Pages", - "Type", - "ArchivalDate", - "Description", - "UserComments", - "ReportHandle" - ], - "group": "Options" - }, - { - "type": "string", - "name": "host", - "aliases": [ - "hostname" - ], - "description": "Hostname or ip address of the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "number", - "name": "port", - "description": "Port of the target View REST API instance.", - "numericValueRange": [ - 0, - 65535 - ], - "required": false, - "defaultValue": 443, - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "user", - "aliases": [ - "username" - ], - "description": "User name used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "string", - "name": "password", - "description": "Password used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "base-path", - "description": "Context name of the target View REST API instance.", - "required": false, - "defaultValue": "web-viewer", - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "protocol", - "description": "Protocol of the target View REST API instance.", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "defaultValue": "https", - "group": "View Connection Options", - "aliases": [] - }, - { - "name": "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": "caview-profile", - "aliases": [ - "caview-p" - ], - "group": "Profile Options", - "description": "The name of a (caview) 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": "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": [] - } - ], - "profile": { - "optional": [ - "caview", - "base" - ] - }, - "aliases": [], - "passOn": [], - "children": [] - }, - { - "name": "report", - "aliases": [ - "repo" - ], - "summary": "List information about a specific report.", - "description": "List information about a specific report.", - "type": "group", - "children": [ - { - "name": "logical-views", - "aliases": [ - "views" - ], - "summary": "List logical views available for a specific report.", - "description": "List logical views available for a specific report.\nUse the returned 'ReportHandle' to reference a logical view in other commands.\nFor example, use 'ReportHandle' in the 'download report' command to download the logical view of that report.\nUse the returned 'IndexNameHandle' in the 'list report index-values' command to retrieve the list of associated index values (if defined) for that index.", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "repositoryId", - "type": "number", - "description": "Repository identifier.", - "required": true - }, - { - "name": "reportHandle", - "type": "string", - "description": "Report handle.", - "required": true - } - ], - "options": [ - { - "name": "output-format", - "aliases": [ - "output" - ], - "type": "string", - "description": "Output format. This option is ignored if '--response-format-json' is specified.", - "allowableValues": { - "values": [ - "^tabular$", - "^csv$", - "^json$", - "^xml$" - ], - "caseSensitive": false - }, - "defaultValue": "tabular", - "group": "Options" - }, - { - "name": "output-header", - "aliases": [ - "header" - ], - "type": "boolean", - "description": "Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.\nThis option is ignored when you specify any other output format.", - "defaultValue": true, - "group": "Options" - }, - { - "name": "output-field", - "aliases": [ - "f" - ], - "type": "array", - "description": "Field to include in the output. Multiple fields can be specified.\nFields appear in the order you specify.\n\nAllowed values: Description,Index,SubIndexNames,ReportHandle,IndexNameHandle,Number,ViewId,Default", - "defaultValue": [ - "Description", - "Index", - "SubIndexNames", - "ReportHandle", - "IndexNameHandle" - ], - "group": "Options" - }, - { - "type": "string", - "name": "host", - "aliases": [ - "hostname" - ], - "description": "Hostname or ip address of the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "number", - "name": "port", - "description": "Port of the target View REST API instance.", - "numericValueRange": [ - 0, - 65535 - ], - "required": false, - "defaultValue": 443, - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "user", - "aliases": [ - "username" - ], - "description": "User name used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "string", - "name": "password", - "description": "Password used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "base-path", - "description": "Context name of the target View REST API instance.", - "required": false, - "defaultValue": "web-viewer", - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "protocol", - "description": "Protocol of the target View REST API instance.", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "defaultValue": "https", - "group": "View Connection Options", - "aliases": [] - }, - { - "name": "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": "caview-profile", - "aliases": [ - "caview-p" - ], - "group": "Profile Options", - "description": "The name of a (caview) 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": "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": [] - } - ], - "profile": { - "optional": [ - "caview", - "base" - ] - }, - "passOn": [], - "children": [] - }, - { - "name": "index-names", - "aliases": [ - "indexes" - ], - "summary": "List indexes for a a specific report.", - "description": "List indexes for a a specific report.\nUse the returned 'IndexNameHandle' to reference a report index.\nUse the returned 'IndexNameHandle' in the 'list report index-values' command to retrieve the list of associated index values for that index.", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "repositoryId", - "type": "number", - "description": "Repository identifier.", - "required": true - }, - { - "name": "reportHandle", - "type": "string", - "description": "Report handle.", - "required": true - } - ], - "options": [ - { - "name": "filter-names", - "aliases": [ - "names" - ], - "type": "string", - "description": "Filter (include) based on index name. Separate multiple index names with commas. Use the asterisk (*) as a wildcard to represent any number of characters.", - "defaultValue": "*,*,*,*,*,*,*,*", - "group": "Options" - }, - { - "name": "output-format", - "aliases": [ - "output" - ], - "type": "string", - "description": "Output format. This option is ignored if '--response-format-json' is specified.", - "allowableValues": { - "values": [ - "^tabular$", - "^csv$", - "^json$", - "^xml$" - ], - "caseSensitive": false - }, - "defaultValue": "tabular", - "group": "Options" - }, - { - "name": "output-header", - "aliases": [ - "header" - ], - "type": "boolean", - "description": "Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.\nThis option is ignored when you specify any other output format.", - "defaultValue": true, - "group": "Options" - }, - { - "name": "output-field", - "aliases": [ - "f" - ], - "type": "array", - "description": "Field to include in the output. Multiple fields can be specified.\nFields appear in the order you specify.\n\nAllowed values: Index,SubIndexNames,IndexNameHandle", - "defaultValue": [ - "Index", - "SubIndexNames", - "IndexNameHandle" - ], - "group": "Options" - }, - { - "type": "string", - "name": "host", - "aliases": [ - "hostname" - ], - "description": "Hostname or ip address of the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "number", - "name": "port", - "description": "Port of the target View REST API instance.", - "numericValueRange": [ - 0, - 65535 - ], - "required": false, - "defaultValue": 443, - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "user", - "aliases": [ - "username" - ], - "description": "User name used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "string", - "name": "password", - "description": "Password used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "base-path", - "description": "Context name of the target View REST API instance.", - "required": false, - "defaultValue": "web-viewer", - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "protocol", - "description": "Protocol of the target View REST API instance.", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "defaultValue": "https", - "group": "View Connection Options", - "aliases": [] - }, - { - "name": "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": "caview-profile", - "aliases": [ - "caview-p" - ], - "group": "Profile Options", - "description": "The name of a (caview) 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": "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": [] - } - ], - "profile": { - "optional": [ - "caview", - "base" - ] - }, - "passOn": [], - "children": [] - }, - { - "name": "index-values", - "summary": "List index values for a report index.", - "description": "List index values for a report index.\nUse the returned 'ReportHandle' to reference an index value in other commands.\nFor example, use 'ReportHandle' in the 'download report' command to download that corresponding view of the report.", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "repositoryId", - "type": "number", - "description": "Repository identifier.", - "required": true - }, - { - "name": "reportHandle", - "type": "string", - "description": "Report handle.", - "required": true - }, - { - "name": "indexNameHandle", - "type": "string", - "description": "Index name handle.", - "required": true - } - ], - "options": [ - { - "name": "filter-values", - "aliases": [ - "values" - ], - "type": "string", - "description": "Filter (include) based on index values. Separate index values with commas. Use the asterisk (*) as a wildcard to represent any number of characters.", - "defaultValue": "*,*,*,*,*,*,*,*", - "group": "Options" - }, - { - "name": "output-format", - "aliases": [ - "output" - ], - "type": "string", - "description": "Output format. This option is ignored if '--response-format-json' is specified.", - "allowableValues": { - "values": [ - "^tabular$", - "^csv$", - "^json$", - "^xml$" - ], - "caseSensitive": false - }, - "defaultValue": "tabular", - "group": "Options" - }, - { - "name": "output-header", - "aliases": [ - "header" - ], - "type": "boolean", - "description": "Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.\nThis option is ignored when you specify any other output format.", - "defaultValue": true, - "group": "Options" - }, - { - "name": "output-field", - "aliases": [ - "f" - ], - "type": "array", - "description": "Field to include in the output. Multiple fields can be specified.\nFields appear in the order you specify.\n\nAllowed values: Value,SubValues,ReportHandle", - "defaultValue": [ - "Value", - "SubValues", - "ReportHandle" - ], - "group": "Options" - }, - { - "type": "string", - "name": "host", - "aliases": [ - "hostname" - ], - "description": "Hostname or ip address of the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "number", - "name": "port", - "description": "Port of the target View REST API instance.", - "numericValueRange": [ - 0, - 65535 - ], - "required": false, - "defaultValue": 443, - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "user", - "aliases": [ - "username" - ], - "description": "User name used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "string", - "name": "password", - "description": "Password used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "base-path", - "description": "Context name of the target View REST API instance.", - "required": false, - "defaultValue": "web-viewer", - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "protocol", - "description": "Protocol of the target View REST API instance.", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "defaultValue": "https", - "group": "View Connection Options", - "aliases": [] - }, - { - "name": "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": "caview-profile", - "aliases": [ - "caview-p" - ], - "group": "Profile Options", - "description": "The name of a (caview) 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": "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": [] - } - ], - "profile": { - "optional": [ - "caview", - "base" - ] - }, - "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" - } - ], - "positionals": [], - "passOn": [] - }, - { - "name": "export-rules", - "aliases": [ - "rules" - ], - "summary": "List export rules defined for a report.", - "description": "List export rules defined for a report.\nUse the returned 'Identifier' in the 'export report' command to reference that rule.", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "reportId", - "type": "string", - "description": "Report ID (Name).", - "stringLengthRange": [ - 1, - 32 - ], - "required": true - } - ], - "options": [ - { - "name": "output-format", - "aliases": [ - "output" - ], - "type": "string", - "description": "Output format. This option is ignored if '--response-format-json' is specified.", - "allowableValues": { - "values": [ - "^tabular$", - "^csv$", - "^json$", - "^xml$" - ], - "caseSensitive": false - }, - "defaultValue": "tabular", - "group": "Options" - }, - { - "name": "output-header", - "aliases": [ - "header" - ], - "type": "boolean", - "description": "Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.\nThis option is ignored when you specify any other output format.", - "defaultValue": true, - "group": "Options" - }, - { - "name": "output-field", - "aliases": [ - "f" - ], - "type": "array", - "description": "Field to include in the output. Multiple fields can be specified.\nFields appear in the order you specify.\n\nAllowed values: Identifier,Name,Description,Owner,Public", - "defaultValue": [ - "Identifier", - "Name", - "Description" - ], - "group": "Options" - }, - { - "type": "string", - "name": "host", - "aliases": [ - "hostname" - ], - "description": "Hostname or ip address of the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "number", - "name": "port", - "description": "Port of the target View REST API instance.", - "numericValueRange": [ - 0, - 65535 - ], - "required": false, - "defaultValue": 443, - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "user", - "aliases": [ - "username" - ], - "description": "User name used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "string", - "name": "password", - "description": "Password used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "base-path", - "description": "Context name of the target View REST API instance.", - "required": false, - "defaultValue": "web-viewer", - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "protocol", - "description": "Protocol of the target View REST API instance.", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "defaultValue": "https", - "group": "View Connection Options", - "aliases": [] - }, - { - "name": "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": "caview-profile", - "aliases": [ - "caview-p" - ], - "group": "Profile Options", - "description": "The name of a (caview) 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": "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": [] - } - ], - "profile": { - "optional": [ - "caview", - "base" - ] - }, - "passOn": [], - "children": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "type": "string", - "name": "host", - "aliases": [ - "hostname" - ], - "description": "Hostname or ip address of the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "number", - "name": "port", - "description": "Port of the target View REST API instance.", - "numericValueRange": [ - 0, - 65535 - ], - "required": false, - "defaultValue": 443, - "group": "View Connection Options" - }, - { - "type": "string", - "name": "user", - "aliases": [ - "username" - ], - "description": "User name used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "string", - "name": "password", - "description": "Password used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "string", - "name": "base-path", - "description": "Context name of the target View REST API instance.", - "required": false, - "defaultValue": "web-viewer", - "group": "View Connection Options" - }, - { - "type": "string", - "name": "protocol", - "description": "Protocol of the target View REST API instance.", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "defaultValue": "https", - "group": "View Connection Options" - } - ], - "merge": true, - "ignoreNodes": [ - { - "type": "group" - } - ] - } - ], - "options": [ - { - "name": "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": "search", - "aliases": [ - "find" - ], - "summary": "Search data in a View repository.", - "description": "Search data in a View repository.", - "type": "group", - "children": [ - { - "name": "index", - "summary": "Search cross-report index data in a repository.", - "description": "Search cross-report index data in a repository.", - "type": "group", - "children": [ - { - "name": "names", - "summary": "Search cross-report index names in a repository.", - "description": "Search cross-report index names in a repository.\nUse the returned 'IndexNameHandle' to reference a cross-report index name.\nFor example, use the 'IndexNameHandle' in the 'search index values' command to retrieve the list of index values for that cross-report index.", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "repositoryId", - "type": "number", - "description": "Repository identifier.", - "required": true - } - ], - "options": [ - { - "name": "filter-reports", - "aliases": [ - "reports" - ], - "type": "string", - "description": "Filter (include) based on report names (IDs). Use the asterisk (*) as a wildcard to represent any number of characters.", - "defaultValue": "*", - "group": "Options" - }, - { - "name": "filter-names", - "aliases": [ - "names" - ], - "type": "string", - "description": "Filter (include) based on index name. Separate multiple index names with commas. Use the asterisk (*) as a wildcard to represent any number of characters.", - "defaultValue": "*,*,*,*,*,*,*,*", - "group": "Options" - }, - { - "name": "latest-versions", - "aliases": [ - "latest-version", - "lv" - ], - "type": "number", - "numericValueRange": [ - 0, - 32767 - ], - "description": "Number of latest versions (of reports) to include. If not specified, all versions of reports are included.", - "defaultValue": 0, - "group": "Options" - }, - { - "name": "archival-since", - "aliases": [ - "since", - "archival-from", - "from" - ], - "type": "string", - "description": "Date of earliest archived reports to include based on archival date. Specify a value in the ISO-8601 format.", - "defaultValue": null, - "group": "Options" - }, - { - "name": "archival-until", - "aliases": [ - "until", - "archival-to", - "to" - ], - "type": "string", - "description": "Date of latest archived reports to include based on archival date. Specify a value in the ISO-8601 format.", - "defaultValue": null, - "group": "Options" - }, - { - "name": "online-only", - "aliases": [ - "online" - ], - "type": "boolean", - "description": "Include only those reports that are available online.", - "defaultValue": true, - "group": "Options" - }, - { - "name": "output-format", - "aliases": [ - "output" - ], - "type": "string", - "description": "Output format. This option is ignored if '--response-format-json' is specified.", - "allowableValues": { - "values": [ - "^tabular$", - "^csv$", - "^json$", - "^xml$" - ], - "caseSensitive": false - }, - "defaultValue": "tabular", - "group": "Options" - }, - { - "name": "output-header", - "aliases": [ - "header" - ], - "type": "boolean", - "description": "Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.\nThis option is ignored when you specify any other output format.", - "defaultValue": true, - "group": "Options" - }, - { - "name": "output-field", - "aliases": [ - "f" - ], - "type": "array", - "description": "Field to include in the output. Multiple fields can be specified.\nFields appear in the order you specify.\n\nAllowed values: Index,SubIndexNames,IndexNameHandle", - "defaultValue": [ - "Index", - "SubIndexNames", - "IndexNameHandle" - ], - "group": "Options" - }, - { - "type": "string", - "name": "host", - "aliases": [ - "hostname" - ], - "description": "Hostname or ip address of the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "number", - "name": "port", - "description": "Port of the target View REST API instance.", - "numericValueRange": [ - 0, - 65535 - ], - "required": false, - "defaultValue": 443, - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "user", - "aliases": [ - "username" - ], - "description": "User name used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "string", - "name": "password", - "description": "Password used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "base-path", - "description": "Context name of the target View REST API instance.", - "required": false, - "defaultValue": "web-viewer", - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "protocol", - "description": "Protocol of the target View REST API instance.", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "defaultValue": "https", - "group": "View Connection Options", - "aliases": [] - }, - { - "name": "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": "caview-profile", - "aliases": [ - "caview-p" - ], - "group": "Profile Options", - "description": "The name of a (caview) 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": "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": [] - } - ], - "profile": { - "optional": [ - "caview", - "base" - ] - }, - "aliases": [], - "passOn": [], - "children": [] - }, - { - "name": "values", - "summary": "Search cross-report index values in a repository.", - "description": "Search cross-report index values in a repository.\nUse the returned 'IndexValueHandle' in the 'search index reports' command to retrieve the list of reports containing that index value.", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "repositoryId", - "type": "number", - "description": "Repository identifier.", - "required": true - }, - { - "name": "indexNameHandle", - "type": "string", - "description": "Index name handle.", - "required": true - } - ], - "options": [ - { - "name": "filter-reports", - "aliases": [ - "reports" - ], - "type": "string", - "description": "Filter (include) based on report names (IDs). Use the asterisk (*) as a wildcard to represent any number of characters.", - "defaultValue": "*", - "group": "Options" - }, - { - "name": "filter-values", - "aliases": [ - "values" - ], - "type": "string", - "description": "Filter (include) based on index values. Separate index values with commas. Use the asterisk (*) as a wildcard to represent any number of characters.", - "defaultValue": "*,*,*,*,*,*,*,*", - "group": "Options" - }, - { - "name": "latest-versions", - "aliases": [ - "latest-version", - "lv" - ], - "type": "number", - "numericValueRange": [ - 0, - 32767 - ], - "description": "Number of latest versions (of reports) to include. If not specified, all versions of reports are included.", - "defaultValue": 0, - "group": "Options" - }, - { - "name": "archival-since", - "aliases": [ - "since", - "archival-from", - "from" - ], - "type": "string", - "description": "Date of earliest archived reports to include based on archival date. Specify a value in the ISO-8601 format.", - "defaultValue": null, - "group": "Options" - }, - { - "name": "archival-until", - "aliases": [ - "until", - "archival-to", - "to" - ], - "type": "string", - "description": "Date of latest archived reports to include based on archival date. Specify a value in the ISO-8601 format.", - "defaultValue": null, - "group": "Options" - }, - { - "name": "online-only", - "aliases": [ - "online" - ], - "type": "boolean", - "description": "Include only those reports that are available online.", - "defaultValue": true, - "group": "Options" - }, - { - "name": "output-format", - "aliases": [ - "output" - ], - "type": "string", - "description": "Output format. This option is ignored if '--response-format-json' is specified.", - "allowableValues": { - "values": [ - "^tabular$", - "^csv$", - "^json$", - "^xml$" - ], - "caseSensitive": false - }, - "defaultValue": "tabular", - "group": "Options" - }, - { - "name": "output-header", - "aliases": [ - "header" - ], - "type": "boolean", - "description": "Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.\nThis option is ignored when you specify any other output format.", - "defaultValue": true, - "group": "Options" - }, - { - "name": "output-field", - "aliases": [ - "f" - ], - "type": "array", - "description": "Field to include in the output. Multiple fields can be specified.\nFields appear in the order you specify.\n\nAllowed values: Value,SubValues,IndexValueHandle", - "defaultValue": [ - "Value", - "SubValues", - "IndexValueHandle" - ], - "group": "Options" - }, - { - "type": "string", - "name": "host", - "aliases": [ - "hostname" - ], - "description": "Hostname or ip address of the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "number", - "name": "port", - "description": "Port of the target View REST API instance.", - "numericValueRange": [ - 0, - 65535 - ], - "required": false, - "defaultValue": 443, - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "user", - "aliases": [ - "username" - ], - "description": "User name used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "string", - "name": "password", - "description": "Password used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "base-path", - "description": "Context name of the target View REST API instance.", - "required": false, - "defaultValue": "web-viewer", - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "protocol", - "description": "Protocol of the target View REST API instance.", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "defaultValue": "https", - "group": "View Connection Options", - "aliases": [] - }, - { - "name": "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": "caview-profile", - "aliases": [ - "caview-p" - ], - "group": "Profile Options", - "description": "The name of a (caview) 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": "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": [] - } - ], - "profile": { - "optional": [ - "caview", - "base" - ] - }, - "aliases": [], - "passOn": [], - "children": [] - }, - { - "name": "reports", - "summary": "Search reports containing a cross-report index value in a repository.", - "description": "Search reports containing a cross-report index value in a repository.\nUse the returned 'ReportHandle' to reference a view of the report.\nFor example, use the 'ReportHandle' in the 'download report' command to download that view of the report.", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "repositoryId", - "type": "number", - "description": "Repository identifier.", - "required": true - }, - { - "name": "indexNameHandle", - "type": "string", - "description": "Index name handle.", - "required": true - }, - { - "name": "valueHandle", - "type": "string", - "description": "Index value handle.", - "required": true - } - ], - "options": [ - { - "name": "filter-reports", - "aliases": [ - "reports" - ], - "type": "string", - "description": "Filter (include) based on report names (IDs). Use the asterisk (*) as a wildcard to represent any number of characters.", - "defaultValue": "*", - "group": "Options" - }, - { - "name": "latest-versions", - "aliases": [ - "latest-version", - "lv" - ], - "type": "number", - "numericValueRange": [ - 0, - 32767 - ], - "description": "Number of latest versions (of reports) to include. If not specified, all versions of reports are included.", - "defaultValue": 0, - "group": "Options" - }, - { - "name": "archival-since", - "aliases": [ - "since", - "archival-from", - "from" - ], - "type": "string", - "description": "Date of earliest archived reports to include based on archival date. Specify a value in the ISO-8601 format.", - "defaultValue": null, - "group": "Options" - }, - { - "name": "archival-until", - "aliases": [ - "until", - "archival-to", - "to" - ], - "type": "string", - "description": "Date of latest archived reports to include based on archival date. Specify a value in the ISO-8601 format.", - "defaultValue": null, - "group": "Options" - }, - { - "name": "online-only", - "aliases": [ - "online" - ], - "type": "boolean", - "description": "Include only those reports that are available online.", - "defaultValue": true, - "group": "Options" - }, - { - "name": "output-format", - "aliases": [ - "output" - ], - "type": "string", - "description": "Output format. This option is ignored if '--response-format-json' is specified.", - "allowableValues": { - "values": [ - "^tabular$", - "^csv$", - "^json$", - "^xml$" - ], - "caseSensitive": false - }, - "defaultValue": "tabular", - "group": "Options" - }, - { - "name": "output-header", - "aliases": [ - "header" - ], - "type": "boolean", - "description": "Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.\nThis option is ignored when you specify any other output format.", - "defaultValue": true, - "group": "Options" - }, - { - "name": "output-field", - "aliases": [ - "f" - ], - "type": "array", - "description": "Field to include in the output. Multiple fields can be specified.\nFields appear in the order you specify.\n\nAllowed values: ReportName,Lines,Pages,Type,ArchivalDate,Description,UserComments,ReportHandle,TotalPages,OriginalType,Destination,JobName,Origin,Generation,SequenceNumber,SysoutClass,Status,JobID,Forms,XCode,UserID,ReadDate,PrintDate,OnDisk,OnTape,OnOptical,IndexOnDisk,Location,TapeSequence,TapePosition,TapeCount,ExtendedRetentionOptionID,RemainingDays,RemainingGenerations,RemainingCopy,RemainingDiskDays,RemainingDiskGeneration,RemainingDiskCopy,RemainingDisk2days", - "defaultValue": [ - "ReportName", - "Lines", - "Pages", - "Type", - "ArchivalDate", - "Description", - "UserComments", - "ReportHandle" - ], - "group": "Options" - }, - { - "type": "string", - "name": "host", - "aliases": [ - "hostname" - ], - "description": "Hostname or ip address of the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "number", - "name": "port", - "description": "Port of the target View REST API instance.", - "numericValueRange": [ - 0, - 65535 - ], - "required": false, - "defaultValue": 443, - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "user", - "aliases": [ - "username" - ], - "description": "User name used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "string", - "name": "password", - "description": "Password used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "base-path", - "description": "Context name of the target View REST API instance.", - "required": false, - "defaultValue": "web-viewer", - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "protocol", - "description": "Protocol of the target View REST API instance.", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "defaultValue": "https", - "group": "View Connection Options", - "aliases": [] - }, - { - "name": "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": "caview-profile", - "aliases": [ - "caview-p" - ], - "group": "Profile Options", - "description": "The name of a (caview) 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": "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": [] - } - ], - "profile": { - "optional": [ - "caview", - "base" - ] - }, - "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": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "type": "string", - "name": "host", - "aliases": [ - "hostname" - ], - "description": "Hostname or ip address of the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "number", - "name": "port", - "description": "Port of the target View REST API instance.", - "numericValueRange": [ - 0, - 65535 - ], - "required": false, - "defaultValue": 443, - "group": "View Connection Options" - }, - { - "type": "string", - "name": "user", - "aliases": [ - "username" - ], - "description": "User name used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "string", - "name": "password", - "description": "Password used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "string", - "name": "base-path", - "description": "Context name of the target View REST API instance.", - "required": false, - "defaultValue": "web-viewer", - "group": "View Connection Options" - }, - { - "type": "string", - "name": "protocol", - "description": "Protocol of the target View REST API instance.", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "defaultValue": "https", - "group": "View Connection Options" - } - ], - "merge": true, - "ignoreNodes": [ - { - "type": "group" - } - ] - } - ], - "options": [ - { - "name": "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": "set", - "summary": "Set information in View repository.", - "description": "Set information in View repository.", - "type": "group", - "children": [ - { - "name": "user", - "summary": "Set configuration for current user in repository.", - "description": "Set configuration for current user in repository.", - "type": "group", - "children": [ - { - "name": "mode", - "summary": "Set mode for current user in repository.", - "description": "Set mode for current user in repository.", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "repositoryId", - "type": "number", - "description": "Repository identifier.", - "required": true - }, - { - "name": "mode", - "type": "string", - "description": "User mode.\n", - "regex": "^(ALL|SAR|SARO|EXP|EXPO)$", - "required": true - } - ], - "options": [ - { - "name": "output-format", - "aliases": [ - "output" - ], - "type": "string", - "description": "Output format. This option is ignored if '--response-format-json' is specified.", - "allowableValues": { - "values": [ - "^tabular$", - "^csv$", - "^json$", - "^xml$" - ], - "caseSensitive": false - }, - "defaultValue": "tabular", - "group": "Options" - }, - { - "name": "output-header", - "aliases": [ - "header" - ], - "type": "boolean", - "description": "Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.\nThis option is ignored when you specify any other output format.", - "defaultValue": true, - "group": "Options" - }, - { - "name": "output-field", - "aliases": [ - "f" - ], - "type": "array", - "description": "Field to include in the output. Multiple fields can be specified.\nFields appear in the order you specify.\n\nAllowed values: Mode,DistId,ModeAccess,DistMask,Banner,Language,MasterAuthority,Printer,UserId", - "defaultValue": [ - "Mode", - "DistId", - "ModeAccess", - "DistMask" - ], - "group": "Options" - }, - { - "type": "string", - "name": "host", - "aliases": [ - "hostname" - ], - "description": "Hostname or ip address of the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "number", - "name": "port", - "description": "Port of the target View REST API instance.", - "numericValueRange": [ - 0, - 65535 - ], - "required": false, - "defaultValue": 443, - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "user", - "aliases": [ - "username" - ], - "description": "User name used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "string", - "name": "password", - "description": "Password used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "base-path", - "description": "Context name of the target View REST API instance.", - "required": false, - "defaultValue": "web-viewer", - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "protocol", - "description": "Protocol of the target View REST API instance.", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "defaultValue": "https", - "group": "View Connection Options", - "aliases": [] - }, - { - "name": "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": "caview-profile", - "aliases": [ - "caview-p" - ], - "group": "Profile Options", - "description": "The name of a (caview) 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": "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": [] - } - ], - "profile": { - "optional": [ - "caview", - "base" - ] - }, - "aliases": [], - "passOn": [], - "children": [] - }, - { - "name": "distribution", - "summary": "Set distribution id for current user in repository.", - "description": "Set distribution id for current user in repository.", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "repositoryId", - "type": "number", - "description": "Repository identifier.", - "required": true - }, - { - "name": "distributionId", - "type": "string", - "description": "Distribution ID.", - "stringLengthRange": [ - 1, - 32 - ], - "required": true - } - ], - "options": [ - { - "name": "output-format", - "aliases": [ - "output" - ], - "type": "string", - "description": "Output format. This option is ignored if '--response-format-json' is specified.", - "allowableValues": { - "values": [ - "^tabular$", - "^csv$", - "^json$", - "^xml$" - ], - "caseSensitive": false - }, - "defaultValue": "tabular", - "group": "Options" - }, - { - "name": "output-header", - "aliases": [ - "header" - ], - "type": "boolean", - "description": "Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.\nThis option is ignored when you specify any other output format.", - "defaultValue": true, - "group": "Options" - }, - { - "name": "output-field", - "aliases": [ - "f" - ], - "type": "array", - "description": "Field to include in the output. Multiple fields can be specified.\nFields appear in the order you specify.\n\nAllowed values: Mode,DistId,ModeAccess,DistMask,Banner,Language,MasterAuthority,Printer,UserId", - "defaultValue": [ - "Mode", - "DistId", - "ModeAccess", - "DistMask" - ], - "group": "Options" - }, - { - "type": "string", - "name": "host", - "aliases": [ - "hostname" - ], - "description": "Hostname or ip address of the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "number", - "name": "port", - "description": "Port of the target View REST API instance.", - "numericValueRange": [ - 0, - 65535 - ], - "required": false, - "defaultValue": 443, - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "user", - "aliases": [ - "username" - ], - "description": "User name used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "string", - "name": "password", - "description": "Password used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "base-path", - "description": "Context name of the target View REST API instance.", - "required": false, - "defaultValue": "web-viewer", - "group": "View Connection Options", - "aliases": [] - }, - { - "type": "string", - "name": "protocol", - "description": "Protocol of the target View REST API instance.", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "defaultValue": "https", - "group": "View Connection Options", - "aliases": [] - }, - { - "name": "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": "caview-profile", - "aliases": [ - "caview-p" - ], - "group": "Profile Options", - "description": "The name of a (caview) 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": "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": [] - } - ], - "profile": { - "optional": [ - "caview", - "base" - ] - }, - "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": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "type": "string", - "name": "host", - "aliases": [ - "hostname" - ], - "description": "Hostname or ip address of the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "number", - "name": "port", - "description": "Port of the target View REST API instance.", - "numericValueRange": [ - 0, - 65535 - ], - "required": false, - "defaultValue": 443, - "group": "View Connection Options" - }, - { - "type": "string", - "name": "user", - "aliases": [ - "username" - ], - "description": "User name used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "string", - "name": "password", - "description": "Password used to authenticate against the target View REST API instance.", - "required": false, - "group": "View Connection Options" - }, - { - "type": "string", - "name": "base-path", - "description": "Context name of the target View REST API instance.", - "required": false, - "defaultValue": "web-viewer", - "group": "View Connection Options" - }, - { - "type": "string", - "name": "protocol", - "description": "Protocol of the target View REST API instance.", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "defaultValue": "https", - "group": "View Connection Options" - } - ], - "merge": true, - "ignoreNodes": [ - { - "type": "group" - } - ] - } - ], - "options": [ - { - "name": "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": "Access View data and perform related tasks.", - "aliases": [ - "cv" - ], - "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/dbm-db2.jsonc b/commandGroups/dbm-db2.jsonc deleted file mode 100644 index 22b2de3..0000000 --- a/commandGroups/dbm-db2.jsonc +++ /dev/null @@ -1,3121 +0,0 @@ -// 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 the and . The first occurrence in multiple specifications for the same has the highest precedence.\n \nExample:\n \nThe following example demonstrates changes to the table schema (creator) and tablespace names:\n \nTBCR TEST% PROD%\nTBTS TESTTS% PRODTS%\n \nFor more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote:\n- If change-set and change-set-file are both specified, specifications in change-set-file take precedence.\n- The changeSetValues options-profile option has the same behavior as the change-set-file command option. \u001b[0m", - "type": "string", - "aliases": [ - "csf" - ], - "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 the and . The first occurrence in multiple specifications for the same has the highest precedence.\n \nExample:\n \nThe following example demonstrates changes to the table schema (creator) and tablespace names:\n \nTBCR TEST% PROD%\nTBTS TESTTS% PRODTS%\n \nFor more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote:\n- If change-set and change-set-file are both specified, specifications in change-set-file take precedence.\n- The changeSetValues options-profile option has the same behavior as the change-set-file command option. \u001b[0m", - "type": "string", - "aliases": [ - "csf" - ], - "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 the and . The first occurrence in multiple specifications for the same has the highest precedence.\n \nFor a list of global change set attributes, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nExample:\n \nThe following example demonstrates changes to the table schema (creator) and tablespace names:\n \nTBCR TEST% PROD%\nTBTS TESTTS% PRODTS%\n\nNote:\n- If change-set and change-set-file are both specified, specifications in change-set-file take precedence.\n- The changeSetValues options-profile option has the same behavior as the change-set-file command option. \u001b[0m", - "type": "string", - "aliases": [ - "csf" - ], - "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 the and . The first occurrence in multiple specifications for the same has the highest precedence.\n \nFor a list of global change set attributes, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nExample:\n \nThe following example demonstrates changes to the table schema (creator) and tablespace names:\n \nTBCR TEST% PROD%\nTBTS TESTTS% PRODTS%\n\nNote:\n- If change-set and change-set-file are both specified, specifications in change-set-file take precedence.\n- The changeSetValues options-profile option has the same behavior as the change-set-file command option. \u001b[0m", - "type": "string", - "aliases": [ - "csf" - ], - "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/ejes.jsonc b/commandGroups/ejes.jsonc deleted file mode 100644 index 8b7d09f..0000000 --- a/commandGroups/ejes.jsonc +++ /dev/null @@ -1,60811 +0,0 @@ -// Copyright (c) 2020-2023 Phoenix Software International, Inc. -{ - "name": "ejes", - "description": "Welcome to the EJES RESTapi Manager\n\nThis plug-in allows you to interact with EJES on the host to emulate EJES Batch under TSO and to query the EJES monitoredspool and host libraries to retreive tabular and report information", - "type": "group", - "children": [ - { - "name": "api", - "aliases": [ - "a" - ], - "summary": "- Make requests with the (E)JES REST API", - "description": "Make requests with the (E)JES REST API to the (E)JES API using options that correspond to object models in the (E)JES REST API swagger documentation. You should refer to that document, refer to chapter 10 of the (E)JES Reference, and issue \"zowe ejes api init --helpApp\" further details.\n\nAll responses are returned in JSON format by using the --rfj (--response-format-json) option.\n\nThe tools necessary manage the spool with (E)JES are provided. You will be able to download sysout, email it as PDF, and submit jobs from MVS and the local workstation. All downloads are saved to a file in the current working directory, or to the path specified on the EJES_DOWNLOAD_PATH environment variable.\n\nThe CLI generates exit codes. 0 indicates the transaction completed, but you should check the output for (E)JES errors. A non-zero exit code below 100 indicates a problem coding an options or a download file filesystem issue. An exit code above 100 is a response code from the host through the API. If use the host host \"return\" command in the --command option, you will receive a 500 exit code. Use a stateless init request or issue a term request to avoid this result.\n\nThis CLI was developed to provide an easy scripting option to avoid coding directly to the REST API. However, it can be used to experiment with the REST API. The --debug option will return the host requests and responses as objects and properties in JSON.", - "type": "group", - "children": [ - { - "name": "cancel-download", - "aliases": [ - "c" - ], - "summary": " - Issue a cancel-download request", - "description": "Cancels a streaming download of PDF or Text data. A download is initiated via the -d option on an Exec request. Refer to the (E)JES REST API swagger documentation for details on mapped options.\n\nFor a command group overview, issue: zowe ejes api -h ", - "type": "command", - "options": [ - { - "name": "cookie", - "group": "Query Item Options", - "type": "string", - "description": "Supply the cookie output by a stateful request. This option supports optional syntax to enable automatic management of the cookie without scraping from stdout.\n\n--cookie [|read[]|write[]\n\nThe CLI can manage a stateful cookie transaction proactively. On the init, specify --cookie write or --cookie write-pin where pin can be any alphanumeric string. On the exec, cancel-download, and term specify --cookie read or --cookie read-pin. The cookie generated by the host is managed in the user's work directory. A pin is required only when there are multiple simultaneous sessions.", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "examples": [ - { - "description": "Cancel a long running job. Show the status in returned JSON.\n\n Example", - "options": "--rfj --cookie \"EJESWEB_54761=DB856A...;path=/EjesWeb;Secure;HttpOnly\"" - } - ], - "handler": "", - "positionals": [], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "init", - "aliases": [ - "i" - ], - "summary": " - Issue an init request", - "description": "Creates an API session and optionally issues an API command. Returns items as requested by the -q and -c options. A Set-Cookie header is included in the response. The value of the returned cookie identifies the session and should be supplied as an argument on the --cookie option on subsequent API data, exec, and term requests. Cookies can be managed for you. See the --cookie option for details. Close the session with an API term request when it is no longer needed to free up system resources. Sessions that are idle for more than two minutes will be automatically closed. See the (E)JES REST API swagger documentation for details on the mapped options. Enclose all option arguments in double quotes if they include spaces, semicolons, or symbols that are reserved in your terminal shell or if they might otherwise be ambiguous to the shell.\n\nFor a command group overview, issue: zowe ejes api -h ", - "type": "command", - "options": [ - { - "name": "authorization", - "group": "Query Item Options", - "type": "string", - "description": "If you do not specify the --cookie option, you must include --user and --password or this option. The base64 encoded authentication string can be of the form userid:password or userid:group:password. If supplied, it overrides the profile user and password settings and starts a new session.", - "aliases": [] - }, - { - "name": "casKey", - "group": "Init Request Options", - "type": "string", - "description": "See the initParms model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "command", - "group": "Exec Request Options", - "type": "string", - "description": "See the execParms model in the Swagger documentation. The argument is a (E)JES command stack. Refer to chapter 5 of the (E)JES Reference.", - "aliases": [] - }, - { - "name": "platformencoding", - "group": "Platform-encoding Options", - "type": "number", - "description": "See the platformEncoding model in the Swagger documentation. Defaults to 1047 if not specified.", - "aliases": [] - }, - { - "name": "debug", - "group": "Debug Visualization Options", - "type": "number", - "description": "An additive flag for tech support use.\n\n1 - Commands discovered and compiled-options object\n\n2 - Request object\n\n4 - Response headers\n", - "aliases": [] - }, - { - "name": "columns", - "group": "Init Request Options", - "type": "string", - "description": "See the initParms model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "extractdd", - "group": "Init Request Options", - "type": "string", - "description": "See the initParms model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "ipaddress", - "group": "Init Request Options", - "type": "string", - "description": "See the initParms model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "luName", - "group": "Init Request Options", - "type": "string", - "description": "See the initParms model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "patterndd", - "group": "Init Request Options", - "type": "string", - "description": "See the initParms model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "rows", - "group": "Init Request Options", - "type": "string", - "description": "See the initParms model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "subsystem", - "group": "Init Request Options", - "type": "string", - "description": "See the initParms model in the Swagger documentation.", - "allowableValues": { - "values": [ - "jes2", - "jes3" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "useragent", - "group": "Init Request Options", - "type": "string", - "description": "See the initParms model in the Swagger documentation. Shows on the (E)JES Session panel and is a best practise to use.", - "aliases": [] - }, - { - "name": "cookie", - "group": "Query Item Options", - "type": "string", - "description": "Supply the cookie output by a stateful request. This option supports optional syntax to enable automatic management of the cookie without scraping from stdout.\n\n--cookie [|read[]|write[]\n\nThe CLI can manage a stateful cookie transaction proactively. On the init, specify --cookie write or --cookie write-pin where pin can be any alphanumeric string. On the exec, cancel-download, and term specify --cookie read or --cookie read-pin. The cookie generated by the host is managed in the user's work directory. A pin is required only when there are multiple simultaneous sessions.", - "aliases": [] - }, - { - "name": "c", - "group": "Query Item Options", - "type": "string", - "description": "A list of comma separated, case-insensitive names of columns to include in the response. If omitted, all columns for the current tabular display are included.\n\nThis parameter only applies to enumerated data containing columns, specifically, the columns and rows items of the q parameter.\n\nLimiting the included columns to only those you need can dramatically improve the resonse time of the request and significantly reduce system resources.", - "aliases": [] - }, - { - "name": "q", - "group": "Query Item Options", - "type": "string", - "description": "A list of comma separated, case-insensitive items to include in the response. If omitted, no items are included.\n\nLimiting the included items to only those you need can improve response time.\n\nThe following items are supported: columns, environment, execParms, find, function, initParms, jobs, keys, lines, loginfo, rows, lineCommands, message, notice, platformEncoding, position, screen, submittedJobs, userLog, and version. These represent the response properties as described in the models section of this help. The value all can be used to include all of the above items, but generally you should only request the items you need.", - "aliases": [] - }, - { - "name": "commanddata", - "group": "Exec Request Options", - "type": "string", - "description": "See the execParms model in the Swagger documentation. Insert \"\\n\" in the string to indicate line breaks.", - "aliases": [] - }, - { - "name": "commanddatafile", - "group": "Exec Request Options", - "type": "string", - "description": "See the execParms model in the Swagger documentation. The contents of the file are read and escaped properly for --commanddata. Uses EJES_SUBMIT_PATH for the path if it exists in the environment.", - "aliases": [] - }, - { - "name": "enumtime", - "group": "Exec Request Options", - "type": "number", - "description": "See the execParms model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "enumvalue", - "group": "Exec Request Options", - "type": "number", - "description": "See the execParms model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "showhiddencolumns", - "group": "Exec Request Options", - "type": "boolean", - "description": "See the execParms model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "translatescreen", - "group": "Exec Request Options", - "type": "boolean", - "description": "See the execParms model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "waitforresponse", - "group": "Exec Request Options", - "type": "boolean", - "description": "See the execParms model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "examples": [ - { - "description": "Initalize a session by using --command to display the status screen, then output the JCL of the first job. Use --enumValue to request 10 lines. The option -q requests the message array, lines of output, and the function array. Though browsed output is requested, if the first job does not have JCL, the status screen will be returned to show that the job that did not meet the criteria. The --rfj option visualizes the output as JSON. Without it, the CLI returns only the cookie.\n\n Example", - "options": "--command \"status;1 j\" --enumvalue 10 -q message,lines,function --rfj" - } - ], - "handler": "", - "positionals": [], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "exec", - "aliases": [ - "e" - ], - "summary": " - Issue an exec request", - "description": "Executes an API command in an existing (stateful) or new transient (stateless) session.\n\nReturns items as requested by the query parameters. An existing session is used when a valid cookie is used as an argument on the --cookie option. This is the preferred scenario when multiple transactions are expected since it provides significant performance benefits. It requires server affinity for sessions in a clustered server environment.\n\nA new transient session will be created if a --authorization or --user option is provided and a --cookie option is not. A transient session exists only for the current transaction and meets the goal of statelessness as defined by ROA and REST. However, it is much less efficient than using an existing session across multiple transactions, and does not preserve the state of the underlying (E)JES API. Nevertheless, it is the prefered scenario where a single transaction and statelessness suffice.\n\nSee the (E)JES REST API swagger documentation for details on the mapped options. Enclose all option arguments in double quotes if they include spaces, semicolons, or symbols that are reserved in your terminal shell or if they might otherwise be ambiguous to the shell. Options flagged with \"initParms model\" are valid only for stateless transactions on the exec command.\n\nFor a command group overview, issue: zowe ejes api -h ", - "type": "command", - "options": [ - { - "name": "authorization", - "group": "Query Item Options", - "type": "string", - "description": "If you do not specify the --cookie option, you must include --user and --password or this option. The base64 encoded authentication string can be of the form userid:password or userid:group:password. If supplied, it overrides the profile user and password settings and starts a new session.", - "aliases": [] - }, - { - "name": "casKey", - "group": "Init Request Options", - "type": "string", - "description": "See the initParms model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "command", - "group": "Exec Request Options", - "type": "string", - "description": "See the execParms model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "amount", - "group": "PDF and TEXT Common Options", - "type": "number", - "description": "See the pdf or text model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "decorate", - "group": "PDF Download Options", - "type": "string", - "description": "See the pdf model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "allowassembly", - "group": "PDF Security Property Options", - "type": "boolean", - "description": "See the pdf model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "bcc", - "group": "Mail Options", - "type": "string", - "description": "See the mail model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "platformencoding", - "group": "Platform-encoding Options", - "type": "number", - "description": "See the platformEncoding model in the Swagger documentation. Defaults to 1047 if not specified.", - "aliases": [] - }, - { - "name": "debug", - "group": "Debug Visualization Options", - "type": "number", - "description": "An additive flag for tech support use.\n\n1 - Commands discovered and compiled-options object\n\n2 - Request object\n\n4 - Response headers\n", - "aliases": [] - }, - { - "name": "blockid", - "group": "PDF and TEXT Common Options", - "type": "number", - "description": "See the pdf or text model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "cc", - "group": "PDF and TEXT Common Options", - "type": "string", - "description": "See the pdf or text model in the Swagger documentation. (Carriage-control)", - "aliases": [] - }, - { - "name": "count", - "group": "PDF and TEXT Common Options", - "type": "number", - "description": "See the pdf or text model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "recordid", - "group": "PDF and TEXT Common Options", - "type": "number", - "description": "See the pdf or text model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "start", - "group": "PDF and TEXT Common Options", - "type": "number", - "description": "See the pdf or text model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "todend", - "group": "PDF and TEXT Common Options", - "type": "number", - "description": "See the pdf or text model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "todstart", - "group": "PDF and TEXT Common Options", - "type": "number", - "description": "See the pdf or text model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "font", - "group": "PDF Download Options", - "type": "string", - "description": "See the pdf model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "orientation", - "group": "PDF Download Options", - "type": "string", - "description": "See the pdf model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "overflow", - "group": "PDF Download Options", - "type": "string", - "description": "See the pdf model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "pagesize", - "group": "PDF Download Options", - "type": "string", - "description": "See the pdf model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "allowcopying", - "group": "PDF Security Property Options", - "type": "boolean", - "description": "See the pdf model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "allowmodification", - "group": "PDF Security Property Options", - "type": "boolean", - "description": "See the pdf model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "allowprinting", - "group": "PDF Security Property Options", - "type": "boolean", - "description": "See the pdf model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "masterpassword", - "group": "PDF Security Property Options", - "type": "string", - "description": "See the pdf model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "openpassword", - "group": "PDF Security Property Options", - "type": "string", - "description": "See the pdf model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "body", - "group": "Mail Options", - "type": "string", - "description": "See the mail model in the Swagger documentation. Insert \"\\n\" in the string to indicate line breaks.", - "aliases": [] - }, - { - "name": "bodyfile", - "group": "Mail Options", - "type": "string", - "description": "See the mail model in the Swagger documentation. The contents of the file are read and escaped properly for --body. Uses EJES_SUBMIT_PATH for the path if it exists in the environment.", - "aliases": [] - }, - { - "name": "carboncopy", - "group": "Mail Options", - "type": "string", - "description": "See the cc property the mail model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "from", - "group": "Mail Options", - "type": "string", - "description": "See the mail model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "html", - "group": "Mail Options", - "type": "string", - "description": "See the mail model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "subject", - "group": "Mail Options", - "type": "string", - "description": "See the mail model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "to", - "group": "Mail Options", - "type": "string", - "description": "See the mail model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "columns", - "group": "Init Request Options", - "type": "string", - "description": "See the initParms model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "extractdd", - "group": "Init Request Options", - "type": "string", - "description": "See the initParms model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "ipaddress", - "group": "Init Request Options", - "type": "string", - "description": "See the initParms model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "luName", - "group": "Init Request Options", - "type": "string", - "description": "See the initParms model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "patterndd", - "group": "Init Request Options", - "type": "string", - "description": "See the initParms model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "rows", - "group": "Init Request Options", - "type": "string", - "description": "See the initParms model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "subsystem", - "group": "Init Request Options", - "type": "string", - "description": "See the initParms model in the Swagger documentation.", - "allowableValues": { - "values": [ - "jes2", - "jes3" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "useragent", - "group": "Init Request Options", - "type": "string", - "description": "See the initParms model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "cookie", - "group": "Query Item Options", - "type": "string", - "description": "Supply the cookie output by a stateful request. This option supports optional syntax to enable automatic managment of the cookie without scraping from stdout.\n\n--cookie [|read[]|write[]\n\nThe CLI can manage a stateful cookie transaction proactively. On the init, specify --cookie write or --cookie write-pin where pin can be any alphanumeric string. On the exec, cancel-download, and term specify --cookie read or --cookie read-pin. The cookie generated by the host is managed in the user's work directory. A pin is required only when there are multiple simultaneous sessions.", - "aliases": [] - }, - { - "name": "c", - "group": "Query Item Options", - "type": "string", - "description": "A list of comma separated, case-insensitive names of columns to include in the response. If omitted, all columns for the current tabular display are included.\n\nThis parameter only applies to enumerated data containing columns, specifically, the columns and rows items of the q parameter.\n\nLimiting the included columns to only those you need can dramatically improve the resonse time of the request and significantly reduce system resources.", - "aliases": [] - }, - { - "name": "q", - "group": "Query Item Options", - "type": "string", - "description": "A list of comma separated, case-insensitive items to include in the response. If omitted, no items are included.\n\nLimiting the included items to only those you need can improve response time.\n\nThe following items are supported: columns, environment, execParms, find, function, initParms, jobs, keys, lines, loginfo, rows, lineCommands, message, notice, platformEncoding, position, screen, submittedJobs, userLog, and version. These represent the response properties as described in the models section of this help. The value all can be used to include all of the above items, but generally you should only request the items you need.", - "aliases": [] - }, - { - "name": "d", - "group": "Query Item Options", - "type": "string", - "description": "A download type, either pdf or text.\n\nWhen specified, all other query parameters are ignored. The Content-Type response header will report either application/pdf or text/plain (charset utf-8) if no error occurred, and application/json if an error occurred. If no error occurred, a Content-Disposition response header will supply a suggested filename.\n\nA pdf or text property may be included in the POST data to override default pdf and text formatting options.\n\nThis parameter provides pdf or text data in the output stream and does not require enumeration.\n\nThe API must be positioned on a browser type display to download data. Afterwards, the positioning may have changed depending on the amount specified.\n\nYou can use CancelDownload to cancel a long running download.", - "aliases": [] - }, - { - "name": "m", - "group": "Query Item Options", - "type": "string", - "description": "A mail attachment type, either pdf or text.\n\nAt a minimum, a mail property is required in the POST data to specify one or more recipients. A pdf or text property may also be included to override default pdf and text formatting options.\n\nThe API must be positioned on a browser type display to send a mail attachment. Afterwards, the positioning may have changed depending on the amount specified.\n\nNote that you cannot use CancelDownload to cancel a long running mail attachement request because the response \ncontaining the needed Cookie is not sent until after mail has been sent.", - "aliases": [] - }, - { - "name": "commanddata", - "group": "Exec Request Options", - "type": "string", - "description": "See the execParms model in the Swagger documentation. Insert \"\\n\" in the string to indicate line breaks.", - "aliases": [] - }, - { - "name": "commanddatafile", - "group": "Exec Request Options", - "type": "string", - "description": "The contents of this file (usually JCL on the local workstation file system) must be escaped properly for --commanddata. See the execParms model in the Swagger documentation. Uses EJES_SUBMIT_PATH for the path if it exists in the environment.", - "aliases": [] - }, - { - "name": "enumtime", - "group": "Exec Request Options", - "type": "number", - "description": "See the execParms model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "enumvalue", - "group": "Exec Request Options", - "type": "number", - "description": "See the execParms model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "showhiddencolumns", - "group": "Exec Request Options", - "type": "boolean", - "description": "See the execParms model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "translatescreen", - "group": "Exec Request Options", - "type": "boolean", - "description": "See the execParms model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "waitforresponse", - "group": "Exec Request Options", - "type": "boolean", - "description": "See the execParms model in the Swagger documentation.", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "examples": [ - { - "description": "Perform a stateless transaction that submits a job using the --command option. It shows the status of jobs with the same name, sorting so the most recent is shown first. The --enumvalue option is requesting the top 5 lines. The query parameter -q is requesting the message array that will contain the submit result, lines of output, and the array of jobs submitted in this session. The --commanddata option supplies the JCL to submit referred to by the \"api-array\". The \"\\n\" are line separators an editor would supply.\n\n Example", - "options": "--command \"submit api-array;st iefbr14;sort time d;upd\" --enumvalue 5 -q message,lines,submittedJobs --rfj --commanddata \"//IEFBR14 JOB IEFBR14,'IEFBR14',CLASS=A,MSGCLASS=H\\n//EXEC EXEC PGM=IEFBR14\\n//\"" - }, - { - "description": "Perform the same stateless transaction above but use the --commanddatafile option to read a file from the workstation. If EJES_SUBMIT_PATH is defined in the environment, that will be used as the file path, otherwise the same directory the CLI is run in will be used if a full path is not supplied.\n\n Example", - "options": "--command \"submit api-array;st iefbr14;sort time d;upd\" --enumvalue 5 -q message,lines,submittedJobs --rfj --commanddatafile \"iefbr14.jcl\"" - }, - { - "description": "Perform a stateful request. In this case, a previous request positioned the (E)JES api in a job browser. This example downloads the file as PDF using the -d option. It causes the carriage control symbols to be interpretted with the --cc option. Then specifies stateful session with the cookie it generated specified on the --cookie option. The sysout is download to a file with the name consistent with the browsed data set or browser. If EJES_DOWNLOAD_PATH exists in the environment, the path is used for the download. Otherwise, the file is created in the current working directory. (For managed cookie stateful request examples, issue: Zowe ejes api -h)\n\n Example", - "options": "-d text --cc interpret --cookie \"EJESWEB_54761=B6910D...;path=/EjesWeb;Secure;HttpOnly\"" - } - ], - "handler": "", - "positionals": [], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "term", - "aliases": [ - "t" - ], - "summary": " - Issue a term request", - "description": "Terminates the API session.\n\nFor a command group overview, issue: zowe ejes api -h ", - "type": "command", - "examples": [ - { - "description": "Terminate an existing session by specifying the session on the --cookie option. No output is returned if the transaction completes without error.\n\n Example", - "options": "--cookie \"EJESWEB_54761=0F6E5A...;path=/EjesWeb;Secure;HttpOnly\"" - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "positionals": [], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - } - ], - "pluginHealthCheck": "./lib/healthCheck.handler", - "passOn": [ - { - "property": "profile", - "value": { - "required": [ - "ejes" - ] - }, - "merge": false, - "ignoreNodes": [ - { - "type": "group" - } - ] - }, - { - "property": "options", - "value": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options" - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options" - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - } - ], - "merge": true, - "ignoreNodes": [ - { - "type": "group" - } - ] - }, - { - "property": "options", - "value": [ - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - } - ], - "merge": true, - "ignoreNodes": [ - { - "type": "group" - } - ] - } - ], - "examples": [ - { - "description": "This is an example of a init request to position sysout (to download with a subsequent stateful request) using cookie management. Note the --cookie write option. Most of your stateful transaction scripts will be written this way. The --command option contains (E)JES host commands. Refer to the (E)JES Reference for details of the argument for that option.\n\n Example", - "options": "init --cookie write --command \"status hrlyjba;1 b\"" - }, - { - "description": "This downloads the above sysout as a pdf using cookie management The -rfj (--request-format-json) output json includes the PDF file name of the sysout.\n\n Example", - "options": "exec -d pdf --cc interpret --rfj --cookie read" - }, - { - "description": "This example uses the same cookie-managed session as above to download another sysout. The --command option argument string runs first, then the download. The order of options does not matter.\n\n Example", - "options": "exec -d pdf --cc interpret --command \"status hrlyjbb;1b\" --rfj --cookie read" - }, - { - "description": "This terminates the session and deletes the cookie.\n\n Example", - "options": "term --cookie read" - }, - { - "description": "Cancel a long running download. If you had needed to cancel the above download, with cookie management, you would have done it this way. The status is in returned JSON.\n\n Example", - "options": "cancel-download --rfj --cookie read" - }, - { - "description": "Initalize a session by using --command to display the status screen, then output the JCL of the first job. Use --enumValue to request 10 lines. The option -q requests the message array, lines of output, and the function array. Though browsed output is requested, if the first job does not have JCL, the status screen will be returned to show that the job that did not meet the criteria. The --rfj option visualizes the output as JSON. Without it, the CLI returns only the cookie.\n\n Example", - "options": "init --command \"status;1 j\" --enumvalue 10 -q message,lines,function --rfj" - }, - { - "description": "Perform a stateless transaction that submits a job using the --command option. It shows the status of jobs with the same name, sorting so the most recent is shown first. The --enumvalue option is requesting the top 5 lines. The query parameter -q is requesting the message array that will contain the submit result, lines of output, and the array of jobs submitted in this session. The --commanddata option supplies the JCL to submit referred to by the \"api-array\". The \"\\n\" are line separators an editor would supply.\n\n Example", - "options": "exec --command \"submit api-array;st iefbr14;sort time d;upd\" --enumvalue 5 -q message,lines,submittedJobs --rfj --commanddata \"//IEFBR14 JOB IEFBR14,'IEFBR14',CLASS=A,MSGCLASS=H\\n//EXEC EXEC PGM=IEFBR14\\n//\"" - }, - { - "description": "Perform the same stateless transaction above but use the --commanddatafile option to use a file on the workstation. If EJES_SUBMIT_PATH is defined in the environment, that will be used as the file path, otherwise the same directory the CLI is run in will be used if a full path is not supplied.\n\n Example", - "options": "exec --command \"submit api-array;st iefbr14;sort time d;upd\" --enumvalue 5 -q message,lines,submittedJobs --rfj --commanddatafile \"iefbr14.jcl\"" - } - ], - "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": [] - }, - { - "children": [ - { - "name": "cmdstack", - "aliases": [ - "cmd", - "stack", - "stk" - ], - "summary": "# Shell a command stack.", - "description": "Issues a starting command stack. It connects to the host and allows you to use an enhanced set of EJES BATCH commands.", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "A required command stack enclosed in double-quotes. The command stack may contain meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For information about (E)JES host primary commands and their parameters, read Chapter 5 (E)JES Commands in the (E)JES Reference.", - "required": true - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (starts with blanks on)", - "type": "string", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "resume", - "description": "For use with the pause meta command. Use \"off\" to prevent resuming an auto pin session.", - "type": "array", - "aliases": [ - "r" - ], - "group": "Options" - }, - { - "name": "screen", - "description": "Display host screen output to stderr.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "profile": { - "required": [ - "ejes" - ] - }, - "passOn": [], - "children": [] - }, - { - "name": "shell", - "aliases": [ - "sh", - "prompt" - ], - "summary": "# Start the EJES Batch Shell without logging in.", - "description": "Starts the EJES Batch Shell without logging on. It allows you to connect to the host and use an enhanced set of EJES BATCH commands.", - "type": "command", - "handler": "", - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (starts with blanks on)", - "type": "string", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "resume", - "description": "For use with the pause meta command. Use \"off\" to prevent resuming an auto pin session.", - "type": "array", - "aliases": [ - "r" - ], - "group": "Options" - }, - { - "name": "screen", - "description": "Display host screen output to stderr.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "activity", - "aliases": [ - "ac" - ], - "summary": "* Display job activity.", - "description": "Display jobs in all active address spaces for the JESplex or sysplex, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain invocation primary selection criteria, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "apfds", - "aliases": [ - "apf" - ], - "summary": "* APF-authorized libraries.", - "description": "Display APF-authorized libraries defined to the systems in your sysplex, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "class", - "aliases": [ - "cl" - ], - "summary": "* Display job classes.", - "description": "Display job classes defined for the JESplex, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "command", - "alias": [ - "com" - ], - "summary": "* Display the long command processor.", - "description": "Display the long command processor, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "aliases": [], - "passOn": [], - "children": [] - }, - { - "name": "djc", - "aliases": [ - "dj" - ], - "summary": "* Display JES3 dependent job network.", - "description": "Display a table of Dependent Job Control networks in the JESplex, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "dynexit", - "aliases": [ - "dynex", - "dynx" - ], - "summary": "* Display dynamic exits.", - "description": "Display a table of MVS dynamic exits defined within the current sysplex, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "enclave", - "aliases": [ - "enc" - ], - "summary": "* Display enclaves.", - "description": "Display a table of WLM enclaves defined within the JESplex, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain an invocation system selection override and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "enq", - "summary": "* Display ENQs.", - "description": "Display a table of information about ENQs and RESERVEs in the sysplex, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "aliases": [], - "passOn": [], - "children": [] - }, - { - "name": "enqc", - "summary": "* Display ENQ contentions.", - "description": "Display a table of information about ENQ contention in the sysplex, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "aliases": [], - "passOn": [], - "children": [] - }, - { - "name": "enqd", - "summary": "* Display ENQ SYSDSN resources.", - "description": "Display a table of information about ENQ SYSDSN resources in the sysplex, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "aliases": [], - "passOn": [], - "children": [] - }, - { - "name": "entry", - "aliases": [ - "ent" - ], - "summary": "* Display entry panel.", - "description": "Display the (E)JES entry panel, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "fss", - "summary": "* Display functional subsystems.", - "description": "Display a table of Functional Subsystems defined for the JESplex, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "aliases": [], - "passOn": [], - "children": [] - }, - { - "name": "group", - "aliases": [ - "gr" - ], - "summary": "* Display job class groups.", - "description": "Display a table of Generalized Main Scheduler parameters for job class groups in the JESplex, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "hcheck", - "aliases": [ - "hchk", - "hc" - ], - "summary": "* Display health checks.", - "description": "Display a table of the about checks registered with IBM Health Checker for z/OS, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "hold", - "aliases": [ - "h" - ], - "summary": "* Display jobs in hold status.", - "description": "Display a table of the sysout in the Hold queue, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain invocation primary selection criteria and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "init", - "summary": "* Display JES2 initiators.", - "description": "Display a table of JES2-managed batch initiators defined for the JESplex, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain invocation primary selection criteria and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "aliases": [], - "passOn": [], - "children": [] - }, - { - "name": "input", - "aliases": [ - "i" - ], - "summary": "* Display jobs in input status.", - "description": "Display a table of all jobs in the JESplex that are in pre-execution and execution status, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "jesplex", - "aliases": [ - "jesp" - ], - "summary": "* Display JESplex table.", - "description": "Display a table of JES images in your z/OS JESplex, then enter the EJES Batch Shell. A JES2 JESplex is also known as a Multi-Access SPOOL configuration or MAS. A JES3 JESplex is also known as a JES3 complex. ", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "jgroup", - "aliases": [ - "jg" - ], - "summary": "* Display job groups.", - "description": "Display a table of the active job groups in the JESplex, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "line", - "aliases": [ - "li" - ], - "summary": "* Display JES3 dependent job network.", - "description": "Display a table of the lines that connect NJE nodes to your JESplex, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "lnklst", - "aliases": [ - "lnkl", - "lnk" - ], - "summary": "* Display link list data sets.", - "description": "Display a table of data sets in the link list concatenation of the link list libraries defined to the systems in your sysplex, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "lpalst", - "aliases": [ - "lpal", - "lpa" - ], - "summary": "* Display link pack data sets.", - "description": "Display a table of data sets in the LPA concatenation of the link pack libraries defined to the systems in your sysplex, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "log", - "summary": "* Display the log.", - "description": "Display the log, then enter the EJES Batch Shell. You may optionally specify operlog or syslog, or command stack 'logattr on' to see the operlog display in MCS Console colors.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "aliases": [], - "passOn": [], - "children": [] - }, - { - "name": "mds", - "aliases": [ - "md" - ], - "summary": "* Display JES3 MDS jobs.", - "description": "Display a table of jobs in the JESplex that are currently delayed in one of the Main Device Scheduler queues, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain invocation primary selection criteria and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "memusage", - "aliases": [ - "memuse", - "memu" - ], - "summary": "* Display memory usage tabl.", - "description": "Display a table of real and virtual memory requirements of jobs and other tasks running within your sysplex, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "menu", - "summary": "* Display or control the (E)JES menu.", - "description": "Display or control the (E)JES menu, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "aliases": [], - "passOn": [], - "children": [] - }, - { - "name": "mounts", - "aliases": [ - "mount", - "mo" - ], - "summary": "* Display z/OS UNIX mounts.", - "description": "Display a table of mounted file systems within the sysplex, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "netconn", - "aliases": [ - "netc", - "nc" - ], - "summary": "* Display network job entry connections.", - "description": "Display a table of NJE (Network Job Entry) connection, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "netserv", - "aliases": [ - "nets" - ], - "summary": "* Display network servers.", - "description": "Display a table of NJE network servers, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain an invocation system selection override and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "nje", - "summary": "* Display JES3 NJE sysout.", - "description": "Display a table of sysout in the Bulk Data Transfer and TCP/IP NJE queues, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain invocation primary selection criteria and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "aliases": [], - "passOn": [], - "children": [] - }, - { - "name": "node", - "aliases": [ - "ph" - ], - "summary": "* Display NJE nodes.", - "description": "Display a table of the NJE nodes defined to the JESplex, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "nop", - "summary": "# Start/resume session with no operation.", - "description": "Start or resume a session with no operation. Most useful in conjunction with --resume.", - "type": "command", - "handler": "", - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (starts with blanks on)", - "type": "string", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "resume", - "description": "For use with the pause meta command. Use \"off\" to prevent resuming an auto pin session. Most useful in conjunction with --resume.", - "type": "array", - "aliases": [ - "r" - ], - "group": "Options" - }, - { - "name": "screen", - "description": "Display host screen output to stderr.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "profile": { - "required": [ - "ejes" - ] - }, - "aliases": [], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "offload", - "aliases": [ - "off" - ], - "summary": "* Display JES2 spool offloader devices.", - "description": "Display a table of the JES2 spool offload devices in your JESplex, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "Output", - "aliases": [ - "o" - ], - "summary": "* Display JES2 output sysout.", - "description": "Display a table of sysout in the JES2 Output queue, then enter the EJES Batch Shell. The interchangeable terms Output queue and Writer queue are used by the two JESes to describe the queue from which JES-managed or FSS-managed printers can select work.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "pageds", - "aliases": [ - "pag", - "page", - "paged" - ], - "summary": "* Display page data set resources.", - "description": "Display a table of paging resources defined to the systems in your sysplex, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "parmlib", - "aliases": [ - "parml", - "parm" - ], - "summary": "* Display parameter library data sets.", - "description": "Display a table of information about system parameter libraries defined to the systems in your sysplex, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "printer", - "aliases": [ - "pr" - ], - "summary": "* Display printers and punches.", - "description": "Display a table of JES writers which drive local, FSS, and signed-on/logged-on remote printer and punch devices attached to the JESplex, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "proclib", - "aliases": [ - "procl", - "proc" - ], - "summary": "* Display proclib data sets.", - "description": "Display a table of information about your JES proclib concatenations, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "pstatus", - "aliases": [ - "pstat", - "ps" - ], - "summary": "* Display UNIX process statuses.", - "description": "Display a table of z/OS UNIX processes running in the JESplex, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "query", - "summary": "* Display your authorization.", - "description": "Display displays or primary commands your credentials authorize, then enter the EJES Batch Shell. The positional operand is required and may be 'auth' or 'auth display'.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": true - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "aliases": [], - "passOn": [], - "children": [] - }, - { - "name": "resmon", - "aliases": [ - "resm", - "rmon", - "rm" - ], - "summary": "* Display JES2 resource monitor.", - "description": "Display a table of JES resources for the JESplex, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "resource", - "aliases": [ - "reso" - ], - "summary": "* Display WLM resources.", - "description": "Display a table of the WLM Resources defined for the current sysplex, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "schenv", - "aliases": [ - "sch" - ], - "summary": "* Display WLM scheduling environments.", - "description": "Display a table of the WLM Scheduling Environments defined for the current sysplex, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "session", - "aliases": [ - "sess" - ], - "summary": "* Display (E)JES session activity.", - "description": "Display a table of all active (E)JES sessions, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "spart", - "aliases": [ - "spa" - ], - "summary": "* Display spool partitions.", - "description": "Display a table of the SPOOL partition configuration of your JESplex, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "spvol", - "aliases": [ - "spv" - ], - "summary": "* Display spool volume extents.", - "description": "Display a table of the SPOOL volume extent configuration of your JESplex, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "status", - "aliases": [ - "st" - ], - "summary": "* Display job status.", - "description": "Display jobs in the JESplex, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain invocation primary selection criteria and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "subsys", - "aliases": [ - "subsy", - "subs" - ], - "summary": "* Display MVS subsystems.", - "description": "Display a table of all the MVS subsystems defined to the systems in your sysplex, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain invocation primary selection criteria and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "symbol", - "aliases": [ - "sym" - ], - "summary": "* Display system symbols.", - "description": "Display a table of z/OS system symbols as well as JES and JCL symbols defined for the current address space, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "syscls", - "aliases": [ - "sysc" - ], - "summary": "* Display sysout classes.", - "description": "Display a table of the sysout class configuration for your JESplex, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "sysplex", - "aliases": [ - "sysp", - "sys" - ], - "summary": "* Display sysplex members.", - "description": "Display a table of the connected system images in your z/OS sysplex, then enter the EJES Batch Shell. In a monoplex, you manage the current system only (i.e., the image on which your (E)JES session is executing).", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain an invocation system selection override and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "sysreq", - "aliases": [ - "sysr", - "sr" - ], - "summary": "* Display system requests.", - "description": "Display a table of outstanding replies and messages retained by the MVS Action Message Retention Facility (AMRF), then enter the EJES Batch Shell. Outstanding replies and action messages for the entire sysplex are shown.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "ulog", - "aliases": [ - "ph" - ], - "summary": "* Display your ULOG.", - "description": "Display the user log console browser, then enter the EJES Batch Shell. The optional parameter allows you to specify a console name other than that which would normally be chosen automatically. Please refer to the CONSOLE command documentation for considerations when specifying a console name.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "writer", - "aliases": [ - "w" - ], - "summary": "* Display JES3 writer sysout.", - "description": "Display a table of sysout in the JES3 Writer queue, then enter the EJES Batch Shell. The interchangeable terms Output queue and Writer queue are used by the two JESes to describe the queue from which JES-managed or FSS-managed printers can select work.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "zero", - "aliases": [ - "z" - ], - "summary": "* Display JES3 Job zero sysout datasets.", - "description": "Display a table of sysout data sets created by JES3 internal facilities, then enter the EJES Batch Shell.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "ejes" - ] - }, - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "options": [ - { - "name": "blanks", - "description": "Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "b" - ], - "group": "Options" - }, - { - "name": "cmdstack", - "description": "Start with a host command stack, separated by semicolons and enclosed in quotes.", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "autoupdate", - "description": "Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "a", - "aup" - ], - "group": "Options" - }, - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv", - "debug-value" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "echo", - "description": "Display host screen output to stdout. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "e" - ], - "group": "Options" - }, - { - "name": "inactivity", - "type": "number", - "aliases": [ - "i" - ], - "description": "Specify host activity timeout in minutes (starts set to 2).", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "screen", - "description": "Display host screen output to stderr. Off by default. Specify with no argument to turn on.", - "type": "array", - "aliases": [ - "s" - ], - "group": "Options" - }, - { - "name": "terminal", - "description": "Set terminal emulation size or type. String: [*|[[,|x] ]|[2|3|4|5]", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "quiet", - "description": "Prevent output of interactive details, including version title on start and exit code on exit.", - "type": "array", - "aliases": [ - "q" - ], - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "children": [] - } - ], - "name": "batch", - "aliases": [ - "b", - "bat" - ], - "summary": "- A shell environment that emulates using (E)JES on the host.", - "description": "The (E)JES batch interface provides much of the power of the on-line environment to automated programs or scripts.\n\nUsing the batch interface, procedures may be created that issue commands or alter other resources based upon the condition of jobs in the JESplex and the contents of spool information (e.g., reports, condition codes, JES messages) produced by those jobs. System housekeeping functions containing (E)JES batch procedures may be submitted at scheduled times, on demand, or when certain system conditions are met. Practically any function that requires access to spool or other (E)JES-provided information can be automated.", - "type": "group", - "pluginHealthCheck": "./lib/healthCheck.handler", - "passOn": [ - { - "property": "profile", - "value": { - "required": [ - "ejes" - ] - }, - "merge": false, - "ignoreNodes": [ - { - "type": "group" - } - ] - }, - { - "property": "options", - "value": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options" - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options" - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - } - ], - "merge": true, - "ignoreNodes": [ - { - "type": "group" - } - ] - }, - { - "property": "options", - "value": [ - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "issue", - "aliases": [ - "i" - ], - "summary": "- Issue a system command on the host, if authorized.", - "description": "Issue a system command by sending the positional parameters to the host. (E)JES will respond with output sent to your user log.", - "type": "group", - "pluginHealthCheck": "./lib/healthCheck.handler", - "passOn": [ - { - "property": "profile", - "value": { - "required": [ - "ejes" - ] - }, - "merge": false, - "ignoreNodes": [ - { - "type": "group" - } - ] - }, - { - "property": "options", - "value": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options" - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options" - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - } - ], - "merge": true, - "ignoreNodes": [ - { - "type": "group" - } - ] - }, - { - "property": "options", - "value": [ - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - } - ], - "merge": true, - "ignoreNodes": [ - { - "type": "group" - } - ] - } - ], - "children": [ - { - "name": "syscmd", - "aliases": [ - "s" - ], - "summary": "Issue a system command", - "description": "Issue a system command and receive console output as a report in text format.", - "options": [ - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "dry-run", - "type": "array", - "aliases": [ - "n" - ], - "description": "Run under dry-run protocols.", - "group": "Options" - }, - { - "name": "jes2", - "type": "boolean", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "type": "boolean", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "lines", - "type": "string", - "aliases": [ - "y" - ], - "description": "Maximum lines in a table or report. [1000 | tty-default | number | all]", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "width", - "type": "string", - "aliases": [ - "x" - ], - "description": "Maximum characters per line or row. [tty-default | number | all]", - "group": "Options" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "examples": [ - { - "description": "Display the time", - "options": "\"d t\"" - }, - { - "description": "Display time and ppt", - "options": "\"d t;/d ppt\"" - } - ], - "type": "command", - "positionals": [ - { - "name": "command", - "type": "string", - "description": "System console command enclosed in double-quotes. If you wish to issue multiple commands, follow each command with a semicolon and a slash(;/)", - "required": true - } - ], - "handler": "", - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "submit", - "aliases": [ - "sub" - ], - "summary": "Submit a local or host file to the host.", - "description": "Submit a job from the local host with the local: prefix, or a MVS data set or z/OS UNIX path. Responds with submission messages and a table providing a description of a successful submission.", - "options": [ - { - "name": "debug", - "type": "number", - "aliases": [ - "dbg", - "dv" - ], - "description": "Specify a numeric debugging mode.", - "group": "Options" - }, - { - "name": "jes2", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "jes3", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "group": "Options" - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "lrecl", - "type": "number", - "description": "Logical record length.", - "group": "Options", - "aliases": [] - }, - { - "name": "recfm", - "type": "string", - "allowableValues": { - "values": [ - "f", - "v", - "list", - "help" - ], - "caseSensitive": true - }, - "description": "Record format of fixed or variable length.", - "group": "Options", - "aliases": [] - }, - { - "name": "subsys", - "type": "string", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": true - }, - "description": "Subsystem name where the job should be sent. If not specified defaults to the subsystem under which the current (E)JES session is running. For JES3plus, use jes3.", - "group": "Options", - "aliases": [] - }, - { - "name": "unit", - "type": "string", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "group": "Options", - "aliases": [] - }, - { - "name": "volume", - "type": "string", - "description": "Volume serial where an uncataloged MVS data set resides.", - "group": "Options", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "examples": [ - { - "description": "Submit a local workstation file", - "options": "\"local:iefbr14.jcl\" --lrecl 132 --subsys jes3" - }, - { - "description": "Submit a local workstation file using arguments", - "options": "\"local:iefbr14.jcl lrecl(132) subsys(jes3)\"" - }, - { - "description": "Submit a clist member", - "options": "\"a.cntl(iefbr14)\"" - } - ], - "type": "command", - "positionals": [ - { - "name": "command", - "type": "string", - "description": "Any of MVS data set name, z/OS UNIX path name, or a workstation file prefixed by 'local:'. The environment variable EJES_SUBMIT_PATH is used to provide a path for a local workstation file if only a file name is provided. When not present, the current working directory is used instead. While the use of the command line options below is recommended, you may instead append to the command string arguments for the submit command listed in the (E)JES Reference.", - "required": true - } - ], - "handler": "", - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "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" - } - ], - "positionals": [] - }, - { - "name": "log", - "summary": "- Output syslog/operlog to stdout.", - "description": "Output the tail end of the host log to stdout, optionally streaming new records. Positioning, searching, and limiting options are supported, including specifying which log type and what system.", - "type": "group", - "children": [ - { - "name": "stream", - "summary": "- Tail or stream operlog or syslog to stdout.", - "description": "Outputs the operations log or system log to stdout. Behaves like a Linux tail function with support for standard tail options --follow (-f), --lines (-n), -q, -v, and --version.\n\n Set the position in the log to begin output using --find, --line, --time, and --offset. \n\n Use OPERLOG Message Filtering Options to create a windowed log by filtering for and outputting only lines that fit criteria, e.g., fetch only lines associated with an IAT6xxxx message by specifying: --msgId \"IAT6*\". After filtering the log, output is positioned at the bottom. Use position options to change that.\n\n Turn on highlighting for --find using --hilite. Perform regex text matching with highlighting using --match. Enable MCS console color emulation with --mcs. To prevent ANSI escape characters from being output and to instead use accessibility-friendly text-only indicators, specify: --nocolor \"on\".\n\n The order of host commands issued during initialization are fixed in this program in this order:\n\n1. All OPERLOG message filtering options, e.g., --msgId and --msgTxt \n\n2. --line \n\n3. --time \n\n4. --find \n\n5. --offset \n\n Conceptually and depending on specified options, the program can create a window into the log data using message filtering options, then can point to a line in the data such as the first line, then can position at a time, then find arbitrary text, then offset the view up and down by seconds to days or a number of lines.\n\n The program outputs trailer diagnostic lines at the end of the run to stderr. Use this information to make your queries more efficient. The trailer and header lines can be muted using the --quiet (-q) option or setting the EJES_LOG_CLI_QUIET environment variable. The program outputs a bottom-of-data line to stdout that is considered an output line by --lines with a line-count argument. To disable it, set the EJES_LOG_CLI_NO_BOTTOM environment variable.", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "log-type", - "type": "string", - "description": "Optional. If not specified, the Operations Log is output if the Operations Log is active for the current MVS system. Otherwise, the System Log is output.", - "regex": "operlog|oper|o|syslog|sys|s" - } - ], - "options": [ - { - "name": "follow", - "aliases": [ - "f", - "nonstop", - "ns" - ], - "description": "Follow the log stream. Displays last page of log then waits for more data. Ignored for --response-format-json. The actual maximum duration is controlled by your host refresh command settings.", - "type": "boolean", - "group": "Options" - }, - { - "name": "lines", - "description": "Limit output to a number of lines or a time span. 10 lines is used if the option is not specified.\n\n Specify a maximum number of lines up to 999,999 lines (supports multipliers), or specify a time span of 0.01 to 999 seconds, minutes, hours, or days by specifying a number followed by \"s\", \"m\", \"h\", or \"d\". Specify \"all\" for unlimited output.\n\n When --request-format-json (--rfj) is specified, the number of lines up to 5,000 specified on this option (or the default of 10) determines the number of lines fetched from the host and stored in the output json data array. With --rfj, this option overrides --enumValue.\n\n Supports Linux positioning syntax of + followed by a line number. This is the same as specifying --line n --lines all. When the intent is to fetch middle lines from the log, use --line to position and --lines to limit the count.\n\n Note: When there are no positioning requests, the program attempts to get the bottom n lines. However, the log is a dynamic data set and the actual log type may be different than assumed. The bottom-of-data line will output only if the number of lines is not exceeded when bottom is found.", - "type": "array", - "aliases": [ - "n" - ], - "allowableValues": { - "values": [ - "all", - "^(?:[1-9]|\\d\\.)\\d{0,2}[smhd]$", - "^[1-9]\\d{0,5}$", - "^\\+[1-9]\\d*$", - "^[1-9]\\d{0,2}(b|kB|K|MB|M|GB|G|KiB|MiB|GiB)$" - ], - "caseSensitive": true - }, - "conflictsWith": [ - "bytes" - ], - "group": "Options" - }, - { - "name": "bytes", - "aliases": [ - "c" - ], - "description": "Byte level output counts supported only for syntax checking. Use --lines or filter with a TAIL terminal command instead.", - "allowableValues": { - "values": [ - "^\\+[1-9]\\d*$" - ], - "caseSensitive": true - }, - "type": "string", - "group": "Options" - }, - { - "name": "quiet", - "aliases": [ - "q", - "silent" - ], - "description": "Do not display header or trailer lines. Set the environment variable EJES_LOG_CLI_QUIET to make this the default. Set EJES_LOG_CLI_NO_BOTTOM to prevent displaying the bottom of data line.", - "type": "boolean", - "group": "Options" - }, - { - "name": "verbose", - "aliases": [ - "v" - ], - "description": "Display header lines or trailer. This is the default unless the environment variable EJES_LOG_CLI_QUIET is set. Set EJES_LOG_CLI_NO_BOTTOM to prevent displaying the bottom of data line.", - "type": "boolean", - "group": "Options" - }, - { - "name": "version", - "description": "Display version header and quit.", - "type": "boolean", - "group": "Options", - "aliases": [] - }, - { - "name": "requests", - "description": "Limit the number of normally unlimited host requests. Only host requests for data, additional data, or find next data count as a request.", - "numericValueRange": [ - 1, - 99999 - ], - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "name": "mcs", - "aliases": [ - "mcsConsoleColor", - "mcs-console-color" - ], - "description": "Use ANSI escape characters to emulate the color and extended highlighting attributes in OPERLOG output to resemble the formatting on an MCS operator console. If --no-color on is specified, textual attributes will be prefixed instead. The MVS \"DISPLAY MPF\" command displays the message assignments color attributes in use on your host system.", - "type": "boolean", - "group": "ANSI Color Options" - }, - { - "name": "match", - "aliases": [ - "matchText", - "match-text", - "mt", - "m" - ], - "description": "Specify case-independent text to match and highlight using ANSI escape characters.\n\n Specify a string, a Javascript regex pattern without the enclosing slashes (e.g., \"login|logoff|force\"), or a Javascript regex pattern string with slashes and regex option flags (e.g., \"/[Ll]ogo.{1,2}|Signoff/g\"). If the first or second type is used, the flags default to ig (ignore-case and global match).\n\n Matching does not position for output the way --find does; it can be used in conjuction with a --find. Matching is done on each output line separately. All matches in a line will be highlighted. If --no-color on is specified, the line will be prefixed with \">\". If the built-in highlight attribute isn't visible on your terminal, either change the foreground color or set the environment variable EJES_LOG_CLI_ANSIMATCHATTR. 0 to 256 are valid as defined on this Wikipedia page:\n\n ", - "type": "string", - "group": "ANSI Color Options" - }, - { - "name": "find", - "description": "Position start of output using (E)JES host FIND command syntax (below). Find positioning is done after --line and --time, but before --offset. Limit lines to found lines with --only. Limit excessive enumeration and provide context with --context.\n\n NOTE: To search for specific message IDs or find text in messages on the OPERLOG, use --msgId or --msgText instead. OPERLOG message filtering Options show entire messages and may be more efficient. Since these options position at the bottom of the log, specify --line to position at the first message or specify --find to find further refine your search. Refer to OPERLOG Message Filtering Options for further alternatives to FIND.\n\n (E)JES Host FIND Command Syntax: Only the find-string is required. It should be enclosed in single quotes if it contains spaces or special characters. Case-independent search is the default. Case dependent is specified using c'find-string'. Searching for double-quotes is not supported. (The search-type arguments \"next\" and \"prev\" carry over 3270 display behavior. In this program, \"prev\" means find the last occurrence above the last 53 lines of the log; the default \"next\" searches forward starting 53 lines before the bottom.) Refer to the (E)JES Reference for the FIND command for detailed find syntax and option documention.\n\n ['|c'|p'|x']find-string['] [NEXT|prev|first|last] [CHARS|prefix|pre|suffix|suf|word] [startcol[ endcol]]", - "type": "string", - "stringLengthRange": [ - 1, - 80 - ], - "allowableValues": { - "values": [ - "^((?:c|p|x|)'.+'(?:c|p|x|)|[^'\\s]+)(?:(?:\\s+(first|last|next|prev|all)){0,1}(?:(?:\\s+(chars|pre|prefix|suf|suffix|word)){0,1}(?:\\s+(\\d*\\s+\\d*|\\d*)){0,2}){0,1}){0,1}$" - ], - "caseSensitive": false - }, - "group": "Find String and Position Options", - "aliases": [] - }, - { - "name": "hilite", - "aliases": [ - "highlight-find-text", - "highlight", - "ht" - ], - "description": "Use in conjunction with --find to highlight found strings using ANSI escape characters. If --no-color on is specified, the line will be prefixed with \"=\".\n\n If the built-in highlight attribute isn't visible on your terminal, either change the foreground color or set the environment variable EJES_LOG_CLI_ANSIFINDATTR to 8, 6, or 3. 0 to 256 are valid as defined on this Wikipedia page:\n\n ", - "type": "array", - "impliesOneOf": [ - "find" - ], - "group": "Find String and Position Options" - }, - { - "name": "only", - "description": "Output only lines marked by the host as found using the --find option. The --context option modifies this option by also outputing context lines following the found lines. Some OPERLOG message filtering options (e.g., --msgId and --msgTxt) may provide better results and will be more efficient and faster.", - "type": "boolean", - "aliases": [ - "o" - ], - "impliesOneOf": [ - "find" - ], - "group": "Find String and Position Options" - }, - { - "name": "context", - "aliases": [ - "cx" - ], - "description": "Specify 2 to 49 lines of context after the found line when --only is specified. 5 is used if an argument is not specified. To display only found lines, do not specify --context.", - "type": "array", - "implies": [ - "only" - ], - "allowableValues": { - "values": [ - "s", - "sep", - "separator", - "^[1-4]\\d*$|^[2-9]$" - ], - "caseSensitive": false - }, - "group": "Find String and Position Options" - }, - { - "name": "line", - "description": "Position at a specific line in the log. With no argument, it positions to top of the displayable log (like the TOP command). Positioning done before --time, --find, and --offset.", - "type": "array", - "allowableValues": { - "values": [ - "first", - "last", - "^[1-9]\\d*$" - ], - "caseSensitive": false - }, - "group": "Positioning Options", - "aliases": [] - }, - { - "name": "head", - "description": "Position at top of log same as --line without an argument. Positioning done before --time, --find, and --offset.", - "type": "boolean", - "conflictsWith": [ - "line", - "follow" - ], - "group": "Positioning Options", - "aliases": [] - }, - { - "name": "time", - "description": "Positions a time on the current day or to a time and date. With no argument, positions to the beginning of the day. Positioning done before --find and --offset, but after --line.\n\n The argument is hh:mm:ss:th-date, where ss or ss:th and the date are optional.\n\nThe date, if specified, is specified as yyyy.ddd, yyyy-ddd, yyyy/mm/dd, yyyy/dd/mm, mm/dd/yyyy, dd/mm/yyyy, yyyy-mm-dd, yyyy-dd-mm, mm-dd-yyyy, or dd-mm-yyyy. The Julian date form is always valid.\n\n The Gregorian date form depends upon your current date format setting, though both slash (/) and dash (-) are accepted as separator characters. Specify \"?\" to return the Gregorian date format and quit, i.e., --time \"?\"\n\n Two copy-paste date-time formats are supported. A date-time may copied from the log and pasted, enclosed in quotes, after the --time option. Operlog: \"yyyydddd hh:mm:ss.th\". Syslog: \"yyyyddd hhmmsst\".", - "type": "array", - "allowableValues": { - "values": [ - "(?:^(20\\d{5}) (\\d{7})$)|(?:^(20\\d{5}) ((\\d\\d:\\d\\d:\\d\\d.\\d\\d))$)|(?:^(\\d\\d\\:\\d\\d(?:\\:\\d\\d){0,2}(?:-(?:(?:\\d{4}[.-]\\d{3}$)|(?:^\\d{4}(?:[\\/|-]\\d{2}){2}$)|(?:^(?:\\d{2}[\\/|-]){2}\\d{4})))*){0,1}$|^\\?$)" - ], - "caseSensitive": false - }, - "group": "Positioning Options", - "aliases": [] - }, - { - "name": "offset", - "aliases": [ - "off" - ], - "description": "Offset positioning by time or line count after the final position arrived at by message filtering, --line, --time, and --find. Optional directional indicators are next or + (later in log) or prev (earlier). If the directional indicator is omitted, earlier in the log is assumed. Valid trailing time indicators are s, m, h, or d. A number without a time indicator assumes h on OPERLOG, but on SYSLOG positions by adding to the current data set number (if 0, it positions at the top of the current data set). The l indicator is a line count indicator. Specify this to offset by n lines. Without an argument, prev4l is assumed, which is helpful when specifying --find to provide context even when -n 10 (the default) is specified.", - "type": "array", - "conflictsWith": [ - "only" - ], - "allowableValues": { - "values": [ - "^(\\+|next|prev)*(\\d+[smhdl]{0,1})$" - ], - "caseSensitive": false - }, - "group": "Positioning Offset Options" - }, - { - "name": "system-name", - "aliases": [ - "systemName", - "sysname", - "sn" - ], - "description": "Filter for up to 4 provided system name(s). Multiline messages are output in their entirety. Generic (*) and placeholder (%) mask characters allowed. Note: The response time of the OPERLOG browser can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.", - "type": "array", - "group": "OPERLOG Message Filtering Options" - }, - { - "name": "job-name", - "aliases": [ - "jobName", - "jname", - "j" - ], - "description": "Filter OPERLOG for up to 4 provided job names. Multiline messages are output in their entirety. Generic (*) and placeholder (%) mask characters allowed. Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.", - "type": "array", - "group": "OPERLOG Message Filtering Options" - }, - { - "name": "job-id", - "aliases": [ - "jobId", - "jid" - ], - "description": "Filter OPERLOG for up to 4 provided job ids, e.g, J0632369. Multiline messages are output in their entirety. Generic (*) and placeholder (%) mask characters allowed. Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.", - "type": "array", - "group": "OPERLOG Message Filtering Options" - }, - { - "name": "console", - "aliases": [ - "con" - ], - "description": "Filter OPERLOG for up to 4 provided consoles. Multiline messages are output in their entirety. Generic (*) and placeholder (%) mask characters allowed. Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.", - "type": "array", - "group": "OPERLOG Message Filtering Options" - }, - { - "name": "message-id", - "aliases": [ - "messageId", - "msgId", - "mi" - ], - "description": "Filter OPERLOG for up to 3 provided message ids of up to 12 characters. Multiline messages are output in their entirety. Generic (*) and placeholder (%) mask characters allowed. Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.", - "type": "array", - "group": "OPERLOG Message Filtering Options" - }, - { - "name": "message-text", - "aliases": [ - "messageText", - "msgText", - "msgTxt", - "mtxt", - "mx" - ], - "description": "Filter OPERLOG for message text of up to 34 characters. Multiline messages are output in their entirety. Generic (*) and placeholder (%) mask characters allowed. To filter for strings inside a message's text, use generic characters, e.g., \"*logon*\". Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.", - "type": "array", - "group": "OPERLOG Message Filtering Options" - }, - { - "name": "routing-codes", - "aliases": [ - "routingCodes", - "routing", - "r" - ], - "description": "Filter OPERLOG for routing codes. Up to 34 characters that may be ALL, NONE, or a list of decimal routing codes or ranges. For example: 1,3,6-9,100-128. Multiline messages are output in their entirety. Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.", - "type": "array", - "defaultValue": [ - "ALL" - ], - "group": "OPERLOG Message Filtering Options" - }, - { - "name": "descriptor-codes", - "aliases": [ - "descriptorCodes", - "descriptor", - "dc" - ], - "description": "Filter OPERLOG for descriptor codes. Up to 34 characters that may be ALL, NONE, or a list of decimal descriptor codes or ranges. For example: 1,3,6-9. Multiline messages are output in their entirety. Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.", - "type": "array", - "defaultValue": [ - "ALL" - ], - "group": "OPERLOG Message Filtering Options" - }, - { - "name": "window-bottom", - "aliases": [ - "windowBottom", - "winBot", - "wb", - "bot", - "high-time-date", - "htd" - ], - "description": "Filter OPERLOG by setting the time and optionally the date of the bottom of the log to use. Up to 23 characters.\n\n The boundary specifications may be either fixed time-date values, e.g.\"16:00:12:90-2021/02/12\" (see “Time-Date Values” in the (E)JES Reference) or calculated relative to the time stamp associated with the record shown at 57 lines from the bottom of the log at start-up.\n\n A relative value is indicated by the presence of a next (+) or previous preceding the boundary specification, e.g., prev1h. After the next or previous you may specify either a number of seconds, minutes, hours, or days as indicated by using a 's', 'm', 'h', or 'd' suffix. Assumes 'h' if omitted.\n\n Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.", - "type": "array", - "allowableValues": { - "values": [ - "^(\\+|next|prev)*(\\d+[smhd]{0,1})$|(?:^(20\\d{5}) ((\\d\\d:\\d\\d:\\d\\d.\\d\\d))$)|^(?:(\\d\\d\\:\\d\\d(?:\\:\\d\\d){0,2}(?:-(?:(?:\\d{4}[.-]\\d{3})|(?:\\d{4}(?:[\\/|-]\\d{2}){2})|(?:(?:\\d{2}[\\/|-]){2}\\d{4})))*){0,1}|\\?)$" - ], - "caseSensitive": false - }, - "group": "OPERLOG Message Filtering Options" - }, - { - "name": "window-top", - "aliases": [ - "windowTop", - "winTop", - "wt", - "top", - "low-time-date", - "ltd" - ], - "description": "Filter OPERLOG by setting the time and optionally the date of the top of the log to use. Up to 23 characters.\n\n The boundary specifications may be either fixed time-date values, e.g.\"16:00:12:90-2021/02/12\" (see “Time-Date Values” in the (E)JES Reference) or calculated relative to the time stamp associated with the record shown at 57 lines from the bottom of the log at start-up.\n\n A relative value is indicated by the presence of a next (+) or previous preceding the boundary specification, e.g., prev1h. After the next or previous you may specify either a number of seconds, minutes, hours, or days as indicated by using a 's', 'm', 'h', or 'd' suffix. Assumes 'h' if omitted.\n\n Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.", - "type": "array", - "allowableValues": { - "values": [ - "^(\\+|next|prev)*(\\d+[smhd]{0,1})$|(?:^(20\\d{5}) ((\\d\\d:\\d\\d:\\d\\d.\\d\\d))$)|^(?:(\\d\\d\\:\\d\\d(?:\\:\\d\\d){0,2}(?:-(?:(?:\\d{4}[.-]\\d{3})|(?:\\d{4}(?:[\\/|-]\\d{2}){2})|(?:(?:\\d{2}[\\/|-]){2}\\d{4})))*){0,1}|\\?)$" - ], - "caseSensitive": false - }, - "group": "OPERLOG Message Filtering Options" - }, - { - "name": "mpf-exit-flags", - "aliases": [ - "mpfExitFlags", - "mpf" - ], - "description": "Filter OPERLOG for MPF/Exit flags with a \"value mask\" of eight hexadecimal characters, e.g., 00000291. Use in conjunction with the \"result directive\" (see --result-directive).\n\n The filtering is performed by ANDing the hexadecimal value mask against a message’s MPF/Exit Flags value and then displaying the message based upon the result directive (zero or non-zero). For example, a mask and result directive of 00000001 and NZ will display messages that were suppressed by MPF. Specifying 00000001 and Z displays messages that were not suppressed.\n\n Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display. Multiline messages are output in their entirety. ", - "type": "array", - "defaultValue": [ - "FFFFFFFF" - ], - "allowableValues": { - "values": [ - "^[0-9A-F]{8}$", - "^[0-9a-f]{8}$" - ] - }, - "group": "OPERLOG Message Filtering Options" - }, - { - "name": "result-directive", - "aliases": [ - "resultDirective", - "rd" - ], - "description": "Provide the result directive for the --mpf-exit-flags option (see the option for more information). A mask and result directive of 00000001 and NZ will display messages that were suppressed by MPF. A mask and result directive of 00000001 and Z displays messages that were not suppressed. Multiline messages are output in their entirety. Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.", - "type": "array", - "defaultValue": [ - "NZ" - ], - "allowableValues": { - "values": [ - "NZ", - "Z", - "EQ", - "NE" - ], - "caseSensitive": false - }, - "group": "OPERLOG Message Filtering Options" - }, - { - "name": "logsys", - "aliases": [ - "l" - ], - "description": "Specify a syslog to display by specifying the MVS name of a system in a JES2 environment. The current system is browsed if --logsys is not specified.", - "type": "string", - "group": "Log Options" - }, - { - "name": "syslog", - "aliases": [ - "sys" - ], - "description": "Display the SYSLOG instead of the default log. Deprecated. Use the positional parameter instead.", - "type": "boolean", - "defaultValue": false, - "group": "Log Options" - }, - { - "name": "operlog", - "aliases": [ - "oper" - ], - "description": "Display the OPERLOG instead of the default log. Deprecated. Use the positional parameter instead.", - "type": "boolean", - "defaultValue": false, - "group": "Log Options" - }, - { - "name": "jes2", - "aliases": [ - "2" - ], - "description": "Use the JES2 spooler instead of the default spooler.", - "type": "boolean", - "defaultValue": false, - "group": "JES-type Options" - }, - { - "name": "jes3", - "aliases": [ - "3" - ], - "description": "Use the JES3 or JES3plus spooler instead of the default spooler.", - "type": "boolean", - "defaultValue": false, - "group": "JES-type Options" - }, - { - "name": "subsystem", - "description": "Specify the JES spooler system to use instead of the default spooler.", - "type": "string", - "group": "JES-type Options", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options" - }, - { - "name": "user", - "aliases": [ - "U" - ], - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES 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 (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "enum-value", - "aliases": [ - "enumval", - "ev" - ], - "description": "Number of lines to retreieve per (E)JES API call. Overridden by the combination of --rfj and --line (-n). See --line.", - "type": "number", - "defaultValue": 200, - "group": "EJES CLI Runtime Options" - }, - { - "name": "refresh-interval", - "aliases": [ - "refreshInterval", - "refresh", - "ri", - "sleep-interval", - "sleep", - "s" - ], - "description": "Number of seconds between (E)JES API calls in log stream command. The actual minimum and maximum interval is controlled by your host refresh command settings.", - "type": "number", - "defaultValue": 5, - "numericValueRange": [ - 1, - 100 - ], - "group": "EJES CLI Runtime Options" - }, - { - "name": "debug", - "aliases": [ - "dbg", - "dv", - "d" - ], - "description": "Invoke debugging code with additive flags. 1=request, 2=minimum response, 4=full response, 8=housekeeping, 16=show record info, 32=show fetch metadata.", - "type": "number", - "defaultValue": 0, - "group": "EJES CLI Runtime Options" - }, - { - "name": "detailed-json", - "aliases": [ - "detailedjson", - "detail", - "dj" - ], - "description": "Include metadata objects and arrays in --rfj output, not just an array of lines.", - "type": "boolean", - "defaultValue": false, - "group": "EJES CLI Runtime 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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "examples": [ - { - "description": "Output 10 lines at the tail of the log", - "options": "" - }, - { - "description": "Output 40 lines at head of the log with no header or trailer lines. The -n option is an alias for --lines and -q is an alias for --quiet", - "options": "--head -n 40 -q" - }, - { - "description": "Stream the tail of the default log defined for your credentials until you press CTRL+C. The -f option is an alias for --follow", - "options": "--follow" - }, - { - "description": "Stream the tail of the syslog", - "options": "syslog --follow" - }, - { - "description": "Stream the tail of the operlog", - "options": "operlog --follow" - }, - { - "description": "Match and highlight user logons in output lines. (NOTE: This does not position to the string; it *only* highlights them *if* they are in the output.) Match can also work with a simple string, or a regex string with no forward slash characters, implying the \"ig\" flags (ignore-case and global-match)", - "options": "--match \"/[Ll]ogo.{1,2}|force|Signoff/g\"" - }, - { - "description": "Match and mark user logons without ANSI color escape sequences. The --nc option is an alias for --no-color", - "options": "--match \"/[Ll]ogo.{1,2}|force|Signoff/g\" --nc on" - }, - { - "description": "Find your logon Id in the log", - "options": "--find yourLogonId" - }, - { - "description": "Find your logon Id in the log and highlight the found text", - "options": "--hilite --find yourLogonId" - }, - { - "description": "Find your logon id in the log with a few lines above it for context. The --offset option is down 4 lines (prev4l) if the argument is not specified", - "options": "--find yourLogonId --offset" - }, - { - "description": "Find your TSO logons and logoffs for today by specifying you logon id followed by \"- log\" in the log. Note that if the find string includes spaces or special characters, you need to enclose it in single-quotes. Find without a find without a search type uses NEXT, searching forward from a position. Using the --time option without an argument positions to the start of the current day before finding. Without the --time option, the default position is 53 lines from the bottom. (NOTE: The space after the trailing apostrophe and before the double quote is a work-around for a zowe parsing issue.)", - "options": "--find \"'yourLogonId - log' \" --time" - }, - { - "description": "Find your unix home directory in the log. Note that if find string is case sensitive, you need to enclose it in single-quotes prefixed with the letter c, e.g., c'String'", - "options": "--find \"c'DSN=/u/userName' last\"" - }, - { - "description": "Find beginning of speed boost with highlighting", - "options": "--find \"'speed boost is active' first\" --hilite" - }, - { - "description": "Find beginning of speed boost but mark found lines without ANSI color escape sequences. The --ht option is an alias for --hilite and --nc is an alias for --no-color", - "options": "--find \"'speed boost is active' first\" --ht --nc on" - }, - { - "description": "Find all speed boost messages with highlighting and only output found lines", - "options": "--find \"'speed boost is active' first\" --ht --only -n all" - }, - { - "description": "Find all speed boost messages with highlighting and output five lines of context (the default)", - "options": "--find \"'speed boost is active' first\" --ht --only --context -n all" - }, - { - "description": "Filter for IPL and boost informational messages that appear in the IEA681I message. The message can include generic characters to specify classes or subclasses of messages. The entire multiline message is output if the message is multiline. Other OPERLOG filtering options can be found under Message Filters Options", - "options": "--msgId \"IEA681I\"" - }, - { - "description": "Filter for all informational IEA messages. The % character is a placeholder that matches any character. The entire multiline message is output if the message is multiline. Other OPERLOG filtering options can be found under Message Filters Options", - "options": "--msgId \"IEA%%%I\"" - }, - { - "description": "Filter for \"boost\" in the text of any message. Note the use of the generic character * that matches any number of characters before or after the string. These are necessary for this type of search. The entire multiline message is output if the message is multiline. Other OPERLOG filtering options can be found under Message Filters Options", - "options": "--msgTxt \"*boost*\"" - }, - { - "description": "Filter using descriptor codes for audible alarm errors and warning messages with MCS console color emulation on. The program will beep.The option --dc is an alias for --descriptorCodes. OPERLOG filtering options can be found under Message Filt ers Options", - "options": "--descriptorCodes \"1,2,11\" --mcs" - }, - { - "description": "Find all system messages that required action for the hour after midnight. Specifying --only shows just found lines. Specifying --lines with \"1h\" tells the program to output lines up to one hour from the first line output. The --top option here specifies a time without a date, which means the current day. This logically sets the top of the log, windowing it, to midnight today (with no lines above it). Specifying --find with the first verb tells to search from the top. The character in the find string has a special meaning indicating that a message requires action. The special characters \"|\", \"-\", \"@\", \" * \", and \"+\" can be indexed from column 54 and \" * \" is a column 4 character, thus 58 below.\n\n ", - "options": "--find \"'*' first 58 58\" --only --top \"00:00\" --lines 1h" - }, - { - "description": "Same result as previous example but with different options and colorized to emulate an MCS color console. Specifying --time without an argument positions at the beginning of the current day. The difference from above is that --top sets the first line of the log the program sees and positions at the bottom. The --time option positions before --find runs. No directional argument is specified on the --find option so it runs starting as positioned by the --time option.", - "options": "--find \"'*' 58 58\" --only --time --lines 1h --mcs" - }, - { - "description": "Stream the tail of the log until you press CTRL+C. The -f option is an alias for --follow", - "options": "--follow" - } - ], - "aliases": [], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - } - ], - "pluginHealthCheck": "./lib/healthCheck.handler", - "passOn": [ - { - "property": "profile", - "value": { - "required": [ - "ejes" - ] - }, - "merge": false, - "ignoreNodes": [ - { - "type": "group" - } - ] - }, - { - "property": "options", - "value": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options" - }, - { - "name": "user", - "aliases": [ - "U" - ], - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES 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 (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "enum-value", - "aliases": [ - "enumval", - "ev" - ], - "description": "Number of lines to retreieve per (E)JES API call. Overridden by the combination of --rfj and --line (-n). See --line.", - "type": "number", - "defaultValue": 200, - "group": "EJES CLI Runtime Options" - }, - { - "name": "refresh-interval", - "aliases": [ - "refreshInterval", - "refresh", - "ri", - "sleep-interval", - "sleep", - "s" - ], - "description": "Number of seconds between (E)JES API calls in log stream command. The actual minimum and maximum interval is controlled by your host refresh command settings.", - "type": "number", - "defaultValue": 5, - "numericValueRange": [ - 1, - 100 - ], - "group": "EJES CLI Runtime Options" - }, - { - "name": "debug", - "aliases": [ - "dbg", - "dv", - "d" - ], - "description": "Invoke debugging code with additive flags. 1=request, 2=minimum response, 4=full response, 8=housekeeping, 16=show record info, 32=show fetch metadata.", - "type": "number", - "defaultValue": 0, - "group": "EJES CLI Runtime Options" - }, - { - "name": "detailed-json", - "aliases": [ - "detailedjson", - "detail", - "dj" - ], - "description": "Include metadata objects and arrays in --rfj output, not just an array of lines.", - "type": "boolean", - "defaultValue": false, - "group": "EJES CLI Runtime 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": "query", - "aliases": [ - "q" - ], - "summary": "- Query the host using (E)JES", - "description": "Query the host using (E)JES. Return host spool, dataset, and library tables. Return browsable data as reports. Query commands specify which primary table to query. Each primary table may also have child tables or child reports you can query using the --table and/or --report options. You can access only those primary tables you are authorized to use. Issue these commands as an introduction: (1) \"zowe ejes query list\" to show available tables.(2) \"zowe ejes query status --owner help\" to demonstrate how to find how it all works. (3) \"zowe ejes query status --owner list\" to demonstrate how to find appropriate arguments. (4) \"zowe ejes query status --owner myuserid --sort time d\" to view a sorted table of your jobs.(5) \"zowe ejes query status --owner myuserid --sort time d --report \" to view the first job in report form (truncated to your screen).", - "type": "group", - "children": [ - { - "name": "activity", - "aliases": [ - "ac" - ], - "summary": " - Activity table", - "description": "Select a table of all the jobs in all active address spaces for the JESplex or sysplex.\n\nUse Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with \"sys\"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "AC. List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain invocation primary selection criteria or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "apfds", - "aliases": [ - "apf" - ], - "summary": " - APF-authorized libraries table", - "description": "Select a table of APF-authorized libraries defined to the systems in your sysplex.\n\nUse General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "class", - "aliases": [ - "cl" - ], - "summary": " - Job classes table", - "description": "Select table of job classes defined for the JESplex.\n\nUse General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "positionals": [], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "djc", - "aliases": [ - "dj" - ], - "summary": " - JES3 dependent job network control table", - "description": "Select a table of Dependent Job Control networks in the JESplex.\n\nUse Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "positionals": [], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "dynexit", - "aliases": [ - "dynex", - "dynx" - ], - "summary": " - Dynamic exits table", - "description": "Select a table of MVS dynamic exits defined within the current sysplex.\n\nUse General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "enclave", - "aliases": [ - "enc" - ], - "summary": " - Enclaves table", - "description": "Select a table of WLM enclaves defined within the JESplex.\n\nUse Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "enq", - "summary": " - ENQ table", - "description": "Select a table of information about ENQs and RESERVEs in the sysplex.\n\nUse General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters and/or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "aliases": [], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "enqc", - "summary": " - ENQ contention table", - "description": "Select a table of information about ENQ contention in the sysplex.\n\nUse General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters and/or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "aliases": [], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "enqd", - "summary": " - ENQ SYSDSN resources table", - "description": "Select a table of information about ENQ SYSDSN resources in the sysplex.\n\nUse General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters and/or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "aliases": [], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "fss", - "summary": " - FSS (Function Subsystems) table", - "description": "Select a table of Functional Subsystems defined for the JESplex.\n\nUse General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "aliases": [], - "positionals": [], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "group", - "aliases": [ - "gr" - ], - "summary": " - Job class groups table", - "description": "Select a table of Generalized Main Scheduler parameters for job class groups in the JESplex.\n\nUse General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "positionals": [], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "hcheck", - "aliases": [ - "hchk", - "hc" - ], - "summary": " - Health check table", - "description": "Select a table of the about checks registered with IBM Health Checker for z/OS.\n\nUse General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "hold", - "aliases": [ - "h" - ], - "summary": " - Hold table", - "description": "Select a table of the sysout in the Hold queue.\n\nUse Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with \"sys\"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "init", - "summary": " - JES2 initiators table", - "description": "Select a table of JES2-managed batch initiators defined for the JESplex.\n\nUse General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "aliases": [], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "input", - "aliases": [ - "i" - ], - "summary": " - Input table", - "description": "Select a table of all jobs in the JESplex that are in pre-execution and execution status.\n\nUse Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with \"sys\"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters or invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "jesplex", - "aliases": [ - "jesp" - ], - "summary": " - JESplex table", - "description": "Select a table of JES images in your z/OS JESplex.\n\nA JES2 JESplex is also known as a Multi-Access SPOOL configuration or MAS. A JES3 JESplex is also known as a JES3 complex. Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "positionals": [], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "jgroup", - "aliases": [ - "jg" - ], - "summary": " - JES2 job groups table", - "description": "Select a table of the active job groups in the JESplex.\n\nUse Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "positionals": [], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "line", - "aliases": [ - "li" - ], - "summary": " - JES3 dependent job network control table", - "description": "Select a table of the lines that connect NJE nodes to your JESplex.\n\nUse General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "list", - "summary": " - List primary tables you are authorized to use.", - "description": "Display a list of all the primary display tables you are authorized to query on the host.", - "type": "command", - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "aliases": [], - "positionals": [], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "lnklst", - "aliases": [ - "lnkl", - "lnk" - ], - "summary": " - Link list data sets table", - "description": "Select a table of data sets in the link list concatenation of the link list libraries defined to the systems in your sysplex.\n\nUse General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "lpalst", - "aliases": [ - "lpal", - "lpa" - ], - "summary": " - Link pack data sets table", - "description": "Select a table of data sets in the LPA concatenation of the link pack libraries defined to the systems in your sysplex.\n\nUse General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "mds", - "aliases": [ - "md" - ], - "summary": " - JES3 MDS table", - "description": "Select a table of jobs in the JESplex that are currently delayed in one of the Main Device Scheduler queues.\n\nUse Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "memusage", - "aliases": [ - "memuse", - "memu" - ], - "summary": " - Memory usage table", - "description": "Select a table of real and virtual memory requirements of jobs and other tasks running within your sysplex.\n\nUse Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with \"sys\"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "mounts", - "aliases": [ - "mount", - "mo" - ], - "summary": " - z/OS UNIX mounts table", - "description": "Select a table of mounted file systems within the sysplex.\n\nUse General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "netconn", - "aliases": [ - "netc", - "nc" - ], - "summary": " - Network connections table", - "description": "Select a table of NJE (Network Job Entry) connections.\n\nUse General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "netserv", - "aliases": [ - "nets" - ], - "summary": " - Network servers table", - "description": "Select a table of NJE network servers.\n\nUse General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "nje", - "summary": " - JES3 NJE sysout table", - "description": "Select a table of sysout in the Bulk Data Transfer and TCP/IP NJE queues.\n\nUse Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with \"sys\"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "aliases": [], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "node", - "aliases": [ - "node", - "no" - ], - "summary": " - Node table", - "description": "Select a table of the NJE nodes defined to the JESplex.\n\nUse General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "offload", - "aliases": [ - "off" - ], - "summary": " - JES2 spool offloader device table", - "description": "Select a table of the JES2 spool offload devices in your JESplex.\n\nUse General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "positionals": [], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "pageds", - "aliases": [ - "pag", - "page", - "paged" - ], - "summary": " - Page data set resources table", - "description": "Select a table of paging resources defined to the systems in your sysplex.\n\nUse General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "parmlib", - "aliases": [ - "parml", - "parm" - ], - "summary": " - Parameter library data sets table", - "description": "Select a table of information about system parameter libraries defined to the systems in your sysplex.\n\nUse General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "positionals": [], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "printer", - "aliases": [ - "pr" - ], - "summary": " - Printer and punch table", - "description": "Select a table of JES writers which drive local, FSS, and signed-on/logged-on remote printer and punch devices attached to the JESplex.\n\nUse General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "proclib", - "aliases": [ - "procl", - "proc" - ], - "summary": " - Proclib data sets table", - "description": "Select a table of information about your JES proclib concatenations.\n\nUse General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "positionals": [], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "pstatus", - "aliases": [ - "pstat", - "ps" - ], - "summary": " - UNIX process status table", - "description": "Select a table of z/OS UNIX processes running in the JESplex.\n\nUse Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with \"sys\"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "resmon", - "aliases": [ - "resm", - "rmon", - "rm" - ], - "summary": " - JES2 resource monitor table", - "description": "Select a table of JES resources for the JESplex.\n\nUse General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "resource", - "aliases": [ - "reso" - ], - "summary": " - Workload manager resource table", - "description": "Select a table of the WLM Resources defined for the current sysplex.\n\nUse General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "schenv", - "aliases": [ - "sch" - ], - "summary": " - Workload manager scheduling environments table", - "description": "Select a table of the WLM Scheduling Environments defined for the current sysplex.\n\nUse General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "session", - "aliases": [ - "ses" - ], - "summary": " - (E)JES session table", - "description": "Select a table of all active (E)JES sessions.\n\nUse General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "spart", - "aliases": [ - "spa" - ], - "summary": " - Spool partitions table", - "description": "Select a table of the SPOOL partition configuration of your JESplex.\n\nUse General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "spvol", - "aliases": [ - "spv" - ], - "summary": " - Spool volume extents table", - "description": "Select a table of the SPOOL volume extent configuration of your JESplex.\n\nUse General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "positionals": [], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "status", - "aliases": [ - "st" - ], - "summary": " - Job status table", - "description": "Select a table of all jobs in the JESplex.\n\nUse Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with \"sys\"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "subsys", - "aliases": [ - "subsy", - "subs" - ], - "summary": " - MVS Sysplex Subsystems", - "description": "Select a table of all the MVS subsystems defined to the systems in your sysplex.\n\nUse Primary Selection options to modify which rows are included in a table (for example, --sysnames sys* includes only systems starting with \"sys\"). Use General Use options to narrow your selected rows further. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the selection columns available for this table.\n\nThe \"list\" argument may be used on any option. A descriptive table for that option will be displayed and any other work will stop. The table may display available columns or positional input fields depending on the option.\n\n Example", - "options": "--select list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "symbol", - "aliases": [ - "sym" - ], - "summary": " - System symbols table", - "description": "Select a table of z/OS system symbols as well as JES and JCL symbols defined for the current address space.\n\nUse General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "syscls", - "aliases": [ - "sysc" - ], - "summary": " - Sysout classes table", - "description": "Select a table of the sysout class configuration for your JESplex.\n\nUse General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "positionals": [], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "sysplex", - "aliases": [ - "sysp", - "sys" - ], - "summary": " - Sysplex members table", - "description": "Select a table of the connected system images in your z/OS sysplex. In a monoplex, you manage the current system only (i.e., the image on which your (E)JES session is executing).\n\nUse General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "sysreq", - "aliases": [ - "sysr", - "sr" - ], - "summary": " - System requests table", - "description": "Select a table of outstanding replies and messages retained by the MVS Action Message Retention Facility (AMRF). Outstanding replies and action messages for the entire sysplex are shown.\n\nUse General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other wor`k will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "writer", - "aliases": [ - "w", - "output", - "o" - ], - "summary": " - Writer (Output) table", - "description": "Select a table of sysout in the Output queue (JES2) or Writer queue (JES3). The interchangeable terms Output queue and Writer queue are used by the two JESes to describe the queue from which JES-managed or FSS-managed printers can select work.\n\nUse Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with \"sys\"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters or invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - }, - { - "name": "zero", - "aliases": [ - "z" - ], - "summary": " - JES3 Job zero table", - "description": "Select a table of sysout data sets created by JES3 internal facilities.\n\nUse Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.", - "type": "command", - "examples": [ - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "--table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "--metafilter help" - } - ], - "positionals": [ - { - "name": "parameter-list", - "type": "string", - "description": "Optional list enclosed in double-quotes. May contain optional parameters or invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.", - "required": false - } - ], - "handler": "", - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options", - "aliases": [] - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - }, - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help", - "aliases": [] - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format.", - "aliases": [] - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length.", - "aliases": [] - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides.", - "aliases": [] - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - }, - "aliases": [] - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]", - "aliases": [] - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler.", - "group": "Options", - "aliases": [] - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help", - "aliases": [] - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank.", - "aliases": [] - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided.", - "aliases": [] - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help", - "aliases": [] - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help", - "aliases": [] - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help", - "aliases": [] - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help", - "aliases": [] - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - }, - "aliases": [] - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - }, - { - "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": "ejes-profile", - "aliases": [ - "ejes-p" - ], - "group": "Profile Options", - "description": "The name of a (ejes) profile to load for this command execution.", - "type": "string" - } - ], - "passOn": [], - "profile": { - "required": [ - "ejes" - ] - }, - "children": [] - } - ], - "pluginHealthCheck": "./lib/healthCheck.handler", - "passOn": [ - { - "property": "profile", - "value": { - "required": [ - "ejes" - ] - }, - "merge": false, - "ignoreNodes": [ - { - "type": "group" - } - ] - }, - { - "property": "options", - "value": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "Protocol used to access (E)JES server.", - "type": "string", - "defaultValue": "https", - "group": "EJES Connection Options", - "allowableValues": { - "values": [ - "http", - "https", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "description": "The (E)JES server host name.", - "type": "string", - "required": true, - "group": "EJES Connection Options" - }, - { - "name": "port", - "description": "The (E)JES server port.", - "type": "number", - "defaultValue": 443, - "group": "EJES Connection Options" - }, - { - "name": "user", - "description": "Mainframe (E)JES user name, which can be the same as your TSO login.", - "type": "string", - "required": true, - "group": "EJES Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe (E)JES password, which can be the same as your TSO password.", - "type": "string", - "group": "EJES Connection Options", - "required": true - }, - { - "name": "reject-unauthorized", - "aliases": [ - "rejectunauthorized", - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "EJES Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "basepath", - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.", - "type": "string", - "group": "EJES Connection Options" - }, - { - "name": "color-scheme", - "aliases": [ - "scheme", - "cs" - ], - "description": "Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use \"zowe ejes emulate batch --helpApp scheme-info\". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.\n\nAllowed values: dark, light, powershell, nono, none, user-scheme-file, list, help", - "type": "string", - "defaultValue": "dark", - "group": "EJES Connection Options" - }, - { - "name": "no-color", - "aliases": [ - "nocolor", - "nc" - ], - "description": "Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.", - "type": "string", - "group": "EJES Connection Options" - } - ], - "merge": true, - "ignoreNodes": [ - { - "type": "group" - } - ] - }, - { - "property": "options", - "value": [ - { - "name": "helpApp", - "aliases": [ - "ha" - ], - "description": "Invoke extended application specific detailed help.", - "type": "array", - "group": "Global Options" - } - ], - "merge": true, - "ignoreNodes": [ - { - "type": "group" - } - ] - }, - { - "property": "options", - "value": [ - { - "name": "metafilter", - "group": "General Use Options", - "aliases": [ - "m" - ], - "type": "array", - "description": "Specify row filtering in a table. Use \"-m help\" for detailed information. Use \"-m list\" to show available columns.\n\nAllowed value: off, metafilter_construct, list, help" - }, - { - "name": "dest", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.\n\nAllowed values: off, destination-mask(s), list, help" - }, - { - "name": "header", - "group": "Query options", - "type": "string", - "description": "Specify whether to include headers for tables.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "actpurge", - "group": "Command Processing Options", - "type": "string", - "description": "Enable cancel/purge commands for executing jobs on job-oriented tables.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "submit", - "group": "Job Submission Options", - "aliases": [ - "submit", - "sub" - ], - "type": "string", - "description": "Submit a local or host file to the host. Searches the current working directory for the file or the path on the EJES_SUBMIT_PATH environment variable.\n\nAllowed values: local:path, MVS data set, z/OS UNIX path" - }, - { - "name": "debug", - "group": "Debug and Test Options", - "aliases": [ - "dbg", - "debug-value", - "dv" - ], - "type": "string", - "description": "Specify a numeric debugging mode.\n\nAllowed values: number, list, help", - "allowableValues": { - "values": [ - "\\d+", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "atx", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting APPC/MVS transaction jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "acplex", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the data gathering scope for the Activity display.", - "allowableValues": { - "values": [ - "jes", - "sys", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "cc", - "group": "Query options", - "type": "string", - "description": "Establish carriage control handling for downloaded reports.", - "allowableValues": { - "values": [ - "discard", - "interpret", - "keep", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "codepage", - "group": "Advanced Use Options", - "aliases": [ - "--cp" - ], - "type": "string", - "description": "Change the code page set for your installation for output as UTF-8.", - "allowableValues": { - "values": [ - "list", - "help", - "0", - "273", - "277", - "280", - "284", - "297", - "297", - "424", - "833", - "870", - "875", - "1026", - "1047", - "1122", - "1141", - "1143", - "1145", - "1147", - "1149", - "1159", - "37", - "275", - "278", - "281", - "285", - "420", - "500", - "836", - "871", - "1025", - "1027", - "1112", - "1140", - "1140", - "1142", - "1144", - "1146", - "1148", - "1153" - ], - "caseSensitive": true - } - }, - { - "name": "command", - "group": "Command Processing Options", - "aliases": [ - "c" - ], - "type": "string", - "description": "Specify a line command. Use \"-c list\" to show available commands.\n\nAllowed values: command[ argument], list, help" - }, - { - "name": "confirm", - "group": "Command Processing Options", - "type": "string", - "description": "Confirm previously queued commands. Use \"--confirm help\" for detailed information.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "countOnly", - "group": "Query options", - "aliases": [ - "count" - ], - "type": "string", - "description": "When a table or report is selected for output, only output the \"Rows available\" line.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "curstep", - "group": "Advanced Use Options", - "type": "string", - "description": "Enable extra columns on JES2 Input and Job Status.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "datefmt", - "group": "Advanced Use Options", - "type": "string", - "description": "Customize date formatting.", - "allowableValues": { - "values": [ - "yyyyddd .", - "yyyyddd -", - "yyyyddd", - "YYYYMMDD /", - "YYYYMMDD -", - "YYYYMMDD", - "YYYYDDMM /", - "YYYYDDMM -", - "YYYYDDMM", - "MMDDYYYY /", - "MMDDYYYY -", - "MMDDYYYY", - "DDMMYYYY /", - "DDMMYYYY -", - "DDMMYYYY" - ], - "caseSensitive": false - } - }, - { - "name": "deltxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Possibly show canceled or printed data sets in the JES spool.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "recfm", - "group": "Job Submission Options", - "type": "array", - "description": "Record format." - }, - { - "name": "lrecl", - "group": "Job Submission Options", - "type": "array", - "description": "Logical record length." - }, - { - "name": "unit", - "group": "Job Submission Options", - "type": "array", - "description": "Generic or esoteric unit name where an uncataloged MVS data set resides." - }, - { - "name": "volume", - "group": "Job Submission Options", - "type": "array", - "description": "Volume serial where an uncataloged MVS data set resides." - }, - { - "name": "subsys", - "group": "Job Submission Options", - "type": "array", - "description": "Subsystem name where the job should be sent. If not speficied defaults to the subsystem under which the current (E)JES session is running.", - "allowableValues": { - "values": [ - "jes2", - "jes3", - "list", - "help" - ], - "caseSensitive": false - } - }, - { - "name": "dry-run", - "group": "Debug and Test Options", - "aliases": [ - "n" - ], - "type": "array", - "description": "Run under dry-run protocols.", - "allowableValues": { - "values": [ - "syntax", - "check", - "all", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "hidecols", - "group": "Query options", - "type": "string", - "description": "Specify columns to hide in a table. Use \"--hidecols list\" to show available columns.\n\nAllowed values: column-key..., list, help]" - }, - { - "name": "immediate", - "group": "Command Processing Options", - "aliases": [ - "i" - ], - "type": "string", - "description": "Run line commands without confirmation.", - "implies": [ - "command" - ], - "allowableValues": { - "values": [ - "fast", - "slow", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "inptxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show in-stream SYSIN data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "jes2", - "group": "Advanced Use Options", - "aliases": [ - "2" - ], - "type": "boolean", - "description": "Use the JES2 spooler instead of the default spooler." - }, - { - "name": "jes3", - "group": "Advanced Use Options", - "aliases": [ - "3" - ], - "type": "boolean", - "description": "Use the JES3 or JES3plus spooler instead of the default spooler." - }, - { - "name": "subsystem", - "type": "string", - "description": "Name of the spooler to use instead of the default spooler." - }, - { - "name": "job", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting batch jobs for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "jobclass", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, jobclass-mask(s), list, help" - }, - { - "name": "jobname", - "group": "General Primary Selection Options", - "aliases": [ - "j" - ], - "type": "string", - "description": "Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.\n\nAllowed values: off, jobname-mask(s), list, help" - }, - { - "name": "lines", - "group": "Query options", - "aliases": [ - "y" - ], - "type": "string", - "description": "Specify lines in a table or report.\n\nDefault value:  Table: Terminal rows - 6, Report: 1000\nAllowed values: 1000, number, all, list, help" - }, - { - "name": "max", - "group": "Advanced Use Options", - "type": "string", - "description": "Change level of detail to show maximum number of columns. Filters these tables: activity, djc, hold, input, job status, nje, and writer.", - "allowableValues": { - "values": [ - "on", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "numchar", - "group": "Advanced Use Options", - "type": "string", - "description": "Establish the numeric magnitude and decimal separator character to be used when formatting numeric values.\n\nAllowed values: 'MD', 'M ' where M is a magnitude character, D is a decimal character, and either can be blank." - }, - { - "name": "pdf", - "group": "Query options", - "type": "array", - "description": "Output a report in PDF format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "text", - "group": "Query options", - "aliases": [ - "txt" - ], - "type": "array", - "description": "Output a report in text format to a host provided file name corresponding to the data set. Optionally provide a file name or path. The EJES_DOWNLOAD_PATH environment variable value is prepended if a path is not provided." - }, - { - "name": "origin", - "group": "General Primary Selection Options", - "type": "string", - "description": "Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, origin-mask(s), list, help" - }, - { - "name": "owner", - "group": "General Primary Selection Options", - "aliases": [ - "o" - ], - "type": "string", - "description": "Specify up to 8 owner masks.\n\nAllowed values: off, name-mask(s), list, help" - }, - { - "name": "report", - "group": "General Use Options", - "aliases": [ - "r" - ], - "type": "array", - "description": "Specify a child report to output. Only the first row of the table is selected for the report. You may want to use --sort, --select, or --metafilter to position the desired report as the first row. Use \"-r list\" to show available reports.\n\nDefault value:  b\nAllowed values: browse-linecommand, list, help" - }, - { - "name": "select", - "group": "General Use Options", - "aliases": [ - "s" - ], - "type": "array", - "description": "Specify column selections (TSELECT). Use \"-s help\" for detailed information. Use \"-s list\" to show available arguments for the table.\n\nAllowed values: off, select_construct, list, help" - }, - { - "name": "setup", - "group": "Advanced Use Options", - "type": "string", - "description": "On Printer/Punch table, show required attributes of devices in setup status (on) or show current attributes of devices in setup status(off).", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "showcols", - "group": "General Use Options", - "aliases": [ - "w" - ], - "type": "string", - "description": "Specify the only columns to show in a table being output, and their order. It does not apply to the parent tables of the output table. Use \"-w list\" to show available columns.\n\nAllowed values: column-key..., list, help" - }, - { - "name": "sort", - "group": "General Use Options", - "aliases": [ - "z" - ], - "type": "array", - "description": "Specify column sorting. Use \"-z list\" to show available columns.\n\nAllowed values: off, sort_construct, list, help" - }, - { - "name": "start", - "group": "Query options", - "type": "string", - "description": "Specify the beginning line number for a report.\n\nAllowed values: number, 1, list, help" - }, - { - "name": "stc", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting started tasks for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "sysclass", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Establish up to 8 1-character sysclasses without spaces. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets and job zero.\n\nAllowed values: off, sysclass(es), list, help" - }, - { - "name": "sysname", - "group": "Advanced Use Options", - "type": "string", - "description": "Set the server system name filter. This filter limits the systems from which peer-to-peer remote server data is gathered.\n\nAllowed values: system-mask, '', *, list, help" - }, - { - "name": "systxt", - "group": "Advanced Use Options", - "type": "string", - "description": "Show internal JES data sets.", - "allowableValues": { - "values": [ - "on", - "off", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "table", - "group": "General Use Options", - "aliases": [ - "t" - ], - "type": "array", - "description": "Specify a child table. Use \"-t list\" to show available tables.\n\nDefault value:  s\nAllowed values: tabular-linecommand, list, help" - }, - { - "name": "tsu", - "group": "Advanced Use Primary Selection Options", - "type": "string", - "description": "Disable selecting TSO user output for applicable tables by specifying \"no\".", - "allowableValues": { - "values": [ - "yes", - "no", - "off", - "list", - "help" - ], - "caseSensitive": true - } - }, - { - "name": "usr", - "group": "Advanced Use Primary Selection Options", - "aliases": [ - "userid" - ], - "type": "string", - "description": "Establish up to 8 submitter user filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.\n\nAllowed values: off, user-mask(s), list, help" - }, - { - "name": "width", - "group": "Query options", - "aliases": [ - "x" - ], - "type": "string", - "description": "Specify maximum characters per line or row.\n\nDefault value:  tty default character width\nAllowed values: number, all, list, help" - } - ], - "merge": true, - "ignoreNodes": [ - { - "type": "group" - } - ] - } - ], - "examples": [ - { - "description": "Customize status table output.\n\n(1) Limit to owners beginning with \"rb\". If not specified, the owner will be the same as your logon id. To specify all, use an asterisk(*). (2) Filter rows to display only abends. (3) Show only relevant columns and arrange in the order desired. (4) Limit the number of lines, including headers, to 10. (5) Remove header lines.\n\n Example", - "options": "st --owner rb* --metafilter \"maxcomp eq ab*\" \n --showcols \"jobname maxcomp status jobid rec\" --lines 10 --header off" - }, - { - "description": "Display a table of data sets for a specific job on the spool by job id.\n\n(1) Select job 0437107. The asterisk causes the positional job name to be ignored. (2) Display a child table by table type. Data sets status is \"s\" on the status table.\n\n Example", - "options": "st --select \"* j0437107\" --table s" - }, - { - "description": "List the available table types for the child table.\n\nThe \"list\" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.\n\n Example", - "options": "st --table list" - }, - { - "description": "Provide detailed help for the metafilter option.\n\n The \"help\" argument may be used on any option. Help for the option will be displayed and any other work will stop.\n\n Example", - "options": "hchk --metafilter help" - } - ], - "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": "Zowe CLI EJES RESTapi Manager plug-in", - "aliases": [ - "ejes" - ], - "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-bridge-for-git.jsonc b/commandGroups/endevor-bridge-for-git.jsonc deleted file mode 100644 index 0602a4b..0000000 --- a/commandGroups/endevor-bridge-for-git.jsonc +++ /dev/null @@ -1,7174 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "endevor-bridge-for-git", - "description": "Use the Endevor Bridge for Git plug-in to manage your Git-Endevor mappings and build your local Git changes before synchronizing them to Endevor.", - "type": "group", - "children": [ - { - "name": "branch", - "aliases": [ - "br" - ], - "description": "Manage the branches of your Git-Endevor mapping.", - "type": "group", - "children": [ - { - "name": "add", - "aliases": [ - "a" - ], - "type": "command", - "handler": "", - "description": "Add a branch to an existing mapping", - "positionals": [ - { - "name": "context", - "description": "Git-Endevor mapping context (ID of the organization, project, team or owner of the Git repository).", - "type": "string", - "required": true - }, - { - "name": "mapping", - "description": "Git-Endevor mapping name (ID of the Git repository).", - "type": "string", - "required": true - }, - { - "name": "branch", - "aliases": [ - "b" - ], - "description": "Name of the branch that will be added/removed.", - "type": "string", - "required": true - } - ], - "profile": { - "optional": [ - "ebg", - "endevor", - "base" - ] - }, - "options": [ - { - "name": "endevor-system", - "aliases": [ - "endevorsys", - "system" - ], - "description": "The Endevor system where your project resides.", - "type": "string", - "stringLengthRange": [ - 1, - 8 - ], - "required": false, - "group": "Options" - }, - { - "name": "endevor-subsystem", - "aliases": [ - "endevorsub", - "sub", - "subsystem" - ], - "description": "The Endevor subsystem where your project resides.", - "type": "string", - "stringLengthRange": [ - 1, - 8 - ], - "required": false, - "group": "Options" - }, - { - "name": "system-alias", - "description": "The alias of Endevor system.", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "subsystem-alias", - "description": "The alias of Endevor subsystem.", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "endevor-environment", - "aliases": [ - "endevorenv", - "env", - "environment" - ], - "description": "The Endevor environment where your project resides.", - "type": "string", - "stringLengthRange": [ - 1, - 8 - ], - "required": false, - "group": "Options" - }, - { - "name": "read-only", - "description": "If specified, it is necessary to use the option --endevor-stage-number. The synchronized elements will be read-only.", - "type": "boolean", - "required": false, - "implies": [ - "endevor-stage-number" - ], - "group": "Options", - "aliases": [] - }, - { - "name": "endevor-stage-number", - "aliases": [ - "endevorsn" - ], - "description": "The Endevor stage where your project resides (only for read only mappings).", - "type": "string", - "implies": [ - "read-only" - ], - "group": "Options" - }, - { - "name": "mapping-mode", - "description": "Mapping mode of the mapping ('FULL', 'WORK_ENV_ONLY' or 'MIRROR')", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "FULL", - "WORK_ENV_ONLY", - "MIRROR" - ], - "caseSensitive": true - }, - "group": "Options", - "aliases": [] - }, - { - "name": "like", - "description": "Add branch using parameters from another branch in the same repository", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "repository-check", - "description": "If set to allowNonEmpty, user can proceed with initialization of the branch even if the branch exists.", - "allowableValues": { - "values": [ - "REQUIRE_EMPTY", - "ALLOW_NON_EMPTY" - ] - }, - "type": "string", - "defaultValue": "REQUIRE_EMPTY", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "endevor-protocol", - "aliases": [ - "endevorprot" - ], - "description": "The Endevor SCM Rest API protocol. \n\nDefault value: http", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "endevor-host", - "aliases": [ - "endevorh" - ], - "description": "The Endevor Rest API hostname.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-port", - "aliases": [ - "endevorp" - ], - "description": "The Endevor Rest API port.", - "type": "number", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-user", - "aliases": [ - "endevoru" - ], - "description": "Mainframe (Endevor) username, which can be the same as your TSO login.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-password", - "aliases": [ - "endevorpass", - "endevorpw" - ], - "description": "Mainframe (Endevor) password, which can be the same as your TSO password.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-reject-unauthorized", - "aliases": [ - "endevorru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: true", - "type": "boolean", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-base-path", - "aliases": [ - "endevorbp" - ], - "description": "The Endevor SCM Rest API base path. \n\nDefault value: EndevorService/rest", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "The Endevor Bridge for Git SCM protocol. \n\nDefault value: https", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The Endevor Bridge for Git hostname.", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "The Endevor Bridge for Git port.", - "type": "number", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Endevor Bridge for Git username (your git username).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "token", - "aliases": [ - "t" - ], - "description": "Git personal access token (it can be obtained from your Git Enterprise Server).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: false", - "type": "boolean", - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "ebg-profile", - "aliases": [ - "ebg-p" - ], - "group": "Profile Options", - "description": "The name of a (ebg) profile to load for this command execution.", - "type": "string" - }, - { - "name": "endevor-profile", - "aliases": [ - "endevor-p" - ], - "group": "Profile Options", - "description": "The name of a (endevor) profile to load for this command execution.", - "type": "string" - }, - { - "name": "base-profile", - "aliases": [ - "base-p" - ], - "group": "Profile Options", - "description": "The name of a (base) profile to load for this command execution.", - "type": "string" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Password to authenticate to service on the mainframe.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-type", - "aliases": [ - "tt" - ], - "description": "The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-value", - "aliases": [ - "tv" - ], - "description": "The value of the token to pass to the API.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "cert-file", - "description": "The file path to a certificate file to use for authentication.\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": "Add a branch to my Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile", - "options": "MY-CONTEXT MY-MAPPING MY-BRANCH --endevor-environment ENVNAME --endevor-system SYSNAME --endevor-subsystem SUBNAME" - }, - { - "description": "Add a branch to my Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile by using another branch as a template with different environment", - "options": "MY-CONTEXT MY-MAPPING MY-BRANCH --like TEMPLATE_BRANCH --endevor-environment DIFFERENT_ENVIRONMENT" - }, - { - "description": "Add a branch to my Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile by using another branch as a template with different system/subsystem", - "options": "MY-CONTEXT MY-MAPPING MY-BRANCH --like TEMPLATE_BRANCH --endevor-system DIFFERENT_SYSTEM --endevor-subsystem DIFFERENT_SUBSYSTEM" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "delete", - "aliases": [ - "d" - ], - "type": "command", - "handler": "", - "description": "Remove a branch from an existing mapping", - "positionals": [ - { - "name": "context", - "description": "Git-Endevor mapping context (ID of the organization, project, team or owner of the Git repository).", - "type": "string", - "required": true - }, - { - "name": "mapping", - "description": "Git-Endevor mapping name (ID of the Git repository).", - "type": "string", - "required": true - }, - { - "name": "branch", - "aliases": [ - "b" - ], - "description": "Name of the branch that will be added/removed.", - "type": "string", - "required": true - } - ], - "profile": { - "optional": [ - "ebg", - "base" - ] - }, - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "The Endevor Bridge for Git SCM protocol. \n\nDefault value: https", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The Endevor Bridge for Git hostname.", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "The Endevor Bridge for Git port.", - "type": "number", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Endevor Bridge for Git username (your git username).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "token", - "aliases": [ - "t" - ], - "description": "Git personal access token (it can be obtained from your Git Enterprise Server).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: false", - "type": "boolean", - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "ebg-profile", - "aliases": [ - "ebg-p" - ], - "group": "Profile Options", - "description": "The name of a (ebg) profile to load for this command execution.", - "type": "string" - }, - { - "name": "base-profile", - "aliases": [ - "base-p" - ], - "group": "Profile Options", - "description": "The name of a (base) profile to load for this command execution.", - "type": "string" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Password to authenticate to service on the mainframe.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-type", - "aliases": [ - "tt" - ], - "description": "The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-value", - "aliases": [ - "tv" - ], - "description": "The value of the token to pass to the API.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "cert-file", - "description": "The file path to a certificate file to use for authentication.\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": "Remove a branch from my Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG profile", - "options": "MY-CONTEXT MY-MAPPING MY-BRANCH" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "list", - "aliases": [ - "ls" - ], - "type": "command", - "handler": "", - "description": "List the branches of an existing mapping", - "positionals": [ - { - "name": "context", - "description": "Git-Endevor mapping context (ID of the organization, project, team or owner of the Git repository).", - "type": "string", - "required": true - }, - { - "name": "mapping", - "description": "Git-Endevor mapping name (ID of the Git repository).", - "type": "string", - "required": true - } - ], - "profile": { - "optional": [ - "ebg", - "base" - ] - }, - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "The Endevor Bridge for Git SCM protocol. \n\nDefault value: https", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The Endevor Bridge for Git hostname.", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "The Endevor Bridge for Git port.", - "type": "number", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Endevor Bridge for Git username (your git username).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "token", - "aliases": [ - "t" - ], - "description": "Git personal access token (it can be obtained from your Git Enterprise Server).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: false", - "type": "boolean", - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "ebg-profile", - "aliases": [ - "ebg-p" - ], - "group": "Profile Options", - "description": "The name of a (ebg) profile to load for this command execution.", - "type": "string" - }, - { - "name": "base-profile", - "aliases": [ - "base-p" - ], - "group": "Profile Options", - "description": "The name of a (base) profile to load for this command execution.", - "type": "string" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Password to authenticate to service on the mainframe.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-type", - "aliases": [ - "tt" - ], - "description": "The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-value", - "aliases": [ - "tv" - ], - "description": "The value of the token to pass to the API.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "cert-file", - "description": "The file path to a certificate file to use for authentication.\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": "List all branch of my Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG profile", - "options": "MY-CONTEXT MY-MAPPING" - } - ], - "passOn": [], - "children": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "The Endevor Bridge for Git SCM protocol. \n\nDefault value: https", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The Endevor Bridge for Git hostname.", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "The Endevor Bridge for Git port.", - "type": "number", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Endevor Bridge for Git username (your git username).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "token", - "aliases": [ - "t" - ], - "description": "Git personal access token (it can be obtained from your Git Enterprise Server).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: false", - "type": "boolean", - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - } - ], - "merge": true - } - ], - "options": [ - { - "name": "help-examples", - "group": "Global Options", - "description": "Display examples for all the commands in a group", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [] - }, - { - "name": "build", - "aliases": [ - "b" - ], - "description": "Build changes from git local repository in Endevor", - "type": "group", - "children": [ - { - "name": "execute", - "aliases": [ - "exec" - ], - "type": "command", - "handler": "", - "summary": "Build changes from Git local repository in Endevor", - "description": "Build changes against remote git repository's Endevor Bridge for Git synchronized branch, using work area or build subsystem.It does not support autogen for building dependencies.", - "profile": { - "optional": [ - "endevor", - "base" - ] - }, - "options": [ - { - "name": "endevor-instance", - "aliases": [ - "endevori" - ], - "description": "The Endevor Web Services Endevor configuration name.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "work-area-id", - "aliases": [ - "waid" - ], - "type": "string", - "description": "Endevor work area ID. Name-masking is not allowed.", - "group": "Endevor work area options", - "conflictsWith": [ - "endevor-subsystem", - "endevor-environment", - "endevor-system" - ] - }, - { - "name": "endevor-subsystem", - "aliases": [ - "endevorsub" - ], - "description": "The Endevor SCM build subsystem. Note: The build subsystem can be cleared without prior permission.", - "type": "string", - "stringLengthRange": [ - 1, - 8 - ], - "group": "Endevor work area options", - "implies": [ - "endevor-environment", - "endevor-system" - ] - }, - { - "name": "endevor-environment", - "aliases": [ - "endevorenv" - ], - "description": "The Endevor SCM environment where your build subsystem resides.", - "type": "string", - "stringLengthRange": [ - 1, - 8 - ], - "group": "Endevor work area options", - "implies": [ - "endevor-subsystem", - "endevor-system" - ] - }, - { - "name": "endevor-system", - "aliases": [ - "endevorsys" - ], - "description": "The Endevor SCM system where your build subsystem resides.", - "type": "string", - "stringLengthRange": [ - 1, - 8 - ], - "group": "Endevor work area options", - "implies": [ - "endevor-subsystem", - "endevor-environment" - ] - }, - { - "name": "work-dir", - "aliases": [ - "wd" - ], - "description": "The local working directory of your Git-Endevor mapping that you are building.", - "type": "string", - "defaultValue": "./", - "group": "Options" - }, - { - "name": "listing-dir", - "description": "Specify the directory where you would like to have your build outputs downloaded", - "type": "string", - "defaultValue": ".endevor/listings", - "group": "Options", - "aliases": [] - }, - { - "name": "listing-rc", - "description": "All the elements that have a generate result equal to or greater than \"listing-rc\" will have their build outputs downloaded into \"listing-dir\"", - "type": "number", - "defaultValue": 4, - "group": "Options", - "aliases": [] - }, - { - "name": "force-cleanup", - "aliases": [ - "fc" - ], - "description": "Starts the build process after cleaning the build subsystem.", - "type": "boolean", - "defaultValue": false, - "group": "Options" - }, - { - "name": "endevor-protocol", - "aliases": [ - "endevorprot" - ], - "description": "The Endevor SCM Rest API protocol. \n\nDefault value: http", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "endevor-host", - "aliases": [ - "endevorh" - ], - "description": "The Endevor Rest API hostname.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-port", - "aliases": [ - "endevorp" - ], - "description": "The Endevor Rest API port.", - "type": "number", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-user", - "aliases": [ - "endevoru" - ], - "description": "Mainframe (Endevor) username, which can be the same as your TSO login.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-password", - "aliases": [ - "endevorpass", - "endevorpw" - ], - "description": "Mainframe (Endevor) password, which can be the same as your TSO password.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-reject-unauthorized", - "aliases": [ - "endevorru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: true", - "type": "boolean", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-base-path", - "aliases": [ - "endevorbp" - ], - "description": "The Endevor SCM Rest API base path. \n\nDefault value: EndevorService/rest", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "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": "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": [] - }, - { - "name": "response-format-filter", - "aliases": [ - "rff" - ], - "description": "Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.", - "type": "array", - "group": "Response Format Options" - }, - { - "name": "response-format-type", - "aliases": [ - "rft" - ], - "description": "The command response output format type. Must be one of the following:\n\ntable: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.\n\nlist: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.\n\nobject: Formats output data as a list of prettified objects (or single object). Can be used in place of \"table\" to change from tabular output to a list of prettified objects.\n\nstring: Formats output data as a string. JSON objects/arrays are stringified.", - "type": "string", - "allowableValues": { - "values": [ - "table", - "list", - "object", - "string" - ], - "caseSensitive": false - }, - "group": "Response Format Options" - }, - { - "name": "response-format-header", - "aliases": [ - "rfh" - ], - "description": "If \"--response-format-type table\" is specified, include the column headers in the output.", - "type": "boolean", - "group": "Response Format Options", - "defaultValue": null - } - ], - "outputFormatOptions": true, - "examples": [ - { - "description": "Compile the changed elements in the current Git working directory using the work area \"WORKAREA1\" and an existing Endevor profile", - "options": "--endevor-instance INSTANCE --work-area-id WORKAREA1" - }, - { - "description": "Compile the changed elements in the current Git working directory using the build subsystem \"SUBNAME\" and an existing Endevor profile", - "options": "--endevor-instance INSTANCE --endevor-subsystem SUBNAME --endevor-environment ENVNAME --endevor-system SYSNAME" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "job-submit", - "aliases": [ - "js" - ], - "type": "command", - "handler": "", - "summary": "Submit build job. [step 1]", - "description": "Build changes from git local repository in Endevor by submitting a job. It supports autogen for building dependencies using with the option of selecting autogen span. After submitting, the command 'build job-report' must be issued to finalize processing.", - "profile": { - "optional": [ - "endevor", - "zosmf", - "base" - ] - }, - "options": [ - { - "name": "endevor-instance", - "aliases": [ - "endevori" - ], - "description": "The Endevor Web Services Endevor configuration name.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "work-area-id", - "aliases": [ - "waid" - ], - "type": "string", - "description": "Endevor work area ID. Name-masking is not allowed.", - "group": "Endevor work area options", - "conflictsWith": [ - "endevor-subsystem", - "endevor-environment", - "endevor-system" - ] - }, - { - "name": "endevor-subsystem", - "aliases": [ - "endevorsub" - ], - "description": "The Endevor SCM build subsystem. Note: The build subsystem can be cleared without prior permission.", - "type": "string", - "stringLengthRange": [ - 1, - 8 - ], - "group": "Endevor work area options", - "implies": [ - "endevor-environment", - "endevor-system" - ] - }, - { - "name": "endevor-environment", - "aliases": [ - "endevorenv" - ], - "description": "The Endevor SCM environment where your build subsystem resides.", - "type": "string", - "stringLengthRange": [ - 1, - 8 - ], - "group": "Endevor work area options", - "implies": [ - "endevor-subsystem", - "endevor-system" - ] - }, - { - "name": "endevor-system", - "aliases": [ - "endevorsys" - ], - "description": "The Endevor SCM system where your build subsystem resides.", - "type": "string", - "stringLengthRange": [ - 1, - 8 - ], - "group": "Endevor work area options", - "implies": [ - "endevor-subsystem", - "endevor-environment" - ] - }, - { - "name": "skeleton-jcl", - "aliases": [ - "sjcl" - ], - "description": "The path of the file of skeleton JCL to submit endevor scl statements. Download it from: https://techdocs.broadcom.com/content/broadcom/techdocs/us/en/ca-mainframe-software/devops/ca-endevor-integrations-for-enterprise-devops/1-0/ca-endevor-bridge-for-git/set-up-and-run-the-ca-endevor-bridge-for-git/configuration-for-build-using-zowe-cli.html", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "work-dir", - "aliases": [ - "wd" - ], - "description": "The local working directory of your Git-Endevor mapping that you are building.", - "type": "string", - "defaultValue": "./", - "group": "Options" - }, - { - "name": "force-cleanup", - "aliases": [ - "fc" - ], - "description": "Starts the build process after cleaning the build subsystem.", - "type": "boolean", - "defaultValue": false, - "group": "Options" - }, - { - "name": "autogen-span", - "aliases": [ - "ags" - ], - "description": "Specifies the autogen action option to automatically generate using elements.\nThe allowed values which have the following meaning:\nNONE - Generates all elements that use the component being acted upon.\nALL - Generates using elements that are found in any System and Subsystem combinations within the Environment and Stage of the component's logical map.\nSYSTEMS - Generates using elements that are found in any System, provided the element's Subsystem name matches the name of the Subsystem of the target component.\nSUBSYSTEMS - Generates using elements from all Subsystems with the same-named System of the component specified.", - "type": "string", - "defaultValue": "NONE", - "allowableValues": { - "values": [ - "NONE", - "ALL", - "SYSTEMS", - "SUBSYSTEMS" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "endevor-protocol", - "aliases": [ - "endevorprot" - ], - "description": "The Endevor SCM Rest API protocol. \n\nDefault value: http", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "endevor-host", - "aliases": [ - "endevorh" - ], - "description": "The Endevor Rest API hostname.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-port", - "aliases": [ - "endevorp" - ], - "description": "The Endevor Rest API port.", - "type": "number", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-user", - "aliases": [ - "endevoru" - ], - "description": "Mainframe (Endevor) username, which can be the same as your TSO login.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-password", - "aliases": [ - "endevorpass", - "endevorpw" - ], - "description": "Mainframe (Endevor) password, which can be the same as your TSO password.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-reject-unauthorized", - "aliases": [ - "endevorru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: true", - "type": "boolean", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-base-path", - "aliases": [ - "endevorbp" - ], - "description": "The Endevor SCM Rest API base path. \n\nDefault value: EndevorService/rest", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "zosmf-host", - "aliases": [ - "zosmfh" - ], - "description": "The z/OSMF server host name.", - "type": "string", - "required": false, - "group": "z/OSMF connection options (alternatively use a 'zosmf' profile)" - }, - { - "name": "zosmf-port", - "aliases": [ - "zosmfp" - ], - "description": "The z/OSMF server port.\n\nDefault value: 443", - "type": "number", - "required": false, - "group": "z/OSMF connection options (alternatively use a 'zosmf' profile)" - }, - { - "name": "zosmf-user", - "aliases": [ - "zosmfu" - ], - "description": "Mainframe (z/OSMF) username, which can be the same as your TSO login.", - "type": "string", - "required": false, - "group": "z/OSMF connection options (alternatively use a 'zosmf' profile)" - }, - { - "name": "zosmf-password", - "aliases": [ - "zosmfpass", - "zosmfpw" - ], - "description": "Mainframe (z/OSMF) password, which can be the same as your TSO password.", - "type": "string", - "required": false, - "group": "z/OSMF connection options (alternatively use a 'zosmf' profile)" - }, - { - "name": "zosmf-reject-unauthorized", - "aliases": [ - "zosmfru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: true", - "type": "boolean", - "required": false, - "group": "z/OSMF connection options (alternatively use a 'zosmf' profile)" - }, - { - "name": "zosmf-base-path", - "aliases": [ - "zosmfbp" - ], - "description": "The base path for your API mediation layer instance. Specify this option toprepend the base path to all z/OSMF resources when making REST requests. Do notspecify this option if you are not using an API mediation layer.", - "type": "string", - "required": false, - "group": "z/OSMF connection options (alternatively use a 'zosmf' profile)" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "endevor-profile", - "aliases": [ - "endevor-p" - ], - "group": "Profile Options", - "description": "The name of a (endevor) 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": "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": [] - }, - { - "name": "response-format-filter", - "aliases": [ - "rff" - ], - "description": "Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.", - "type": "array", - "group": "Response Format Options" - }, - { - "name": "response-format-type", - "aliases": [ - "rft" - ], - "description": "The command response output format type. Must be one of the following:\n\ntable: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.\n\nlist: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.\n\nobject: Formats output data as a list of prettified objects (or single object). Can be used in place of \"table\" to change from tabular output to a list of prettified objects.\n\nstring: Formats output data as a string. JSON objects/arrays are stringified.", - "type": "string", - "allowableValues": { - "values": [ - "table", - "list", - "object", - "string" - ], - "caseSensitive": false - }, - "group": "Response Format Options" - }, - { - "name": "response-format-header", - "aliases": [ - "rfh" - ], - "description": "If \"--response-format-type table\" is specified, include the column headers in the output.", - "type": "boolean", - "group": "Response Format Options", - "defaultValue": null - } - ], - "outputFormatOptions": true, - "examples": [ - { - "description": "Compile the changed elements at \"/endevor/ebg/repository\" using work area with ID \"WORKAREA1\", jcl skeleton at \"/endevor/jcl/jcl.txt\" and existing Endevor and z/OSMF profiles", - "options": "--skeleton-jcl /endevor/jcl/jcl.txt --work-area-id WORKAREA1 --work-dir /endevor/ebg/repository" - }, - { - "description": "Compile the changed elements at \"/endevor/ebg/repository\" using build subsystem \"SUBNAME\", jcl skeleton at \"/endevor/jcl/jcl.txt\" and existing Endevor and z/OSMF profiles", - "options": "--skeleton-jcl /endevor/jcl/jcl.txt --endevor-subsystem SUBNAME --endevor-environment ENVNAME --endevor-system SYSNAME --work-dir /endevor/ebg/repository" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "job-report", - "aliases": [ - "jr" - ], - "type": "command", - "handler": "", - "summary": "Get report of build job. [step 2]", - "description": "Get the report after executing 'build job-submit' command. This this command must be issued to finalize processing.", - "profile": { - "optional": [ - "endevor", - "zosmf", - "base" - ] - }, - "options": [ - { - "name": "endevor-instance", - "aliases": [ - "endevori" - ], - "description": "The Endevor Web Services Endevor configuration name.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "work-dir", - "aliases": [ - "wd" - ], - "description": "The local working directory of your Git-Endevor mapping that you are building.", - "type": "string", - "defaultValue": "./", - "group": "Options" - }, - { - "name": "listing-dir", - "description": "Specify the directory where you would like to have your build outputs downloaded", - "type": "string", - "defaultValue": ".endevor/listings", - "group": "Options", - "aliases": [] - }, - { - "name": "listing-rc", - "description": "All the elements that have a generate result equal to or greater than \"listing-rc\" will have their build outputs downloaded into \"listing-dir\"", - "type": "number", - "defaultValue": 4, - "group": "Options", - "aliases": [] - }, - { - "name": "endevor-protocol", - "aliases": [ - "endevorprot" - ], - "description": "The Endevor SCM Rest API protocol. \n\nDefault value: http", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "endevor-host", - "aliases": [ - "endevorh" - ], - "description": "The Endevor Rest API hostname.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-port", - "aliases": [ - "endevorp" - ], - "description": "The Endevor Rest API port.", - "type": "number", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-user", - "aliases": [ - "endevoru" - ], - "description": "Mainframe (Endevor) username, which can be the same as your TSO login.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-password", - "aliases": [ - "endevorpass", - "endevorpw" - ], - "description": "Mainframe (Endevor) password, which can be the same as your TSO password.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-reject-unauthorized", - "aliases": [ - "endevorru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: true", - "type": "boolean", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-base-path", - "aliases": [ - "endevorbp" - ], - "description": "The Endevor SCM Rest API base path. \n\nDefault value: EndevorService/rest", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "zosmf-host", - "aliases": [ - "zosmfh" - ], - "description": "The z/OSMF server host name.", - "type": "string", - "required": false, - "group": "z/OSMF connection options (alternatively use a 'zosmf' profile)" - }, - { - "name": "zosmf-port", - "aliases": [ - "zosmfp" - ], - "description": "The z/OSMF server port.\n\nDefault value: 443", - "type": "number", - "required": false, - "group": "z/OSMF connection options (alternatively use a 'zosmf' profile)" - }, - { - "name": "zosmf-user", - "aliases": [ - "zosmfu" - ], - "description": "Mainframe (z/OSMF) username, which can be the same as your TSO login.", - "type": "string", - "required": false, - "group": "z/OSMF connection options (alternatively use a 'zosmf' profile)" - }, - { - "name": "zosmf-password", - "aliases": [ - "zosmfpass", - "zosmfpw" - ], - "description": "Mainframe (z/OSMF) password, which can be the same as your TSO password.", - "type": "string", - "required": false, - "group": "z/OSMF connection options (alternatively use a 'zosmf' profile)" - }, - { - "name": "zosmf-reject-unauthorized", - "aliases": [ - "zosmfru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: true", - "type": "boolean", - "required": false, - "group": "z/OSMF connection options (alternatively use a 'zosmf' profile)" - }, - { - "name": "zosmf-base-path", - "aliases": [ - "zosmfbp" - ], - "description": "The base path for your API mediation layer instance. Specify this option toprepend the base path to all z/OSMF resources when making REST requests. Do notspecify this option if you are not using an API mediation layer.", - "type": "string", - "required": false, - "group": "z/OSMF connection options (alternatively use a 'zosmf' profile)" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "endevor-profile", - "aliases": [ - "endevor-p" - ], - "group": "Profile Options", - "description": "The name of a (endevor) 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": "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": [] - }, - { - "name": "response-format-filter", - "aliases": [ - "rff" - ], - "description": "Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.", - "type": "array", - "group": "Response Format Options" - }, - { - "name": "response-format-type", - "aliases": [ - "rft" - ], - "description": "The command response output format type. Must be one of the following:\n\ntable: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.\n\nlist: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.\n\nobject: Formats output data as a list of prettified objects (or single object). Can be used in place of \"table\" to change from tabular output to a list of prettified objects.\n\nstring: Formats output data as a string. JSON objects/arrays are stringified.", - "type": "string", - "allowableValues": { - "values": [ - "table", - "list", - "object", - "string" - ], - "caseSensitive": false - }, - "group": "Response Format Options" - }, - { - "name": "response-format-header", - "aliases": [ - "rfh" - ], - "description": "If \"--response-format-type table\" is specified, include the column headers in the output.", - "type": "boolean", - "group": "Response Format Options", - "defaultValue": null - } - ], - "outputFormatOptions": true, - "examples": [ - { - "description": "Get the reports from the build job submitted by 'build job-submit' command from git working directory \"/endevor/ebg/repository\" using existing Endevor and z/OSMF profiles", - "options": "--wd \"C:\\endevor\\ebg\\dir\" " - } - ], - "positionals": [], - "passOn": [], - "children": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "name": "endevor-protocol", - "aliases": [ - "endevorprot" - ], - "description": "The Endevor SCM Rest API protocol. \n\nDefault value: http", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "endevor-host", - "aliases": [ - "endevorh" - ], - "description": "The Endevor Rest API hostname.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-port", - "aliases": [ - "endevorp" - ], - "description": "The Endevor Rest API port.", - "type": "number", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-user", - "aliases": [ - "endevoru" - ], - "description": "Mainframe (Endevor) username, which can be the same as your TSO login.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-password", - "aliases": [ - "endevorpass", - "endevorpw" - ], - "description": "Mainframe (Endevor) password, which can be the same as your TSO password.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-reject-unauthorized", - "aliases": [ - "endevorru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: true", - "type": "boolean", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-base-path", - "aliases": [ - "endevorbp" - ], - "description": "The Endevor SCM Rest API base path. \n\nDefault value: EndevorService/rest", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - } - ], - "merge": true - }, - { - "property": "options", - "value": [ - { - "name": "zosmf-host", - "aliases": [ - "zosmfh" - ], - "description": "The z/OSMF server host name.", - "type": "string", - "required": false, - "group": "z/OSMF connection options (alternatively use a 'zosmf' profile)" - }, - { - "name": "zosmf-port", - "aliases": [ - "zosmfp" - ], - "description": "The z/OSMF server port.\n\nDefault value: 443", - "type": "number", - "required": false, - "group": "z/OSMF connection options (alternatively use a 'zosmf' profile)" - }, - { - "name": "zosmf-user", - "aliases": [ - "zosmfu" - ], - "description": "Mainframe (z/OSMF) username, which can be the same as your TSO login.", - "type": "string", - "required": false, - "group": "z/OSMF connection options (alternatively use a 'zosmf' profile)" - }, - { - "name": "zosmf-password", - "aliases": [ - "zosmfpass", - "zosmfpw" - ], - "description": "Mainframe (z/OSMF) password, which can be the same as your TSO password.", - "type": "string", - "required": false, - "group": "z/OSMF connection options (alternatively use a 'zosmf' profile)" - }, - { - "name": "zosmf-reject-unauthorized", - "aliases": [ - "zosmfru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: true", - "type": "boolean", - "required": false, - "group": "z/OSMF connection options (alternatively use a 'zosmf' profile)" - }, - { - "name": "zosmf-base-path", - "aliases": [ - "zosmfbp" - ], - "description": "The base path for your API mediation layer instance. Specify this option toprepend the base path to all z/OSMF resources when making REST requests. Do notspecify this option if you are not using an API mediation layer.", - "type": "string", - "required": false, - "group": "z/OSMF connection options (alternatively use a 'zosmf' profile)" - } - ], - "merge": true, - "ignoreNodes": [ - { - "name": "execute", - "type": "command" - } - ] - } - ], - "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": "endevor-connection", - "aliases": [ - "co" - ], - "summary": "Manage the stored Endevor connections.", - "description": "Manage connections to Endevor Web Services used by Endevor Bridge for Git.", - "type": "group", - "children": [ - { - "name": "list", - "aliases": [ - "ls" - ], - "type": "command", - "handler": "", - "description": "List Endevor connections used by Endevor Bridge for Git.", - "summary": "List Endevor connections", - "profile": { - "optional": [ - "ebg", - "base" - ] - }, - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "The Endevor Bridge for Git SCM protocol. \n\nDefault value: https", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The Endevor Bridge for Git hostname.", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "The Endevor Bridge for Git port.", - "type": "number", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Endevor Bridge for Git username (your git username).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "token", - "aliases": [ - "t" - ], - "description": "Git personal access token (it can be obtained from your Git Enterprise Server).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: false", - "type": "boolean", - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "ebg-profile", - "aliases": [ - "ebg-p" - ], - "group": "Profile Options", - "description": "The name of a (ebg) profile to load for this command execution.", - "type": "string" - }, - { - "name": "base-profile", - "aliases": [ - "base-p" - ], - "group": "Profile Options", - "description": "The name of a (base) profile to load for this command execution.", - "type": "string" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Password to authenticate to service on the mainframe.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-type", - "aliases": [ - "tt" - ], - "description": "The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-value", - "aliases": [ - "tv" - ], - "description": "The value of the token to pass to the API.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "cert-file", - "description": "The file path to a certificate file to use for authentication.\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, - "examples": [ - { - "description": "List all the Endevor connections using the default EBG profile", - "options": "" - }, - { - "description": "List all the Endevor connections without an EBG profile", - "options": "--protocol http --host my-host --port 8080 --user my-git-username --token 1234567890" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "create", - "aliases": [ - "c" - ], - "type": "command", - "handler": "", - "description": "Create new Endevor connection for Endevor Bridge for Git.", - "summary": "Create new Endevor connection", - "positionals": [ - { - "name": "connection", - "description": "Endevor connection name.", - "type": "string", - "required": true - } - ], - "profile": { - "optional": [ - "ebg", - "endevor", - "base" - ] - }, - "options": [ - { - "name": "endevor-instance", - "aliases": [ - "endevori" - ], - "description": "The Endevor Web Services Endevor configuration name.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "endevor-protocol", - "aliases": [ - "endevorprot" - ], - "description": "The Endevor SCM Rest API protocol. \n\nDefault value: http", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "endevor-host", - "aliases": [ - "endevorh" - ], - "description": "The Endevor Rest API hostname.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-port", - "aliases": [ - "endevorp" - ], - "description": "The Endevor Rest API port.", - "type": "number", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-user", - "aliases": [ - "endevoru" - ], - "description": "Mainframe (Endevor) username, which can be the same as your TSO login.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-password", - "aliases": [ - "endevorpass", - "endevorpw" - ], - "description": "Mainframe (Endevor) password, which can be the same as your TSO password.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-reject-unauthorized", - "aliases": [ - "endevorru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: true", - "type": "boolean", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-base-path", - "aliases": [ - "endevorbp" - ], - "description": "The Endevor SCM Rest API base path. \n\nDefault value: EndevorService/rest", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "The Endevor Bridge for Git SCM protocol. \n\nDefault value: https", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The Endevor Bridge for Git hostname.", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "The Endevor Bridge for Git port.", - "type": "number", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Endevor Bridge for Git username (your git username).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "token", - "aliases": [ - "t" - ], - "description": "Git personal access token (it can be obtained from your Git Enterprise Server).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: false", - "type": "boolean", - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "ebg-profile", - "aliases": [ - "ebg-p" - ], - "group": "Profile Options", - "description": "The name of a (ebg) profile to load for this command execution.", - "type": "string" - }, - { - "name": "endevor-profile", - "aliases": [ - "endevor-p" - ], - "group": "Profile Options", - "description": "The name of a (endevor) profile to load for this command execution.", - "type": "string" - }, - { - "name": "base-profile", - "aliases": [ - "base-p" - ], - "group": "Profile Options", - "description": "The name of a (base) profile to load for this command execution.", - "type": "string" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Password to authenticate to service on the mainframe.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-type", - "aliases": [ - "tt" - ], - "description": "The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-value", - "aliases": [ - "tv" - ], - "description": "The value of the token to pass to the API.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "cert-file", - "description": "The file path to a certificate file to use for authentication.\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": "Create the Endevor connection 'MY-CONNECTION' using the default EBG and Endevor profile", - "options": "MY-CONNECTION --endevor-instance INSTANCE" - }, - { - "description": "Create the Endevor connection 'MY-CONNECTION' using the default EBG profile", - "options": "MY-CONNECTION --endevor-protocol http --endevor-host endevor-host --endevor-port 12345 --endevor-instance INSTANCE" - }, - { - "description": "Create the Endevor connection 'MY-CONNECTION' using the default Endevor profile", - "options": "MY-CONNECTION --protocol http --host bridge-host --port 8080 --endevor-instance INSTANCE" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "rename", - "aliases": [ - "ren" - ], - "type": "command", - "handler": "", - "description": "Rename existing Endevor connection defined to Endevor Bridge for Git.", - "summary": "Rename existing Endevor connection", - "positionals": [ - { - "name": "connection", - "description": "Endevor connection name.", - "type": "string", - "required": true - }, - { - "name": "new-connection", - "description": "New Endevor connection name.", - "type": "string", - "required": true - } - ], - "profile": { - "optional": [ - "ebg", - "base" - ] - }, - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "The Endevor Bridge for Git SCM protocol. \n\nDefault value: https", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The Endevor Bridge for Git hostname.", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "The Endevor Bridge for Git port.", - "type": "number", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Endevor Bridge for Git username (your git username).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "token", - "aliases": [ - "t" - ], - "description": "Git personal access token (it can be obtained from your Git Enterprise Server).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: false", - "type": "boolean", - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "ebg-profile", - "aliases": [ - "ebg-p" - ], - "group": "Profile Options", - "description": "The name of a (ebg) profile to load for this command execution.", - "type": "string" - }, - { - "name": "base-profile", - "aliases": [ - "base-p" - ], - "group": "Profile Options", - "description": "The name of a (base) profile to load for this command execution.", - "type": "string" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Password to authenticate to service on the mainframe.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-type", - "aliases": [ - "tt" - ], - "description": "The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-value", - "aliases": [ - "tv" - ], - "description": "The value of the token to pass to the API.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "cert-file", - "description": "The file path to a certificate file to use for authentication.\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": "Rename the Endevor connection using the default EBG profile", - "options": "MY-CONNECTION NEW-NAME" - }, - { - "description": "Rename the Endevor connection without an EBG profile", - "options": "MY-CONNECTION NEW-NAME --protocol http --host my-host --port 8080 --user my-git-username --token 1234567890" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "delete", - "aliases": [ - "del" - ], - "type": "command", - "handler": "", - "description": "Delete existing Endevor connection defined to Endevor Bridge for Git.", - "summary": "Delete existing Endevor connection", - "positionals": [ - { - "name": "connection", - "description": "Endevor connection name.", - "type": "string", - "required": true - } - ], - "profile": { - "optional": [ - "ebg", - "base" - ] - }, - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "The Endevor Bridge for Git SCM protocol. \n\nDefault value: https", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The Endevor Bridge for Git hostname.", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "The Endevor Bridge for Git port.", - "type": "number", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Endevor Bridge for Git username (your git username).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "token", - "aliases": [ - "t" - ], - "description": "Git personal access token (it can be obtained from your Git Enterprise Server).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: false", - "type": "boolean", - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "ebg-profile", - "aliases": [ - "ebg-p" - ], - "group": "Profile Options", - "description": "The name of a (ebg) profile to load for this command execution.", - "type": "string" - }, - { - "name": "base-profile", - "aliases": [ - "base-p" - ], - "group": "Profile Options", - "description": "The name of a (base) profile to load for this command execution.", - "type": "string" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Password to authenticate to service on the mainframe.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-type", - "aliases": [ - "tt" - ], - "description": "The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-value", - "aliases": [ - "tv" - ], - "description": "The value of the token to pass to the API.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "cert-file", - "description": "The file path to a certificate file to use for authentication.\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": "Delete the Endevor connection using the default EBG profile", - "options": "MY-CONNECTION" - }, - { - "description": "Delete the Endevor connection without an EBG profile", - "options": "MY-CONNECTION --protocol http --host my-host --port 8080 --user my-git-username --token 1234567890" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "update-credentials", - "aliases": [ - "uc" - ], - "type": "command", - "handler": "", - "description": "Update your Endevor credentials for the Endevor connection.", - "positionals": [ - { - "name": "connection", - "description": "Endevor connection name.", - "type": "string", - "required": true - } - ], - "profile": { - "optional": [ - "ebg", - "endevor", - "base" - ] - }, - "options": [ - { - "name": "endevor-user", - "aliases": [ - "endevoru" - ], - "description": "Mainframe (Endevor) username, which can be the same as your TSO login.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-password", - "aliases": [ - "endevorpass", - "endevorpw" - ], - "description": "Mainframe (Endevor) password, which can be the same as your TSO password.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "The Endevor Bridge for Git SCM protocol. \n\nDefault value: https", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The Endevor Bridge for Git hostname.", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "The Endevor Bridge for Git port.", - "type": "number", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Endevor Bridge for Git username (your git username).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "token", - "aliases": [ - "t" - ], - "description": "Git personal access token (it can be obtained from your Git Enterprise Server).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: false", - "type": "boolean", - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "ebg-profile", - "aliases": [ - "ebg-p" - ], - "group": "Profile Options", - "description": "The name of a (ebg) profile to load for this command execution.", - "type": "string" - }, - { - "name": "endevor-profile", - "aliases": [ - "endevor-p" - ], - "group": "Profile Options", - "description": "The name of a (endevor) profile to load for this command execution.", - "type": "string" - }, - { - "name": "base-profile", - "aliases": [ - "base-p" - ], - "group": "Profile Options", - "description": "The name of a (base) profile to load for this command execution.", - "type": "string" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Password to authenticate to service on the mainframe.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-type", - "aliases": [ - "tt" - ], - "description": "The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-value", - "aliases": [ - "tv" - ], - "description": "The value of the token to pass to the API.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "cert-file", - "description": "The file path to a certificate file to use for authentication.\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": "Update the Endevor credentials for the Endevor connection MY-CONNECTION using the default EBG and Endevor profile", - "options": "MY-CONNECTION" - }, - { - "description": "Update the Endevor credentials for the Endevor connection MY-CONNECTION using the default EBG profile but not using an Endevor profile", - "options": "MY-CONNECTION --endevor-user my-user --endevor-password my-password" - } - ], - "passOn": [], - "children": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "The Endevor Bridge for Git SCM protocol. \n\nDefault value: https", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The Endevor Bridge for Git hostname.", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "The Endevor Bridge for Git port.", - "type": "number", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Endevor Bridge for Git username (your git username).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "token", - "aliases": [ - "t" - ], - "description": "Git personal access token (it can be obtained from your Git Enterprise Server).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: false", - "type": "boolean", - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - } - ], - "merge": true - } - ], - "options": [ - { - "name": "help-examples", - "group": "Global Options", - "description": "Display examples for all the commands in a group", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [] - }, - { - "name": "local-hook-token", - "aliases": [ - "token" - ], - "summary": "Manage your stored local hook token", - "description": "Manage the token you use for secure communication with BridgeForGit when using the local hook validation.", - "type": "group", - "children": [ - { - "name": "generate", - "aliases": [ - "g" - ], - "type": "command", - "handler": "", - "description": "Generate a new local hook token for Endevor Bridge for Git.", - "summary": "Generate a new token", - "profile": { - "optional": [ - "ebg", - "base" - ] - }, - "options": [ - { - "name": "overwrite", - "description": "If specified, your previous token will be overwritten.", - "type": "boolean", - "defaultValue": false, - "group": "Options", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "The Endevor Bridge for Git SCM protocol. \n\nDefault value: https", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The Endevor Bridge for Git hostname.", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "The Endevor Bridge for Git port.", - "type": "number", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Endevor Bridge for Git username (your git username).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "token", - "aliases": [ - "t" - ], - "description": "Git personal access token (it can be obtained from your Git Enterprise Server).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: false", - "type": "boolean", - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "ebg-profile", - "aliases": [ - "ebg-p" - ], - "group": "Profile Options", - "description": "The name of a (ebg) profile to load for this command execution.", - "type": "string" - }, - { - "name": "base-profile", - "aliases": [ - "base-p" - ], - "group": "Profile Options", - "description": "The name of a (base) profile to load for this command execution.", - "type": "string" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Password to authenticate to service on the mainframe.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-type", - "aliases": [ - "tt" - ], - "description": "The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-value", - "aliases": [ - "tv" - ], - "description": "The value of the token to pass to the API.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "cert-file", - "description": "The file path to a certificate file to use for authentication.\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": "Generate a token using the default EBG profile", - "options": "" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "revoke", - "aliases": [ - "r" - ], - "type": "command", - "handler": "", - "description": "Revoke your local hook token.", - "summary": "Revoke your local hook token.", - "profile": { - "optional": [ - "ebg", - "base" - ] - }, - "examples": [ - { - "description": "Revoke your token using the default EBG profile", - "options": "" - } - ], - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "The Endevor Bridge for Git SCM protocol. \n\nDefault value: https", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The Endevor Bridge for Git hostname.", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "The Endevor Bridge for Git port.", - "type": "number", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Endevor Bridge for Git username (your git username).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "token", - "aliases": [ - "t" - ], - "description": "Git personal access token (it can be obtained from your Git Enterprise Server).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: false", - "type": "boolean", - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "ebg-profile", - "aliases": [ - "ebg-p" - ], - "group": "Profile Options", - "description": "The name of a (ebg) profile to load for this command execution.", - "type": "string" - }, - { - "name": "base-profile", - "aliases": [ - "base-p" - ], - "group": "Profile Options", - "description": "The name of a (base) profile to load for this command execution.", - "type": "string" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Password to authenticate to service on the mainframe.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-type", - "aliases": [ - "tt" - ], - "description": "The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-value", - "aliases": [ - "tv" - ], - "description": "The value of the token to pass to the API.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "cert-file", - "description": "The file path to a certificate file to use for authentication.\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": [], - "passOn": [], - "children": [] - }, - { - "name": "list", - "aliases": [ - "ls" - ], - "type": "command", - "handler": "", - "description": "List your local hook token.", - "summary": "List your local hook token.", - "profile": { - "optional": [ - "ebg", - "base" - ] - }, - "examples": [ - { - "description": "List your token using the default EBG profile", - "options": "" - } - ], - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "The Endevor Bridge for Git SCM protocol. \n\nDefault value: https", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The Endevor Bridge for Git hostname.", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "The Endevor Bridge for Git port.", - "type": "number", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Endevor Bridge for Git username (your git username).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "token", - "aliases": [ - "t" - ], - "description": "Git personal access token (it can be obtained from your Git Enterprise Server).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: false", - "type": "boolean", - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "ebg-profile", - "aliases": [ - "ebg-p" - ], - "group": "Profile Options", - "description": "The name of a (ebg) profile to load for this command execution.", - "type": "string" - }, - { - "name": "base-profile", - "aliases": [ - "base-p" - ], - "group": "Profile Options", - "description": "The name of a (base) profile to load for this command execution.", - "type": "string" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Password to authenticate to service on the mainframe.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-type", - "aliases": [ - "tt" - ], - "description": "The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-value", - "aliases": [ - "tv" - ], - "description": "The value of the token to pass to the API.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "cert-file", - "description": "The file path to a certificate file to use for authentication.\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": [], - "passOn": [], - "children": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "The Endevor Bridge for Git SCM protocol. \n\nDefault value: https", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The Endevor Bridge for Git hostname.", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "The Endevor Bridge for Git port.", - "type": "number", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Endevor Bridge for Git username (your git username).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "token", - "aliases": [ - "t" - ], - "description": "Git personal access token (it can be obtained from your Git Enterprise Server).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: false", - "type": "boolean", - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - } - ], - "merge": true - } - ], - "options": [ - { - "name": "help-examples", - "group": "Global Options", - "description": "Display examples for all the commands in a group", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [] - }, - { - "name": "mapping", - "aliases": [ - "m" - ], - "description": "Manage the Git-Endevor mappings.", - "type": "group", - "children": [ - { - "name": "create", - "aliases": [ - "c" - ], - "type": "command", - "handler": "", - "description": "Create a Git-Endevor mapping", - "profile": { - "optional": [ - "ebg", - "endevor", - "base" - ] - }, - "options": [ - { - "name": "remote-url", - "aliases": [ - "url" - ], - "description": "Git repository remote URL", - "type": "string", - "required": false, - "conflictsWith": [ - "json-file" - ], - "group": "Options" - }, - { - "name": "connection", - "description": "Endevor connection name.", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "endevor-instance", - "aliases": [ - "endevori" - ], - "description": "The Endevor Web Services Endevor configuration name.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "endevor-system", - "aliases": [ - "endevorsys", - "system" - ], - "description": "The Endevor system where your project resides.", - "type": "string", - "stringLengthRange": [ - 1, - 8 - ], - "required": false, - "group": "Options" - }, - { - "name": "endevor-subsystem", - "aliases": [ - "endevorsub", - "sub", - "subsystem" - ], - "description": "The Endevor subsystem where your project resides.", - "type": "string", - "stringLengthRange": [ - 1, - 8 - ], - "required": false, - "group": "Options" - }, - { - "name": "system-alias", - "description": "The alias of Endevor system.", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "subsystem-alias", - "description": "The alias of Endevor subsystem.", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "endevor-environment", - "aliases": [ - "endevorenv", - "env", - "environment" - ], - "description": "The Endevor environment where your project resides.", - "type": "string", - "stringLengthRange": [ - 1, - 8 - ], - "required": false, - "group": "Options" - }, - { - "name": "branch", - "aliases": [ - "b" - ], - "description": "Name of the synchronized branch in the Git repository.", - "type": "string", - "defaultValue": "master", - "group": "Options" - }, - { - "name": "read-only", - "description": "If specified, it is necessary to use the option --endevor-stage-number. The synchronized elements will be read-only.", - "type": "boolean", - "required": false, - "implies": [ - "endevor-stage-number" - ], - "conflictsWith": [ - "json-file" - ], - "group": "Options", - "aliases": [] - }, - { - "name": "endevor-stage-number", - "aliases": [ - "endevorsn" - ], - "description": "The Endevor stage where your project resides (only for read only mappings).", - "type": "string", - "implies": [ - "read-only" - ], - "conflictsWith": [ - "json-file" - ], - "group": "Options" - }, - { - "name": "type-filters", - "description": "Type filters that your mapping will be using. There can be multiple separated by a space. eg --type-filters \"COBOL\" \"COPY\".", - "type": "array", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "name-filters", - "description": "Name filters that your mapping will be using. There can be multiple separated by a space. eg --name-filters \"ELE*\" \"CO*\".", - "type": "array", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "repository-check", - "description": "If set to allowNonEmpty, user can proceed with initialization even if the repository is not empty.", - "allowableValues": { - "values": [ - "REQUIRE_EMPTY", - "ALLOW_NON_EMPTY" - ] - }, - "type": "string", - "defaultValue": "REQUIRE_EMPTY", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "mapping-mode", - "description": "Mapping mode of the mapping ('FULL', 'WORK_ENV_ONLY' or 'MIRROR')", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "FULL", - "WORK_ENV_ONLY", - "MIRROR" - ], - "caseSensitive": true - }, - "group": "Options", - "aliases": [] - }, - { - "name": "json-file", - "aliases": [ - "json" - ], - "description": "Mapping JSON file to import", - "type": "existingLocalFile", - "required": false, - "conflictsWith": [ - "remote-url", - "endevor-stage-number", - "read-only", - "endevor-instance", - "endevor-environment", - "endevor-system", - "endevor-subsystem" - ], - "group": "Options" - }, - { - "name": "endevor-protocol", - "aliases": [ - "endevorprot" - ], - "description": "The Endevor SCM Rest API protocol. \n\nDefault value: http", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "endevor-host", - "aliases": [ - "endevorh" - ], - "description": "The Endevor Rest API hostname.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-port", - "aliases": [ - "endevorp" - ], - "description": "The Endevor Rest API port.", - "type": "number", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-user", - "aliases": [ - "endevoru" - ], - "description": "Mainframe (Endevor) username, which can be the same as your TSO login.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-password", - "aliases": [ - "endevorpass", - "endevorpw" - ], - "description": "Mainframe (Endevor) password, which can be the same as your TSO password.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-reject-unauthorized", - "aliases": [ - "endevorru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: true", - "type": "boolean", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-base-path", - "aliases": [ - "endevorbp" - ], - "description": "The Endevor SCM Rest API base path. \n\nDefault value: EndevorService/rest", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "The Endevor Bridge for Git SCM protocol. \n\nDefault value: https", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The Endevor Bridge for Git hostname.", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "The Endevor Bridge for Git port.", - "type": "number", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Endevor Bridge for Git username (your git username).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "token", - "aliases": [ - "t" - ], - "description": "Git personal access token (it can be obtained from your Git Enterprise Server).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: false", - "type": "boolean", - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "ebg-profile", - "aliases": [ - "ebg-p" - ], - "group": "Profile Options", - "description": "The name of a (ebg) profile to load for this command execution.", - "type": "string" - }, - { - "name": "endevor-profile", - "aliases": [ - "endevor-p" - ], - "group": "Profile Options", - "description": "The name of a (endevor) profile to load for this command execution.", - "type": "string" - }, - { - "name": "base-profile", - "aliases": [ - "base-p" - ], - "group": "Profile Options", - "description": "The name of a (base) profile to load for this command execution.", - "type": "string" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Password to authenticate to service on the mainframe.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-type", - "aliases": [ - "tt" - ], - "description": "The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-value", - "aliases": [ - "tv" - ], - "description": "The value of the token to pass to the API.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "cert-file", - "description": "The file path to a certificate file to use for authentication.\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": "Create the Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile", - "options": "--remote-url https://git-server-enterprise.com/my-context/my-mapping.git --endevor-instance INSTANCE --endevor-environment ENVNAME --endevor-system SYSNAME --endevor-subsystem SUBNAME " - }, - { - "description": "Create the Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile", - "options": "--remote-url https://git-server-enterprise.com/my-context/my-mapping.git --connection endevor-connection-name --endevor-environment ENVNAME --endevor-system SYSNAME --endevor-subsystem SUBNAME " - }, - { - "description": "Create the read-only Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile", - "options": "--remote-url https://git-server-enterprise.com/my-context/my-mapping.git --endevor-instance INSTANCE --endevor-environment ENVNAME --endevor-system SYSNAME --endevor-subsystem SUBNAME --read-only --endevor-stage-number 2" - }, - { - "description": "Create the Git-Endevor mapping with importing a mapping file", - "options": "--json-file my-mapping.json " - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "delete", - "aliases": [ - "del" - ], - "type": "command", - "handler": "", - "description": "Delete a Git-Endevor mapping", - "positionals": [ - { - "name": "context", - "description": "Git-Endevor mapping context (ID of the organization, project, team or owner of the Git repository).", - "type": "string", - "required": true - }, - { - "name": "mapping", - "description": "Git-Endevor mapping name (ID of the Git repository).", - "type": "string", - "required": true - } - ], - "profile": { - "optional": [ - "ebg", - "base" - ] - }, - "examples": [ - { - "description": "Delete the Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG profile", - "options": "MY-CONTEXT MY-MAPPING" - } - ], - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "The Endevor Bridge for Git SCM protocol. \n\nDefault value: https", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The Endevor Bridge for Git hostname.", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "The Endevor Bridge for Git port.", - "type": "number", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Endevor Bridge for Git username (your git username).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "token", - "aliases": [ - "t" - ], - "description": "Git personal access token (it can be obtained from your Git Enterprise Server).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: false", - "type": "boolean", - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "ebg-profile", - "aliases": [ - "ebg-p" - ], - "group": "Profile Options", - "description": "The name of a (ebg) profile to load for this command execution.", - "type": "string" - }, - { - "name": "base-profile", - "aliases": [ - "base-p" - ], - "group": "Profile Options", - "description": "The name of a (base) profile to load for this command execution.", - "type": "string" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Password to authenticate to service on the mainframe.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-type", - "aliases": [ - "tt" - ], - "description": "The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-value", - "aliases": [ - "tv" - ], - "description": "The value of the token to pass to the API.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "cert-file", - "description": "The file path to a certificate file to use for authentication.\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": "list", - "aliases": [ - "ls" - ], - "type": "command", - "handler": "", - "description": "List Git-Endevor mappings. If the mapping contains multiple systems and/or subsystems, the field 'system' and 'subsystem' will contain the value 'multi'.", - "summary": "List Git-Endevor mappings", - "profile": { - "optional": [ - "ebg", - "base" - ] - }, - "options": [ - { - "name": "view", - "aliases": [ - "v" - ], - "description": "Type of detail to be displayed.", - "type": "string", - "allowableValues": { - "values": [ - "default", - "endevor", - "all" - ], - "caseSensitive": false - }, - "defaultValue": "default", - "group": "Options" - }, - { - "name": "export", - "description": "Export list of mapping to a json file.", - "type": "boolean", - "defaultValue": false, - "group": "Options", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "The Endevor Bridge for Git SCM protocol. \n\nDefault value: https", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The Endevor Bridge for Git hostname.", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "The Endevor Bridge for Git port.", - "type": "number", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Endevor Bridge for Git username (your git username).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "token", - "aliases": [ - "t" - ], - "description": "Git personal access token (it can be obtained from your Git Enterprise Server).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: false", - "type": "boolean", - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "ebg-profile", - "aliases": [ - "ebg-p" - ], - "group": "Profile Options", - "description": "The name of a (ebg) profile to load for this command execution.", - "type": "string" - }, - { - "name": "base-profile", - "aliases": [ - "base-p" - ], - "group": "Profile Options", - "description": "The name of a (base) profile to load for this command execution.", - "type": "string" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Password to authenticate to service on the mainframe.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-type", - "aliases": [ - "tt" - ], - "description": "The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-value", - "aliases": [ - "tv" - ], - "description": "The value of the token to pass to the API.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "cert-file", - "description": "The file path to a certificate file to use for authentication.\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, - "examples": [ - { - "description": "List all the Git-Endevor mappings using the default EBG profile", - "options": "" - }, - { - "description": "List all the Git-Endevor mappings and show their Endevor details using the default EBG profile", - "options": "--view endevor" - }, - { - "description": "List all the Git-Endevor mappings and show all their details using the default EBG profile", - "options": "--view all" - }, - { - "description": "List all the Git-Endevor mappings without an EBG profile", - "options": "--protocol http --host my-host --port 8080 --user my-git-username --token 1234567890" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "add-element", - "aliases": [ - "add" - ], - "type": "command", - "handler": "", - "description": "Add an element from up the map in your Endevor to your Git repository.", - "positionals": [ - { - "name": "context", - "description": "Git-Endevor mapping context (ID of the organization, project, team or owner of the Git repository).", - "type": "string", - "required": true - }, - { - "name": "mapping", - "description": "Git-Endevor mapping name (ID of the Git repository).", - "type": "string", - "required": true - } - ], - "profile": { - "optional": [ - "ebg", - "endevor", - "base" - ] - }, - "options": [ - { - "name": "element-name", - "aliases": [ - "name" - ], - "description": "The name of the Endevor element you want to add.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "element-type", - "aliases": [ - "type" - ], - "description": "The type of the Endevor element you want to add", - "type": "string", - "stringLengthRange": [ - 1, - 8 - ], - "required": false, - "group": "Options" - }, - { - "name": "endevor-system", - "aliases": [ - "endevorsys", - "system" - ], - "description": "The Endevor system where your element resides.", - "type": "string", - "stringLengthRange": [ - 1, - 8 - ], - "group": "Options" - }, - { - "name": "endevor-subsystem", - "aliases": [ - "endevorsub", - "sub", - "subsystem" - ], - "description": "The Endevor subsystem where your element resides.", - "type": "string", - "stringLengthRange": [ - 1, - 8 - ], - "group": "Options" - }, - { - "name": "withDependencies", - "description": "If specified, the requested element will be added with dependencies (eg. COBOL copybooks).", - "type": "boolean", - "defaultValue": false, - "group": "Options", - "aliases": [] - }, - { - "name": "force-get-dependencies", - "aliases": [ - "force" - ], - "description": "If specified, the maximum number of dependencies will be bypassed. This only applies to the repository administrator.", - "type": "boolean", - "defaultValue": false, - "group": "Options" - }, - { - "name": "validate", - "description": "If specified, the requested elements will be validated against Endevor.", - "type": "boolean", - "defaultValue": false, - "group": "Options", - "aliases": [] - }, - { - "name": "branchId", - "description": "If specified, the requested elements will be added to the selected branch.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "all-branches", - "description": "If specified, the requested elements will be added to all synchronized branches in your repository.", - "type": "boolean", - "defaultValue": false, - "group": "Options", - "aliases": [] - }, - { - "name": "file", - "aliases": [ - "fn" - ], - "description": "If specified, the elements to add will be read from file. Make sure that the file is in the correct format as specified in the documentation.", - "type": "existingLocalFile", - "group": "Options" - }, - { - "name": "endevor-protocol", - "aliases": [ - "endevorprot" - ], - "description": "The Endevor SCM Rest API protocol. \n\nDefault value: http", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "endevor-host", - "aliases": [ - "endevorh" - ], - "description": "The Endevor Rest API hostname.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-port", - "aliases": [ - "endevorp" - ], - "description": "The Endevor Rest API port.", - "type": "number", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-user", - "aliases": [ - "endevoru" - ], - "description": "Mainframe (Endevor) username, which can be the same as your TSO login.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-password", - "aliases": [ - "endevorpass", - "endevorpw" - ], - "description": "Mainframe (Endevor) password, which can be the same as your TSO password.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-reject-unauthorized", - "aliases": [ - "endevorru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: true", - "type": "boolean", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-base-path", - "aliases": [ - "endevorbp" - ], - "description": "The Endevor SCM Rest API base path. \n\nDefault value: EndevorService/rest", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "The Endevor Bridge for Git SCM protocol. \n\nDefault value: https", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The Endevor Bridge for Git hostname.", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "The Endevor Bridge for Git port.", - "type": "number", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Endevor Bridge for Git username (your git username).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "token", - "aliases": [ - "t" - ], - "description": "Git personal access token (it can be obtained from your Git Enterprise Server).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: false", - "type": "boolean", - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "ebg-profile", - "aliases": [ - "ebg-p" - ], - "group": "Profile Options", - "description": "The name of a (ebg) profile to load for this command execution.", - "type": "string" - }, - { - "name": "endevor-profile", - "aliases": [ - "endevor-p" - ], - "group": "Profile Options", - "description": "The name of a (endevor) profile to load for this command execution.", - "type": "string" - }, - { - "name": "base-profile", - "aliases": [ - "base-p" - ], - "group": "Profile Options", - "description": "The name of a (base) profile to load for this command execution.", - "type": "string" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Password to authenticate to service on the mainframe.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-type", - "aliases": [ - "tt" - ], - "description": "The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-value", - "aliases": [ - "tv" - ], - "description": "The value of the token to pass to the API.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "cert-file", - "description": "The file path to a certificate file to use for authentication.\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": "Add an element 'MY-ELEMENT-TYPE / MY-ELEMENT-NAME' for your mapping 'MY-CONTEXT / MY-MAPPING'", - "options": "MY-CONTEXT MY-MAPPING --name MY-ELEMENT-NAME --type MY-ELEMENT-TYPE" - }, - { - "description": "Add multiple elements for your mapping 'MY-CONTEXT / MY-MAPPING' from file", - "options": "MY-CONTEXT MY-MAPPING --fileName MY-FILEPATH.json" - } - ], - "passOn": [], - "children": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "The Endevor Bridge for Git SCM protocol. \n\nDefault value: https", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The Endevor Bridge for Git hostname.", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "The Endevor Bridge for Git port.", - "type": "number", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Endevor Bridge for Git username (your git username).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "token", - "aliases": [ - "t" - ], - "description": "Git personal access token (it can be obtained from your Git Enterprise Server).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: false", - "type": "boolean", - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - } - ], - "merge": true - } - ], - "options": [ - { - "name": "help-examples", - "group": "Global Options", - "description": "Display examples for all the commands in a group", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [] - }, - { - "name": "processor-group", - "aliases": [ - "proc-group", - "pg" - ], - "description": "Manage the processor groups of your mapping", - "type": "group", - "children": [ - { - "name": "list", - "aliases": [ - "ls" - ], - "type": "command", - "handler": "", - "description": "List processor groups used by a type in your mapping", - "summary": "List Processor Groups", - "options": [ - { - "name": "work-dir", - "aliases": [ - "wd" - ], - "description": "The local working directory of your Git-Endevor mapping.", - "type": "string", - "defaultValue": "./", - "group": "Options" - }, - { - "name": "endevor-system", - "aliases": [ - "endevorsys" - ], - "description": "The Endevor system or alias of the system where your project resides.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "endevor-subsystem", - "aliases": [ - "endevorsub" - ], - "description": "The Endevor subsystem or alias of the subsystem where your project resides.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "type", - "aliases": [ - "type" - ], - "description": "The type of the Endevor element", - "type": "string", - "stringLengthRange": [ - 1, - 8 - ], - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "response-format-filter", - "aliases": [ - "rff" - ], - "description": "Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.", - "type": "array", - "group": "Response Format Options" - }, - { - "name": "response-format-type", - "aliases": [ - "rft" - ], - "description": "The command response output format type. Must be one of the following:\n\ntable: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.\n\nlist: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.\n\nobject: Formats output data as a list of prettified objects (or single object). Can be used in place of \"table\" to change from tabular output to a list of prettified objects.\n\nstring: Formats output data as a string. JSON objects/arrays are stringified.", - "type": "string", - "allowableValues": { - "values": [ - "table", - "list", - "object", - "string" - ], - "caseSensitive": false - }, - "group": "Response Format Options" - }, - { - "name": "response-format-header", - "aliases": [ - "rfh" - ], - "description": "If \"--response-format-type table\" is specified, include the column headers in the output.", - "type": "boolean", - "group": "Response Format Options", - "defaultValue": null - } - ], - "outputFormatOptions": true, - "examples": [ - { - "description": "List all the processor groups used by a type in your mapping for a single system/subsystem mapping.", - "options": "--type TYPE" - }, - { - "description": "List all the processor groups used by a type in your mapping for a multi system/subsystem mapping.", - "options": "--endevorsys SYSTEM --endevorsub SUBSYSTEM --type TYPE" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "update", - "aliases": [ - "u" - ], - "type": "command", - "handler": "", - "description": "Update the processor group of a specific element in your local repository", - "summary": "Update the processor group of an element", - "positionals": [ - { - "name": "element", - "aliases": [ - "element" - ], - "description": "The name of the Endevor element that its processor group will be modified", - "type": "string", - "required": true - }, - { - "name": "processor-group", - "aliases": [ - "proc-group", - "pg" - ], - "description": "The name of the processor group you want to use", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "work-dir", - "aliases": [ - "wd" - ], - "description": "The local working directory of your Git-Endevor mapping.", - "type": "string", - "defaultValue": "./", - "group": "Options" - }, - { - "name": "endevor-system", - "aliases": [ - "endevorsys" - ], - "description": "The Endevor system or alias of the system where your project resides.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "endevor-subsystem", - "aliases": [ - "endevorsub" - ], - "description": "The Endevor subsystem or alias of the subsystem where your project resides.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "type", - "aliases": [ - "type" - ], - "description": "The type of the Endevor element", - "type": "string", - "stringLengthRange": [ - 1, - 8 - ], - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "response-format-filter", - "aliases": [ - "rff" - ], - "description": "Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.", - "type": "array", - "group": "Response Format Options" - }, - { - "name": "response-format-type", - "aliases": [ - "rft" - ], - "description": "The command response output format type. Must be one of the following:\n\ntable: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.\n\nlist: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.\n\nobject: Formats output data as a list of prettified objects (or single object). Can be used in place of \"table\" to change from tabular output to a list of prettified objects.\n\nstring: Formats output data as a string. JSON objects/arrays are stringified.", - "type": "string", - "allowableValues": { - "values": [ - "table", - "list", - "object", - "string" - ], - "caseSensitive": false - }, - "group": "Response Format Options" - }, - { - "name": "response-format-header", - "aliases": [ - "rfh" - ], - "description": "If \"--response-format-type table\" is specified, include the column headers in the output.", - "type": "boolean", - "group": "Response Format Options", - "defaultValue": null - } - ], - "outputFormatOptions": true, - "examples": [], - "passOn": [], - "children": [] - }, - { - "name": "update-all", - "aliases": [ - "ua" - ], - "type": "command", - "handler": "", - "description": "Update the processor group of all changed elements of a specific type", - "summary": "Update the processor group of all changed elements", - "positionals": [ - { - "name": "processor-group", - "aliases": [ - "proc-group", - "pg" - ], - "description": "The name of the processor group you want to use", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "work-dir", - "aliases": [ - "wd" - ], - "description": "The local working directory of your Git-Endevor mapping.", - "type": "string", - "defaultValue": "./", - "group": "Options" - }, - { - "name": "endevor-system", - "aliases": [ - "endevorsys" - ], - "description": "The Endevor system or alias of the system where your project resides.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "endevor-subsystem", - "aliases": [ - "endevorsub" - ], - "description": "The Endevor subsystem or alias of the subsystem where your project resides.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "type", - "aliases": [ - "type" - ], - "description": "The type of the Endevor element", - "type": "string", - "stringLengthRange": [ - 1, - 8 - ], - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "response-format-filter", - "aliases": [ - "rff" - ], - "description": "Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.", - "type": "array", - "group": "Response Format Options" - }, - { - "name": "response-format-type", - "aliases": [ - "rft" - ], - "description": "The command response output format type. Must be one of the following:\n\ntable: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.\n\nlist: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.\n\nobject: Formats output data as a list of prettified objects (or single object). Can be used in place of \"table\" to change from tabular output to a list of prettified objects.\n\nstring: Formats output data as a string. JSON objects/arrays are stringified.", - "type": "string", - "allowableValues": { - "values": [ - "table", - "list", - "object", - "string" - ], - "caseSensitive": false - }, - "group": "Response Format Options" - }, - { - "name": "response-format-header", - "aliases": [ - "rfh" - ], - "description": "If \"--response-format-type table\" is specified, include the column headers in the output.", - "type": "boolean", - "group": "Response Format Options", - "defaultValue": null - } - ], - "outputFormatOptions": true, - "examples": [], - "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" - } - ], - "positionals": [], - "passOn": [] - }, - { - "name": "work-area", - "aliases": [ - "wa" - ], - "description": "Use an Endevor work area from the list defined by your administrator.", - "type": "group", - "children": [ - { - "name": "list", - "aliases": [ - "ls" - ], - "type": "command", - "handler": "", - "description": "List Endevor work areas.", - "positionals": [ - { - "name": "work-area-id", - "type": "string", - "description": "Specify to list only one Endevor work area ID. Name-masking is not allowed." - } - ], - "options": [ - { - "name": "work-dir", - "aliases": [ - "wd" - ], - "description": "The local working directory of your Git-Endevor mapping that you are building.", - "type": "string", - "defaultValue": "./", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "response-format-filter", - "aliases": [ - "rff" - ], - "description": "Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.", - "type": "array", - "group": "Response Format Options" - }, - { - "name": "response-format-type", - "aliases": [ - "rft" - ], - "description": "The command response output format type. Must be one of the following:\n\ntable: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.\n\nlist: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.\n\nobject: Formats output data as a list of prettified objects (or single object). Can be used in place of \"table\" to change from tabular output to a list of prettified objects.\n\nstring: Formats output data as a string. JSON objects/arrays are stringified.", - "type": "string", - "allowableValues": { - "values": [ - "table", - "list", - "object", - "string" - ], - "caseSensitive": false - }, - "group": "Response Format Options" - }, - { - "name": "response-format-header", - "aliases": [ - "rfh" - ], - "description": "If \"--response-format-type table\" is specified, include the column headers in the output.", - "type": "boolean", - "group": "Response Format Options", - "defaultValue": null - } - ], - "outputFormatOptions": true, - "examples": [ - { - "description": "Show the details of all the work areas in the current working directory", - "options": "" - }, - { - "description": "Show the details of work area with ID \"WORKAREA1\"", - "options": "WORKAREA1" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "reserve", - "aliases": [ - "r" - ], - "type": "command", - "handler": "", - "summary": "Reserve work area in Endevor.", - "description": "Reserve the first found available Endevor work area. When success, returns the reserved work area id", - "positionals": [ - { - "name": "work-area-id", - "type": "string", - "description": "Reserve the Endevor work area with the ID specified. Name-masking is not allowed." - } - ], - "profile": { - "optional": [ - "endevor", - "base" - ] - }, - "options": [ - { - "name": "endevor-instance", - "aliases": [ - "endevori" - ], - "description": "The Endevor Web Services Endevor configuration name.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "work-dir", - "aliases": [ - "wd" - ], - "description": "The local working directory of your Git-Endevor mapping that you are building.", - "type": "string", - "defaultValue": "./", - "group": "Options" - }, - { - "name": "endevor-protocol", - "aliases": [ - "endevorprot" - ], - "description": "The Endevor SCM Rest API protocol. \n\nDefault value: http", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "endevor-host", - "aliases": [ - "endevorh" - ], - "description": "The Endevor Rest API hostname.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-port", - "aliases": [ - "endevorp" - ], - "description": "The Endevor Rest API port.", - "type": "number", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-user", - "aliases": [ - "endevoru" - ], - "description": "Mainframe (Endevor) username, which can be the same as your TSO login.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-password", - "aliases": [ - "endevorpass", - "endevorpw" - ], - "description": "Mainframe (Endevor) password, which can be the same as your TSO password.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-reject-unauthorized", - "aliases": [ - "endevorru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: true", - "type": "boolean", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-base-path", - "aliases": [ - "endevorbp" - ], - "description": "The Endevor SCM Rest API base path. \n\nDefault value: EndevorService/rest", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "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": "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": [ - { - "description": "Reserve the first found available Endevor work area using an existing Endevor profile", - "options": "--endevor-instance ENDEVOR" - }, - { - "description": "Reserve the work area with ID \"WORKAREA1\", if available, using an existing Endevor profile", - "options": "WORKAREA1 --endevor-instance ENDEVOR" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "unreserve", - "aliases": [ - "unr" - ], - "type": "command", - "handler": "", - "description": "Unreserve an Endevor work area.", - "positionals": [ - { - "name": "work-area-id", - "type": "string", - "description": "Endevor work area ID. Name-masking is not allowed.", - "required": true - } - ], - "profile": { - "optional": [ - "endevor", - "base" - ] - }, - "options": [ - { - "name": "endevor-instance", - "aliases": [ - "endevori" - ], - "description": "The Endevor Web Services Endevor configuration name.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "work-dir", - "aliases": [ - "wd" - ], - "description": "The local working directory of your Git-Endevor mapping that you are building.", - "type": "string", - "defaultValue": "./", - "group": "Options" - }, - { - "name": "endevor-protocol", - "aliases": [ - "endevorprot" - ], - "description": "The Endevor SCM Rest API protocol. \n\nDefault value: http", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "endevor-host", - "aliases": [ - "endevorh" - ], - "description": "The Endevor Rest API hostname.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-port", - "aliases": [ - "endevorp" - ], - "description": "The Endevor Rest API port.", - "type": "number", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-user", - "aliases": [ - "endevoru" - ], - "description": "Mainframe (Endevor) username, which can be the same as your TSO login.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-password", - "aliases": [ - "endevorpass", - "endevorpw" - ], - "description": "Mainframe (Endevor) password, which can be the same as your TSO password.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-reject-unauthorized", - "aliases": [ - "endevorru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: true", - "type": "boolean", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-base-path", - "aliases": [ - "endevorbp" - ], - "description": "The Endevor SCM Rest API base path. \n\nDefault value: EndevorService/rest", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "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": "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": [ - { - "description": "Unreserve work area with id \"WORKAREA1\" using an existing Endevor profile", - "options": "WORKAREA1 --endevor-instance ENDEVOR" - } - ], - "passOn": [], - "children": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "name": "endevor-protocol", - "aliases": [ - "endevorprot" - ], - "description": "The Endevor SCM Rest API protocol. \n\nDefault value: http", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "endevor-host", - "aliases": [ - "endevorh" - ], - "description": "The Endevor Rest API hostname.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-port", - "aliases": [ - "endevorp" - ], - "description": "The Endevor Rest API port.", - "type": "number", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-user", - "aliases": [ - "endevoru" - ], - "description": "Mainframe (Endevor) username, which can be the same as your TSO login.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-password", - "aliases": [ - "endevorpass", - "endevorpw" - ], - "description": "Mainframe (Endevor) password, which can be the same as your TSO password.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-reject-unauthorized", - "aliases": [ - "endevorru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: true", - "type": "boolean", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-base-path", - "aliases": [ - "endevorbp" - ], - "description": "The Endevor SCM Rest API base path. \n\nDefault value: EndevorService/rest", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - } - ], - "merge": true, - "ignoreNodes": [ - { - "name": "list", - "type": "command" - } - ] - } - ], - "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": "Interact with a Endevor Bridge for Git server", - "aliases": [ - "ebg" - ], - "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 deleted file mode 100644 index fa56cce..0000000 --- a/commandGroups/endevor.jsonc +++ /dev/null @@ -1,23975 +0,0 @@ -// 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/file-master-plus.jsonc b/commandGroups/file-master-plus.jsonc deleted file mode 100644 index 9496e02..0000000 --- a/commandGroups/file-master-plus.jsonc +++ /dev/null @@ -1,6636 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "file-master-plus", - "description": "File Master Plus command line interface is a file management and data manipulation tool.\nIt speeds up file creation and manipulates virtual storage access method (VSAM), sequential and partitioned data sets.\nIt also supports symbolic access to data via layouts and data manipulation like selection of records in data sets.", - "type": "group", - "children": [ - { - "name": "copy", - "aliases": [ - "c" - ], - "type": "group", - "summary": "Copy a data set", - "description": "Copy data from a data set and optionally filter or modify the copied data by using selection criteria.", - "children": [ - { - "name": "data-set", - "aliases": [ - "ds" - ], - "description": "Copy from a data set to another data set.\nIf the data set does not exist, File Master Plus automatically creates a new data set using the attributes of data set.\nIt supports all data set types that are supported by File Master Plus.", - "summary": "Copy a data set", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "from", - "type": "string", - "description": "Specifies the name of the data set to copy from.", - "required": true - }, - { - "name": "to", - "type": "string", - "description": "Specifies the name of the data set to copy to.", - "required": true - } - ], - "options": [ - { - "name": "members", - "aliases": [ - "m" - ], - "description": "Specifies the members that you want to copy from the data set. To rename the member, specify a new member name after the delimiter ','.If this parameter is not specified all the members are copied.\nNote: This parameter only applies to a PDS or PDSE.\nExample: --mem mem1,newmem1 mem2. Here 'mem2' is copied as it is, and 'mem1' is renamed as 'newmem1'.", - "type": "array", - "required": false, - "group": "Options" - }, - { - "name": "generation", - "aliases": [ - "g" - ], - "description": "Specifies the PDSE V2 generation number that you want to copy from the data set from.\nNote: This parameter should only be specified if data set from is PDSEV2. If not specified and data set from is a PDSE V2 then current generation, i.e. generation 0, is copied. If generation is negative specifies Relative generation, positive specifies Absolute generation, * specifies all generations and 0 specifies current generation.\nExample1: --generation *. All generations of member(s) is copied.\nExample2: --generation -1. Relative generation -1 of member(s) is copied.\nExample3: --generation 4. Absolute generation 4 of member(s) is copied.\nAllowed values: '*','range from -2000000000 to 2000000000'", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "replace", - "aliases": [ - "r" - ], - "description": "Replace resource-specific items in the target data set. Note: Used only if the target data set is a PDS or a VSAM KSDS.\nExample: -r n.", - "type": "string", - "required": false, - "defaultValue": "y", - "allowableValues": { - "values": [ - "y", - "n" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "static-selection-criteria", - "aliases": [ - "ssc" - ], - "description": "Specifies the name of pre-defined File Master Plus selection criteria. The name refers to a member in the defaultselection criteria data set as defined in the FMM_CLIST parameter in File Master Plus server.\nExample: --ssc testcri", - "type": "string", - "conflictsWith": [ - "dynamic-selection-criteria" - ], - "required": false, - "group": "Options" - }, - { - "name": "dynamic-selection-criteria", - "aliases": [ - "dsc" - ], - "description": "Specifies path of the .txt file where the dynamic selection criteria exist. Ensure the format of the file is identical to the static selection criteria created by File Master Plus. If the selection criteria refer to field names in a Cobol or PL/I copybook, use the --layout-member and --layout-data-set parameters to name the copybook location.\nExample: --dsc ../selcri/testcri.txt ", - "type": "string", - "conflictsWith": [ - "static-selection-criteria" - ], - "required": false, - "group": "Options" - }, - { - "name": "layout-member", - "aliases": [ - "lm" - ], - "description": "Specifies name of the Cobol or PL/I copybook.\nExample: -lm testlay.", - "type": "string", - "required": false, - "implies": [ - "layout-data-set", - "dynamic-selection-criteria" - ], - "group": "Options" - }, - { - "name": "layout-data-set", - "aliases": [ - "lds" - ], - "description": "Specifies name of the data set that contains the layout member.\nExample: -lds fmmvs.layout.dataset.", - "type": "string", - "required": false, - "implies": [ - "layout-member", - "dynamic-selection-criteria" - ], - "group": "Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies File Master Plus server host name.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies File Master Plus server port.", - "type": "number", - "defaultValue": 51914, - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Specifies Mainframe user name. May be the same as TSO login.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Specifies Mainframe password. May be the same as TSO password.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies File Master Plus REST API protocol.", - "type": "string", - "defaultValue": "https", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "FMP Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "required": false, - "group": "FMP 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 FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "FMP 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": "fmp-profile", - "aliases": [ - "fmp-p" - ], - "group": "Profile Options", - "description": "The name of a (fmp) 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": [] - } - ], - "profile": { - "optional": [ - "fmp", - "base" - ] - }, - "examples": [ - { - "options": "fmmvs.pds1 fmmvs.pds2", - "description": "Copying a data set" - }, - { - "options": "fmmvs.from.ps fmmvs.to.ps --lds fmmvs.layout.dataset --lm testlay --dsc ./fmmvs/selcri/testcri", - "description": "Copying a data set with dynamic selection criteria" - }, - { - "options": "fmmvs.from.psdsev2 fmmvs.to.psdsev2 --generation *", - "description": "Copying a PDSE V2 data set with all generations" - } - ], - "passOn": [], - "children": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies File Master Plus server host name.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies File Master Plus server port.", - "type": "number", - "defaultValue": 51914, - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Specifies Mainframe user name. May be the same as TSO login.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Specifies Mainframe password. May be the same as TSO password.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies File Master Plus REST API protocol.", - "type": "string", - "defaultValue": "https", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "FMP Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "required": false, - "group": "FMP 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 FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "FMP 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": [] - }, - { - "name": "create", - "aliases": [ - "cre" - ], - "type": "group", - "description": "Create a data set.", - "summary": "Create a data set", - "children": [ - { - "name": "physical-sequential", - "aliases": [ - "ps" - ], - "summary": "Create a physical sequential data set", - "type": "command", - "description": "Create a physical sequential data set.", - "handler": "", - "positionals": [ - { - "name": "name", - "type": "string", - "description": "Specifies the name of the data set to create.", - "required": true - } - ], - "options": [ - { - "name": "model", - "aliases": [ - "m" - ], - "description": "Specifies the name of a model physical sequential data set name for allocating parameters.\nThe parameters of the model data set override all defaults.\nExample: -m fmmvs.model.dsname", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "logical-record-length", - "aliases": [ - "lrecl", - "lrl" - ], - "description": "Specifies the length of the logical record.\nAllowed values: 1-32760\nDefault value: 80\nExample: --lrecl 80", - "type": "number", - "required": false, - "numericValueRange": [ - 1, - 32760 - ], - "group": "Options" - }, - { - "name": "block-size", - "aliases": [ - "blksize", - "bs" - ], - "description": "Specifies the size of the block of records.\nAllowed values: 1-32760\nDefault value: 6160\nExample: --blksize 6160", - "type": "number", - "required": false, - "numericValueRange": [ - 1, - 32760 - ], - "group": "Options" - }, - { - "name": "record-format", - "aliases": [ - "recfm", - "rf" - ], - "description": "Specifies the record format.\nThe allowed values which have the following meaning: \nF - Fixed-length records\nV - Variable-length records\nU - Undefined-length records\nB - Records are blocked\nA - Records contain ASCII printer control characters\nM - Records contain machine code control characters\nS - For variable-length records, records may span blocks\nT - Records may be written into overflow tracks\nDefault value: FB\nExample: --recfm FB", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "F", - "FA", - "FM", - "FB", - "FBA", - "FBM", - "FS", - "FSA", - "FSM", - "FT", - "FTA", - "FTM", - "FBS", - "FBT", - "U", - "UA", - "UM", - "UT", - "UTA", - "UTM", - "V", - "VA", - "VM", - "VB", - "VBA", - "VBM", - "VS", - "VSA", - "VSM", - "VT", - "VTA", - "VTM", - "VBS", - "VBT" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "space-units", - "aliases": [ - "su" - ], - "description": "Specifies the space allocation unit.\nThe allowed values which have the following meaning:\nTRK - Tracks\nCYL - Cylinders\nBLK - Blocksize\nDefault value: CYL\nExample: --su blk", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "TRK", - "CYL", - "BLK" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "primary-space", - "aliases": [ - "ps" - ], - "description": "Specifies primary space allocation unit.\nAllowed values: 1-16777215\nDefault value: 1\nExample: --ps 3", - "type": "number", - "required": false, - "numericValueRange": [ - 1, - 16777215 - ], - "group": "Options" - }, - { - "name": "secondary-space", - "aliases": [ - "ss" - ], - "description": "Specifies secondary space allocation unit.\nAllowed values: 1-16777215\nDefault value: 1\nExample: --ss 5", - "type": "number", - "required": false, - "numericValueRange": [ - 1, - 16777215 - ], - "group": "Options" - }, - { - "name": "volume", - "aliases": [ - "v" - ], - "description": "Specifies a disk volume or specific tapes.\nExample: -v vol002", - "type": "array", - "required": false, - "group": "Options" - }, - { - "name": "unit-type", - "aliases": [ - "ut" - ], - "description": "Specifies the DASD unit name.\nExample: --ut sysda", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "expiration-date", - "aliases": [ - "ed" - ], - "description": "Specifies the expiration date after which the data set can be deleted.\nSpecify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.\nExample: --ed 2032-07-31", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "storage-class", - "aliases": [ - "sc" - ], - "description": "Specifies the storage class.\nExample: --sc scl002", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "management-class", - "aliases": [ - "mc" - ], - "description": "Specifies the management class.\nExample: --mc mcl002", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "data-class", - "aliases": [ - "dc" - ], - "description": "Specifies the data class.\nExample: --dc dcl002", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies File Master Plus server host name.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies File Master Plus server port.", - "type": "number", - "defaultValue": 51914, - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Specifies Mainframe user name. May be the same as TSO login.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Specifies Mainframe password. May be the same as TSO password.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies File Master Plus REST API protocol.", - "type": "string", - "defaultValue": "https", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "FMP Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "required": false, - "group": "FMP 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 FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "FMP 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": "fmp-profile", - "aliases": [ - "fmp-p" - ], - "group": "Profile Options", - "description": "The name of a (fmp) 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": [] - } - ], - "profile": { - "optional": [ - "fmp", - "base" - ] - }, - "examples": [ - { - "options": "fmmvs.test.dsname", - "description": "Creating a physical sequential data set with default option values" - }, - { - "options": "fmmvs.test.dsname --lrecl 180 --blksize 32720 --recfm vb --ps 5 --ss 5 -v vol005 --su trk --ed 2025-09-27", - "description": "Creating a physical sequential data set with options" - }, - { - "options": "fmmvs.test.dsname --model fmmvs.model.dsname", - "description": "Creating a physical sequential data set like a model physical sequential data set" - }, - { - "options": "fmmvs.test.dsname --model fmmvs.model.dsname --lrecl 180 --recfm VB --ps 5 --ss 5 --ed p", - "description": "Creating a physical sequential data set like a model physical sequential data set and overriding the parameters with options" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "large-format-sequential", - "aliases": [ - "large" - ], - "summary": "Create a large format sequential data set", - "type": "command", - "description": "Create a large format sequential data set.", - "handler": "", - "positionals": [ - { - "name": "name", - "type": "string", - "description": "Specifies the name of the data set to create.", - "required": true - } - ], - "options": [ - { - "name": "model", - "aliases": [ - "m" - ], - "description": "Specifies the name of a model large format sequential data set name for allocating parameters.\nThe parameters of the model data set override all defaults.\nExample: -m fmmvs.model.dsname", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "logical-record-length", - "aliases": [ - "lrecl", - "lrl" - ], - "description": "Specifies the length of the logical record.\nAllowed values: 1-32760\nDefault value: 80\nExample: --lrecl 80", - "type": "number", - "required": false, - "numericValueRange": [ - 1, - 32760 - ], - "group": "Options" - }, - { - "name": "block-size", - "aliases": [ - "blksize", - "bs" - ], - "description": "Specifies the size of the block of records.\nAllowed values: 1-32760\nDefault value: 6160\nExample: --blksize 6160", - "type": "number", - "required": false, - "numericValueRange": [ - 1, - 32760 - ], - "group": "Options" - }, - { - "name": "record-format", - "aliases": [ - "recfm", - "rf" - ], - "description": "Specifies the record format.\nThe allowed values which have the following meaning: \nF - Fixed-length records\nV - Variable-length records\nU - Undefined-length records\nB - Records are blocked\nA - Records contain ASCII printer control characters\nM - Records contain machine code control characters\nS - For variable-length records, records may span blocks\nT - Records may be written into overflow tracks\nDefault value: FB\nExample: --recfm FB", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "F", - "FA", - "FM", - "FB", - "FBA", - "FBM", - "FS", - "FSA", - "FSM", - "FT", - "FTA", - "FTM", - "FBS", - "FBT", - "U", - "UA", - "UM", - "UT", - "UTA", - "UTM", - "V", - "VA", - "VM", - "VB", - "VBA", - "VBM", - "VS", - "VSA", - "VSM", - "VT", - "VTA", - "VTM", - "VBS", - "VBT" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "space-units", - "aliases": [ - "su" - ], - "description": "Specifies the space allocation unit.\nThe allowed values which have the following meaning:\nTRK - Tracks\nCYL - Cylinders\nBLK - Blocksize\nDefault value: CYL\nExample: --su blk", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "TRK", - "CYL", - "BLK" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "primary-space", - "aliases": [ - "ps" - ], - "description": "Specifies primary space allocation unit.\nAllowed values: 1-16777215\nDefault value: 1\nExample: --ps 3", - "type": "number", - "required": false, - "numericValueRange": [ - 1, - 16777215 - ], - "group": "Options" - }, - { - "name": "secondary-space", - "aliases": [ - "ss" - ], - "description": "Specifies secondary space allocation unit.\nAllowed values: 1-16777215\nDefault value: 1\nExample: --ss 5", - "type": "number", - "required": false, - "numericValueRange": [ - 1, - 16777215 - ], - "group": "Options" - }, - { - "name": "volume", - "aliases": [ - "v" - ], - "description": "Specifies a disk volume or specific tapes.\nExample: -v vol002", - "type": "array", - "required": false, - "group": "Options" - }, - { - "name": "unit-type", - "aliases": [ - "ut" - ], - "description": "Specifies the DASD unit name.\nExample: --ut sysda", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "expiration-date", - "aliases": [ - "ed" - ], - "description": "Specifies the expiration date after which the data set can be deleted.\nSpecify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.\nExample: --ed 2032-07-31", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "storage-class", - "aliases": [ - "sc" - ], - "description": "Specifies the storage class.\nExample: --sc scl002", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "management-class", - "aliases": [ - "mc" - ], - "description": "Specifies the management class.\nExample: --mc mcl002", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "data-class", - "aliases": [ - "dc" - ], - "description": "Specifies the data class.\nExample: --dc dcl002", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies File Master Plus server host name.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies File Master Plus server port.", - "type": "number", - "defaultValue": 51914, - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Specifies Mainframe user name. May be the same as TSO login.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Specifies Mainframe password. May be the same as TSO password.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies File Master Plus REST API protocol.", - "type": "string", - "defaultValue": "https", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "FMP Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "required": false, - "group": "FMP 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 FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "FMP 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": "fmp-profile", - "aliases": [ - "fmp-p" - ], - "group": "Profile Options", - "description": "The name of a (fmp) 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": [] - } - ], - "profile": { - "optional": [ - "fmp", - "base" - ] - }, - "examples": [ - { - "options": "fmmvs.test.dsname", - "description": "Creating a large format sequential data set with default option values" - }, - { - "options": "fmmvs.test.dsname --lrecl 180 --blksize 32720 --recfm vb --ps 5 --ss 5 -v vol005 --su trk --ed 2025-09-27", - "description": "Creating a large format sequential data set with options" - }, - { - "options": "fmmvs.test.dsname --model fmmvs.model.dsname", - "description": "Creating a large format sequential data set like a model large format sequential data set" - }, - { - "options": "fmmvs.test.dsname --model fmmvs.model.dsname --lrecl 180 --recfm VB --ps 5 --ss 5 --ed p", - "description": "Creating a large format sequential data set like a model large format sequential data set and overriding the parameters with options" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "partitioned-data-set", - "aliases": [ - "pds" - ], - "summary": "Create a partitioned data set", - "type": "command", - "description": "Create a partitioned data set.", - "handler": "", - "positionals": [ - { - "name": "name", - "type": "string", - "description": "Specifies the name of the data set to create.", - "required": true - } - ], - "options": [ - { - "name": "model", - "aliases": [ - "m" - ], - "description": "Specifies the name of a model partitioned data set for allocating parameters.\nThe parameters of the model data set override all defaults.\nExample: -m fmmvs.model.dsname", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "logical-record-length", - "aliases": [ - "lrecl", - "lrl" - ], - "description": "Specifies the length of the logical record.\nAllowed values: 1-32760\nDefault value: 80\nExample: --lrecl 80", - "type": "number", - "required": false, - "numericValueRange": [ - 1, - 32760 - ], - "group": "Options" - }, - { - "name": "block-size", - "aliases": [ - "blksize", - "bs" - ], - "description": "Specifies the size of the block of records.\nAllowed values: 1-32760\nDefault value: 6160\nExample: --blksize 6160", - "type": "number", - "required": false, - "numericValueRange": [ - 1, - 32760 - ], - "group": "Options" - }, - { - "name": "record-format", - "aliases": [ - "recfm", - "rf" - ], - "description": "Specifies the record format.\nThe allowed values have the following meaning:\nF - Fixed-length records\nV - Variable-length records\nU - Undefined-length records\nB - Records are blocked\nA - Records contain ASCII printer control characters\nM - Records contain machine code control characters\nS - For variable-length records, records may span blocks\nT - Records may be written into overflow tracks\nDefault value: FB\nExample: --recfm FB", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "F", - "FA", - "FM", - "FB", - "FBA", - "FBM", - "FS", - "FSA", - "FSM", - "FT", - "FTA", - "FTM", - "FBS", - "FBT", - "U", - "UA", - "UM", - "UT", - "UTA", - "UTM", - "V", - "VA", - "VM", - "VB", - "VBA", - "VBM", - "VS", - "VSA", - "VSM", - "VT", - "VTA", - "VTM", - "VBS", - "VBT" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "space-units", - "aliases": [ - "su" - ], - "description": "Specifies the space allocation unit.\nThe allowed values which have the following meaning: \nTRK - Tracks\nCYL - Cylinders\nBLK - Blocksize\nDefault value: CYL\nExample: --su blk", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "TRK", - "CYL", - "BLK" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "primary-space", - "aliases": [ - "ps" - ], - "description": "Specifies the primary space allocation unit.\nAllowed values: 1-16777215\nDefault value: 1\nExample: --ps 3", - "type": "number", - "required": false, - "numericValueRange": [ - 1, - 16777215 - ], - "group": "Options" - }, - { - "name": "secondary-space", - "aliases": [ - "ss" - ], - "description": "Specifies the secondary space allocation unit.\nAllowed values: 1-16777215\nDefault value: 1\nExample: --ss 5", - "type": "number", - "required": false, - "numericValueRange": [ - 1, - 16777215 - ], - "group": "Options" - }, - { - "name": "directory-blocks", - "aliases": [ - "db" - ], - "description": "Specifies number of directory blocks.\nAllowed values: 1-16777215\nDefault value: 5\nExample: --db 5", - "type": "number", - "required": false, - "numericValueRange": [ - 1, - 16777215 - ], - "group": "Options" - }, - { - "name": "volume", - "aliases": [ - "v" - ], - "description": "Specifies a disk volume or specific tapes.\nExample: -v vol002", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "unit-type", - "aliases": [ - "ut" - ], - "description": "Specifies the DASD unit name.\nExample: --ut sysda", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "expiration-date", - "aliases": [ - "ed" - ], - "description": "Specifies the expiration date after which the data set can be deleted.\nSpecify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.\nExample: --ed 2032-07-31", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "storage-class", - "aliases": [ - "sc" - ], - "description": "Specifies the storage class.\nExample: --sc scl002", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "management-class", - "aliases": [ - "mc" - ], - "description": "Specifies the management class.\nExample: --mc mcl002", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "data-class", - "aliases": [ - "dc" - ], - "description": "Specifies the data class.\nExample: --dc dcl002", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies File Master Plus server host name.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies File Master Plus server port.", - "type": "number", - "defaultValue": 51914, - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Specifies Mainframe user name. May be the same as TSO login.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Specifies Mainframe password. May be the same as TSO password.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies File Master Plus REST API protocol.", - "type": "string", - "defaultValue": "https", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "FMP Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "required": false, - "group": "FMP 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 FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "FMP 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": "fmp-profile", - "aliases": [ - "fmp-p" - ], - "group": "Profile Options", - "description": "The name of a (fmp) 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": [] - } - ], - "profile": { - "optional": [ - "fmp", - "base" - ] - }, - "examples": [ - { - "options": "fmmvs.test.dsname", - "description": "Creating a PDS with default option values" - }, - { - "options": "fmmvs.test.dsname --lrecl 180 --blksize 32720 --recfm vb --ps 5 --ss 5 --db 5 -v vol005 --su trk --ed p", - "description": "Creating a PDS with options" - }, - { - "options": "fmmvs.test.dsname --model fmmvs.model.dsname", - "description": "Creating a PDS like a model PDS" - }, - { - "options": "fmmvs.test.dsname --model fmmvs.model.dsname --lrecl 180 --recfm vb --ps 5 --ss 5 --db 5 -v vol005 --ed 2025-09-27", - "description": "Creating a PDS like a model PDS and overriding the parameters with options" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "partitioned-data-set-extended", - "aliases": [ - "pdse" - ], - "summary": "Create an extended partitioned data set", - "type": "command", - "description": "Create an extended partitioned data set.", - "handler": "", - "positionals": [ - { - "name": "name", - "type": "string", - "description": "Specifies the name of the data set to create.", - "required": true - } - ], - "options": [ - { - "name": "model", - "aliases": [ - "m" - ], - "description": "Specifies the name of a model extentded partitioned data set name for allocating parameters.\nThe parameters of the model data set override all defaults.\nExample: -m fmmvs.model.dsname", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "data-set-version", - "aliases": [ - "dsv", - "ver" - ], - "description": "Specifies the data set version.\nDefault value depends on the system settings.\nExample: --ver 2", - "type": "number", - "required": false, - "allowableValues": { - "values": [ - "1", - "2" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "generations", - "aliases": [ - "g" - ], - "description": "Specifies the number of generations.\nApplicable when data set version is '2'.\nDefault value: 0\nExample: -g 10", - "type": "number", - "required": false, - "group": "Options" - }, - { - "name": "logical-record-length", - "aliases": [ - "lrecl", - "lrl" - ], - "description": "Specifies the length of the logical record.\nAllowed values: 1-32760\nDefault value: 80\nExample: --lrecl 80", - "type": "number", - "required": false, - "numericValueRange": [ - 1, - 32760 - ], - "group": "Options" - }, - { - "name": "block-size", - "aliases": [ - "blksize", - "bs" - ], - "description": "Specifies the size of the block of records.\nAllowed values: 1-32760\nDefault value: 6160\nExample: --blksize 6160", - "type": "number", - "required": false, - "numericValueRange": [ - 1, - 32760 - ], - "group": "Options" - }, - { - "name": "record-format", - "aliases": [ - "recfm", - "rf" - ], - "description": "Specifies the record format.\nThe allowed values which have the following meaning: \nF - Fixed-length records\nV - Variable-length records\nU - Undefined-length records\nB - Records are blocked\nA - Records contain ASCII printer control characters\nM - Records contain machine code control characters\nS - For variable-length records, records may span blocks\nT - Records may be written into overflow tracks\nDefault value: FB\nExample: --recfm FB", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "F", - "FA", - "FM", - "FB", - "FBA", - "FBM", - "FS", - "FSA", - "FSM", - "FT", - "FTA", - "FTM", - "FBS", - "FBT", - "U", - "UA", - "UM", - "UT", - "UTA", - "UTM", - "V", - "VA", - "VM", - "VB", - "VBA", - "VBM", - "VS", - "VSA", - "VSM", - "VT", - "VTA", - "VTM", - "VBS", - "VBT" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "space-units", - "aliases": [ - "su" - ], - "description": "Specifies the space allocation unit.\nThe allowed values have the following meaning: \nTRK - Tracks\nCYL - Cylinders\nBLK - Blocksize\nDefault value: CYL\nExample: --su blk", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "TRK", - "CYL", - "BLK" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "primary-space", - "aliases": [ - "ps" - ], - "description": "Specifies primary space allocation unit.\nAllowed values: 1-16777215\nDefault value: 1\nExample: --ps 3", - "type": "number", - "required": false, - "numericValueRange": [ - 1, - 16777215 - ], - "group": "Options" - }, - { - "name": "secondary-space", - "aliases": [ - "ss" - ], - "description": "Specifies secondary space allocation unit.\nAllowed values: 1-16777215\nDefault value: 1\nExample: --ss 5", - "type": "number", - "required": false, - "numericValueRange": [ - 1, - 16777215 - ], - "group": "Options" - }, - { - "name": "volume", - "aliases": [ - "v" - ], - "description": "Specifies a disk volume or specific tapes.\nExample: -v vol002", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "unit-type", - "aliases": [ - "ut" - ], - "description": "Specifies the DASD unit name.\nExample: --ut sysda", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "expiration-date", - "aliases": [ - "ed" - ], - "description": "Specifies the expiration date after which the data set can be deleted.\nSpecify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.\nExample: --ed 2032-07-31", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "storage-class", - "aliases": [ - "sc" - ], - "description": "Specifies the storage class.\nExample: --sc scl002", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "management-class", - "aliases": [ - "mc" - ], - "description": "Specifies the management class.\nExample: --mc mcl002", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "data-class", - "aliases": [ - "dc" - ], - "description": "Specifies the data class.\nExample: --dc dcl002", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies File Master Plus server host name.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies File Master Plus server port.", - "type": "number", - "defaultValue": 51914, - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Specifies Mainframe user name. May be the same as TSO login.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Specifies Mainframe password. May be the same as TSO password.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies File Master Plus REST API protocol.", - "type": "string", - "defaultValue": "https", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "FMP Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "required": false, - "group": "FMP 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 FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "FMP 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": "fmp-profile", - "aliases": [ - "fmp-p" - ], - "group": "Profile Options", - "description": "The name of a (fmp) 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": [] - } - ], - "profile": { - "optional": [ - "fmp", - "base" - ] - }, - "examples": [ - { - "options": "fmmvs.test.dsname", - "description": "Creating a PDSE with default option values" - }, - { - "options": "fmmvs.test.dsname --ver 2 -g 10 --lrecl 180 --blksize 32720 --recfm vb --ps 5 --ss 5 -v vol005 --su trk --ed 2025-09-27", - "description": "Creating a PDSE version 2 with options" - }, - { - "options": "fmmvs.test.dsname --model fmmvs.model.dsname", - "description": "Creating a PDSE data set like a model PDSE" - }, - { - "options": "fmmvs.test.dsname --model fmmvs.model.dsname --lrecl 180 --recfm vb --ps 5 --ss 5 --db 5 -v vol005 --ed p", - "description": "Creating a PDSE like a model PDSE and the parameters with options" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "vsam-ksds", - "aliases": [ - "ksds" - ], - "summary": "Create a KSDS VSAM data set", - "type": "command", - "description": "Create a key-sequenced data set (KSDS) Virtual Storage Access Method (VSAM) data set.", - "handler": "", - "positionals": [ - { - "name": "name", - "type": "string", - "description": "Specifies the name of the data set to create.", - "required": true - } - ], - "options": [ - { - "name": "model", - "aliases": [ - "m" - ], - "description": "Specifies the name of a model KSDS (key-sequenced VSAM data set) for allocating parameters.\nThe parameters of the model data set override all defaults.\nExample: -m fmmvs.model.dsname", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "keys-position", - "aliases": [ - "kp" - ], - "description": "Specifies the position of the key within the base cluster.\nThis parameter is mandatory unless a model data set is specified.\nExample: --kp 1 ", - "type": "number", - "required": false, - "group": "Options" - }, - { - "name": "keys-length", - "aliases": [ - "kl" - ], - "description": "Specifies the length of the key within the base cluster.\nThis parameter is mandatory unless a model data set is specified.\nExample: --kl 7 ", - "type": "number", - "required": false, - "group": "Options" - }, - { - "name": "maximum-record-size", - "aliases": [ - "mrs" - ], - "description": "Specifies the maximum length of data records.\nThis parameter is mandatory unless a model data set is specified.\nExample: --mrs 180", - "type": "number", - "required": false, - "group": "Options" - }, - { - "name": "average-record-size", - "aliases": [ - "ars" - ], - "description": "Specifies the average length of data records.\nIf this parameter is not specified then it is set to the same as the maximum-record-size option.\nExample: --ars 110", - "type": "number", - "required": false, - "group": "Options" - }, - { - "name": "data-dsname", - "aliases": [ - "ddsn" - ], - "description": "Specifies the data set name of the data VSAM component.\nIf this parameter is not specified then by default it is set to the cluster name with ‘.DATA’.\nExample: --ddsn fmmvs.vsam.ksds.data", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "data-control-interval-size", - "aliases": [ - "dcis" - ], - "description": "Specifies the size of the Control Interval for the data VSAM component.\nDefault value: 20480\nExample: --dcis 3584", - "type": "number", - "required": false, - "group": "Options" - }, - { - "name": "data-space-units", - "aliases": [ - "dsu" - ], - "description": "Specifies the space allocation unit for data vsam component.\nThe allowed values have the following meaning: \nTRK - Tracks\nCYL - Cylinders\nREC - Records\nK - Kilobytes\nM - Megabytes\nDefault value: TRK\nExample: --dsu rec", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "TRK", - "CYL", - "REC", - "K", - "M" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "data-primary-space", - "aliases": [ - "dps" - ], - "description": "Specifies the primary space allocation unit for the data VSAM component.\nAllowed values: 1-16777215\nDefault value: 18\nExample: --dps 3", - "type": "number", - "required": false, - "numericValueRange": [ - 1, - 16777215 - ], - "group": "Options" - }, - { - "name": "data-secondary-space", - "aliases": [ - "dss" - ], - "description": "Specifies the secondary space allocation unit for the data VSAM component.\nAllowed values: 1-16777215\nDefault value: 3\nExample: --dss 5", - "type": "number", - "required": false, - "numericValueRange": [ - 1, - 16777215 - ], - "group": "Options" - }, - { - "name": "data-volume", - "aliases": [ - "dv" - ], - "description": "Specifies a disk volume or specific tapes for the data VSAM component.\nExample: -dv vol002", - "type": "array", - "required": false, - "group": "Options" - }, - { - "name": "index-dsname", - "aliases": [ - "idsn" - ], - "description": "Specifies the data set name of the index VSAM component.\nIf this parameter is not specified then it is set to the cluster name with ‘.INDEX’ appended.\nExample: --ddsn fmmvs.vsam.ksds.index", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "index-control-interval-size", - "aliases": [ - "icis" - ], - "description": "Specifies the size of Control Interval for index VSAM component.\nDefault value: 512\nExample: --icis 3584", - "type": "number", - "required": false, - "group": "Options" - }, - { - "name": "index-space-units", - "aliases": [ - "isu" - ], - "description": "Specifies the space allocation unit for index VSAM component.\nThe allowed values have the following meaning: \nTRK - Tracks\nCYL - Cylinders\nREC - Records\nK - Kilobytes\nM - Megabytes\nDefault value: TRK\nExample: --isu cyl", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "TRK", - "CYL", - "REC", - "K", - "M" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "index-primary-space", - "aliases": [ - "ips" - ], - "description": "Specifies primary space allocation unit for index VSAM component.\nAllowed values: 1-16777215\nDefault value: 1\nExample: --ips 3", - "type": "number", - "required": false, - "numericValueRange": [ - 1, - 16777215 - ], - "group": "Options" - }, - { - "name": "index-secondary-space", - "aliases": [ - "iss" - ], - "description": "Specifies secondary space allocation unit for index VSAM component.\nAllowed values: 1-16777215\nDefault value: 1\nExample: --iss 5", - "type": "number", - "required": false, - "numericValueRange": [ - 1, - 16777215 - ], - "group": "Options" - }, - { - "name": "index-volume", - "aliases": [ - "iv" - ], - "description": "Specifies a disk volume or specific tapes for the index VSAM component.\nExample: -iv vol002", - "type": "array", - "required": false, - "group": "Options" - }, - { - "name": "buffer-space", - "aliases": [ - "bs" - ], - "description": "Specifies the minimum buffer space to allocate when this VSAM file is accessed.\nExample: --bs 37376", - "type": "number", - "required": false, - "group": "Options" - }, - { - "name": "erase", - "aliases": [ - "e" - ], - "description": "Indicates whether the VSAM file was allocated with the ERASE parameter, causing all components of the file to be overwritten with binary zeros, when the VSAM file is deleted from the catalog.\nDefault value: n\nExample: -e y", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "y", - "n" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "load-restartable", - "aliases": [ - "lr" - ], - "description": "Specify 'Y' to request that the VSAM component definition use the 'RECOVERY' parameter (which causes the data component to be preformatted previous to the initial load). Using this option causes the initial load to take longer, but loads which do not complete successfully can be restarted.\n Specify 'N' to request that the VSAM component definition use the 'SPEED' parameter (which causes the data component to NOT be preformatted previous to the initial load).\nDefault value: n\nExample: -lr y", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "y", - "n" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "reuse", - "aliases": [ - "r" - ], - "description": "Indicates whether the VSAM file was allocated with the REUSE parameter specifying that the cluster can be opened again and again as a reusable cluster.\nDefault value: n\nExample: -r y", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "y", - "n" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "spanned", - "aliases": [ - "s" - ], - "description": "Indicates whether VSAM file was allocated with the SPANNED parameter indicating that data records larger than a control interval can span multiple control intervals.\nDefault value: n\nExample: -s y", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "y", - "n" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "write-check", - "aliases": [ - "wc" - ], - "description": "Indicates whether the VSAM file was allocated with the WRITECHECK parameter requesting each write to the VSAM file to be validated by a read without data transfer.\nDefault value: n\nExample: --wc y", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "y", - "n" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "control-interval-freespace-percentage", - "aliases": [ - "cifp" - ], - "description": "Specifies the percentage of empty space in each control interval when the file is initially loaded.The free space lets records be inserted or expanded within a control interval before requiring a control interval split.\nExample: --cifp 10", - "type": "number", - "required": false, - "numericValueRange": [ - 0, - 100 - ], - "group": "Options" - }, - { - "name": "control-area-freespace-percentage", - "aliases": [ - "cafp" - ], - "description": "Specifies the percentage of control intervals to be left unused in each control area as the file is initially loaded. The use of control area free space lets some control interval splits occur before requiring a control area split.\nExample: --cafp 10", - "type": "number", - "required": false, - "numericValueRange": [ - 0, - 100 - ], - "group": "Options" - }, - { - "name": "cross-region-share-option", - "aliases": [ - "crso" - ], - "description": "Specifies that the file can be shared among regions within the same system or within multiple systems using GRS (Global Resource Serialization).\nThe allowed values have the following meaning: \n1 - The data set can be opened for read processing by an unlimited number of users, but the data set can be accessed by only one user when that user is doing read and write processing.\n2 - The data set can be opened by only one user at a time for read and write processing, but any number of users can also be accessing the data set for read processing\n3 - The data set can be fully shared by any number of users.\n4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.\nDefault value: 1\nExample: --crso 2", - "type": "number", - "required": false, - "allowableValues": { - "values": [ - "1", - "2", - "3", - "4" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "cross-system-share-option", - "aliases": [ - "csso" - ], - "description": "Specifies how the file can be shared among systems.\nThe allowed values have the following meaning: \n3 - The data set can be fully shared by any number of users.\n4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.\nDefault value: 3\nExample: --csso 4", - "type": "number", - "required": false, - "allowableValues": { - "values": [ - "3", - "4" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "expiration-date", - "aliases": [ - "ed" - ], - "description": "Specifies the expiration date after which the data set can be deleted.\nSpecify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.\nExample: --ed 2032-07-31", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "storage-class", - "aliases": [ - "sc" - ], - "description": "Specifies the storage class.\nExample: --sc scl002", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "management-class", - "aliases": [ - "mc" - ], - "description": "Specifies the management class.\nExample: --mc mcl002", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "data-class", - "aliases": [ - "dc" - ], - "description": "Specifies the data class.\nExample: --dc dcl002", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "log", - "aliases": [ - "l" - ], - "description": "When specified, 'ALL' or 'UNDO' or 'NONE' indicates the VSAM RLS recovery option.\nExample: --log ALL", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "NONE", - "UNDO", - "ALL" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "frlog", - "aliases": [ - "fr" - ], - "description": "Specifies the type of VSAM batch logging to perform for this VSAM data set.\nThe allowed values have the following meaning:\nNONE - Disables VSAM batch logging.\nREDO - Enables VSAM batch logging.\nUNDO - Changes made to your VSAM data set are backed out using VSAM batch logging.\nALL - Changes made to your VSAM data set are backed out and forward recovered using VSAM batch logging.\nExample: --frlog ALL", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "NONE", - "UNDO", - "ALL", - "REDO" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "log-replicate", - "aliases": [ - "lrp" - ], - "description": "Specify 'Y' to enable VSAM replication for this data set.\nExample: --lrp y", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "Y", - "N" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "log-stream-id", - "aliases": [ - "lsi" - ], - "description": "Specifies the 1- to 26-character name of the forward recovery log stream.\nExample: --lsi LOGSTRA", - "type": "string", - "required": false, - "stringLengthRange": [ - 1, - 26 - ], - "group": "Options" - }, - { - "name": "rls-enable", - "aliases": [ - "rls", - "re" - ], - "description": "Specify 'N' to disable VSAM record-level sharing.\nDefault value: y\nExample: --rls n", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "Y", - "N" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies File Master Plus server host name.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies File Master Plus server port.", - "type": "number", - "defaultValue": 51914, - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Specifies Mainframe user name. May be the same as TSO login.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Specifies Mainframe password. May be the same as TSO password.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies File Master Plus REST API protocol.", - "type": "string", - "defaultValue": "https", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "FMP Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "required": false, - "group": "FMP 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 FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "FMP 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": "fmp-profile", - "aliases": [ - "fmp-p" - ], - "group": "Profile Options", - "description": "The name of a (fmp) 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": [] - } - ], - "profile": { - "optional": [ - "fmp", - "base" - ] - }, - "examples": [ - { - "options": "fmmvs.test.dsname --kp 1 --kl 7 --mrs 160", - "description": "Creating a KSDS with default option values and mandatory options" - }, - { - "options": "fmmvs.test.dsname --kp 1 --kl 7 --mrs 160 --ars 120 --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --icis 512 --isu cyl --ips 1 --iss 1 --iv vol002 --bs 37376 -e y -r y -s n --ed 2025-09-27", - "description": "Creating a KSDS with options" - }, - { - "options": "fmmvs.test.dsname --kp 1 --kl 7 --mrs 160 --ars 120 --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --icis 512 --isu cyl --ips 1 --iss 1 --iv vol002 --bs 37376 -e y -r y -s n --rls y -l all --lsi loga --lrp y --fr ALL", - "description": "Creating a RLS enabled KSDS with logging options" - }, - { - "options": "fmmvs.test.dsname --model fmmvs.model.dsname", - "description": "Creating a KSDS data set like a model KSDS data set" - }, - { - "options": "fmmvs.test.dsname --model fmmvs.model.dsname --kp 1 --kl 7 --mrs 160 --wc y --bs 37376 --crso 3 --csso 4 --ed p", - "description": "Creating a KSDS like a model KSDS data set and overriding the parameters with options" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "vsam-esds", - "aliases": [ - "esds" - ], - "summary": "Create an ESDS VSAM data set", - "type": "command", - "description": "Create an entry-sequenced Virtual Storage Access Method (VSAM) data set (ESDS).", - "handler": "", - "positionals": [ - { - "name": "name", - "type": "string", - "description": "Specifies the name of the data set to create.", - "required": true - } - ], - "options": [ - { - "name": "model", - "aliases": [ - "m" - ], - "description": "Specifies the name of a ESDS (entry-sequenced VSAM data set) for allocating parameters.\nThe parameters of the model data set override all defaults.\nExample: -m fmmvs.model.dsname", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "maximum-record-size", - "aliases": [ - "mrs" - ], - "description": "Specifies the maximum length of data records.\nThis parameter is mandatory unless a model data set is specified.\nExample: --mrs 180", - "type": "number", - "required": false, - "group": "Options" - }, - { - "name": "average-record-size", - "aliases": [ - "ars" - ], - "description": "Specifies the average length of data records.\nIf this parameter is not specified then it is set to the same as the maximum-record-size option.\nExample: --ars 110", - "type": "number", - "required": false, - "group": "Options" - }, - { - "name": "data-dsname", - "aliases": [ - "ddsn" - ], - "description": "Specifies the data set name of the data VSAM component.\nIf this parameter is not specified then by default it is set to the cluster name with ‘.DATA’.\nExample: --ddsn fmmvs.vsam.esds.data", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "data-control-interval-size", - "aliases": [ - "dcis" - ], - "description": "Specifies the size of the Control Interval for the data VSAM component.\nDefault value: 20480\nExample: --dcis 3584", - "type": "number", - "required": false, - "group": "Options" - }, - { - "name": "data-space-units", - "aliases": [ - "dsu" - ], - "description": "Specifies the space allocation unit for data vsam component.\nThe allowed values have the following meaning: \nTRK - Tracks\nCYL - Cylinders\nREC - Records\nK - Kilobytes\nM - Megabytes\nDefault value: TRK\nExample: --dsu rec", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "TRK", - "CYL", - "REC", - "K", - "M" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "data-primary-space", - "aliases": [ - "dps" - ], - "description": "Specifies the primary space allocation unit for the data VSAM component.\nAllowed values: 1-16777215\nDefault value: 18\nExample: --dps 3", - "type": "number", - "required": false, - "numericValueRange": [ - 1, - 16777215 - ], - "group": "Options" - }, - { - "name": "data-secondary-space", - "aliases": [ - "dss" - ], - "description": "Specifies the secondary space allocation unit for the data VSAM component.\nAllowed values: 1-16777215\nDefault value: 3\nExample: --dss 5", - "type": "number", - "required": false, - "numericValueRange": [ - 1, - 16777215 - ], - "group": "Options" - }, - { - "name": "data-volume", - "aliases": [ - "dv" - ], - "description": "Specifies a disk volume or specific tapes for the data VSAM component.\nExample: -dv vol002", - "type": "array", - "required": false, - "group": "Options" - }, - { - "name": "buffer-space", - "aliases": [ - "bs" - ], - "description": "Specifies the minimum buffer space to allocate when this VSAM file is accessed.\nExample: --bs 37376", - "type": "number", - "required": false, - "group": "Options" - }, - { - "name": "erase", - "aliases": [ - "e" - ], - "description": "Indicates whether the VSAM file was allocated with the ERASE parameter, causing all components of the file to be overwritten with binary zeros, when the VSAM file is deleted from the catalog.\nDefault value: n\nExample: -e y", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "y", - "n" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "load-restartable", - "aliases": [ - "lr" - ], - "description": "Specify 'Y' to request that the VSAM component definition use the 'RECOVERY' parameter (which causes the data component to be preformatted previous to the initial load). Using this option causes the initial load to take longer, but loads which do not complete successfully can be restarted.\n Specify 'N' to request that the VSAM component definition use the 'SPEED' parameter (which causes the data component to NOT be preformatted previous to the initial load).\nDefault value: n\nExample: -lr y", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "y", - "n" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "reuse", - "aliases": [ - "r" - ], - "description": "Indicates whether the VSAM file was allocated with the REUSE parameter specifying that the cluster can be opened again and again as a reusable cluster.\nDefault value: n\nExample: -r y", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "y", - "n" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "spanned", - "aliases": [ - "s" - ], - "description": "Indicates whether VSAM file was allocated with the SPANNED parameter indicating that data records larger than a control interval can span multiple control intervals.\nDefault value: n\nExample: -s y", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "y", - "n" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "write-check", - "aliases": [ - "wc" - ], - "description": "Indicates whether the VSAM file was allocated with the WRITECHECK parameter requesting each write to the VSAM file to be validated by a read without data transfer.\nDefault value: n\nExample: --wc y", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "y", - "n" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "control-interval-freespace-percentage", - "aliases": [ - "cifp" - ], - "description": "Specifies the percentage of empty space in each control interval when the file is initially loaded.The free space lets records be inserted or expanded within a control interval before requiring a control interval split.\nExample: --cifp 10", - "type": "number", - "required": false, - "numericValueRange": [ - 0, - 100 - ], - "group": "Options" - }, - { - "name": "control-area-freespace-percentage", - "aliases": [ - "cafp" - ], - "description": "Specifies the percentage of control intervals to be left unused in each control area as the file is initially loaded. The use of control area free space lets some control interval splits occur before requiring a control area split.\nExample: --cafp 10", - "type": "number", - "required": false, - "numericValueRange": [ - 0, - 100 - ], - "group": "Options" - }, - { - "name": "cross-region-share-option", - "aliases": [ - "crso" - ], - "description": "Specifies that the file can be shared among regions within the same system or within multiple systems using GRS (Global Resource Serialization).\nThe allowed values have the following meaning:\n1 - The data set can be opened for read processing by an unlimited number of users, but the data set can be accessed by only one user when that user is doing read and write processing.\n2 - The data set can be opened by only one user at a time for read and write processing, but any number of users can also be accessing the data set for read processing\n3 - The data set can be fully shared by any number of users.\n4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.\nDefault value: 1\nExample: --crso 2", - "type": "number", - "required": false, - "allowableValues": { - "values": [ - "1", - "2", - "3", - "4" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "cross-system-share-option", - "aliases": [ - "csso" - ], - "description": "Specifies how the file can be shared among systems.\nThe allowed values have the following meaning: \n3 - The data set can be fully shared by any number of users.\n4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.\nDefault value: 3\nExample: --csso 4", - "type": "number", - "required": false, - "allowableValues": { - "values": [ - "3", - "4" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "expiration-date", - "aliases": [ - "ed" - ], - "description": "Specifies the expiration date after which the data set can be deleted.\nSpecify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.\nExample: --ed 2032-07-31", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "storage-class", - "aliases": [ - "sc" - ], - "description": "Specifies the storage class.\nExample: --sc scl002", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "management-class", - "aliases": [ - "mc" - ], - "description": "Specifies the management class.\nExample: --mc mcl002", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "data-class", - "aliases": [ - "dc" - ], - "description": "Specifies the data class.\nExample: --dc dcl002", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "log", - "aliases": [ - "l" - ], - "description": "When specified, 'ALL' or 'UNDO' or 'NONE' indicates the VSAM RLS recovery option.\nExample: --log ALL", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "NONE", - "UNDO", - "ALL" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "frlog", - "aliases": [ - "fr" - ], - "description": "Specifies the type of VSAM batch logging to perform for this VSAM data set.\nThe allowed values have the following meaning:\nNONE - Disables VSAM batch logging.\nREDO - Enables VSAM batch logging.\nUNDO - Changes made to your VSAM data set are backed out using VSAM batch logging.\nALL - Changes made to your VSAM data set are backed out and forward recovered using VSAM batch logging.\nExample: --frlog ALL", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "NONE", - "UNDO", - "ALL", - "REDO" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "log-replicate", - "aliases": [ - "lrp" - ], - "description": "Specify 'Y' to enable VSAM replication for this data set.\nExample: --lrp y", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "Y", - "N" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "log-stream-id", - "aliases": [ - "lsi" - ], - "description": "Specifies the 1- to 26-character name of the forward recovery log stream.\nExample: --lsi LOGSTRA", - "type": "string", - "required": false, - "stringLengthRange": [ - 1, - 26 - ], - "group": "Options" - }, - { - "name": "rls-enable", - "aliases": [ - "rls", - "re" - ], - "description": "Specify 'N' to disable VSAM record-level sharing.\nDefault value: y\nExample: --rls n", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "Y", - "N" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies File Master Plus server host name.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies File Master Plus server port.", - "type": "number", - "defaultValue": 51914, - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Specifies Mainframe user name. May be the same as TSO login.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Specifies Mainframe password. May be the same as TSO password.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies File Master Plus REST API protocol.", - "type": "string", - "defaultValue": "https", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "FMP Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "required": false, - "group": "FMP 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 FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "FMP 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": "fmp-profile", - "aliases": [ - "fmp-p" - ], - "group": "Profile Options", - "description": "The name of a (fmp) 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": [] - } - ], - "profile": { - "optional": [ - "fmp", - "base" - ] - }, - "examples": [ - { - "options": "fmmvs.test.dsname --mrs 160", - "description": "Creating a ESDS with default option values and mandatory options" - }, - { - "options": "fmmvs.test.dsname --mrs 160 --ars 120 --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --bs 37376 -e y -r y -s n --ed 2025-09-27", - "description": "Creating a ESDS with options" - }, - { - "options": "fmmvs.test.dsname --mrs 160 --ars 120 --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --bs 37376 -e y -r y -s n --rls y -l all --lsi loga --lrp y --fr ALL", - "description": "Creating a RLS enabled ESDS with logging options" - }, - { - "options": "fmmvs.test.dsname --model fmmvs.model.dsname", - "description": "Creating a ESDS data set like a model ESDS data set" - }, - { - "options": "fmmvs.test.dsname --model fmmvs.model.dsname --mrs 160 --wc y --bs 37376 --crso 3 --csso 4 --ed p", - "description": "Creating a ESDS like a model ESDS data set and overriding the parameters with options" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "vsam-lds", - "aliases": [ - "lds" - ], - "summary": "Create a LDS VSAM data set", - "type": "command", - "description": "Create linear data set (LDS) Virtual Storage Access Method (VSAM) data set.", - "handler": "", - "positionals": [ - { - "name": "name", - "type": "string", - "description": "Specifies the name of the data set to create.", - "required": true - } - ], - "options": [ - { - "name": "model", - "aliases": [ - "m" - ], - "description": "Specifies the name of a model LDS (Linear VSAM data set) for allocating parameters.\nThe parameters of the model data set override all defaults.\nExample: -m fmmvs.model.dsname", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "data-dsname", - "aliases": [ - "ddsn" - ], - "description": "Specifies the data set name of the data VSAM component.\nIf this parameter is not specified then by default it is set to the cluster name with ‘.DATA’.\nExample: --ddsn fmmvs.vsam.esds.data", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "data-control-interval-size", - "aliases": [ - "dcis" - ], - "description": "Specifies the size of the Control Interval for the data VSAM component.\nDefault value: 4096\nExample: --dcis 3584", - "type": "number", - "required": false, - "group": "Options" - }, - { - "name": "data-space-units", - "aliases": [ - "dsu" - ], - "description": "Specifies the space allocation unit for data vsam component.\nThe allowed values have the following meaning: \nTRK - Tracks\nCYL - Cylinders\nREC - Records\nK - Kilobytes\nM - Megabytes\nDefault value: TRK\nExample: --dsu rec", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "TRK", - "CYL", - "REC", - "K", - "M" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "data-primary-space", - "aliases": [ - "dps" - ], - "description": "Specifies the primary space allocation unit for the data VSAM component.\nAllowed values: 1-16777215\nDefault value: 18\nExample: --dps 3", - "type": "number", - "required": false, - "numericValueRange": [ - 1, - 16777215 - ], - "group": "Options" - }, - { - "name": "data-secondary-space", - "aliases": [ - "dss" - ], - "description": "Specifies the secondary space allocation unit for the data VSAM component.\nAllowed values: 1-16777215\nDefault value: 3\nExample: --dss 5", - "type": "number", - "required": false, - "numericValueRange": [ - 1, - 16777215 - ], - "group": "Options" - }, - { - "name": "data-volume", - "aliases": [ - "dv" - ], - "description": "Specifies a disk volume or specific tapes for the data VSAM component.\nExample: -dv vol002", - "type": "array", - "required": false, - "group": "Options" - }, - { - "name": "buffer-space", - "aliases": [ - "bs" - ], - "description": "Specifies the minimum buffer space to allocate when this VSAM file is accessed.\nExample: --bs 37376", - "type": "number", - "required": false, - "group": "Options" - }, - { - "name": "erase", - "aliases": [ - "e" - ], - "description": "Indicates whether the VSAM file was allocated with the ERASE parameter, causing all components of the file to be overwritten with binary zeros, when the VSAM file is deleted from the catalog.\nDefault value: n\nExample: -e y", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "y", - "n" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "load-restartable", - "aliases": [ - "lr" - ], - "description": "Specify 'Y' to request that the VSAM component definition use the 'RECOVERY' parameter (which causes the data component to be preformatted previous to the initial load). Using this option causes the initial load to take longer, but loads which do not complete successfully can be restarted.\n Specify 'N' to request that the VSAM component definition use the 'SPEED' parameter (which causes the data component to NOT be preformatted previous to the initial load).\nDefault value: n\nExample: -lr y", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "y", - "n" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "reuse", - "aliases": [ - "r" - ], - "description": "Indicates whether the VSAM file was allocated with the REUSE parameter specifying that the cluster can be opened again and again as a reusable cluster.\nDefault value: n\nExample: -r y", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "y", - "n" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "write-check", - "aliases": [ - "wc" - ], - "description": "Indicates whether the VSAM file was allocated with the WRITECHECK parameter requesting each write to the VSAM file to be validated by a read without data transfer.\nDefault value: n\nExample: --wc y", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "y", - "n" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "control-interval-freespace-percentage", - "aliases": [ - "cifp" - ], - "description": "Specifies the percentage of empty space in each control interval when the file is initially loaded.The free space lets records be inserted or expanded within a control interval before requiring a control interval split.\nExample: --cifp 10", - "type": "number", - "required": false, - "numericValueRange": [ - 0, - 100 - ], - "group": "Options" - }, - { - "name": "control-area-freespace-percentage", - "aliases": [ - "cafp" - ], - "description": "Specifies the percentage of control intervals to be left unused in each control area as the file is initially loaded. The use of control area free space lets some control interval splits occur before requiring a control area split.\nExample: --cafp 10", - "type": "number", - "required": false, - "numericValueRange": [ - 0, - 100 - ], - "group": "Options" - }, - { - "name": "cross-region-share-option", - "aliases": [ - "crso" - ], - "description": "Specifies that the file can be shared among regions within the same system or within multiple systems using GRS (Global Resource Serialization).\nThe alloweThe allowed values have the following meaning: \n1 - The data set can be opened for read processing by an unlimited number of users, but the data set can be accessed by only one user when that user is doing read and write processing.\n2 - The data set can be opened by only one user at a time for read and write processing, but any number of users can also be accessing the data set for read processing\n3 - The data set can be fully shared by any number of users.\n4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.\nDefault value: 1\nExample: --crso 2", - "type": "number", - "required": false, - "allowableValues": { - "values": [ - "1", - "2", - "3", - "4" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "cross-system-share-option", - "aliases": [ - "csso" - ], - "description": "Specifies how the file can be shared among systems.\nThe allowed values have the following meaning: \n3 - The data set can be fully shared by any number of users.\n4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.\nDefault value: 3\nExample: --csso 4", - "type": "number", - "required": false, - "allowableValues": { - "values": [ - "3", - "4" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "expiration-date", - "aliases": [ - "ed" - ], - "description": "Specifies the expiration date after which the data set can be deleted.\nSpecify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.\nExample: --ed 2032-07-31", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "storage-class", - "aliases": [ - "sc" - ], - "description": "Specifies the storage class.\nExample: --sc scl002", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "management-class", - "aliases": [ - "mc" - ], - "description": "Specifies the management class.\nExample: --mc mcl002", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "data-class", - "aliases": [ - "dc" - ], - "description": "Specifies the data class.\nExample: --dc dcl002", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies File Master Plus server host name.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies File Master Plus server port.", - "type": "number", - "defaultValue": 51914, - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Specifies Mainframe user name. May be the same as TSO login.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Specifies Mainframe password. May be the same as TSO password.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies File Master Plus REST API protocol.", - "type": "string", - "defaultValue": "https", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "FMP Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "required": false, - "group": "FMP 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 FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "FMP 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": "fmp-profile", - "aliases": [ - "fmp-p" - ], - "group": "Profile Options", - "description": "The name of a (fmp) 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": [] - } - ], - "profile": { - "optional": [ - "fmp", - "base" - ] - }, - "examples": [ - { - "options": "fmmvs.test.dsname", - "description": "Creating a LDS with default option values" - }, - { - "options": "fmmvs.test.dsname --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --bs 37376 -e y -r y -s n --ed p", - "description": "Creating a LDS with options" - }, - { - "options": "fmmvs.test.dsname --model fmmvs.model.dsname", - "description": "Creating a LDS data set like a model LDS data set" - }, - { - "options": "fmmvs.test.dsname --model fmmvs.model.dsname --wc y --bs 37376 --crso 3 --csso 4 --ed 2025-09-27", - "description": "Creating a LDS like a model LDS data set and overriding the parameters with options" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "vsam-rrds", - "aliases": [ - "rrds" - ], - "summary": "Create a RRDS VSAM data set", - "type": "command", - "description": "Create a relative-record data set (RRDS) Virtual Storage Access Method (VSAM) data set.", - "handler": "", - "positionals": [ - { - "name": "name", - "type": "string", - "description": "Specifies the name of the data set to create.", - "required": true - } - ], - "options": [ - { - "name": "model", - "aliases": [ - "m" - ], - "description": "Specifies the name of a model RRDS (relative-record VSAM data set) for allocating parameters.\nThe parameters of the model data set override all defaults.\nExample: -m fmmvs.model.dsname", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "maximum-record-size", - "aliases": [ - "mrs" - ], - "description": "Specifies the maximum length of data records.\nThis parameter is mandatory unless a model data set is specified.\nExample: --mrs 180", - "type": "number", - "required": false, - "group": "Options" - }, - { - "name": "data-dsname", - "aliases": [ - "ddsn" - ], - "description": "Specifies the data set name of the data VSAM component.\nIf this parameter is not specified then by default it is set to the cluster name with ‘.DATA’.\nExample: --ddsn fmmvs.vsam.rrds.data", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "data-control-interval-size", - "aliases": [ - "dcis" - ], - "description": "Specifies the size of the Control Interval for the data VSAM component.\nDefault value: 20480\nExample: --dcis 3584", - "type": "number", - "required": false, - "group": "Options" - }, - { - "name": "data-space-units", - "aliases": [ - "dsu" - ], - "description": "Specifies the space allocation unit for data vsam component.\nThe allowed values have the following meaning: \nTRK - Tracks\nCYL - Cylinders\nREC - Records\nK - Kilobytes\nM - Megabytes\nDefault value: TRK\nExample: --dsu rec", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "TRK", - "CYL", - "REC", - "K", - "M" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "data-primary-space", - "aliases": [ - "dps" - ], - "description": "Specifies the primary space allocation unit for the data VSAM component.\nAllowed values: 1-16777215\nDefault value: 18\nExample: --dps 3", - "type": "number", - "required": false, - "numericValueRange": [ - 1, - 16777215 - ], - "group": "Options" - }, - { - "name": "data-secondary-space", - "aliases": [ - "dss" - ], - "description": "Specifies the secondary space allocation unit for the data VSAM component.\nAllowed values: 1-16777215\nDefault value: 3\nExample: --dss 5", - "type": "number", - "required": false, - "numericValueRange": [ - 1, - 16777215 - ], - "group": "Options" - }, - { - "name": "data-volume", - "aliases": [ - "dv" - ], - "description": "Specifies a disk volume or specific tapes for the data VSAM component.\nExample: -dv vol002", - "type": "array", - "required": false, - "group": "Options" - }, - { - "name": "buffer-space", - "aliases": [ - "bs" - ], - "description": "Specifies the minimum buffer space to allocate when this VSAM file is accessed.\nExample: --bs 37376", - "type": "number", - "required": false, - "group": "Options" - }, - { - "name": "erase", - "aliases": [ - "e" - ], - "description": "Indicates whether the VSAM file was allocated with the ERASE parameter, causing all components of the file to be overwritten with binary zeros, when the VSAM file is deleted from the catalog.\nDefault value: n\nExample: -e y", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "y", - "n" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "load-restartable", - "aliases": [ - "lr" - ], - "description": "Specify 'Y' to request that the VSAM component definition use the 'RECOVERY' parameter (which causes the data component to be preformatted previous to the initial load). Using this option causes the initial load to take longer, but loads which do not complete successfully can be restarted.\n Specify 'N' to request that the VSAM component definition use the 'SPEED' parameter (which causes the data component to NOT be preformatted previous to the initial load).\nDefault value: n\nExample: -lr y", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "y", - "n" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "reuse", - "aliases": [ - "r" - ], - "description": "Indicates whether the VSAM file was allocated with the REUSE parameter specifying that the cluster can be opened again and again as a reusable cluster.\nDefault value: n\nExample: -r y", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "y", - "n" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "write-check", - "aliases": [ - "wc" - ], - "description": "Indicates whether the VSAM file was allocated with the WRITECHECK parameter requesting each write to the VSAM file to be validated by a read without data transfer.\nDefault value: n\nExample: --wc y", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "y", - "n" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "control-interval-freespace-percentage", - "aliases": [ - "cifp" - ], - "description": "Specifies the percentage of empty space in each control interval when the file is initially loaded.The free space lets records be inserted or expanded within a control interval before requiring a control interval split.\nExample: --cifp 10", - "type": "number", - "required": false, - "numericValueRange": [ - 0, - 100 - ], - "group": "Options" - }, - { - "name": "control-area-freespace-percentage", - "aliases": [ - "cafp" - ], - "description": "Specifies the percentage of control intervals to be left unused in each control area as the file is initially loaded. The use of control area free space lets some control interval splits occur before requiring a control area split.\nExample: --cafp 10", - "type": "number", - "required": false, - "numericValueRange": [ - 0, - 100 - ], - "group": "Options" - }, - { - "name": "cross-region-share-option", - "aliases": [ - "crso" - ], - "description": "Specifies that the file can be shared among regions within the same system or within multiple systems using GRS (Global Resource Serialization).\nThe allowed values have the following meaning: \n1 - The data set can be opened for read processing by an unlimited number of users, but the data set can be accessed by only one user when that user is doing read and write processing.\n2 - The data set can be opened by only one user at a time for read and write processing, but any number of users can also be accessing the data set for read processing\n3 - The data set can be fully shared by any number of users.\n4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.\nDefault value: 1\nExample: --crso 2", - "type": "number", - "required": false, - "allowableValues": { - "values": [ - "1", - "2", - "3", - "4" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "cross-system-share-option", - "aliases": [ - "csso" - ], - "description": "Specifies how the file can be shared among systems.\nThe allowed values have the following meaning: \n3 - The data set can be fully shared by any number of users.\n4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.\nDefault value: 3\nExample: --csso 4", - "type": "number", - "required": false, - "allowableValues": { - "values": [ - "3", - "4" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "expiration-date", - "aliases": [ - "ed" - ], - "description": "Specifies the expiration date after which the data set can be deleted.\nSpecify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.\nExample: --ed 2032-07-31", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "storage-class", - "aliases": [ - "sc" - ], - "description": "Specifies the storage class.\nExample: --sc scl002", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "management-class", - "aliases": [ - "mc" - ], - "description": "Specifies the management class.\nExample: --mc mcl002", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "data-class", - "aliases": [ - "dc" - ], - "description": "Specifies the data class.\nExample: --dc dcl002", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "log", - "aliases": [ - "l" - ], - "description": "When specified, 'ALL' or 'UNDO' or 'NONE' indicates the VSAM RLS recovery option.\nExample: --log ALL", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "NONE", - "UNDO", - "ALL" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "frlog", - "aliases": [ - "fr" - ], - "description": "Specifies the type of VSAM batch logging to perform for this VSAM data set.\nThe allowed values have the following meaning:\nNONE - Disables VSAM batch logging.\nREDO - Enables VSAM batch logging.\nUNDO - Changes made to your VSAM data set are backed out using VSAM batch logging.\nALL - Changes made to your VSAM data set are backed out and forward recovered using VSAM batch logging.\nExample: --frlog ALL", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "NONE", - "UNDO", - "ALL", - "REDO" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "log-replicate", - "aliases": [ - "lrp" - ], - "description": "Specify 'Y' to enable VSAM replication for this data set.\nExample: --lrp y", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "Y", - "N" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "log-stream-id", - "aliases": [ - "lsi" - ], - "description": "Specifies the 1- to 26-character name of the forward recovery log stream.\nExample: --lsi LOGSTRA", - "type": "string", - "required": false, - "stringLengthRange": [ - 1, - 26 - ], - "group": "Options" - }, - { - "name": "rls-enable", - "aliases": [ - "rls", - "re" - ], - "description": "Specify 'N' to disable VSAM record-level sharing.\nDefault value: y\nExample: --rls n", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "Y", - "N" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies File Master Plus server host name.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies File Master Plus server port.", - "type": "number", - "defaultValue": 51914, - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Specifies Mainframe user name. May be the same as TSO login.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Specifies Mainframe password. May be the same as TSO password.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies File Master Plus REST API protocol.", - "type": "string", - "defaultValue": "https", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "FMP Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "required": false, - "group": "FMP 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 FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "FMP 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": "fmp-profile", - "aliases": [ - "fmp-p" - ], - "group": "Profile Options", - "description": "The name of a (fmp) 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": [] - } - ], - "profile": { - "optional": [ - "fmp", - "base" - ] - }, - "examples": [ - { - "options": "fmmvs.test.dsname --mrs 160", - "description": "Creating a RRDS with default option values and mandatory options" - }, - { - "options": "fmmvs.test.dsname --mrs 160 --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --bs 37376 -e y -r y -s n --ed p", - "description": "Creating a RRDS with options" - }, - { - "options": "fmmvs.test.dsname --mrs 160 --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --bs 37376 -e y -r y -s n --ed p --rls y -l all --lsi loga --lrp y --fr ALL", - "description": "Creating a RLS enabled RRDS with logging options" - }, - { - "options": "fmmvs.test.dsname --model fmmvs.model.dsname", - "description": "Creating a RRDS data set like a model RRDS data set" - }, - { - "options": "fmmvs.test.dsname --model fmmvs.model.dsname --mrs 160 --wc y --bs 37376 --crso 3 --csso 4 --ed 2025-09-27", - "description": "Creating a RRDS like a model RRDS data set and overriding the parameters with options" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "vsam-vrrds", - "aliases": [ - "vrrds" - ], - "summary": "Create a VRRDS VSAM data set", - "type": "command", - "description": "Create a variable-length relative-record data set (VRRDS) Virtual Storage Access Method (VSAM) data set.", - "handler": "", - "positionals": [ - { - "name": "name", - "type": "string", - "description": "Specifies the name of the data set to create.", - "required": true - } - ], - "options": [ - { - "name": "model", - "aliases": [ - "m" - ], - "description": "Specifies the name of a model VRRDS (variable-length relative-record VSAM data set) for allocating parameters.\nThe parameters of the model data set override all defaults.\nExample: -m fmmvs.model.dsname", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "maximum-record-size", - "aliases": [ - "mrs" - ], - "description": "Specifies the maximum length of data records.\nThis parameter is mandatory unless a model data set is specified and it should be greater than the average record size.\nExample: --mrs 180", - "type": "number", - "required": false, - "group": "Options" - }, - { - "name": "average-record-size", - "aliases": [ - "ars" - ], - "description": "Specifies the average length of data records.\nThis parameter is mandatory unless a model data set is specified and it should be less than the maximum record size.\nExample: --ars 110", - "type": "number", - "required": false, - "group": "Options" - }, - { - "name": "data-dsname", - "aliases": [ - "ddsn" - ], - "description": "Specifies the data set name of the data VSAM component.\nIf this parameter is not specified then by default it is set to the cluster name with ‘.DATA’.\nExample: --ddsn fmmvs.vsam.ksds.data", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "data-control-interval-size", - "aliases": [ - "dcis" - ], - "description": "Specifies the size of the Control Interval for the data VSAM component.\nDefault value: 20480\nExample: --dcis 3584", - "type": "number", - "required": false, - "group": "Options" - }, - { - "name": "data-space-units", - "aliases": [ - "dsu" - ], - "description": "Specifies the space allocation unit for data vsam component.\nThe allowed values have the following meaning: \nTRK - Tracks\nCYL - Cylinders\nREC - Records\nK - Kilobytes\nM - Megabytes\nDefault value: TRK\nExample: --dsu rec", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "TRK", - "CYL", - "REC", - "K", - "M" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "data-primary-space", - "aliases": [ - "dps" - ], - "description": "Specifies the primary space allocation unit for the data VSAM component.\nAllowed values: 1-16777215\nDefault value: 18\nExample: --dps 3", - "type": "number", - "required": false, - "numericValueRange": [ - 1, - 16777215 - ], - "group": "Options" - }, - { - "name": "data-secondary-space", - "aliases": [ - "dss" - ], - "description": "Specifies the secondary space allocation unit for the data VSAM component.\nAllowed values: 1-16777215\nDefault value: 3\nExample: --dss 5", - "type": "number", - "required": false, - "numericValueRange": [ - 1, - 16777215 - ], - "group": "Options" - }, - { - "name": "data-volume", - "aliases": [ - "dv" - ], - "description": "Specifies a disk volume or specific tapes for the data VSAM component.\nExample: -dv vol002", - "type": "array", - "required": false, - "group": "Options" - }, - { - "name": "index-dsname", - "aliases": [ - "idsn" - ], - "description": "Specifies the data set name of the index VSAM component.\nIf this parameter is not specified then it is set to the cluster name with ‘.INDEX’ appended.\nExample: --ddsn fmmvs.vsam.ksds.index", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "index-control-interval-size", - "aliases": [ - "icis" - ], - "description": "Specifies the size of Control Interval for index VSAM component.\nDefault value: 512\nExample: --icis 3584", - "type": "number", - "required": false, - "group": "Options" - }, - { - "name": "index-space-units", - "aliases": [ - "isu" - ], - "description": "Specifies the space allocation unit for index VSAM component.\nThe allowed values have the following meaning: \nTRK - Tracks\nCYL - Cylinders\nREC - Records\nK - Kilobytes\nM - Megabytes\nDefault value: TRK\nExample: --isu cyl", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "TRK", - "CYL", - "REC", - "K", - "M" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "index-primary-space", - "aliases": [ - "ips" - ], - "description": "Specifies primary space allocation unit for index VSAM component.\nAllowed values: 1-16777215\nDefault value: 1\nExample: --ips 3", - "type": "number", - "required": false, - "numericValueRange": [ - 1, - 16777215 - ], - "group": "Options" - }, - { - "name": "index-secondary-space", - "aliases": [ - "iss" - ], - "description": "Specifies secondary space allocation unit for index VSAM component.\nAllowed values: 1-16777215\nDefault value: 1\nExample: --iss 5", - "type": "number", - "required": false, - "numericValueRange": [ - 1, - 16777215 - ], - "group": "Options" - }, - { - "name": "index-volume", - "aliases": [ - "iv" - ], - "description": "Specifies a disk volume or specific tapes for the data VSAM component.\nExample: -iv vol002", - "type": "array", - "required": false, - "group": "Options" - }, - { - "name": "buffer-space", - "aliases": [ - "bs" - ], - "description": "Specifies the minimum buffer space to allocate when this VSAM file is accessed.\nExample: --bs 37376", - "type": "number", - "required": false, - "group": "Options" - }, - { - "name": "erase", - "aliases": [ - "e" - ], - "description": "Indicates whether the VSAM file was allocated with the ERASE parameter, causing all components of the file to be overwritten with binary zeros, when the VSAM file is deleted from the catalog.\nDefault value: n\nExample: -e y", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "y", - "n" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "load-restartable", - "aliases": [ - "lr" - ], - "description": "Specify 'Y' to request that the VSAM component definition use the 'RECOVERY' parameter (which causes the data component to be preformatted previous to the initial load). Using this option causes the initial load to take longer, but loads which do not complete successfully can be restarted.\n Specify 'N' to request that the VSAM component definition use the 'SPEED' parameter (which causes the data component to NOT be preformatted previous to the initial load).\nDefault value: n\nExample: -lr y", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "y", - "n" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "reuse", - "aliases": [ - "r" - ], - "description": "Indicates whether the VSAM file was allocated with the REUSE parameter specifying that the cluster can be opened again and again as a reusable cluster.\nDefault value: n\nExample: -r y", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "y", - "n" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "write-check", - "aliases": [ - "wc" - ], - "description": "Indicates whether the VSAM file was allocated with the WRITECHECK parameter requesting each write to the VSAM file to be validated by a read without data transfer.\nDefault value: n\nExample: --wc y", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "y", - "n" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "control-interval-freespace-percentage", - "aliases": [ - "cifp" - ], - "description": "Specifies the percentage of empty space in each control interval when the file is initially loaded.The free space lets records be inserted or expanded within a control interval before requiring a control interval split.\nExample: --cifp 10", - "type": "number", - "required": false, - "numericValueRange": [ - 0, - 100 - ], - "group": "Options" - }, - { - "name": "control-area-freespace-percentage", - "aliases": [ - "cafp" - ], - "description": "Specifies the percentage of control intervals to be left unused in each control area as the file is initially loaded. The use of control area free space lets some control interval splits occur before requiring a control area split.\nExample: --cafp 10", - "type": "number", - "required": false, - "numericValueRange": [ - 0, - 100 - ], - "group": "Options" - }, - { - "name": "cross-region-share-option", - "aliases": [ - "crso" - ], - "description": "Specifies that the file can be shared among regions within the same system or within multiple systems using GRS (Global Resource Serialization).\nThe allowed values have the following meaning: \n1 - The data set can be opened for read processing by an unlimited number of users, but the data set can be accessed by only one user when that user is doing read and write processing.\n2 - The data set can be opened by only one user at a time for read and write processing, but any number of users can also be accessing the data set for read processing\n3 - The data set can be fully shared by any number of users.\n4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.\nDefault value: 1\nExample: --crso 2", - "type": "number", - "required": false, - "allowableValues": { - "values": [ - "1", - "2", - "3", - "4" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "cross-system-share-option", - "aliases": [ - "csso" - ], - "description": "Specifies how the file can be shared among systems.\nThe allowed values have the following meaning: \n3 - The data set can be fully shared by any number of users.\n4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.\nDefault value: 3\nExample: --csso 4", - "type": "number", - "required": false, - "allowableValues": { - "values": [ - "3", - "4" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "expiration-date", - "aliases": [ - "ed" - ], - "description": "Specifies the expiration date after which the data set can be deleted.\nSpecify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.\nExample: --ed 2032-07-31", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "storage-class", - "aliases": [ - "sc" - ], - "description": "Specifies the storage class.\nExample: --sc scl002", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "management-class", - "aliases": [ - "mc" - ], - "description": "Specifies the management class.\nExample: --mc mcl002", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "data-class", - "aliases": [ - "dc" - ], - "description": "Specifies the data class.\nExample: --dc dcl002", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "log", - "aliases": [ - "l" - ], - "description": "When specified, 'ALL' or 'UNDO' or 'NONE' indicates the VSAM RLS recovery option.\nExample: --log ALL", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "NONE", - "UNDO", - "ALL" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "frlog", - "aliases": [ - "fr" - ], - "description": "Specifies the type of VSAM batch logging to perform for this VSAM data set.\nThe allowed values have the following meaning:\nNONE - Disables VSAM batch logging.\nREDO - Enables VSAM batch logging.\nUNDO - Changes made to your VSAM data set are backed out using VSAM batch logging.\nALL - Changes made to your VSAM data set are backed out and forward recovered using VSAM batch logging.\nExample: --frlog ALL", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "NONE", - "UNDO", - "ALL", - "REDO" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "log-replicate", - "aliases": [ - "lrp" - ], - "description": "Specify 'Y' to enable VSAM replication for this data set.\nExample: --lrp y", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "Y", - "N" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "log-stream-id", - "aliases": [ - "lsi" - ], - "description": "Specifies the 1- to 26-character name of the forward recovery log stream.\nExample: --lsi LOGSTRA", - "type": "string", - "required": false, - "stringLengthRange": [ - 1, - 26 - ], - "group": "Options" - }, - { - "name": "rls-enable", - "aliases": [ - "rls", - "re" - ], - "description": "Specify 'N' to disable VSAM record-level sharing.\nDefault value: y\nExample: --rls n", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "Y", - "N" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies File Master Plus server host name.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies File Master Plus server port.", - "type": "number", - "defaultValue": 51914, - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Specifies Mainframe user name. May be the same as TSO login.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Specifies Mainframe password. May be the same as TSO password.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies File Master Plus REST API protocol.", - "type": "string", - "defaultValue": "https", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "FMP Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "required": false, - "group": "FMP 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 FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "FMP 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": "fmp-profile", - "aliases": [ - "fmp-p" - ], - "group": "Profile Options", - "description": "The name of a (fmp) 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": [] - } - ], - "profile": { - "optional": [ - "fmp", - "base" - ] - }, - "examples": [ - { - "options": "fmmvs.test.dsname --mrs 160", - "description": "Creating a VRRDS with default option values and mandatory options" - }, - { - "options": "fmmvs.test.dsname --mrs 160 --ars 120 --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --icis 512 --isu cyl --ips 1 --iss 1 --iv vol002 --bs 37376 -e y -r y --ed 2025-09-27", - "description": "Creating a VRRDS with options" - }, - { - "options": "fmmvs.test.dsname --mrs 160 --ars 120 --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --icis 512 --isu cyl --ips 1 --iss 1 --iv vol002 --bs 37376 -e y -r y --rls y -l all --lsi loga --lrp y --fr ALL", - "description": "Creating a RLS enabled VRRDS with logging options" - }, - { - "options": "fmmvs.test.dsname --model fmmvs.model.dsname", - "description": "Creating a VRRDS data set like a model VRRDS data set" - }, - { - "options": "fmmvs.test.dsname --model fmmvs.model.dsname --mrs 160 --wc y --bs 37376 --crso 3 --csso 4 --ed p", - "description": "Creating a VRRDS like a model VRRDS data set and overriding the parameters with options" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "like-model", - "aliases": [ - "model", - "lm" - ], - "summary": "Create a data set based on the parameters of an existing data set", - "type": "command", - "description": "Create a data set by allocating parameters from a model data set.", - "handler": "", - "positionals": [ - { - "name": "name", - "type": "string", - "description": "Specifies the name of the data set to create.", - "required": true - }, - { - "name": "model", - "type": "string", - "description": "Specifies the name of the model data set.", - "required": true - } - ], - "profile": { - "optional": [ - "fmp", - "base" - ] - }, - "examples": [ - { - "options": "fmmvs.create.dsname fmmvs.model.dsname", - "description": "Creating a data set like a model data set" - } - ], - "options": [ - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies File Master Plus server host name.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies File Master Plus server port.", - "type": "number", - "defaultValue": 51914, - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Specifies Mainframe user name. May be the same as TSO login.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Specifies Mainframe password. May be the same as TSO password.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies File Master Plus REST API protocol.", - "type": "string", - "defaultValue": "https", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "FMP Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "required": false, - "group": "FMP 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 FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "FMP 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": "fmp-profile", - "aliases": [ - "fmp-p" - ], - "group": "Profile Options", - "description": "The name of a (fmp) 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": [ - "H" - ], - "description": "Specifies File Master Plus server host name.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies File Master Plus server port.", - "type": "number", - "defaultValue": 51914, - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Specifies Mainframe user name. May be the same as TSO login.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Specifies Mainframe password. May be the same as TSO password.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies File Master Plus REST API protocol.", - "type": "string", - "defaultValue": "https", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "FMP Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "required": false, - "group": "FMP 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 FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "FMP 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": [] - }, - { - "name": "delete", - "aliases": [ - "del" - ], - "type": "group", - "description": "Permanently deletes a data set.", - "summary": "Delete a data set", - "children": [ - { - "name": "data-set", - "aliases": [ - "ds" - ], - "summary": "Permanently deletes a data set", - "type": "command", - "description": "Permanently deletes a data set.\nIt supports all data set types that are supported by File Master Plus.", - "handler": "", - "positionals": [ - { - "name": "name", - "type": "string", - "description": "Specifies the name of the data set that you want to delete.", - "required": true - } - ], - "profile": { - "optional": [ - "fmp", - "base" - ] - }, - "examples": [ - { - "options": "fmmvs.dsname", - "description": "Deleting a data set" - } - ], - "options": [ - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies File Master Plus server host name.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies File Master Plus server port.", - "type": "number", - "defaultValue": 51914, - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Specifies Mainframe user name. May be the same as TSO login.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Specifies Mainframe password. May be the same as TSO password.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies File Master Plus REST API protocol.", - "type": "string", - "defaultValue": "https", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "FMP Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "required": false, - "group": "FMP 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 FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "FMP 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": "fmp-profile", - "aliases": [ - "fmp-p" - ], - "group": "Profile Options", - "description": "The name of a (fmp) 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": [ - "H" - ], - "description": "Specifies File Master Plus server host name.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies File Master Plus server port.", - "type": "number", - "defaultValue": 51914, - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Specifies Mainframe user name. May be the same as TSO login.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Specifies Mainframe password. May be the same as TSO password.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies File Master Plus REST API protocol.", - "type": "string", - "defaultValue": "https", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "FMP Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "required": false, - "group": "FMP 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 FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "FMP 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": [] - }, - { - "name": "populate", - "aliases": [ - "pop" - ], - "type": "group", - "summary": "Add records in a data set", - "description": "Populate the specified data set with records.\nIt supports all data set types that are supported by File Master Plus.", - "children": [ - { - "name": "data-set", - "aliases": [ - "ds" - ], - "description": "Populate a specific data set with records.\nThe layout of the records to add are described by a Cobol or PL/I copybook.", - "summary": "Populate a data set", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "name", - "type": "string", - "description": "Specifies the name of the data set to populate.", - "required": true - } - ], - "options": [ - { - "name": "member", - "aliases": [ - "m" - ], - "description": "Specifies name of the member.\nNote: Used only if the specified data set is a PDS or PDSE.\nExample: -m member1.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "layout-member", - "aliases": [ - "lm" - ], - "description": "Specifies the name of the Cobol or PL/I copybook.\nExample: --lm testlay.", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "layout-data-set", - "aliases": [ - "lds" - ], - "description": "Specifies the name of the data set that contains the layout member.\nExample: --lds fmmvs.layout.dataset.", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "data", - "aliases": [ - "d" - ], - "description": "Specifies path of the .txt/.json file of the data stream. Ensure the data stream is an array in JSON format represented by a layout data set and its member.\nExample: -d ../instream/data1.txt ", - "type": "string", - "conflictsWith": [ - "static-selection" - ], - "required": true, - "group": "Required Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies File Master Plus server host name.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies File Master Plus server port.", - "type": "number", - "defaultValue": 51914, - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Specifies Mainframe user name. May be the same as TSO login.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Specifies Mainframe password. May be the same as TSO password.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies File Master Plus REST API protocol.", - "type": "string", - "defaultValue": "https", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "FMP Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "required": false, - "group": "FMP 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 FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "FMP 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": "fmp-profile", - "aliases": [ - "fmp-p" - ], - "group": "Profile Options", - "description": "The name of a (fmp) 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": [] - } - ], - "profile": { - "optional": [ - "fmp", - "base" - ] - }, - "examples": [ - { - "options": "fmmvs.dsname --lds fmmvs.layout.dataset --lm testlay --data ../instream/data1.txt ", - "description": "Populating a data set" - } - ], - "passOn": [], - "children": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies File Master Plus server host name.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies File Master Plus server port.", - "type": "number", - "defaultValue": 51914, - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Specifies Mainframe user name. May be the same as TSO login.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Specifies Mainframe password. May be the same as TSO password.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies File Master Plus REST API protocol.", - "type": "string", - "defaultValue": "https", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "FMP Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "required": false, - "group": "FMP 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 FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "FMP 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": [] - }, - { - "name": "rename", - "aliases": [ - "ren" - ], - "type": "group", - "summary": "Rename a data set", - "description": "Rename the specified data set.", - "children": [ - { - "name": "data-set", - "aliases": [ - "ds" - ], - "description": "Rename a data set.\nIt supports all data set types that are supported by File Master Plus.", - "summary": "Rename a data set", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "old", - "type": "string", - "description": "Specifies the name of the data set that you want to rename.", - "required": true - }, - { - "name": "new", - "type": "string", - "description": "Specifies the new name of the data set.", - "required": true - } - ], - "options": [ - { - "name": "vsam-component", - "aliases": [ - "vsamc" - ], - "description": "Rename the data and index components of a VSAM cluster if they share the cluster name.\nNote: Used only if the target data set is a VSAM cluster.\nExample: --vsamc y.", - "type": "string", - "required": false, - "defaultValue": "n", - "allowableValues": { - "values": [ - "y", - "n" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies File Master Plus server host name.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies File Master Plus server port.", - "type": "number", - "defaultValue": 51914, - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Specifies Mainframe user name. May be the same as TSO login.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Specifies Mainframe password. May be the same as TSO password.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies File Master Plus REST API protocol.", - "type": "string", - "defaultValue": "https", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "FMP Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "required": false, - "group": "FMP 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 FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "FMP 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": "fmp-profile", - "aliases": [ - "fmp-p" - ], - "group": "Profile Options", - "description": "The name of a (fmp) 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": [] - } - ], - "profile": { - "optional": [ - "fmp", - "base" - ] - }, - "examples": [ - { - "options": "fmmvs.old.dsname fmmvs.new.dsname", - "description": "Renaming a data set" - }, - { - "options": "fmmvs.oldvsam.dsname fmmvs.newvsam.dsname --vsamc y", - "description": "Renaming a VSAM data set along with its components" - } - ], - "passOn": [], - "children": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies File Master Plus server host name.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies File Master Plus server port.", - "type": "number", - "defaultValue": 51914, - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Specifies Mainframe user name. May be the same as TSO login.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Specifies Mainframe password. May be the same as TSO password.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies File Master Plus REST API protocol.", - "type": "string", - "defaultValue": "https", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "FMP Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "required": false, - "group": "FMP 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 FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "FMP 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": "Advanced file management and data manipulation", - "aliases": [ - "fmp" - ], - "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/idms.jsonc b/commandGroups/idms.jsonc deleted file mode 100644 index d5c04e1..0000000 --- a/commandGroups/idms.jsonc +++ /dev/null @@ -1,3591 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "idms", - "description": "IDMS plug-in for listing real-time monitor statistics and information, viewing DC log messages, and issuing DCMT and DCUF commands", - "type": "group", - "children": [ - { - "name": "issue", - "aliases": [ - "iss" - ], - "summary": "Issue IDMS DCMT and DCUF commands", - "description": "Issues IDMS DCMT and DCUF commands", - "type": "group", - "children": [ - { - "name": "dcmt-display", - "aliases": [ - "dd" - ], - "summary": "DCMT DISPLAY commands", - "description": "Execute a DCMT DISPLAY command", - "type": "command", - "handler": "", - "options": [ - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Host name of the IDMS REST API service", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Port for the IDMS REST API service", - "type": "number", - "group": "IDMS Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Mainframe user name, which can be the same as your TSO login ID", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe password, which can be the same as your TSO password", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates", - "type": "boolean", - "defaultValue": true, - "group": "IDMS Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "datasource", - "aliases": [ - "d" - ], - "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "args", - "type": "string", - "description": "DCMT DISPLAY command arguments", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "broadcast", - "aliases": [ - "b" - ], - "type": "string", - "description": "Broadcast parameters used if the system is part of a data sharing group", - "group": "Options" - }, - { - "name": "datasource", - "aliases": [ - "d" - ], - "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", - "type": "string", - "required": true, - "group": "IDMS Connection Options" - }, - { - "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": "idms-profile", - "aliases": [ - "idms-p" - ], - "group": "Profile Options", - "description": "The name of a (idms) profile to load for this command execution.", - "type": "string" - }, - { - "name": "base-profile", - "aliases": [ - "base-p" - ], - "group": "Profile Options", - "description": "The name of a (base) profile to load for this command execution.", - "type": "string" - }, - { - "name": "token-type", - "aliases": [ - "tt" - ], - "description": "The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-value", - "aliases": [ - "tv" - ], - "description": "The value of the token to pass to the API.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "cert-file", - "description": "The file path to a certificate file to use for authentication.\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 - } - ], - "profile": { - "optional": [ - "idms", - "base" - ] - }, - "outputFormatOptions": true, - "examples": [ - { - "options": "--args \"task send\"", - "description": "Issues a 'dcmt display task send' command to display information associated with the SEND task" - }, - { - "options": "--args \"active programs\" --idms-profile myprofile2 --datasource sysdemo", - "description": "Issues a 'dcmt display active programs' command with an IDMS profile and data source to override the default" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "dcmt-vary", - "aliases": [ - "dv" - ], - "summary": "DCMT VARY commands", - "description": "Execute a DCMT VARY command", - "type": "command", - "handler": "", - "options": [ - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Host name of the IDMS REST API service", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Port for the IDMS REST API service", - "type": "number", - "group": "IDMS Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Mainframe user name, which can be the same as your TSO login ID", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe password, which can be the same as your TSO password", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates", - "type": "boolean", - "defaultValue": true, - "group": "IDMS Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "datasource", - "aliases": [ - "d" - ], - "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "args", - "type": "string", - "description": "DCMT VARY command arguments", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "broadcast", - "aliases": [ - "b" - ], - "type": "string", - "description": "Broadcast parameters used if the system is part of a data sharing group", - "group": "Options" - }, - { - "name": "datasource", - "aliases": [ - "d" - ], - "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", - "type": "string", - "required": true, - "group": "IDMS Connection Options" - }, - { - "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": "idms-profile", - "aliases": [ - "idms-p" - ], - "group": "Profile Options", - "description": "The name of a (idms) profile to load for this command execution.", - "type": "string" - }, - { - "name": "base-profile", - "aliases": [ - "base-p" - ], - "group": "Profile Options", - "description": "The name of a (base) profile to load for this command execution.", - "type": "string" - }, - { - "name": "token-type", - "aliases": [ - "tt" - ], - "description": "The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-value", - "aliases": [ - "tv" - ], - "description": "The value of the token to pass to the API.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "cert-file", - "description": "The file path to a certificate file to use for authentication.\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 - } - ], - "profile": { - "optional": [ - "idms", - "base" - ] - }, - "outputFormatOptions": true, - "examples": [ - { - "options": "--args \"task signon enabled\"", - "description": "Issues a 'dcmt vary task signon enabled' command to enable the SIGNON task" - }, - { - "options": "--args \"journal swap\" --idms-profile myprofile2 --datasource sysdemo", - "description": "Issues a 'dcmt vary journal swap' command with an IDMS profile and data source to override the default" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "dcmt-help", - "aliases": [ - "dh" - ], - "summary": "DCMT HELP command", - "description": "Execute a DCMT HELP command", - "type": "command", - "handler": "", - "options": [ - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Host name of the IDMS REST API service", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Port for the IDMS REST API service", - "type": "number", - "group": "IDMS Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Mainframe user name, which can be the same as your TSO login ID", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe password, which can be the same as your TSO password", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates", - "type": "boolean", - "defaultValue": true, - "group": "IDMS Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "datasource", - "aliases": [ - "d" - ], - "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "args", - "type": "string", - "description": "DCMT HELP command arguments", - "group": "Options", - "aliases": [] - }, - { - "name": "broadcast", - "aliases": [ - "b" - ], - "type": "string", - "description": "Broadcast parameters used if the system is part of a data sharing group", - "group": "Options" - }, - { - "name": "datasource", - "aliases": [ - "d" - ], - "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", - "type": "string", - "required": true, - "group": "IDMS Connection Options" - }, - { - "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": "idms-profile", - "aliases": [ - "idms-p" - ], - "group": "Profile Options", - "description": "The name of a (idms) profile to load for this command execution.", - "type": "string" - }, - { - "name": "base-profile", - "aliases": [ - "base-p" - ], - "group": "Profile Options", - "description": "The name of a (base) profile to load for this command execution.", - "type": "string" - }, - { - "name": "token-type", - "aliases": [ - "tt" - ], - "description": "The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-value", - "aliases": [ - "tv" - ], - "description": "The value of the token to pass to the API.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "cert-file", - "description": "The file path to a certificate file to use for authentication.\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 - } - ], - "profile": { - "optional": [ - "idms", - "base" - ] - }, - "outputFormatOptions": true, - "examples": [ - { - "options": "", - "description": "Issues a 'dcmt help' command to display a summary of the syntax for DCMT commands" - }, - { - "options": "--args \"task\" --datasource sysdemo", - "description": "Issues a 'dcmt help task' command with a data source to override the default" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "dcmt-quiesce", - "aliases": [ - "dq" - ], - "summary": "DCMT QUIESCE command", - "description": "Execute a DCMT QUIESCE command", - "type": "command", - "handler": "", - "options": [ - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Host name of the IDMS REST API service", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Port for the IDMS REST API service", - "type": "number", - "group": "IDMS Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Mainframe user name, which can be the same as your TSO login ID", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe password, which can be the same as your TSO password", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates", - "type": "boolean", - "defaultValue": true, - "group": "IDMS Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "datasource", - "aliases": [ - "d" - ], - "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "args", - "type": "string", - "description": "DCMT QUIESCE command arguments. Specifies the DCMT QUIESCE target area, segment, or DBNAME", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "datasource", - "aliases": [ - "d" - ], - "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", - "type": "string", - "required": true, - "group": "IDMS Connection Options" - }, - { - "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": "idms-profile", - "aliases": [ - "idms-p" - ], - "group": "Profile Options", - "description": "The name of a (idms) profile to load for this command execution.", - "type": "string" - }, - { - "name": "base-profile", - "aliases": [ - "base-p" - ], - "group": "Profile Options", - "description": "The name of a (base) profile to load for this command execution.", - "type": "string" - }, - { - "name": "token-type", - "aliases": [ - "tt" - ], - "description": "The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-value", - "aliases": [ - "tv" - ], - "description": "The value of the token to pass to the API.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "cert-file", - "description": "The file path to a certificate file to use for authentication.\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 - } - ], - "profile": { - "optional": [ - "idms", - "base" - ] - }, - "outputFormatOptions": true, - "examples": [ - { - "options": "--args \"dbname empdemo id 1\"", - "description": "Issues the command 'dcmt quiesce dbname empdemo id 1' which quiesces all areas associated with segments included in the EMPDEMO database and assigns the operation to dcmt-id 1" - }, - { - "options": "--args \"area emp* id 2\"", - "description": "Issues the command 'dcmt quiesce area emp* id 2' which quiesces all areas whose segment name begins with EMP and assigns the operation to dcmt-id 2" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "dcmt-shutdown", - "aliases": [ - "shutdown" - ], - "summary": "DCMT SHUTDOWN commands", - "description": "Execute a DCMT SHUTDOWN command", - "type": "command", - "handler": "", - "options": [ - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Host name of the IDMS REST API service", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Port for the IDMS REST API service", - "type": "number", - "group": "IDMS Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Mainframe user name, which can be the same as your TSO login ID", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe password, which can be the same as your TSO password", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates", - "type": "boolean", - "defaultValue": true, - "group": "IDMS Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "datasource", - "aliases": [ - "d" - ], - "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "args", - "type": "string", - "description": "DCMT SHUTDOWN command arguments. NOPROMPT must be specified. IMMEDIATE is optional", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "datasource", - "aliases": [ - "d" - ], - "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", - "type": "string", - "required": true, - "group": "IDMS Connection Options" - }, - { - "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": "idms-profile", - "aliases": [ - "idms-p" - ], - "group": "Profile Options", - "description": "The name of a (idms) profile to load for this command execution.", - "type": "string" - }, - { - "name": "base-profile", - "aliases": [ - "base-p" - ], - "group": "Profile Options", - "description": "The name of a (base) profile to load for this command execution.", - "type": "string" - }, - { - "name": "token-type", - "aliases": [ - "tt" - ], - "description": "The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-value", - "aliases": [ - "tv" - ], - "description": "The value of the token to pass to the API.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "cert-file", - "description": "The file path to a certificate file to use for authentication.\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 - } - ], - "profile": { - "optional": [ - "idms", - "base" - ] - }, - "outputFormatOptions": true, - "examples": [ - { - "options": "--args \"noprompt\"", - "description": "Issues a 'dcmt shutdown noprompt' command to shut down the DC/UCF system while allowing all active tasks and external run units to terminate normally first" - }, - { - "options": "--args \"noprompt immediate\"", - "description": "Issues a 'dcmt shutdown noprompt immediate' command to immediately shut down the DC/UCF system, abending all active tasks and external run units with code SHUT" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "dcmt-statistics", - "aliases": [ - "ds" - ], - "summary": "DCMT STATISTICS commands", - "description": "Execute a DCMT STATISTICS command", - "type": "command", - "handler": "", - "options": [ - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Host name of the IDMS REST API service", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Port for the IDMS REST API service", - "type": "number", - "group": "IDMS Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Mainframe user name, which can be the same as your TSO login ID", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe password, which can be the same as your TSO password", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates", - "type": "boolean", - "defaultValue": true, - "group": "IDMS Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "datasource", - "aliases": [ - "d" - ], - "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "args", - "type": "string", - "description": "DCMT STATISTICS command arguments. Can specify ROLL to reset statistics to zero after writing them", - "group": "Options", - "aliases": [] - }, - { - "name": "broadcast", - "aliases": [ - "b" - ], - "type": "string", - "description": "Broadcast parameters used if the system is part of a data sharing group", - "group": "Options" - }, - { - "name": "datasource", - "aliases": [ - "d" - ], - "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", - "type": "string", - "required": true, - "group": "IDMS Connection Options" - }, - { - "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": "idms-profile", - "aliases": [ - "idms-p" - ], - "group": "Profile Options", - "description": "The name of a (idms) profile to load for this command execution.", - "type": "string" - }, - { - "name": "base-profile", - "aliases": [ - "base-p" - ], - "group": "Profile Options", - "description": "The name of a (base) profile to load for this command execution.", - "type": "string" - }, - { - "name": "token-type", - "aliases": [ - "tt" - ], - "description": "The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-value", - "aliases": [ - "tv" - ], - "description": "The value of the token to pass to the API.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "cert-file", - "description": "The file path to a certificate file to use for authentication.\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 - } - ], - "profile": { - "optional": [ - "idms", - "base" - ] - }, - "outputFormatOptions": true, - "examples": [ - { - "options": "--args \"roll\"", - "description": "Issues a 'dcmt write statistics roll' command to write the current system and line statistics and histograms to the log file and then reset their values to zero" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "dcmt-test", - "aliases": [ - "dt" - ], - "summary": "DCMT TEST commands", - "description": "Execute a DCMT TEST command. Obtains diagnostic information for Broadcom technical support personnel.\n\n The DCMT TEST command is used for debugging and diagnostic purposes only. Use it only when told to do so by IDMS technical support personnel. It is enabled only if certain CSA test flags are turned on", - "type": "command", - "handler": "", - "options": [ - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Host name of the IDMS REST API service", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Port for the IDMS REST API service", - "type": "number", - "group": "IDMS Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Mainframe user name, which can be the same as your TSO login ID", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe password, which can be the same as your TSO password", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates", - "type": "boolean", - "defaultValue": true, - "group": "IDMS Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "datasource", - "aliases": [ - "d" - ], - "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "args", - "type": "string", - "description": "DCMT TEST command arguments. Specifies which debugging options to use", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "broadcast", - "aliases": [ - "b" - ], - "type": "string", - "description": "Broadcast parameters used if the system is part of a data sharing group", - "group": "Options" - }, - { - "name": "datasource", - "aliases": [ - "d" - ], - "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", - "type": "string", - "required": true, - "group": "IDMS Connection Options" - }, - { - "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": "idms-profile", - "aliases": [ - "idms-p" - ], - "group": "Profile Options", - "description": "The name of a (idms) profile to load for this command execution.", - "type": "string" - }, - { - "name": "base-profile", - "aliases": [ - "base-p" - ], - "group": "Profile Options", - "description": "The name of a (base) profile to load for this command execution.", - "type": "string" - }, - { - "name": "token-type", - "aliases": [ - "tt" - ], - "description": "The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-value", - "aliases": [ - "tv" - ], - "description": "The value of the token to pass to the API.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "cert-file", - "description": "The file path to a certificate file to use for authentication.\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 - } - ], - "profile": { - "optional": [ - "idms", - "base" - ] - }, - "outputFormatOptions": true, - "examples": [ - { - "options": "--args \"debug options\"", - "description": "Issues a 'dcmt test debug options' command, with 'debug options' being the options provided by IDMS technical support" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "dcuf-help", - "aliases": [ - "dfh" - ], - "summary": "DCUF HELP command", - "description": "Execute a DCUF HELP command", - "type": "command", - "handler": "", - "options": [ - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Host name of the IDMS REST API service", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Port for the IDMS REST API service", - "type": "number", - "group": "IDMS Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Mainframe user name, which can be the same as your TSO login ID", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe password, which can be the same as your TSO password", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates", - "type": "boolean", - "defaultValue": true, - "group": "IDMS Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "datasource", - "aliases": [ - "d" - ], - "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "datasource", - "aliases": [ - "d" - ], - "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", - "type": "string", - "required": true, - "group": "IDMS Connection Options" - }, - { - "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": "idms-profile", - "aliases": [ - "idms-p" - ], - "group": "Profile Options", - "description": "The name of a (idms) profile to load for this command execution.", - "type": "string" - }, - { - "name": "base-profile", - "aliases": [ - "base-p" - ], - "group": "Profile Options", - "description": "The name of a (base) profile to load for this command execution.", - "type": "string" - }, - { - "name": "token-type", - "aliases": [ - "tt" - ], - "description": "The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-value", - "aliases": [ - "tv" - ], - "description": "The value of the token to pass to the API.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "cert-file", - "description": "The file path to a certificate file to use for authentication.\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 - } - ], - "profile": { - "optional": [ - "idms", - "base" - ] - }, - "outputFormatOptions": true, - "examples": [ - { - "options": "", - "description": "Issues a 'dcuf help' command to display a list of DCUF commands and parameters. Note: Only SHOW commands are supported by the CLI" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "dcuf-show", - "aliases": [ - "dfs" - ], - "summary": "DCUF SHOW commands", - "description": "Execute a DCUF SHOW command", - "type": "command", - "handler": "", - "options": [ - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Host name of the IDMS REST API service", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Port for the IDMS REST API service", - "type": "number", - "group": "IDMS Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Mainframe user name, which can be the same as your TSO login ID", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe password, which can be the same as your TSO password", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates", - "type": "boolean", - "defaultValue": true, - "group": "IDMS Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "datasource", - "aliases": [ - "d" - ], - "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "args", - "type": "string", - "description": "DCUF SHOW command arguments", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "broadcast", - "aliases": [ - "b" - ], - "type": "string", - "description": "Broadcast parameters used if the system is part of a data sharing group", - "group": "Options" - }, - { - "name": "datasource", - "aliases": [ - "d" - ], - "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", - "type": "string", - "required": true, - "group": "IDMS Connection Options" - }, - { - "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": "idms-profile", - "aliases": [ - "idms-p" - ], - "group": "Profile Options", - "description": "The name of a (idms) profile to load for this command execution.", - "type": "string" - }, - { - "name": "base-profile", - "aliases": [ - "base-p" - ], - "group": "Profile Options", - "description": "The name of a (base) profile to load for this command execution.", - "type": "string" - }, - { - "name": "token-type", - "aliases": [ - "tt" - ], - "description": "The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-value", - "aliases": [ - "tv" - ], - "description": "The value of the token to pass to the API.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "cert-file", - "description": "The file path to a certificate file to use for authentication.\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 - } - ], - "profile": { - "optional": [ - "idms", - "base" - ] - }, - "outputFormatOptions": true, - "examples": [ - { - "options": "--args \"tables\"", - "description": "Issues a 'dcuf show tables' command to display a list of the available tables" - }, - { - "options": "--args \"user username\"", - "description": "Issues a 'dcuf show user ' command to display information about a specific user" - } - ], - "positionals": [], - "passOn": [], - "children": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "name": "datasource", - "aliases": [ - "d" - ], - "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", - "type": "string", - "required": true, - "group": "IDMS Connection Options" - } - ], - "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": "list", - "aliases": [ - "ls" - ], - "summary": "List available datasources, active IDMS systems, log messages, user tasks, and transaction details", - "description": "Lists available datasources, real-time monitor statistics information, log messages, active user tasks, and transaction details", - "type": "group", - "children": [ - { - "name": "datasources", - "aliases": [ - "ds" - ], - "summary": "Lists defined data sources", - "description": "Lists data sources defined to the IDMS REST API", - "type": "command", - "handler": "", - "options": [ - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Host name of the IDMS REST API service", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Port for the IDMS REST API service", - "type": "number", - "group": "IDMS Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Mainframe user name, which can be the same as your TSO login ID", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe password, which can be the same as your TSO password", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates", - "type": "boolean", - "defaultValue": true, - "group": "IDMS Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "datasource", - "aliases": [ - "d" - ], - "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "datasourcename", - "aliases": [ - "dsn" - ], - "description": "Specifies a specific datasource to view the definition of", - "type": "string", - "group": "Options" - }, - { - "name": "all", - "aliases": [ - "a" - ], - "description": "Lists each datasource defined to the IDMS REST API", - "type": "boolean", - "defaultValue": null, - "group": "Options" - }, - { - "name": "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": "idms-profile", - "aliases": [ - "idms-p" - ], - "group": "Profile Options", - "description": "The name of a (idms) profile to load for this command execution.", - "type": "string" - }, - { - "name": "base-profile", - "aliases": [ - "base-p" - ], - "group": "Profile Options", - "description": "The name of a (base) profile to load for this command execution.", - "type": "string" - }, - { - "name": "token-type", - "aliases": [ - "tt" - ], - "description": "The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-value", - "aliases": [ - "tv" - ], - "description": "The value of the token to pass to the API.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "cert-file", - "description": "The file path to a certificate file to use for authentication.\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 - } - ], - "profile": { - "optional": [ - "idms", - "base" - ] - }, - "outputFormatOptions": true, - "examples": [ - { - "options": "--all", - "description": "Lists all data sources defined to the IDMS Rest API" - }, - { - "options": "--dsn SYSDEMO", - "description": "Lists a single IDMS data source identified by the data source name" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "systems", - "aliases": [ - "sys" - ], - "summary": "Lists active IDMS systems", - "description": "Lists either all active IDMS systems on an LPAR or lists information about a specific system if a jobname is provided", - "type": "command", - "handler": "", - "options": [ - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Host name of the IDMS REST API service", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Port for the IDMS REST API service", - "type": "number", - "group": "IDMS Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Mainframe user name, which can be the same as your TSO login ID", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe password, which can be the same as your TSO password", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates", - "type": "boolean", - "defaultValue": true, - "group": "IDMS Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "datasource", - "aliases": [ - "d" - ], - "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "jobname", - "aliases": [ - "j" - ], - "description": "The job name of the active IDMS system", - "type": "string", - "group": "Options" - }, - { - "name": "all", - "aliases": [ - "a" - ], - "description": "Lists all active systems. This is the default behavior if no job name is provided", - "type": "boolean", - "defaultValue": null, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "idms-profile", - "aliases": [ - "idms-p" - ], - "group": "Profile Options", - "description": "The name of a (idms) profile to load for this command execution.", - "type": "string" - }, - { - "name": "base-profile", - "aliases": [ - "base-p" - ], - "group": "Profile Options", - "description": "The name of a (base) profile to load for this command execution.", - "type": "string" - }, - { - "name": "token-type", - "aliases": [ - "tt" - ], - "description": "The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-value", - "aliases": [ - "tv" - ], - "description": "The value of the token to pass to the API.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "cert-file", - "description": "The file path to a certificate file to use for authentication.\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 - } - ], - "profile": { - "optional": [ - "idms", - "base" - ] - }, - "outputFormatOptions": true, - "examples": [ - { - "options": "--all", - "description": "Lists all active IDMS systems on the LPAR where the IDMS REST API service is running" - }, - { - "options": "--jobname SYSDEMO", - "description": "Lists a single active IDMS system identified by the IDMS system job name" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "log", - "summary": "Lists log messages", - "description": "Lists log messages based on the search options provided", - "type": "command", - "handler": "", - "options": [ - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Host name of the IDMS REST API service", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Port for the IDMS REST API service", - "type": "number", - "group": "IDMS Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Mainframe user name, which can be the same as your TSO login ID", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe password, which can be the same as your TSO password", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates", - "type": "boolean", - "defaultValue": true, - "group": "IDMS Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "datasource", - "aliases": [ - "d" - ], - "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "datasource", - "aliases": [ - "d" - ], - "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", - "type": "string", - "group": "IDMS Connection Options", - "required": true - }, - { - "name": "start-time", - "aliases": [ - "st" - ], - "description": "Start time of the first log message\n\nFormat: 'YYYY-MM-DD HH:mm:ss[.SSSSSS]'", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "end-time", - "aliases": [ - "et" - ], - "description": "End time of the last log message\n\nFormat: 'YYYY-MM-DD HH:mm:ss[.SSSSSS]'", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "record-type", - "aliases": [ - "rt" - ], - "description": "Type of log records:\n\n1 - #WTL text line\n\n2 - User trace text or physical I/O trace text\n\n3 - User binary trace entries\n\n4 - Snap or dump text\n\n5 - Snap or dump binary entries\n\nExamples: '1,2', '1,4,5', '2'", - "type": "string", - "group": "Options" - }, - { - "name": "record-identifier", - "aliases": [ - "ri" - ], - "description": "Identifier contained in log messages\n\nExamples: 'LTE0001,LTVTM011', 'DCSYSTEM', 'SYSTE160'", - "type": "string", - "group": "Options" - }, - { - "name": "search-text", - "aliases": [ - "stext" - ], - "description": "Text contained in log messages\n\nExamples: 'DB001108', 'any_text_that_might_exist_in_the_message'", - "type": "string", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "idms-profile", - "aliases": [ - "idms-p" - ], - "group": "Profile Options", - "description": "The name of a (idms) profile to load for this command execution.", - "type": "string" - }, - { - "name": "base-profile", - "aliases": [ - "base-p" - ], - "group": "Profile Options", - "description": "The name of a (base) profile to load for this command execution.", - "type": "string" - }, - { - "name": "token-type", - "aliases": [ - "tt" - ], - "description": "The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-value", - "aliases": [ - "tv" - ], - "description": "The value of the token to pass to the API.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "cert-file", - "description": "The file path to a certificate file to use for authentication.\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 - } - ], - "profile": { - "optional": [ - "idms", - "base" - ] - }, - "outputFormatOptions": true, - "examples": [ - { - "options": "--start-time \"2020-08-05 09:20:00\" --end-time \"2020-08-05 10:20:00\"", - "description": "Lists all the log messages where the time stamps satisfy the start and end time criteria" - }, - { - "options": "--start-time \"2020-08-05 09:20:00\" --end-time \"2020-08-05 10:20:00\" --record-type 1 --search-text DB001108", - "description": "Lists all the #WTL log messages where 'DB001108' is contained in the log message and where the time stamps satisfy the start and end time criteria" - }, - { - "options": "--start-time \"2020-08-05 08:00:00.001234\" --end-time \"2020-08-05 13:43:33.26\" --record-identifier DCSYSTEM", - "description": "Lists all log messages with the DCSYSTEM record identifier where the time stamps satisfy the start and end time criteria" - } - ], - "aliases": [], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "transactions", - "aliases": [ - "ts" - ], - "summary": "Lists details of active IDMS transactions", - "description": "Lists transaction details on a specific IDMS system", - "type": "command", - "handler": "", - "options": [ - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Host name of the IDMS REST API service", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Port for the IDMS REST API service", - "type": "number", - "group": "IDMS Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Mainframe user name, which can be the same as your TSO login ID", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe password, which can be the same as your TSO password", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates", - "type": "boolean", - "defaultValue": true, - "group": "IDMS Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "datasource", - "aliases": [ - "d" - ], - "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "jobname", - "aliases": [ - "j" - ], - "description": "The job name of the active IDMS system", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "datasourcename", - "aliases": [ - "dsn" - ], - "description": "The data source name of the specified IDMS system", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "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": "idms-profile", - "aliases": [ - "idms-p" - ], - "group": "Profile Options", - "description": "The name of a (idms) profile to load for this command execution.", - "type": "string" - }, - { - "name": "base-profile", - "aliases": [ - "base-p" - ], - "group": "Profile Options", - "description": "The name of a (base) profile to load for this command execution.", - "type": "string" - }, - { - "name": "token-type", - "aliases": [ - "tt" - ], - "description": "The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-value", - "aliases": [ - "tv" - ], - "description": "The value of the token to pass to the API.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "cert-file", - "description": "The file path to a certificate file to use for authentication.\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 - } - ], - "profile": { - "optional": [ - "idms", - "base" - ] - }, - "outputFormatOptions": true, - "examples": [ - { - "options": "--jobname SYSDEMO", - "description": "Lists the transaction details of the IDMS system identified by the IDMS system job name" - }, - { - "options": "--jobname SYSDEMO --rfj", - "description": "Lists the transaction details of the IDMS system identified by the IDMS system job name as JSON formatted data" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "user-tasks", - "aliases": [ - "ut" - ], - "summary": "Lists active IDMS user tasks", - "description": "Lists all active user tasks on a specific IDMS system", - "type": "command", - "handler": "", - "options": [ - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Host name of the IDMS REST API service", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Port for the IDMS REST API service", - "type": "number", - "group": "IDMS Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Mainframe user name, which can be the same as your TSO login ID", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe password, which can be the same as your TSO password", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates", - "type": "boolean", - "defaultValue": true, - "group": "IDMS Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "datasource", - "aliases": [ - "d" - ], - "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "jobname", - "aliases": [ - "j" - ], - "description": "The job name of the active IDMS system", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "datasourcename", - "aliases": [ - "dsn" - ], - "description": "The data source name of the specified IDMS system", - "type": "string", - "required": true, - "group": "Required Options" - }, - { - "name": "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": "idms-profile", - "aliases": [ - "idms-p" - ], - "group": "Profile Options", - "description": "The name of a (idms) profile to load for this command execution.", - "type": "string" - }, - { - "name": "base-profile", - "aliases": [ - "base-p" - ], - "group": "Profile Options", - "description": "The name of a (base) profile to load for this command execution.", - "type": "string" - }, - { - "name": "token-type", - "aliases": [ - "tt" - ], - "description": "The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-value", - "aliases": [ - "tv" - ], - "description": "The value of the token to pass to the API.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "cert-file", - "description": "The file path to a certificate file to use for authentication.\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 - } - ], - "profile": { - "optional": [ - "idms", - "base" - ] - }, - "outputFormatOptions": true, - "examples": [ - { - "options": "--jobname SYSDEMO", - "description": "Lists the active user tasks of the IDMS system identified by the IDMS system job name" - }, - { - "options": "--jobname SYSDEMO --rfj", - "description": "Lists the active user tasks of the IDMS system identified by the IDMS system job name as JSON formatted data" - } - ], - "positionals": [], - "passOn": [], - "children": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "name": "jobname", - "aliases": [ - "j" - ], - "description": "The job name of the active IDMS system", - "type": "string", - "required": true - }, - { - "name": "datasourcename", - "aliases": [ - "dsn" - ], - "description": "The data source name of the specified IDMS system", - "type": "string", - "required": true - } - ], - "merge": true, - "ignoreNodes": [ - { - "type": "group" - }, - { - "name": "datasources" - }, - { - "name": "systems" - }, - { - "name": "log" - } - ] - } - ], - "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": "Interact with IDMS", - "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/jclcheck.jsonc b/commandGroups/jclcheck.jsonc deleted file mode 100644 index 911414c..0000000 --- a/commandGroups/jclcheck.jsonc +++ /dev/null @@ -1,670 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "jclcheck", - "description": "Validates the accuracy of job control language (JCL) and also helps identify execution-time errors, such as security violations and missing data sets that could cause jobs to fail.", - "type": "group", - "children": [ - { - "name": "check", - "aliases": [ - "ck" - ], - "summary": "Perform a check on JCL that is contained in an MVS data set or a local file", - "description": "Perform a check on JCL that is contained in an MVS data set or a local file.", - "type": "group", - "children": [ - { - "name": "data-set", - "aliases": [ - "ds" - ], - "summary": "Check JCL contained in an MVS data set", - "description": "Reads the specified input data set and invokes the JCLCheck service with the data set contents.", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "dataSet", - "type": "string", - "description": "The MVS data set containing the JCL contents. The data set can be a physical sequential (PS) or partitioned data set (PDS) member. The data set attributes must be recfm fixed-block (FB) and lrecl 80. The data set must be catalogued.", - "required": true - } - ], - "options": [ - { - "name": "max-return-code", - "aliases": [ - "mrc" - ], - "type": "number", - "description": "Specifies the maximum acceptable return code from the JCLCheck service. If the JCLCheck overall return code exceeds the value specified on this option, the command will exit with a failure status code of 1.", - "group": "Options" - }, - { - "name": "raw-output", - "aliases": [ - "ro" - ], - "type": "boolean", - "description": "Causes the command to print the unformatted JCLCheck report (raw report) instead of the formatted error table. Use this option if you intend to change the format of the JCLCheck report via runtime options. Changing the format may affect the ability to produce a structured API response.", - "defaultValue": false, - "group": "Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the JCLCheck API service that is running on the mainframe system.", - "required": false, - "group": "JCLCheck Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the JCLCheck API service that is running on the mainframe system.", - "defaultValue": 12697, - "required": false, - "group": "JCLCheck Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the JCLCheck API service that is running on the mainframe system.", - "required": false, - "group": "JCLCheck Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the JCLCheck API service that is running on the mainframe system.", - "required": false, - "group": "JCLCheck Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "defaultValue": "cajclcheck/api/v1", - "required": false, - "group": "JCLCheck Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "required": false, - "group": "JCLCheck Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for JCLCheck connection (http or https).", - "type": "string", - "defaultValue": "https", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "JCLCheck Connection Options" - }, - { - "name": "jclcheck-options", - "aliases": [ - "jo" - ], - "description": "The desired set of JCLCheck runtime options. Specify the options exactly as you would on the PARM= or OPTIONS DD on a batch run of JCLCheck. See the JCLCheck runtime options documentation for details on available runtime options. If you specify options that change the format of the JCLCheck reports, you should request '--raw-output'. Changing the format of the report will affect the ability to produce a structured API response.", - "type": "stringOrEmpty", - "required": false, - "group": "JCLCheck 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": "jclcheck-profile", - "aliases": [ - "jclcheck-p" - ], - "group": "Profile Options", - "description": "The name of a (jclcheck) 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": [] - } - ], - "profile": { - "optional": [ - "jclcheck", - "base" - ] - }, - "examples": [ - { - "options": "\"MY.DATASET(JCL)\" --host hostname --port 1234 --jclcheck-options \"NOAS NOAU NOHCD NOJCL NORES NOSIGN\"", - "description": "Check the JCL contained in \"MY.DATASET(JCL)\" and print a table of statements in error" - }, - { - "options": "\"MY.DATASET(JCL)\" --host hostname --port 1234 --jclcheck-options \"NOAS NOAU NOHCD NOJCL NORES NOSIGN\" --raw-output", - "description": "Check the JCL contained in \"MY.DATASET(JCL)\" and print the raw JCLCheck report" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "local-file", - "aliases": [ - "lf" - ], - "summary": "Check JCL contained in a local file", - "description": "Reads the contents of the local file specified and invokes the JCLCheck service with the JCL contents.", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "localFile", - "type": "string", - "description": "The local file containing the JCL to check. The local JCL file can contain a single job or multiple jobs (specified one after another without blank lines or line breaks). The JCL lines in the file must not exceed 80 characters.", - "required": true - } - ], - "options": [ - { - "name": "max-return-code", - "aliases": [ - "mrc" - ], - "type": "number", - "description": "Specifies the maximum acceptable return code from the JCLCheck service. If the JCLCheck overall return code exceeds the value specified on this option, the command will exit with a failure status code of 1.", - "group": "Options" - }, - { - "name": "raw-output", - "aliases": [ - "ro" - ], - "type": "boolean", - "description": "Causes the command to print the unformatted JCLCheck report (raw report) instead of the formatted error table. Use this option if you intend to change the format of the JCLCheck report via runtime options. Changing the format may affect the ability to produce a structured API response.", - "defaultValue": false, - "group": "Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the JCLCheck API service that is running on the mainframe system.", - "required": false, - "group": "JCLCheck Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the JCLCheck API service that is running on the mainframe system.", - "defaultValue": 12697, - "required": false, - "group": "JCLCheck Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the JCLCheck API service that is running on the mainframe system.", - "required": false, - "group": "JCLCheck Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the JCLCheck API service that is running on the mainframe system.", - "required": false, - "group": "JCLCheck Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "defaultValue": "cajclcheck/api/v1", - "required": false, - "group": "JCLCheck Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "required": false, - "group": "JCLCheck Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for JCLCheck connection (http or https).", - "type": "string", - "defaultValue": "https", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "JCLCheck Connection Options" - }, - { - "name": "jclcheck-options", - "aliases": [ - "jo" - ], - "description": "The desired set of JCLCheck runtime options. Specify the options exactly as you would on the PARM= or OPTIONS DD on a batch run of JCLCheck. See the JCLCheck runtime options documentation for details on available runtime options. If you specify options that change the format of the JCLCheck reports, you should request '--raw-output'. Changing the format of the report will affect the ability to produce a structured API response.", - "type": "stringOrEmpty", - "required": false, - "group": "JCLCheck 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": "jclcheck-profile", - "aliases": [ - "jclcheck-p" - ], - "group": "Profile Options", - "description": "The name of a (jclcheck) 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": [] - } - ], - "profile": { - "optional": [ - "jclcheck", - "base" - ] - }, - "examples": [ - { - "options": "jcl.txt --host hostname --port 1234 --jclcheck-options \"NOAS NOAU NOHCD NOJCL NORES NOSIGN\"", - "description": "Check the JCL contained in the file \"jcl.txt\" and print a table of statements in error" - }, - { - "options": "jcl.txt --host hostname --port 1234 --jclcheck-options \"NOAS NOAU NOHCD NOJCL NORES NOSIGN\" --raw-output", - "description": "Check the JCL contained in the file \"jcl.txt\" and print the raw JCLCheck report" - } - ], - "passOn": [], - "children": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the JCLCheck API service that is running on the mainframe system.", - "required": false, - "group": "JCLCheck Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the JCLCheck API service that is running on the mainframe system.", - "defaultValue": 12697, - "required": false, - "group": "JCLCheck Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the JCLCheck API service that is running on the mainframe system.", - "required": false, - "group": "JCLCheck Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the JCLCheck API service that is running on the mainframe system.", - "required": false, - "group": "JCLCheck Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "defaultValue": "cajclcheck/api/v1", - "required": false, - "group": "JCLCheck Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "required": false, - "group": "JCLCheck Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for JCLCheck connection (http or https).", - "type": "string", - "defaultValue": "https", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "JCLCheck Connection Options" - }, - { - "name": "jclcheck-options", - "aliases": [ - "jo" - ], - "description": "The desired set of JCLCheck runtime options. Specify the options exactly as you would on the PARM= or OPTIONS DD on a batch run of JCLCheck. See the JCLCheck runtime options documentation for details on available runtime options. If you specify options that change the format of the JCLCheck reports, you should request '--raw-output'. Changing the format of the report will affect the ability to produce a structured API response.", - "type": "stringOrEmpty", - "required": false, - "group": "JCLCheck 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": "JCLCheck plugin", - "aliases": [ - "jck" - ], - "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/mat-pma-util.jsonc b/commandGroups/mat-pma-util.jsonc deleted file mode 100644 index cc7dac8..0000000 --- a/commandGroups/mat-pma-util.jsonc +++ /dev/null @@ -1,2398 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "mat-pma-util", - "description": "The MAT Detect plug-in for Zowe CLI enables you to detect performance issues and access performance data supplied by the Performance Management Assistant component (PMA) of Mainframe Application Tuner.", - "type": "group", - "children": [ - { - "name": "get", - "aliases": [ - "gt" - ], - "type": "group", - "summary": "Get performance information using PMA utilities.", - "description": "Get performance information using PMA utilities. You can get the current performance data of your jobs and check for the daily performance alerts.", - "children": [ - { - "name": "alert", - "aliases": [ - "at" - ], - "type": "command", - "summary": "Get daily performance alert information.", - "description": "Check for alerts created in PMA and detect whether any of your jobs exceeds the average daily performance. If the threshold is exceeded, a PMA alert is triggered. We recommend that you include this command in your end-of-day build to trace all jobs that might cause performance degradation by code changes during the day. ", - "handler": "", - "profile": { - "required": [ - "zosmf" - ], - "optional": [ - "pma", - "base" - ] - }, - "examples": [ - { - "description": "Check whether any of your jobs exceeds the average daily performance using the default profile", - "options": "" - }, - { - "description": "Check whether any of your jobs exceeds the average daily performance using specific PMA profile details", - "options": "--ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ" - } - ], - "options": [ - { - "name": "job_acct", - "aliases": [ - "ja" - ], - "description": "Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)", - "type": "string", - "required": true, - "group": "PMA Connection Options" - }, - { - "name": "job_class", - "aliases": [ - "jc" - ], - "description": "Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9) ", - "type": "string", - "required": true, - "stringLengthRange": [ - 1, - 1 - ], - "group": "PMA Connection Options" - }, - { - "name": "job_mclass", - "aliases": [ - "jmc" - ], - "description": "Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9) ", - "type": "string", - "defaultValue": "A", - "required": false, - "stringLengthRange": [ - 1, - 1 - ], - "group": "PMA Connection Options" - }, - { - "name": "job_load", - "aliases": [ - "jl" - ], - "description": "Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD) ", - "type": "string", - "required": true, - "group": "PMA Connection Options" - }, - { - "name": "job_pmahlq", - "aliases": [ - "jph" - ], - "description": "Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data", - "type": "string", - "required": true, - "group": "PMA 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": "zosmf-profile", - "aliases": [ - "zosmf-p" - ], - "group": "Profile Options", - "description": "The name of a (zosmf) profile to load for this command execution.", - "type": "string" - }, - { - "name": "pma-profile", - "aliases": [ - "pma-p" - ], - "group": "Profile Options", - "description": "The name of a (pma) 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": [], - "passOn": [], - "children": [] - }, - { - "name": "alert-by-job", - "aliases": [ - "abyj" - ], - "type": "command", - "summary": "Get daily performance status of a specific job.", - "description": "Check whether the specified job exceeds the average daily performance. No record returned indicates that no performance degradation was detected for this job.", - "handler": "", - "profile": { - "required": [ - "zosmf" - ], - "optional": [ - "pma", - "base" - ] - }, - "positionals": [ - { - "name": "jobname", - "description": "Specifies the name of the job that is being tested (e.g. TESTPMA8).", - "type": "string", - "stringLengthRange": [ - 1, - 8 - ], - "required": true - } - ], - "examples": [ - { - "description": "Check whether your job TESTPMA8 exceeds the average daily performance using the default profile", - "options": "TESTPMA8" - }, - { - "description": "Check whether your job TESTPMA8 exceeds the average daily performance using specific PMA profile details", - "options": "TESTPMA8 --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ" - } - ], - "options": [ - { - "name": "job_acct", - "aliases": [ - "ja" - ], - "description": "Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)", - "type": "string", - "required": true, - "group": "PMA Connection Options" - }, - { - "name": "job_class", - "aliases": [ - "jc" - ], - "description": "Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9) ", - "type": "string", - "required": true, - "stringLengthRange": [ - 1, - 1 - ], - "group": "PMA Connection Options" - }, - { - "name": "job_mclass", - "aliases": [ - "jmc" - ], - "description": "Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9) ", - "type": "string", - "defaultValue": "A", - "required": false, - "stringLengthRange": [ - 1, - 1 - ], - "group": "PMA Connection Options" - }, - { - "name": "job_load", - "aliases": [ - "jl" - ], - "description": "Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD) ", - "type": "string", - "required": true, - "group": "PMA Connection Options" - }, - { - "name": "job_pmahlq", - "aliases": [ - "jph" - ], - "description": "Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data", - "type": "string", - "required": true, - "group": "PMA 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": "zosmf-profile", - "aliases": [ - "zosmf-p" - ], - "group": "Profile Options", - "description": "The name of a (zosmf) profile to load for this command execution.", - "type": "string" - }, - { - "name": "pma-profile", - "aliases": [ - "pma-p" - ], - "group": "Profile Options", - "description": "The name of a (pma) 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": [] - }, - { - "name": "perf", - "aliases": [ - "pf" - ], - "type": "command", - "summary": "Get the performance test result for a specific job", - "description": "Get the current performance data of a specific job using PMA. If the current measurement results for any of the measured parameters are higher than average values, an alert message is displayed.", - "handler": "", - "profile": { - "optional": [ - "zosmf", - "pma", - "base" - ] - }, - "positionals": [ - { - "name": "jobname", - "description": "Specifies the name of the job that is being tested (e.g. TESTPMA8).", - "type": "string", - "stringLengthRange": [ - 1, - 8 - ], - "required": true - } - ], - "examples": [ - { - "description": "Get the current performance data of the TESTPMA8 job using the default profile", - "options": "TESTPMA8" - }, - { - "description": "Get the current performance data of the TESTPMA8 job using specific PMA profile details", - "options": "TESTPMA8 --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ" - } - ], - "options": [ - { - "name": "job_acct", - "aliases": [ - "ja" - ], - "description": "Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)", - "type": "string", - "required": true, - "group": "PMA Connection Options" - }, - { - "name": "job_class", - "aliases": [ - "jc" - ], - "description": "Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9) ", - "type": "string", - "required": true, - "stringLengthRange": [ - 1, - 1 - ], - "group": "PMA Connection Options" - }, - { - "name": "job_mclass", - "aliases": [ - "jmc" - ], - "description": "Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9) ", - "type": "string", - "defaultValue": "A", - "required": false, - "stringLengthRange": [ - 1, - 1 - ], - "group": "PMA Connection Options" - }, - { - "name": "job_load", - "aliases": [ - "jl" - ], - "description": "Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD) ", - "type": "string", - "required": true, - "group": "PMA Connection Options" - }, - { - "name": "job_pmahlq", - "aliases": [ - "jph" - ], - "description": "Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data", - "type": "string", - "required": true, - "group": "PMA 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": "zosmf-profile", - "aliases": [ - "zosmf-p" - ], - "group": "Profile Options", - "description": "The name of a (zosmf) profile to load for this command execution.", - "type": "string" - }, - { - "name": "pma-profile", - "aliases": [ - "pma-p" - ], - "group": "Profile Options", - "description": "The name of a (pma) 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": [] - } - ], - "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": [] - }, - { - "name": "scope", - "aliases": [ - "scp" - ], - "type": "group", - "summary": "Get and define the PMA scope information.", - "description": "Get and define the PMA scope information. You can create and update the list of jobs that you want to include, or the list of programs to be excluded from the PMA scope of work.", - "children": [ - { - "name": "exl-pgm", - "aliases": [ - "exlp" - ], - "type": "command", - "summary": "Exclude a program from the PMA scope of work.", - "description": "Exclude a program from the PMA scope of work.", - "handler": "", - "profile": { - "required": [ - "zosmf" - ], - "optional": [ - "pma", - "base" - ] - }, - "positionals": [ - { - "name": "pgmname", - "description": "Specifies the name of the program that you want to add to the list of exclusions from the PMA scope (e.g. TESTPMA8).", - "type": "string", - "stringLengthRange": [ - 1, - 8 - ], - "required": true - } - ], - "options": [ - { - "name": "description", - "aliases": [ - "dc" - ], - "description": "Specifies the description of the program that you want to exclude from the PMA scope.", - "type": "string", - "stringLengthRange": [ - 1, - 45 - ], - "required": false, - "group": "Options" - }, - { - "name": "job_acct", - "aliases": [ - "ja" - ], - "description": "Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)", - "type": "string", - "required": true, - "group": "PMA Connection Options" - }, - { - "name": "job_class", - "aliases": [ - "jc" - ], - "description": "Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9) ", - "type": "string", - "required": true, - "stringLengthRange": [ - 1, - 1 - ], - "group": "PMA Connection Options" - }, - { - "name": "job_mclass", - "aliases": [ - "jmc" - ], - "description": "Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9) ", - "type": "string", - "defaultValue": "A", - "required": false, - "stringLengthRange": [ - 1, - 1 - ], - "group": "PMA Connection Options" - }, - { - "name": "job_load", - "aliases": [ - "jl" - ], - "description": "Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD) ", - "type": "string", - "required": true, - "group": "PMA Connection Options" - }, - { - "name": "job_pmahlq", - "aliases": [ - "jph" - ], - "description": "Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data", - "type": "string", - "required": true, - "group": "PMA 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": "zosmf-profile", - "aliases": [ - "zosmf-p" - ], - "group": "Profile Options", - "description": "The name of a (zosmf) profile to load for this command execution.", - "type": "string" - }, - { - "name": "pma-profile", - "aliases": [ - "pma-p" - ], - "group": "Profile Options", - "description": "The name of a (pma) 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": [ - { - "description": "Exclude the TESTPMA8 program from the PMA scope", - "options": "TESTPMA8" - }, - { - "description": "Exclude the TESTPMA8 program from the PMA scope and add a description to the excluded program", - "options": "TESTPMA8 --dc \"EXCLUDE FROM THE CURRENT SCOPE\" " - }, - { - "description": "Exclude the TESTPMA8 program from the PMA scope and add a description to the excluded program using specific PMA profile details", - "options": "TESTPMA8 --dc \"EXCLUDE FROM THE CURRENT SCOPE\" --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "inc-job", - "aliases": [ - "incj" - ], - "type": "command", - "summary": "Include a job in the PMA scope of work.", - "description": "Include a job in the PMA scope of work.", - "handler": "", - "profile": { - "required": [ - "zosmf" - ], - "optional": [ - "pma", - "base" - ] - }, - "positionals": [ - { - "name": "jobname", - "description": "Specifies the name of the job that you want to add to the list of inclusions in the PMA scope (e.g. TESTPMA8).", - "type": "string", - "stringLengthRange": [ - 1, - 8 - ], - "required": true - } - ], - "options": [ - { - "name": "stepname", - "aliases": [ - "st" - ], - "description": "Specifies the name of the job step that you want to include in the PMA scope.", - "type": "string", - "stringLengthRange": [ - 1, - 8 - ], - "required": false, - "group": "Options" - }, - { - "name": "procstep", - "aliases": [ - "ps" - ], - "description": "Specifies the procname of the job that you want to include in the PMA scope.", - "type": "string", - "stringLengthRange": [ - 1, - 8 - ], - "required": false, - "group": "Options" - }, - { - "name": "description", - "aliases": [ - "dc" - ], - "description": "Specifies the description of the job that you want to include in the PMA scope.", - "type": "string", - "stringLengthRange": [ - 1, - 45 - ], - "required": false, - "group": "Options" - }, - { - "name": "job_acct", - "aliases": [ - "ja" - ], - "description": "Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)", - "type": "string", - "required": true, - "group": "PMA Connection Options" - }, - { - "name": "job_class", - "aliases": [ - "jc" - ], - "description": "Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9) ", - "type": "string", - "required": true, - "stringLengthRange": [ - 1, - 1 - ], - "group": "PMA Connection Options" - }, - { - "name": "job_mclass", - "aliases": [ - "jmc" - ], - "description": "Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9) ", - "type": "string", - "defaultValue": "A", - "required": false, - "stringLengthRange": [ - 1, - 1 - ], - "group": "PMA Connection Options" - }, - { - "name": "job_load", - "aliases": [ - "jl" - ], - "description": "Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD) ", - "type": "string", - "required": true, - "group": "PMA Connection Options" - }, - { - "name": "job_pmahlq", - "aliases": [ - "jph" - ], - "description": "Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data", - "type": "string", - "required": true, - "group": "PMA 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": "zosmf-profile", - "aliases": [ - "zosmf-p" - ], - "group": "Profile Options", - "description": "The name of a (zosmf) profile to load for this command execution.", - "type": "string" - }, - { - "name": "pma-profile", - "aliases": [ - "pma-p" - ], - "group": "Profile Options", - "description": "The name of a (pma) 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": [ - { - "description": "Include the TESTPMA8 job in the PMA scope", - "options": "TESTPMA8" - }, - { - "description": "Include the specific procname and step name of the TESTPMA8 job in the PMA scope and add a description to the included job", - "options": "TESTPMA8 --ps TESTCALL --st TESTDO --dc \"INCLUDE IN THE CURRENT SCOPE\"" - }, - { - "description": "Include the specific procname and step name of the TESTPMA8 job in the PMA scope and add a description to the included job using specific PMA profile details", - "options": "TESTPMA8 --ps TESTCALL --st TESTDO --dc \"INCLUDE IN THE CURRENT SCOPE\" --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "get-listj", - "aliases": [ - "getlj" - ], - "type": "command", - "summary": "Get the list of jobs included in the PMA scope.", - "description": "Get the list of jobs included in the PMA scope.", - "handler": "", - "profile": { - "required": [ - "zosmf" - ], - "optional": [ - "pma", - "base" - ] - }, - "examples": [ - { - "description": "Get the list of jobs included in the PMA scope", - "options": "" - }, - { - "description": "Get the list of jobs included in the PMA scope using specific PMA profile details", - "options": "--ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ" - } - ], - "options": [ - { - "name": "job_acct", - "aliases": [ - "ja" - ], - "description": "Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)", - "type": "string", - "required": true, - "group": "PMA Connection Options" - }, - { - "name": "job_class", - "aliases": [ - "jc" - ], - "description": "Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9) ", - "type": "string", - "required": true, - "stringLengthRange": [ - 1, - 1 - ], - "group": "PMA Connection Options" - }, - { - "name": "job_mclass", - "aliases": [ - "jmc" - ], - "description": "Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9) ", - "type": "string", - "defaultValue": "A", - "required": false, - "stringLengthRange": [ - 1, - 1 - ], - "group": "PMA Connection Options" - }, - { - "name": "job_load", - "aliases": [ - "jl" - ], - "description": "Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD) ", - "type": "string", - "required": true, - "group": "PMA Connection Options" - }, - { - "name": "job_pmahlq", - "aliases": [ - "jph" - ], - "description": "Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data", - "type": "string", - "required": true, - "group": "PMA 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": "zosmf-profile", - "aliases": [ - "zosmf-p" - ], - "group": "Profile Options", - "description": "The name of a (zosmf) profile to load for this command execution.", - "type": "string" - }, - { - "name": "pma-profile", - "aliases": [ - "pma-p" - ], - "group": "Profile Options", - "description": "The name of a (pma) 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": [], - "passOn": [], - "children": [] - }, - { - "name": "get-listp", - "aliases": [ - "getlp" - ], - "type": "command", - "summary": "Get the list of programs excluded from the PMA scope.", - "description": "Get the list of programs excluded from the PMA scope.", - "handler": "", - "profile": { - "required": [ - "zosmf" - ], - "optional": [ - "pma", - "base" - ] - }, - "examples": [ - { - "description": "Get the list of programs excluded from the PMA scope", - "options": "" - }, - { - "description": "Get the list of programs excluded from the PMA scope using specific PMA profile details", - "options": "--ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ" - } - ], - "options": [ - { - "name": "job_acct", - "aliases": [ - "ja" - ], - "description": "Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)", - "type": "string", - "required": true, - "group": "PMA Connection Options" - }, - { - "name": "job_class", - "aliases": [ - "jc" - ], - "description": "Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9) ", - "type": "string", - "required": true, - "stringLengthRange": [ - 1, - 1 - ], - "group": "PMA Connection Options" - }, - { - "name": "job_mclass", - "aliases": [ - "jmc" - ], - "description": "Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9) ", - "type": "string", - "defaultValue": "A", - "required": false, - "stringLengthRange": [ - 1, - 1 - ], - "group": "PMA Connection Options" - }, - { - "name": "job_load", - "aliases": [ - "jl" - ], - "description": "Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD) ", - "type": "string", - "required": true, - "group": "PMA Connection Options" - }, - { - "name": "job_pmahlq", - "aliases": [ - "jph" - ], - "description": "Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data", - "type": "string", - "required": true, - "group": "PMA 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": "zosmf-profile", - "aliases": [ - "zosmf-p" - ], - "group": "Profile Options", - "description": "The name of a (zosmf) profile to load for this command execution.", - "type": "string" - }, - { - "name": "pma-profile", - "aliases": [ - "pma-p" - ], - "group": "Profile Options", - "description": "The name of a (pma) 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": [], - "passOn": [], - "children": [] - }, - { - "name": "del-job", - "aliases": [ - "delj" - ], - "type": "command", - "summary": "Delete a job from the list of inclusions in the PMA scope.", - "description": "Delete a job from the list of inclusions in the PMA scope.", - "handler": "", - "profile": { - "required": [ - "zosmf" - ], - "optional": [ - "pma", - "base" - ] - }, - "positionals": [ - { - "name": "jobname", - "description": "Specifies the name of the job that you want to delete from the list of inclusions in the PMA scope (e.g. TESTPMA8).", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "stepname", - "aliases": [ - "st" - ], - "description": "Specifies the name of the job step that you want to delete from the list of inclusions in the PMA scope.", - "type": "string", - "stringLengthRange": [ - 1, - 8 - ], - "required": false, - "group": "Options" - }, - { - "name": "procstep", - "aliases": [ - "ps" - ], - "description": "Specifies the procname of the job that you want to delete from the list of inclusions in the PMA scope.", - "type": "string", - "stringLengthRange": [ - 1, - 8 - ], - "required": false, - "group": "Options" - }, - { - "name": "job_acct", - "aliases": [ - "ja" - ], - "description": "Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)", - "type": "string", - "required": true, - "group": "PMA Connection Options" - }, - { - "name": "job_class", - "aliases": [ - "jc" - ], - "description": "Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9) ", - "type": "string", - "required": true, - "stringLengthRange": [ - 1, - 1 - ], - "group": "PMA Connection Options" - }, - { - "name": "job_mclass", - "aliases": [ - "jmc" - ], - "description": "Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9) ", - "type": "string", - "defaultValue": "A", - "required": false, - "stringLengthRange": [ - 1, - 1 - ], - "group": "PMA Connection Options" - }, - { - "name": "job_load", - "aliases": [ - "jl" - ], - "description": "Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD) ", - "type": "string", - "required": true, - "group": "PMA Connection Options" - }, - { - "name": "job_pmahlq", - "aliases": [ - "jph" - ], - "description": "Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data", - "type": "string", - "required": true, - "group": "PMA 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": "zosmf-profile", - "aliases": [ - "zosmf-p" - ], - "group": "Profile Options", - "description": "The name of a (zosmf) profile to load for this command execution.", - "type": "string" - }, - { - "name": "pma-profile", - "aliases": [ - "pma-p" - ], - "group": "Profile Options", - "description": "The name of a (pma) 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": [ - { - "description": "Delete the TESTPMA8 job from the list of inclusions in the PMA scope", - "options": "TESTPMA8" - }, - { - "description": "Delete the specific procname and step name of the TESTPMA8 job from the list of inclusions in the PMA scope", - "options": "TESTPMA8 --ps TESTCALL --st TESTDO" - }, - { - "description": "Delete the specific procname and step name of the TESTPMA8 job from the list of inclusions in the PMA scope using specific PMA profile details", - "options": "TESTPMA8 --ps TESTCALL --st TESTDO --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "del-pgm", - "aliases": [ - "delp" - ], - "type": "command", - "summary": "Delete a program from the list of exclusions from the PMA scope.", - "description": "Delete a program from the list of exclusions from the PMA scope.", - "handler": "", - "profile": { - "required": [ - "zosmf" - ], - "optional": [ - "pma", - "base" - ] - }, - "positionals": [ - { - "name": "pgmname", - "description": "Specifies the name of the program that you want to delete from the list of exclusions from the PMA scope (e.g. TESTPMA8).", - "type": "string", - "required": true - } - ], - "examples": [ - { - "description": "Delete the TESTPMA8 program from the exclusions list from the PMA scope", - "options": "TESTPMA8" - }, - { - "description": "Delete the TESTPMA8 program from the exclusions list from the PMA scope using specific PMA profile details", - "options": "TESTPMA8 --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ" - } - ], - "options": [ - { - "name": "job_acct", - "aliases": [ - "ja" - ], - "description": "Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)", - "type": "string", - "required": true, - "group": "PMA Connection Options" - }, - { - "name": "job_class", - "aliases": [ - "jc" - ], - "description": "Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9) ", - "type": "string", - "required": true, - "stringLengthRange": [ - 1, - 1 - ], - "group": "PMA Connection Options" - }, - { - "name": "job_mclass", - "aliases": [ - "jmc" - ], - "description": "Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9) ", - "type": "string", - "defaultValue": "A", - "required": false, - "stringLengthRange": [ - 1, - 1 - ], - "group": "PMA Connection Options" - }, - { - "name": "job_load", - "aliases": [ - "jl" - ], - "description": "Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD) ", - "type": "string", - "required": true, - "group": "PMA Connection Options" - }, - { - "name": "job_pmahlq", - "aliases": [ - "jph" - ], - "description": "Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data", - "type": "string", - "required": true, - "group": "PMA 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": "zosmf-profile", - "aliases": [ - "zosmf-p" - ], - "group": "Profile Options", - "description": "The name of a (zosmf) profile to load for this command execution.", - "type": "string" - }, - { - "name": "pma-profile", - "aliases": [ - "pma-p" - ], - "group": "Profile Options", - "description": "The name of a (pma) 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": [] - } - ], - "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": [] - } - ], - "summary": "The MAT Detect plug-in for Zowe CLI enables you to detect performance issues and access performance data supplied by the Performance Management Assistant component (PMA) of Mainframe Application Tuner.", - "aliases": [ - "pma" - ], - "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/mat.jsonc b/commandGroups/mat.jsonc deleted file mode 100644 index 3b42664..0000000 --- a/commandGroups/mat.jsonc +++ /dev/null @@ -1,7627 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "mat", - "description": "The MAT Analyze plug-in for ZOWE CLI enables you to manage monitor profiles and get the measurement analysis data using Mainframe Application Tuner (MAT)", - "type": "group", - "children": [ - { - "name": "monitor", - "summary": "Get monitor data", - "description": "Get monitor history and measurement analysis data from MAT.", - "type": "group", - "children": [ - { - "name": "overview", - "aliases": [ - "ov" - ], - "summary": "Get Overview data", - "description": "Get the overview details of the measurement.", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "mat", - "base" - ] - }, - "options": [ - { - "name": "profile", - "description": "Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "mon_num", - "description": "Specifies the unique monitor number of the measurement.", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies the protocol defined for the MAT REST API server (http or https).", - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "defaultValue": "https", - "group": "MAT Profile Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the server port (e.g. 8080).", - "type": "number", - "group": "MAT Profile Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Your mainframe username.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "password", - "aliases": [ - "pw" - ], - "description": "Your mainframe password.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "MAT Profile Options" - }, - { - "name": "listingDir", - "aliases": [ - "ldir" - ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", - "type": "string", - "required": false, - "group": "MAT Profile Options" - }, - { - "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": "mat-profile", - "aliases": [ - "mat-p" - ], - "group": "Profile Options", - "description": "The name of a (mat) 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": "Get the overview details of the measurement for monitor number 5", - "options": "--mon_num 5" - }, - { - "description": "Get the overview details of the measurement for the latest monitor in the TESTPROF profile", - "options": "--profile TESTPROF" - }, - { - "description": "Get the measurement overview details for monitor number 5, with the specific MAT profile details defined", - "options": "--mon_num 5 --host \"example.com\" --port 12345 --user johndoe --password qwerty" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "codeview", - "summary": "Get CodeView data", - "description": "Get the CodeView measurement details.", - "type": "group", - "children": [ - { - "name": "csect", - "aliases": [ - "cs" - ], - "summary": "Get CodeView data in Csect mode", - "description": "Get the CodeView measurement details in Csect mode.", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "mat", - "base" - ] - }, - "options": [ - { - "name": "profile", - "description": "Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "mon_num", - "description": "Specifies the unique monitor number of the measurement.", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies the protocol defined for the MAT REST API server (http or https).", - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "defaultValue": "https", - "group": "MAT Profile Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the server port (e.g. 8080).", - "type": "number", - "group": "MAT Profile Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Your mainframe username.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "password", - "aliases": [ - "pw" - ], - "description": "Your mainframe password.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "MAT Profile Options" - }, - { - "name": "listingDir", - "aliases": [ - "ldir" - ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", - "type": "string", - "required": false, - "group": "MAT Profile Options" - }, - { - "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": "mat-profile", - "aliases": [ - "mat-p" - ], - "group": "Profile Options", - "description": "The name of a (mat) 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": "Get the CodeView measurement details in Csect mode for monitor number 5", - "options": "--mon_num 5" - }, - { - "description": "Get the CodeView measurement details in Csect mode for the latest monitor in the TESTPROF profile", - "options": "--profile TESTPROF" - }, - { - "description": "Get the CodeView measurement details in Csect mode for monitor number 5, with the specific MAT profile details defined", - "options": "--mon_num 5 --host \"example.com\" --port 12345 --user johndoe --password qwerty" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "module", - "aliases": [ - "mod" - ], - "summary": "Get CodeView data in Module mode", - "description": "Get the CodeView measurement details in Module mode.", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "mat", - "base" - ] - }, - "options": [ - { - "name": "profile", - "description": "Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "mon_num", - "description": "Specifies the unique monitor number of the measurement.", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies the protocol defined for the MAT REST API server (http or https).", - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "defaultValue": "https", - "group": "MAT Profile Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the server port (e.g. 8080).", - "type": "number", - "group": "MAT Profile Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Your mainframe username.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "password", - "aliases": [ - "pw" - ], - "description": "Your mainframe password.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "MAT Profile Options" - }, - { - "name": "listingDir", - "aliases": [ - "ldir" - ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", - "type": "string", - "required": false, - "group": "MAT Profile Options" - }, - { - "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": "mat-profile", - "aliases": [ - "mat-p" - ], - "group": "Profile Options", - "description": "The name of a (mat) 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": "Get the CodeView measurement details in Module mode for monitor number 5", - "options": "--mon_num 5" - }, - { - "description": "Get the CodeView measurement details in Module mode for the latest monitor in the TESTPROF profile", - "options": "--profile TESTPROF" - }, - { - "description": "Get the CodeView measurement details in Module mode for monitor number 5, with the specific MAT profile details defined", - "options": "--mon_num 5 --host \"example.com\" --port 12345 --user johndoe --password qwerty" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "callerid", - "aliases": [ - "cil" - ], - "summary": "Get CodeView CallerID details", - "description": "Get the CodeView CallerID details for the specific CSECT and module.", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "mat", - "base" - ] - }, - "options": [ - { - "name": "profile", - "description": "Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "mon_num", - "description": "Specifies the unique monitor number of the measurement.", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "name": "module", - "description": "Specifies the module name that you request the CallerID details for. You get the module value from the 'codeview csect' command response. The module name can be empty (e.g., --module \"IGZCPAC\" or --module '\"\"').", - "type": "stringOrEmpty", - "group": "Options", - "aliases": [] - }, - { - "name": "csect", - "description": "Specifies the CSECT name that you request the CallerID details for. You get the csect value from the 'codeview csect' command response. The CSECT name can be empty (e.g., --csect \"TUNCOB01\" or --csect '\"\"').", - "type": "stringOrEmpty", - "group": "Options", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies the protocol defined for the MAT REST API server (http or https).", - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "defaultValue": "https", - "group": "MAT Profile Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the server port (e.g. 8080).", - "type": "number", - "group": "MAT Profile Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Your mainframe username.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "password", - "aliases": [ - "pw" - ], - "description": "Your mainframe password.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "MAT Profile Options" - }, - { - "name": "listingDir", - "aliases": [ - "ldir" - ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", - "type": "string", - "required": false, - "group": "MAT Profile Options" - }, - { - "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": "mat-profile", - "aliases": [ - "mat-p" - ], - "group": "Profile Options", - "description": "The name of a (mat) 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": "Get the CallerID details for monitor number 5, CSECT name TUNCOB01, and module name RUNCOB", - "options": "--mon_num 5 --csect \"TUNCOB01\" --module \"RUNCOB\"" - }, - { - "description": "Get the CallerID details for the latest monitor in the TESTPROF profile for CSECT name TUNCOB01 and empty module name", - "options": "--profile TESTPROF --csect \"TUNCOB01\" --module '\"\"'" - }, - { - "description": "Get the CallerID details for monitor number 5, CSECT name TUNCOB01, and module name RUNCOB, with the specific MAT profile details defined", - "options": "--mon_num 5 --csect \"TUNCOB01\" --module \"RUNCOB\" --host \"example.com\" --port 12345 --user johndoe --password qwerty" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "histogram", - "aliases": [ - "hsg" - ], - "summary": "Get Histogram data", - "description": "Get the Histogram details for the measurement.", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "mat", - "base" - ] - }, - "options": [ - { - "name": "profile", - "description": "Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "mon_num", - "description": "Specifies the unique monitor number of the measurement.", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "name": "module", - "description": "Specifies the module name that you request the Histogram data for. You get the module value from the 'codeview csect' command response. The module name can be empty (e.g., --module \"IGZCPAC\" or --module '\"\"').", - "type": "stringOrEmpty", - "group": "Options", - "aliases": [] - }, - { - "name": "csect", - "description": "Specifies the CSECT name that you request the Histogram data for. You get the csect value from the 'codeview csect' command response. The CSECT name can be empty (e.g., --csect \"TUNCOB01\" or --csect '\"\"').", - "type": "stringOrEmpty", - "group": "Options", - "aliases": [] - }, - { - "name": "group", - "description": "Specifies the histogram group size parameter that defines the resolution of the histogram (e.g., --group 32). If you do not specify the group parameter, the group size value defaults to 4 bytes. If the source program listing is registered with MAT, the group size parameter is ignored. The --group parameter is optional. Lower values of the --group parameter result in more granular representation of the histogram data. Values: numbers between 2 and 999999.", - "type": "stringOrEmpty", - "group": "Options", - "aliases": [] - }, - { - "name": "top", - "description": "Specifies the maximum number of the top consuming CSECT activity locations that you want to obtain in the response (e.g., --top 5). If you specify --top 0, you get the list of all CSECT activity locations that MAT has detected during the measurement.The --top parameter is optional. Values: numbers between 0 and 300.", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "name": "listing", - "description": "Enables you to retrieve program listing details that pertain to the specific CSECT and statement. To use the listing retrieval option, you must install and configure the Endevor® Web Services and have the program listing for the specific measurement registered with MAT. The source code listing is retrieved through Endevor® footprints for Cobol, C/C++, and Assembler programs. The program listing file is downloaded to your local directory that you specified with the 'listingDir' parameter in your MAT configuration profile. When you request the histogram details with the '--listing' option, the 'histogram' command returns the additional 'listing' column that contains a reference to the program listing with the specific CSECT name, program type, line and column number that pertain to the requested CSECT and statement, for example, c:listingsSA420LE.asm:382:51. If you use Visual Studio Code (VS Code) IDE, you can click on the reference in the command responce in your VS Code terminal to navigate directly to the indicated source program location.The --listing parameter is optional.", - "type": "boolean", - "group": "Options", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies the protocol defined for the MAT REST API server (http or https).", - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "defaultValue": "https", - "group": "MAT Profile Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the server port (e.g. 8080).", - "type": "number", - "group": "MAT Profile Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Your mainframe username.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "password", - "aliases": [ - "pw" - ], - "description": "Your mainframe password.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "MAT Profile Options" - }, - { - "name": "listingDir", - "aliases": [ - "ldir" - ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", - "type": "string", - "required": false, - "group": "MAT Profile Options" - }, - { - "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": "mat-profile", - "aliases": [ - "mat-p" - ], - "group": "Profile Options", - "description": "The name of a (mat) 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": "Get the Histogram details for monitor number 5, CSECT name TUNCOB01, and module name RUNCOB", - "options": "--mon_num 5 --csect \"TUNCOB01\" --module \"RUNCOB\"" - }, - { - "description": "Get the Histogram details for the latest monitor in the TESTPROF profile for CSECT name TUNCOB01, empty module name, limiting the group size to 32 bytes and the number of returned records to 5 top consumers", - "options": "--profile TESTPROF --csect \"TUNCOB01\" --module '\"\"' --top 5 --group 32" - }, - { - "description": "Get the Histogram details for monitor number 5, CSECT name TUNCOB01, and module name RUNCOB, limit the number of returned records to 5 top consumers, and request the listing details", - "options": "--mon_num 5 --csect \"TUNCOB01\" --module \"RUNCOB\" --top 5 --listing" - }, - { - "description": "Get the Histogram details for monitor number 5, CSECT name TUNCOB01, and module name RUNCOB, with the specific MAT profile details defined", - "options": "--mon_num 5 --csect \"TUNCOB01\" --module \"RUNCOB\" --host \"example.com\" --port 12345 --user johndoe --password qwerty" - } - ], - "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": "delayview", - "summary": "Get DelayView data", - "description": "Get the DelayView measurement details.", - "type": "group", - "children": [ - { - "name": "delay", - "aliases": [ - "de" - ], - "summary": "Get DelayView data", - "description": "Get the delay details for the measurement.", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "mat", - "base" - ] - }, - "options": [ - { - "name": "profile", - "description": "Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "mon_num", - "description": "Specifies the unique monitor number of the measurement.", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies the protocol defined for the MAT REST API server (http or https).", - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "defaultValue": "https", - "group": "MAT Profile Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the server port (e.g. 8080).", - "type": "number", - "group": "MAT Profile Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Your mainframe username.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "password", - "aliases": [ - "pw" - ], - "description": "Your mainframe password.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "MAT Profile Options" - }, - { - "name": "listingDir", - "aliases": [ - "ldir" - ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", - "type": "string", - "required": false, - "group": "MAT Profile Options" - }, - { - "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": "mat-profile", - "aliases": [ - "mat-p" - ], - "group": "Profile Options", - "description": "The name of a (mat) 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": "Get the DelayView measurement details for monitor number 5", - "options": "--mon_num 5" - }, - { - "description": "Get the DelayView measurement details for the latest monitor in the TESTPROF profile", - "options": "--profile TESTPROF" - }, - { - "description": "Get the DelayView measurement details for monitor number 5, with the specific MAT profile details defined", - "options": "--mon_num 5 --host \"example.com\" --port 12345 --user johndoe --password qwerty" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "address", - "aliases": [ - "ad" - ], - "summary": "Get delay address data", - "description": "Get the delay address details for the measurement.", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "mat", - "base" - ] - }, - "options": [ - { - "name": "profile", - "description": "Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "mon_num", - "description": "Specifies the unique monitor number of the measurement.", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "name": "majorcategory", - "description": "Specifies the major delay category name identified for the analysis item (e.g., --majorcategory \"PC routine delay\"). You get the majorcategory value from the 'delayview delay' command response.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "minorcategory", - "description": "Specifies the minor delay category name identified for the analysis item (e.g., --minorcategory \"PC CALL\"). You get the minorcategory value from the 'delayview delay' command response.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies the protocol defined for the MAT REST API server (http or https).", - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "defaultValue": "https", - "group": "MAT Profile Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the server port (e.g. 8080).", - "type": "number", - "group": "MAT Profile Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Your mainframe username.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "password", - "aliases": [ - "pw" - ], - "description": "Your mainframe password.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "MAT Profile Options" - }, - { - "name": "listingDir", - "aliases": [ - "ldir" - ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", - "type": "string", - "required": false, - "group": "MAT Profile Options" - }, - { - "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": "mat-profile", - "aliases": [ - "mat-p" - ], - "group": "Profile Options", - "description": "The name of a (mat) 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": "Get the delay address details for majorcategory \"PC routine delay\" and minorcategory \"PC CALL\" for monitor number 5", - "options": "--mon_num 5 –-majorcategory \"PC routine delay\" –-minorcategory \"PC CALL\"" - }, - { - "description": "Get the delay address details for majorcategory \"PC routine delay\" and minorcategory \"PC CALL\" for the latest monitor in the TESTPROF profile", - "options": "--profile TESTPROF –-majorcategory \"PC routine delay\" –-minorcategory \"PC CALL\"" - }, - { - "description": "Get the delay address details for majorcategory \"PC routine delay\" and minorcategory \"PC CALL\" for monitor number 5, with the specific MAT profile details defined", - "options": "--mon_num 5 –-majorcategory \"PC routine delay\" –-minorcategory \"PC CALL\" --host \"example.com\" --port 12345 --user johndoe --password qwerty" - } - ], - "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": "history", - "aliases": [ - "hs" - ], - "summary": "Get monitor history for a profile", - "description": "Get list of all available measurements that are stored in the history of the specific monitor profile.", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "mat", - "base" - ] - }, - "options": [ - { - "name": "profile", - "description": "Specifies the name of the profile.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies the protocol defined for the MAT REST API server (http or https).", - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "defaultValue": "https", - "group": "MAT Profile Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the server port (e.g. 8080).", - "type": "number", - "group": "MAT Profile Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Your mainframe username.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "password", - "aliases": [ - "pw" - ], - "description": "Your mainframe password.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "MAT Profile Options" - }, - { - "name": "listingDir", - "aliases": [ - "ldir" - ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", - "type": "string", - "required": false, - "group": "MAT Profile Options" - }, - { - "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": "mat-profile", - "aliases": [ - "mat-p" - ], - "group": "Profile Options", - "description": "The name of a (mat) 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": "Get the list of all available measurements that are stored in the history of the monitor profile TESTPROF", - "options": "--profile TESTPROF" - }, - { - "description": "Get the list of all available measurements that are stored in the history of the monitor profile TESTPROF, with the specific MAT profile details defined", - "options": "--profile TESTPROF --host \"example.com\" --port 12345 --user johndoe --password qwerty" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "db2", - "summary": "Get DB2 Data", - "description": "Get the DB2 measurement details.", - "type": "group", - "children": [ - { - "name": "db2view", - "aliases": [ - "db2v" - ], - "summary": "Get DB2View data", - "description": "Get the DB2View details for the measurement.", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "mat", - "base" - ] - }, - "options": [ - { - "name": "profile", - "description": "Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "mon_num", - "description": "Specifies the unique monitor number of the measurement.", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "name": "top", - "description": "Specifies the maximum number of the top consuming DB2 statements that you want to obtain in the response (e.g., --top 5). If you specify --top 0, you get the list of all DB2 statements that MAT has detected during the measurement.The --top parameter is optional. Values: numbers between 0 and 300.", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies the protocol defined for the MAT REST API server (http or https).", - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "defaultValue": "https", - "group": "MAT Profile Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the server port (e.g. 8080).", - "type": "number", - "group": "MAT Profile Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Your mainframe username.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "password", - "aliases": [ - "pw" - ], - "description": "Your mainframe password.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "MAT Profile Options" - }, - { - "name": "listingDir", - "aliases": [ - "ldir" - ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", - "type": "string", - "required": false, - "group": "MAT Profile Options" - }, - { - "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": "mat-profile", - "aliases": [ - "mat-p" - ], - "group": "Profile Options", - "description": "The name of a (mat) 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": "Get the DB2View details for monitor number 5", - "options": "--mon_num 5" - }, - { - "description": "Get the DB2View details for the latest monitor in the TESTPROF profile, with the top consumer limitation set to 5 top consumers", - "options": "--profile TESTPROF --top 5" - }, - { - "description": "Get the DB2View details for monitor number 5, with the specific MAT profile details defined", - "options": "--mon_num 5 --host \"example.com\" --port 12345 --user johndoe --password qwerty" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "sqlstmt", - "aliases": [ - "sql" - ], - "summary": "Get DB2 SQL statement details", - "description": "Get SQL details for the DB2 statement.", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "mat", - "base" - ] - }, - "options": [ - { - "name": "profile", - "description": "Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "mon_num", - "description": "Specifies the unique monitor number of the measurement.", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "name": "dbrm", - "description": "Specifies the DBRM/Package name that the requested DB2 statement belongs to (e.g., --dbrm CUPBTSDY). You get the dbrm value from the 'db2 db2view ' command response.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "stmtnum", - "description": "Specifies the statement number that you request the SQL details for (e.g., --stmtnum 464). You get the stmtnum value from the 'db2 db2view ' command response.", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "name": "totalsamps", - "description": "Specifies the total number of samples taken for the requested statement (e.g., --totalsamps 1). You get the totalsamps value from the 'db2 db2view ' command response.", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies the protocol defined for the MAT REST API server (http or https).", - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "defaultValue": "https", - "group": "MAT Profile Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the server port (e.g. 8080).", - "type": "number", - "group": "MAT Profile Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Your mainframe username.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "password", - "aliases": [ - "pw" - ], - "description": "Your mainframe password.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "MAT Profile Options" - }, - { - "name": "listingDir", - "aliases": [ - "ldir" - ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", - "type": "string", - "required": false, - "group": "MAT Profile Options" - }, - { - "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": "mat-profile", - "aliases": [ - "mat-p" - ], - "group": "Profile Options", - "description": "The name of a (mat) 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": "Get the DB2 SQL statement details for monitor number 5 for DBRM CUPBTSDY, statement number 464, with total number of taken samples 1", - "options": "--mon_num 5 --dbrm CUPBTSDY --stmtnum 464 --totalsamps 1" - }, - { - "description": "Get the DB2 SQL statement details for the latest monitor in the TESTPROF profile, for DBRM CUPBTSDY, statement number 464, with total number of taken samples 1", - "options": "--profile TESTPROF --dbrm CUPBTSDY --stmtnum 464 --totalsamps 1" - }, - { - "description": "Get the DB2 SQL statement details for monitor number 5 for DBRM CUPBTSDY, statement number 464, with total number of taken samples 1, and with the specific MAT profile details defined", - "options": "--mon_num 5 --dbrm CUPBTSDY --stmtnum 464 --totalsamps 1 --host \"example.com\" --port 12345 --user johndoe --password qwerty" - } - ], - "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": "tranview", - "aliases": [ - "tr" - ], - "summary": "Get TranView data", - "description": "Get the TranView measurement details.", - "type": "group", - "children": [ - { - "name": "stat", - "aliases": [ - "cis" - ], - "summary": "Get CodeView data in Module mode", - "description": "Get the CodeView measurement details in Module mode.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "mat" - ], - "optional": [ - "base" - ] - }, - "options": [ - { - "name": "profile", - "description": "Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "mon_num", - "description": "Specifies the unique monitor number of the measurement.", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "name": "tran", - "description": "Specifies the histogram group size parameter that defines the resolution of the histogram (e.g., --group 32). If you do not specify the group parameter, the group size value defaults to 4 bytes. If the source program listing is registered with MAT, the group size parameter is ignored. The --group parameter is optional. Lower values of the --group parameter result in more granular representation of the histogram data. Values: numbers between 2 and 999999.", - "type": "stringOrEmpty", - "group": "Options", - "aliases": [] - }, - { - "name": "type", - "description": "Specifies the histogram group size parameter that defines the resolution of the histogram (e.g., --group 32). If you do not specify the group parameter, the group size value defaults to 4 bytes. If the source program listing is registered with MAT, the group size parameter is ignored. The --group parameter is optional. Lower values of the --group parameter result in more granular representation of the histogram data. Values: numbers between 2 and 999999.", - "type": "stringOrEmpty", - "group": "Options", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies the protocol defined for the MAT REST API server (http or https).", - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "defaultValue": "https", - "group": "MAT Profile Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the server port (e.g. 8080).", - "type": "number", - "group": "MAT Profile Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Your mainframe username.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "password", - "aliases": [ - "pw" - ], - "description": "Your mainframe password.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "MAT Profile Options" - }, - { - "name": "listingDir", - "aliases": [ - "ldir" - ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", - "type": "string", - "required": false, - "group": "MAT Profile Options" - }, - { - "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": "mat-profile", - "aliases": [ - "mat-p" - ], - "group": "Profile Options", - "description": "The name of a (mat) 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": "Get the CodeView measurement details in Module mode for monitor number 5", - "options": "--mon_num 5" - }, - { - "description": "Get the CodeView measurement details in Module mode for the latest monitor in the TESTPROF profile", - "options": "--profile TESTPROF" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "all", - "aliases": [ - "all" - ], - "summary": "Get CodeView data in Module mode", - "description": "Get the CodeView measurement details in Module mode.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "mat" - ], - "optional": [ - "base" - ] - }, - "options": [ - { - "name": "profile", - "description": "Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "mon_num", - "description": "Specifies the unique monitor number of the measurement.", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "name": "tran", - "description": "Specifies the histogram group size parameter that defines the resolution of the histogram (e.g., --group 32). If you do not specify the group parameter, the group size value defaults to 4 bytes. If the source program listing is registered with MAT, the group size parameter is ignored. The --group parameter is optional. Lower values of the --group parameter result in more granular representation of the histogram data. Values: numbers between 2 and 999999.", - "type": "stringOrEmpty", - "group": "Options", - "aliases": [] - }, - { - "name": "type", - "description": "Specifies the histogram group size parameter that defines the resolution of the histogram (e.g., --group 32). If you do not specify the group parameter, the group size value defaults to 4 bytes. If the source program listing is registered with MAT, the group size parameter is ignored. The --group parameter is optional. Lower values of the --group parameter result in more granular representation of the histogram data. Values: numbers between 2 and 999999.", - "type": "stringOrEmpty", - "group": "Options", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies the protocol defined for the MAT REST API server (http or https).", - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "defaultValue": "https", - "group": "MAT Profile Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the server port (e.g. 8080).", - "type": "number", - "group": "MAT Profile Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Your mainframe username.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "password", - "aliases": [ - "pw" - ], - "description": "Your mainframe password.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "MAT Profile Options" - }, - { - "name": "listingDir", - "aliases": [ - "ldir" - ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", - "type": "string", - "required": false, - "group": "MAT Profile Options" - }, - { - "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": "mat-profile", - "aliases": [ - "mat-p" - ], - "group": "Profile Options", - "description": "The name of a (mat) 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": "Get the CodeView measurement details in Module mode for monitor number 5", - "options": "--mon_num 5" - }, - { - "description": "Get the CodeView measurement details in Module mode for the latest monitor in the TESTPROF profile", - "options": "--profile TESTPROF" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "callerid", - "aliases": [ - "cid" - ], - "summary": "Get Callerid data in Module mode", - "description": "Get the CodeView measurement details in Module mode.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "mat" - ], - "optional": [ - "base" - ] - }, - "options": [ - { - "name": "profile", - "description": "Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "mon_num", - "description": "Specifies the unique monitor number of the measurement.", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "name": "tran", - "description": "Specifies the histogram group size parameter that defines the resolution of the histogram (e.g., --group 32). If you do not specify the group parameter, the group size value defaults to 4 bytes. If the source program listing is registered with MAT, the group size parameter is ignored. The --group parameter is optional. Lower values of the --group parameter result in more granular representation of the histogram data. Values: numbers between 2 and 999999.", - "type": "stringOrEmpty", - "group": "Options", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies the protocol defined for the MAT REST API server (http or https).", - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "defaultValue": "https", - "group": "MAT Profile Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the server port (e.g. 8080).", - "type": "number", - "group": "MAT Profile Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Your mainframe username.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "password", - "aliases": [ - "pw" - ], - "description": "Your mainframe password.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "MAT Profile Options" - }, - { - "name": "listingDir", - "aliases": [ - "ldir" - ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", - "type": "string", - "required": false, - "group": "MAT Profile Options" - }, - { - "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": "mat-profile", - "aliases": [ - "mat-p" - ], - "group": "Profile Options", - "description": "The name of a (mat) 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": "Get the CodeView measurement details in Module mode for monitor number 5", - "options": "--mon_num 5" - }, - { - "description": "Get the CodeView measurement details in Module mode for the latest monitor in the TESTPROF profile", - "options": "--profile TESTPROF" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "callstack", - "aliases": [ - "csk" - ], - "summary": "Get CallStack data in Module mode", - "description": "Get the CodeView measurement details in Module mode.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "mat" - ], - "optional": [ - "base" - ] - }, - "options": [ - { - "name": "profile", - "description": "Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "mon_num", - "description": "Specifies the unique monitor number of the measurement.", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "name": "tran", - "description": "Specifies the histogram group size parameter that defines the resolution of the histogram (e.g., --group 32). If you do not specify the group parameter, the group size value defaults to 4 bytes. If the source program listing is registered with MAT, the group size parameter is ignored. The --group parameter is optional. Lower values of the --group parameter result in more granular representation of the histogram data. Values: numbers between 2 and 999999.", - "type": "stringOrEmpty", - "group": "Options", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies the protocol defined for the MAT REST API server (http or https).", - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "defaultValue": "https", - "group": "MAT Profile Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the server port (e.g. 8080).", - "type": "number", - "group": "MAT Profile Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Your mainframe username.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "password", - "aliases": [ - "pw" - ], - "description": "Your mainframe password.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "MAT Profile Options" - }, - { - "name": "listingDir", - "aliases": [ - "ldir" - ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", - "type": "string", - "required": false, - "group": "MAT Profile Options" - }, - { - "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": "mat-profile", - "aliases": [ - "mat-p" - ], - "group": "Profile Options", - "description": "The name of a (mat) 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": "Get the CodeView measurement details in Module mode for monitor number 5", - "options": "--mon_num 5" - }, - { - "description": "Get the CodeView measurement details in Module mode for the latest monitor in the TESTPROF profile", - "options": "--profile TESTPROF" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "csect", - "aliases": [ - "csd" - ], - "summary": "Get CodeView data in Csect mode", - "description": "Get the CodeView measurement details in Csect mode.", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "mat", - "base" - ] - }, - "options": [ - { - "name": "profile", - "description": "Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "mon_num", - "description": "Specifies the unique monitor number of the measurement.", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "name": "tran", - "description": "Specifies the unique monitor number of the measurement.", - "type": "stringOrEmpty", - "group": "Options", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies the protocol defined for the MAT REST API server (http or https).", - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "defaultValue": "https", - "group": "MAT Profile Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the server port (e.g. 8080).", - "type": "number", - "group": "MAT Profile Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Your mainframe username.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "password", - "aliases": [ - "pw" - ], - "description": "Your mainframe password.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "MAT Profile Options" - }, - { - "name": "listingDir", - "aliases": [ - "ldir" - ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", - "type": "string", - "required": false, - "group": "MAT Profile Options" - }, - { - "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": "mat-profile", - "aliases": [ - "mat-p" - ], - "group": "Profile Options", - "description": "The name of a (mat) 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": "Get the CodeView measurement details in Csect mode for monitor number 5", - "options": "--mon_num 5" - }, - { - "description": "Get the CodeView measurement details in Csect mode for the latest monitor in the TESTPROF profile", - "options": "--profile TESTPROF" - }, - { - "description": "Get the CodeView measurement details in Csect mode for monitor number 5, with the specific MAT profile details defined", - "options": "--mon_num 5 --host \"example.com\" --port 12345 --user johndoe --password qwerty" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "delay", - "aliases": [ - "dl" - ], - "summary": "Get DelayView data", - "description": "Get the delay details for the measurement.", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "mat", - "base" - ] - }, - "options": [ - { - "name": "profile", - "description": "Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "mon_num", - "description": "Specifies the unique monitor number of the measurement.", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "name": "tran", - "description": "Specifies the unique monitor number of the measurement.", - "type": "stringOrEmpty", - "group": "Options", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies the protocol defined for the MAT REST API server (http or https).", - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "defaultValue": "https", - "group": "MAT Profile Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the server port (e.g. 8080).", - "type": "number", - "group": "MAT Profile Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Your mainframe username.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "password", - "aliases": [ - "pw" - ], - "description": "Your mainframe password.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "MAT Profile Options" - }, - { - "name": "listingDir", - "aliases": [ - "ldir" - ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", - "type": "string", - "required": false, - "group": "MAT Profile Options" - }, - { - "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": "mat-profile", - "aliases": [ - "mat-p" - ], - "group": "Profile Options", - "description": "The name of a (mat) 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": "Get the DelayView measurement details for monitor number 5", - "options": "--mon_num 5" - }, - { - "description": "Get the DelayView measurement details for the latest monitor in the TESTPROF profile", - "options": "--profile TESTPROF" - }, - { - "description": "Get the DelayView measurement details for monitor number 5, with the specific MAT profile details defined", - "options": "--mon_num 5 --host \"example.com\" --port 12345 --user johndoe --password qwerty" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "module", - "aliases": [ - "mod" - ], - "summary": "Get Module data in Module mode", - "description": "Get the CodeView measurement details in Module mode.", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "mat", - "base" - ] - }, - "options": [ - { - "name": "profile", - "description": "Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "mon_num", - "description": "Specifies the unique monitor number of the measurement.", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "name": "tran", - "description": "Specifies the transaction of the measurement.", - "type": "stringOrEmpty", - "group": "Options", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies the protocol defined for the MAT REST API server (http or https).", - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "defaultValue": "https", - "group": "MAT Profile Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the server port (e.g. 8080).", - "type": "number", - "group": "MAT Profile Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Your mainframe username.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "password", - "aliases": [ - "pw" - ], - "description": "Your mainframe password.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "MAT Profile Options" - }, - { - "name": "listingDir", - "aliases": [ - "ldir" - ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", - "type": "string", - "required": false, - "group": "MAT Profile Options" - }, - { - "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": "mat-profile", - "aliases": [ - "mat-p" - ], - "group": "Profile Options", - "description": "The name of a (mat) 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": "Get the Tranview measurement details in Module mode for monitor number 5", - "options": "--mon_num 5" - }, - { - "description": "Get the Tranview measurement details in Module mode for the latest monitor in the TESTPROF profile", - "options": "--profile TESTPROF" - }, - { - "description": "Get the Tranview measurement details in Module mode for transaction number MVGT, with the specific MAT profile details defined", - "options": "--tran MVGT" - } - ], - "positionals": [], - "passOn": [], - "children": [] - } - ], - "profile": { - "required": [ - "mat" - ], - "optional": [ - "base" - ] - }, - "options": [ - { - "name": "profile", - "description": "Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "mon_num", - "description": "Specifies the unique monitor number of the measurement.", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "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" - }, - { - "name": "mat-profile", - "aliases": [ - "mat-p" - ], - "group": "Profile Options", - "description": "The name of a (mat) 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": [ - { - "description": "Get the overview details of the measurement for monitor number 5", - "options": "--mon_num 5" - }, - { - "description": "Get the overview details of the measurement for the latest monitor in the TESTPROF profile", - "options": "--profile TESTPROF" - } - ], - "positionals": [], - "passOn": [] - }, - { - "name": "idms", - "aliases": [ - "idms" - ], - "summary": "Get IDMS data", - "description": "Get the IDMS measurement details.", - "type": "group", - "children": [ - { - "name": "dml", - "aliases": [ - "dml" - ], - "summary": "Get DML data in Module mode", - "description": "Get the IDMS measurement details in DML mode.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "mat" - ], - "optional": [ - "base" - ] - }, - "options": [ - { - "name": "profile", - "description": "Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "mon_num", - "description": "Specifies the unique monitor number of the measurement.", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies the protocol defined for the MAT REST API server (http or https).", - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "defaultValue": "https", - "group": "MAT Profile Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the server port (e.g. 8080).", - "type": "number", - "group": "MAT Profile Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Your mainframe username.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "password", - "aliases": [ - "pw" - ], - "description": "Your mainframe password.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "MAT Profile Options" - }, - { - "name": "listingDir", - "aliases": [ - "ldir" - ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", - "type": "string", - "required": false, - "group": "MAT Profile Options" - }, - { - "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": "mat-profile", - "aliases": [ - "mat-p" - ], - "group": "Profile Options", - "description": "The name of a (mat) 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": "Get the CodeView measurement details in Module mode for monitor number 5", - "options": "--mon_num 5" - }, - { - "description": "Get the CodeView measurement details in Module mode for the latest monitor in the TESTPROF profile", - "options": "--profile TESTPROF" - }, - { - "description": "Get the dml details of the measurement for monitor number 5", - "options": "dml --mon_num 5" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "task", - "aliases": [ - "ts" - ], - "summary": "Get IDMS data in Task mode", - "description": "Get the IDMS measurement details in Task mode.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "mat" - ], - "optional": [ - "base" - ] - }, - "options": [ - { - "name": "profile", - "description": "Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "mon_num", - "description": "Specifies the unique monitor number of the measurement.", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies the protocol defined for the MAT REST API server (http or https).", - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "defaultValue": "https", - "group": "MAT Profile Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the server port (e.g. 8080).", - "type": "number", - "group": "MAT Profile Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Your mainframe username.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "password", - "aliases": [ - "pw" - ], - "description": "Your mainframe password.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "MAT Profile Options" - }, - { - "name": "listingDir", - "aliases": [ - "ldir" - ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", - "type": "string", - "required": false, - "group": "MAT Profile Options" - }, - { - "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": "mat-profile", - "aliases": [ - "mat-p" - ], - "group": "Profile Options", - "description": "The name of a (mat) 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": "Get the CodeView measurement details in Module mode for monitor number 5", - "options": "--mon_num 5" - }, - { - "description": "Get the CodeView measurement details in Module mode for the latest monitor in the TESTPROF profile", - "options": "--profile TESTPROF" - }, - { - "description": "Get the task details of the measurement for monitor number 5", - "options": "task --mon_num 5" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "module", - "aliases": [ - "mod" - ], - "summary": "Get IDMS Module data", - "description": "Get the IDMS measurement details.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "mat" - ], - "optional": [ - "base" - ] - }, - "options": [ - { - "name": "profile", - "description": "Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "mon_num", - "description": "Specifies the unique monitor number of the measurement.", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "name": "module", - "description": "Specifies the module of the measurement.", - "type": "stringOrEmpty", - "group": "Options", - "aliases": [] - }, - { - "name": "taskid", - "description": "Specifies the taskid number.", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "name": "ruid", - "description": "Specifies the ruid number.", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "name": "linecmd", - "description": "Specifies the line command to be used for the row data", - "type": "stringOrEmpty", - "group": "Options", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies the protocol defined for the MAT REST API server (http or https).", - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "defaultValue": "https", - "group": "MAT Profile Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the server port (e.g. 8080).", - "type": "number", - "group": "MAT Profile Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Your mainframe username.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "password", - "aliases": [ - "pw" - ], - "description": "Your mainframe password.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "MAT Profile Options" - }, - { - "name": "listingDir", - "aliases": [ - "ldir" - ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", - "type": "string", - "required": false, - "group": "MAT Profile Options" - }, - { - "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": "mat-profile", - "aliases": [ - "mat-p" - ], - "group": "Profile Options", - "description": "The name of a (mat) 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": "Get the idms details of the measurement for monitor number 5", - "options": "--mon_num 5" - }, - { - "description": "Get the idms details of the measurement for the latest monitor in the TESTPROF profile", - "options": "--profile TESTPROF" - }, - { - "description": "Get the module details of the measurement for monitor number 5", - "options": "module --mon_num 5" - }, - { - "description": "Specify the module | taskid | ruid | linecmd option of the measurement for the module mode", - "options": "--module SQLA01D | --taskid 1 | --ruid 19333 | --linecmd dispatch" - } - ], - "positionals": [], - "passOn": [], - "children": [] - } - ], - "profile": { - "required": [ - "mat" - ], - "optional": [ - "base" - ] - }, - "options": [ - { - "name": "profile", - "description": "Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "mon_num", - "description": "Specifies the unique monitor number of the measurement.", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "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" - }, - { - "name": "mat-profile", - "aliases": [ - "mat-p" - ], - "group": "Profile Options", - "description": "The name of a (mat) 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": [ - { - "description": "Get the overview details of the measurement for monitor number 5", - "options": "--mon_num 5" - }, - { - "description": "Get the overview details of the measurement for the latest monitor in the TESTPROF profile", - "options": "--profile TESTPROF" - } - ], - "positionals": [], - "passOn": [] - }, - { - "name": "imsview", - "summary": "Get IMS data", - "aliases": [ - "ims" - ], - "description": "Get the IMS measurement details.", - "type": "group", - "children": [ - { - "name": "imsview", - "aliases": [ - "imsv" - ], - "summary": "Get IMS View data", - "description": "Get the IMS View details for the measurement.", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "mat", - "base" - ] - }, - "options": [ - { - "name": "mon_num", - "description": "Specifies the unique monitor number of the measurement.", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "name": "profile", - "description": "Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies the protocol defined for the MAT REST API server (http or https).", - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "defaultValue": "https", - "group": "MAT Profile Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the server port (e.g. 8080).", - "type": "number", - "group": "MAT Profile Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Your mainframe username.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "password", - "aliases": [ - "pw" - ], - "description": "Your mainframe password.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "MAT Profile Options" - }, - { - "name": "listingDir", - "aliases": [ - "ldir" - ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", - "type": "string", - "required": false, - "group": "MAT Profile Options" - }, - { - "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": "mat-profile", - "aliases": [ - "mat-p" - ], - "group": "Profile Options", - "description": "The name of a (mat) 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": "Get the IMS View details for monitor number 5", - "options": "--mon_num 5" - }, - { - "description": "Get the IMS View details for the latest monitor in the TESTPROF profile, ", - "options": "--profile TESTPROF" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "dbdname", - "aliases": [ - "dbd" - ], - "summary": "Get IMS View DBDName data", - "description": "Get the IMS View DBDName details for the measurement.", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "mat", - "base" - ] - }, - "options": [ - { - "name": "profile", - "description": "Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "mon_num", - "description": "Specifies the unique monitor number of the measurement.", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies the protocol defined for the MAT REST API server (http or https).", - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "defaultValue": "https", - "group": "MAT Profile Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the server port (e.g. 8080).", - "type": "number", - "group": "MAT Profile Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Your mainframe username.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "password", - "aliases": [ - "pw" - ], - "description": "Your mainframe password.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "MAT Profile Options" - }, - { - "name": "listingDir", - "aliases": [ - "ldir" - ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", - "type": "string", - "required": false, - "group": "MAT Profile Options" - }, - { - "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": "mat-profile", - "aliases": [ - "mat-p" - ], - "group": "Profile Options", - "description": "The name of a (mat) 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": "Get the IMS View DBDName details for monitor number 5", - "options": "--mon_num 5" - }, - { - "description": "Get the IMS View DBDName details for the latest monitor in the TESTPROF profile, ", - "options": "--profile TESTPROF" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "psbname", - "aliases": [ - "psb" - ], - "summary": "Get IMS View PSBName data", - "description": "Get the IMS View PSBName details for the measurement.", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "mat", - "base" - ] - }, - "options": [ - { - "name": "profile", - "description": "Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "mon_num", - "description": "Specifies the unique monitor number of the measurement.", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies the protocol defined for the MAT REST API server (http or https).", - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "defaultValue": "https", - "group": "MAT Profile Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the server port (e.g. 8080).", - "type": "number", - "group": "MAT Profile Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Your mainframe username.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "password", - "aliases": [ - "pw" - ], - "description": "Your mainframe password.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "MAT Profile Options" - }, - { - "name": "listingDir", - "aliases": [ - "ldir" - ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", - "type": "string", - "required": false, - "group": "MAT Profile Options" - }, - { - "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": "mat-profile", - "aliases": [ - "mat-p" - ], - "group": "Profile Options", - "description": "The name of a (mat) 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": "Get the IMS View PSBName details for monitor number 5", - "options": "--mon_num 5" - }, - { - "description": "Get the IMS View PSBName details for the latest monitor in the TESTPROF profile, ", - "options": "--profile TESTPROF" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "region", - "aliases": [ - "reg" - ], - "summary": "Get IMS View Region data", - "description": "Get the IMS View Region details for the measurement.", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "mat", - "base" - ] - }, - "options": [ - { - "name": "profile", - "description": "Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "mon_num", - "description": "Specifies the unique monitor number of the measurement.", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies the protocol defined for the MAT REST API server (http or https).", - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "defaultValue": "https", - "group": "MAT Profile Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the server port (e.g. 8080).", - "type": "number", - "group": "MAT Profile Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Your mainframe username.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "password", - "aliases": [ - "pw" - ], - "description": "Your mainframe password.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "MAT Profile Options" - }, - { - "name": "listingDir", - "aliases": [ - "ldir" - ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", - "type": "string", - "required": false, - "group": "MAT Profile Options" - }, - { - "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": "mat-profile", - "aliases": [ - "mat-p" - ], - "group": "Profile Options", - "description": "The name of a (mat) 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": "Get the IMS View Region details for monitor number 5", - "options": "--mon_num 5" - }, - { - "description": "Get the IMS View Region details for the latest monitor in the TESTPROF profile, ", - "options": "--profile TESTPROF" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "ssa", - "aliases": [ - "ssa" - ], - "summary": "Get IMS View SSA data", - "description": "Get the IMS View SSA details for the measurement.", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "mat", - "base" - ] - }, - "options": [ - { - "name": "profile", - "description": "Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "mon_num", - "description": "Specifies the unique monitor number of the measurement.", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "name": "call", - "description": "Specifies the call details for the specified monitor number or profile name.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "dbdname", - "description": "Specifies the dbdname details for the specified monitor number or profile name.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "psbname", - "description": "Specifies the psbname details for the specified monitor number or profile name.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies the protocol defined for the MAT REST API server (http or https).", - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "defaultValue": "https", - "group": "MAT Profile Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the server port (e.g. 8080).", - "type": "number", - "group": "MAT Profile Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Your mainframe username.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "password", - "aliases": [ - "pw" - ], - "description": "Your mainframe password.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "MAT Profile Options" - }, - { - "name": "listingDir", - "aliases": [ - "ldir" - ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", - "type": "string", - "required": false, - "group": "MAT Profile Options" - }, - { - "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": "mat-profile", - "aliases": [ - "mat-p" - ], - "group": "Profile Options", - "description": "The name of a (mat) 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": "Get the IMS details for monitor number 5, with the specific MAT profile details defined", - "options": "--mon_num 5 --call TESTCALL --dbdname TESTDBDNAME --psbname TESTPSBNAME" - }, - { - "description": "Get the IMS View SSA details for the latest monitor in the TESTPROF profile,with the specific MAT profile details defined ", - "options": "--profile TESTPROF --call TESTCALL --dbdname TESTDBDNAME --psbname TESTPSBNAME" - }, - { - "description": "Get the IMS View SSA details for monitor number 5, with the specific MAT profile details defined", - "options": "--mon_num 5 --call TESTCALL --dbdname TESTDBDNAME --psbname TESTPSBNAME" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "statement", - "aliases": [ - "stat" - ], - "summary": "Get IMS View Statement data", - "description": "Get the IMS View Statement details for the measurement.", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "mat", - "base" - ] - }, - "options": [ - { - "name": "profile", - "description": "Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "mon_num", - "description": "Specifies the unique monitor number of the measurement.", - "type": "number", - "group": "Options", - "aliases": [] - }, - { - "name": "trancode", - "description": "Specifies the trancode for specified monitor number or profile name", - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies the protocol defined for the MAT REST API server (http or https).", - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "defaultValue": "https", - "group": "MAT Profile Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the server port (e.g. 8080).", - "type": "number", - "group": "MAT Profile Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Your mainframe username.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "password", - "aliases": [ - "pw" - ], - "description": "Your mainframe password.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "MAT Profile Options" - }, - { - "name": "listingDir", - "aliases": [ - "ldir" - ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", - "type": "string", - "required": false, - "group": "MAT Profile Options" - }, - { - "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": "mat-profile", - "aliases": [ - "mat-p" - ], - "group": "Profile Options", - "description": "The name of a (mat) 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": "Get the IMS View Statement details for monitor number 5with trancode TESTTRANCODE", - "options": "--mon_num 5 --trancode TESTTRANCODE" - }, - { - "description": "Get the IMS View Statement details for the latest monitor in the TESTPROF profile, with trancode TESTTRANCODE", - "options": "--profile TESTPROF --trancode TESTTRANCODE" - } - ], - "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" - } - ], - "positionals": [], - "passOn": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies the protocol defined for the MAT REST API server (http or https).", - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "defaultValue": "https", - "group": "MAT Profile Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the server port (e.g. 8080).", - "type": "number", - "group": "MAT Profile Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Your mainframe username.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "password", - "aliases": [ - "pw" - ], - "description": "Your mainframe password.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "MAT Profile Options" - }, - { - "name": "listingDir", - "aliases": [ - "ldir" - ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", - "type": "string", - "required": false, - "group": "MAT Profile Options" - } - ], - "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": "profile", - "summary": "Manage monitor profiles", - "description": "Create, invoke, and list MAT monitor profiles.", - "type": "group", - "children": [ - { - "name": "invoke", - "aliases": [ - "ivk" - ], - "summary": "Invoke a MAT monitor profile", - "description": "Invoke a MAT monitor profile to start measurement.", - "handler": "", - "type": "command", - "profile": { - "optional": [ - "mat", - "base" - ] - }, - "options": [ - { - "name": "profile", - "description": "Specifies the name of the profile in MAT that you invoke (e.g. PROFILE1). Values: 1 to 8 characters, a combination of alphanumeric and national characters (A-Z, 0-9, and @), the first character must be an alphabetic or @. The profile name must not contain characters # and $.", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "jobname", - "description": "Specifies the name of the job to be measured (e.g. JOB1). Values: 1 to 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "mondsn", - "description": "Specifies the monitor data set name where MAT saves the measurement (e.g. DEMO.MAT.MONITOR). Values: data set name pattern, maximum 46 characters. If not specified, your default MAT monitor DSN pattern is applied.", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "targsys", - "description": "Specifies the target system in SYSPLEX. Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, a combination of alphanumeric (A-Z and 0-9) and national (@,#,$), the first character must be an alphabetic (A-Z) or a national (@, #, $) (e.g. AA31,AA32).", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "moiuuid", - "description": "Specifies the MOI UUID. Values: maximum 61 characters, alphanumeric (A-Z and 0-9). If you use this parameter for command execution, the value cannot be blank.", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "moitimestamp", - "description": "Specifies the MOI timestamp. Values: maximum 12 characters, numbers only (0-9). If you use this parameter for command execution, the value cannot be blank.", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "listing", - "description": "Activates automated registration of Cobol, C/C++, and Assembler program listings through Endevor® footprints. After completion of the measurement that you invoke with the --listing parameter, the MAT Analyze plug-in for Zowe CLI automatically retrieves the program listing that is associated with the monitored job and registers the listing with MAT. A registered program listing enhances the analysis possibilities of the 'codeview histogram' command the 'codeview histogram' command and enables you to inspect the source code statements that are associated with specific modules and CSECTs.", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies the protocol defined for the MAT REST API server (http or https).", - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "defaultValue": "https", - "group": "MAT Profile Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the server port (e.g. 8080).", - "type": "number", - "group": "MAT Profile Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Your mainframe username.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "password", - "aliases": [ - "pw" - ], - "description": "Your mainframe password.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "MAT Profile Options" - }, - { - "name": "listingDir", - "aliases": [ - "ldir" - ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", - "type": "string", - "required": false, - "group": "MAT Profile Options" - }, - { - "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": "mat-profile", - "aliases": [ - "mat-p" - ], - "group": "Profile Options", - "description": "The name of a (mat) 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": "Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system ", - "options": "--profile PROFILE1 --jobname JOB1 --targsys AA31" - }, - { - "description": "Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system and save the measurement result in the DEMO.MAT.MONITOR.PROFILE1 data set", - "options": "--profile PROFILE1 --jobname JOB1 --targsys AA31 --mondsn DEMO.MAT.MONITOR.PROFILE1" - }, - { - "description": "Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system and register the program listing", - "options": "--profile PROFILE1 --jobname JOB1 --targsys AA31 --listing" - }, - { - "description": "Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system with the specific MAT profile details defined", - "options": "--profile PROFILE1 --jobname JOB1 --targsys AA31 --host \"example.com\" --port 12345 --user johndoe --password qwerty" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "create", - "aliases": [ - "cr" - ], - "summary": "Create a MAT monitor profile", - "description": "Create a MAT monitor profile.", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "mat", - "base" - ] - }, - "options": [ - { - "name": "profile", - "description": "Specifies the name of the profile that you create in MAT (e.g. PROFILE1). Values: 1 to 8 characters, a combination of alphanumeric and national characters (A-Z, 0-9, and @), the first character must be an alphabetic or @. The profile name must not contain characters # and $.", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "jobname", - "description": "Specifies the name of the job that you want to measure (e.g. JOB1). Values: 1 to 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "targsys", - "description": "Specifies the target system in SYSPLEX. Values: a comma separated list of up to 4 values is allowed, 1-8 characters each, a combination of alphanumeric (A-Z and 0-9) and national (@,#,$), the first character must be an alphabetic (A-Z) or a national (@, #, $), e.g. AA31,AA32).", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "batchreports", - "description": "Specifies the setting for the Batch report option upon monitor completion.", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "yes", - "no" - ] - }, - "defaultValue": "no", - "group": "Options", - "aliases": [] - }, - { - "name": "description", - "description": "Provide the monitor description (maximum 24 characters).", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "mondsn", - "description": "Specifies the monitor data set name where MAT saves the measurement (e.g. DEMO.MAT.MONITOR). Values: data set name pattern, maximum 46 characters. If not specified, your default MAT monitor DSN pattern is applied.", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "stepname", - "description": "Specifies the name of the job step to monitor. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "mstep", - "description": "Indicates whether the multi-step monitoring option is enabled.", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "yes", - "no" - ] - }, - "defaultValue": "no", - "group": "Options", - "aliases": [] - }, - { - "name": "procstep", - "description": "Specifies the name of the procedure step. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "program", - "description": "Specifies the name of the program to monitor. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "elapstime", - "description": "Specifies the required monitor duration followed by s (seconds) or m (minutes) (e.g. 60s). Values: maximum 6 characters total, number must be > 0.", - "type": "string", - "required": false, - "defaultValue": "60s", - "group": "Options", - "aliases": [] - }, - { - "name": "smon", - "description": "Specifies whether to monitor the entire step.", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "yes", - "no" - ] - }, - "defaultValue": "no", - "group": "Options", - "aliases": [] - }, - { - "name": "tasklib", - "description": "Specifies an additional DD name for load modules. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "samplecnt", - "description": "Specifies the number of observations requested. Values: maximum 6 characters, numbers between 10 and 999999.", - "type": "string", - "required": false, - "defaultValue": "6000", - "group": "Options", - "aliases": [] - }, - { - "name": "succnt", - "description": "Specifies the maximum number of monitors to run per job execution. Values: maximum 4 characters, numbers between 1 and 9999.", - "type": "string", - "required": false, - "defaultValue": "1", - "group": "Options", - "aliases": [] - }, - { - "name": "reccnt", - "description": "Specifies the number of times this job step will be monitored. Values: maximum 4 characters, numbers between 1 and 9999.", - "type": "string", - "required": false, - "defaultValue": "1", - "group": "Options", - "aliases": [] - }, - { - "name": "sampdelay", - "description": "Specifies the delay monitoring time in seconds after the step start. Values: maximum 4 characters, numbers between 0 and 9999.", - "type": "string", - "required": false, - "defaultValue": "0", - "group": "Options", - "aliases": [] - }, - { - "name": "userexit1", - "description": "Specifies the name for the call user written Data Base. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. DBEXIT1).", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "userexit2", - "description": "Specifies the name 1 for the call user written 4GL exit programs for this monitor . Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. UEXIT1).", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "userexit3", - "description": "Specifies the name 2 for the call user written 4GL exit programs for this monitor . Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. UEXIT2).", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "inctask", - "description": "Specifies the task name to define the tasks that you want to sample in a multitasking environment and restrict monitoring to the specific subtask within the address space. Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. INC31,INC32).", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "exctask", - "description": "Specifies the task name to omit from sampling in a multitasking environment Values: a comma separated list of up to 4 values is allowed, max. 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. EXC31,EXC32).", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "tran", - "description": "Specifies the CICS transaction code name to monitor .Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or +) (e.g. TRAN1,TRAN2).", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "term", - "description": "Specifies the CICS terminal IDs to monitor. Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or +) (e.g. TERM1,TERM2).", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "userid", - "description": "Specifies the CICS user IDs to monitor. Values: Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or +) (e.g. USER1,USER2).", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "db2expl", - "description": "Indicates whether the Explain SQL option is enabled for DB2 SQL statements.", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "yes", - "no" - ] - }, - "defaultValue": "no", - "group": "Options", - "aliases": [] - }, - { - "name": "db2ctsql", - "description": "Indicates whether the Collect SQL from Catalog option is enabled for DB2 SQL statements.If you specify db2expl=yes, then db2ctsql must be also set to yes.", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "yes", - "no" - ] - }, - "defaultValue": "no", - "group": "Options", - "aliases": [] - }, - { - "name": "db2hvloc", - "description": "Indicates whether the Requestor Location option is enabled for DB2 measurements.", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "yes", - "no" - ] - }, - "defaultValue": "no", - "group": "Options", - "aliases": [] - }, - { - "name": "db2hvcor", - "description": "Indicates whether the Correlation ID option for SQL statements is enabled for DB2 measurements.", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "yes", - "no" - ] - }, - "defaultValue": "no", - "group": "Options", - "aliases": [] - }, - { - "name": "db2hviid", - "description": "Indicates whether the Operator ID option for SQL statements is enabled for DB2 measurements.", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "yes", - "no" - ] - }, - "defaultValue": "no", - "group": "Options", - "aliases": [] - }, - { - "name": "db2hvthd", - "description": "Indicates whether the Thread Address option for SQL statements is enabled for DB2 measurements.", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "yes", - "no" - ] - }, - "defaultValue": "no", - "group": "Options", - "aliases": [] - }, - { - "name": "wasexprt", - "description": "Indicates whether the Expert Mode is enabled for Java measurement.", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "yes", - "no" - ] - }, - "defaultValue": "no", - "group": "Options", - "aliases": [] - }, - { - "name": "urlfilt", - "description": "A filtering string to restrict monitoring to the specific application URL, transaction, or stored procedure for Java measurements. Values: a comma separated list of up to 4 values is allowed, max. 64 characters (e.g. mypage1.html,mypage2.html).", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "sysfilt", - "description": "A filtering string to include the specified system class for Java measurements. If you specify a value for sysfilt, the measurement includes only the classes that match the filtering string pattern. Values: a comma separated list of up to 3 values is allowed, max. 64 characters (e.g. user1.class,user2.class).", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "schedule", - "description": "Specifies the name of the schedule that you want to apply to the monitor profile (maximum 8 characters).", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies the protocol defined for the MAT REST API server (http or https).", - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "defaultValue": "https", - "group": "MAT Profile Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the server port (e.g. 8080).", - "type": "number", - "group": "MAT Profile Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Your mainframe username.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "password", - "aliases": [ - "pw" - ], - "description": "Your mainframe password.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "MAT Profile Options" - }, - { - "name": "listingDir", - "aliases": [ - "ldir" - ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", - "type": "string", - "required": false, - "group": "MAT Profile Options" - }, - { - "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": "mat-profile", - "aliases": [ - "mat-p" - ], - "group": "Profile Options", - "description": "The name of a (mat) 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": "Create the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system", - "options": "--profile PROFILE1 --jobname JOB1 --targsys AA31" - }, - { - "description": "Create the PROFILE1 monitor profile to measure for 90 seconds job JOB1 that runs on the AA31 and AA32 systems", - "options": "--profile PROFILE1 --jobname JOB1 --targsys AA31,AA32 --elapstime 90s" - }, - { - "description": "Create the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system, with the specific MAT profile details defined", - "options": "--profile PROFILE1 --jobname JOB1 --targsys AA31 --host \"example.com\" --port 12345 --user johndoe --password qwerty" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "list", - "aliases": [ - "lip" - ], - "summary": "Get the list of monitor profiles", - "description": "Get the list of available monitor profiles.", - "handler": "", - "type": "command", - "profile": { - "optional": [ - "mat", - "base" - ] - }, - "options": [ - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies the protocol defined for the MAT REST API server (http or https).", - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "defaultValue": "https", - "group": "MAT Profile Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the server port (e.g. 8080).", - "type": "number", - "group": "MAT Profile Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Your mainframe username.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "password", - "aliases": [ - "pw" - ], - "description": "Your mainframe password.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "MAT Profile Options" - }, - { - "name": "listingDir", - "aliases": [ - "ldir" - ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", - "type": "string", - "required": false, - "group": "MAT Profile Options" - }, - { - "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": "mat-profile", - "aliases": [ - "mat-p" - ], - "group": "Profile Options", - "description": "The name of a (mat) 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": [] - } - ], - "positionals": [], - "passOn": [], - "children": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies the protocol defined for the MAT REST API server (http or https).", - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "defaultValue": "https", - "group": "MAT Profile Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the server port (e.g. 8080).", - "type": "number", - "group": "MAT Profile Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Your mainframe username.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "password", - "aliases": [ - "pw" - ], - "description": "Your mainframe password.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "MAT Profile Options" - }, - { - "name": "listingDir", - "aliases": [ - "ldir" - ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", - "type": "string", - "required": false, - "group": "MAT Profile Options" - } - ], - "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": [] - } - ], - "summary": "Manage monitor profiles and analyze the measurement data using MAT", - "aliases": [ - "mat" - ], - "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/omspool.jsonc b/commandGroups/omspool.jsonc deleted file mode 100644 index 0e5aaee..0000000 --- a/commandGroups/omspool.jsonc +++ /dev/null @@ -1,544 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "omspool", - "description": "Interact with Spool™", - "type": "group", - "children": [ - { - "name": "issue", - "aliases": [ - "is" - ], - "summary": "Issue Spool commands.", - "description": "Issue Spool commands.", - "type": "group", - "children": [ - { - "name": "command", - "aliases": [ - "cmd" - ], - "summary": "Issue commands to work with Spool.", - "description": "Issue commands to work with Spool.", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "omspool", - "zosmf", - "base" - ] - }, - "positionals": [ - { - "name": "command-text", - "type": "string", - "description": "The Spool command to issue.", - "required": true - } - ], - "examples": [ - { - "description": "Issue the 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": "SPOOL OPTIONS" - }, - { - "description": "High level qualifier of Spool installation.", - "type": "string", - "name": "spoolhlq", - "aliases": [ - "hlq" - ], - "stringLengthRange": [ - 1, - 35 - ], - "required": true, - "group": "SPOOL OPTIONS" - }, - { - "description": "Spool subsystem name.", - "type": "string", - "name": "subsys", - "aliases": [ - "sub" - ], - "stringLengthRange": [ - 1, - 4 - ], - "defaultValue": "ESF", - "group": "SPOOL OPTIONS" - }, - { - "description": "The SYSTSPRT data set allocated by CAI.CBQ4JCL(BQ4JZOWE). It must be unique for each Zowe CLI user interacting with Spool.", - "type": "string", - "name": "outds", - "aliases": [ - "out" - ], - "stringLengthRange": [ - 1, - 44 - ], - "required": true, - "group": "SPOOL OPTIONS" - }, - { - "description": "The data set containing ESFZOWE REXX exec.", - "type": "string", - "name": "clist", - "aliases": [ - "cl" - ], - "stringLengthRange": [ - 1, - 44 - ], - "required": true, - "group": "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": "SPOOL OPTIONS" - }, - { - "description": "High level qualifier of Spool installation.", - "type": "string", - "name": "spoolhlq", - "aliases": [ - "hlq" - ], - "stringLengthRange": [ - 1, - 35 - ], - "required": true, - "group": "SPOOL OPTIONS" - }, - { - "description": "Spool subsystem name.", - "type": "string", - "name": "subsys", - "aliases": [ - "sub" - ], - "stringLengthRange": [ - 1, - 4 - ], - "defaultValue": "ESF", - "group": "SPOOL OPTIONS" - }, - { - "description": "The SYSTSPRT data set allocated by CAI.CBQ4JCL(BQ4JZOWE). It must be unique for each Zowe CLI user interacting with Spool.", - "type": "string", - "name": "outds", - "aliases": [ - "out" - ], - "stringLengthRange": [ - 1, - 44 - ], - "required": true, - "group": "SPOOL OPTIONS" - }, - { - "description": "The data set containing ESFZOWE REXX exec.", - "type": "string", - "name": "clist", - "aliases": [ - "cl" - ], - "stringLengthRange": [ - 1, - 44 - ], - "required": true, - "group": "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": "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 deleted file mode 100644 index 3262689..0000000 --- a/commandGroups/ops.jsonc +++ /dev/null @@ -1,1965 +0,0 @@ -// 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": "disable", - "summary": "Disable OPS/MVS rules.", - "description": "Disable OPS/MVS rules.", - "type": "group", - "children": [ - { - "name": "rule", - "aliases": [], - "summary": "Disable the specified rule.", - "description": "Disable the specified rule.", - "examples": [ - { - "options": "OPSRULES MYRULE --subsystem OPSS", - "description": "Disable MYRULE on ruleset OPSRULES on subsystem OPSS." - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ops", - "base" - ] - }, - "positionals": [ - { - "name": "ruleset", - "type": "string", - "description": "The rule set 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 used to authenticate to OPS Web Services", - "type": "string", - "name": "user", - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS", - "aliases": [] - }, - { - "description": "Your z/OS password used to authenticate to OPS Web Services", - "type": "string", - "name": "password", - "aliases": [ - "pass" - ], - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "The hostname of the server where OPS Web Services is running.", - "type": "string", - "name": "host", - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS", - "aliases": [] - }, - { - "description": "The port number for OPS Web Services.", - "type": "number", - "name": "port", - "aliases": [ - "p" - ], - "required": false, - "group": "OPS WEB SERVICES 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 WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "The protocol used for connecting to OPS Web Services", - "type": "string", - "name": "protocol", - "aliases": [ - "prot" - ], - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "required": true, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.", - "type": "string", - "name": "subsystem", - "aliases": [ - "subs" - ], - "group": "OPS WEB SERVICES 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 used to authenticate to OPS Web Services", - "type": "string", - "name": "user", - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "Your z/OS password used to authenticate to OPS Web Services", - "type": "string", - "name": "password", - "aliases": [ - "pass" - ], - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "The hostname of the server where OPS Web Services is running.", - "type": "string", - "name": "host", - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "The port number for OPS Web Services.", - "type": "number", - "name": "port", - "aliases": [ - "p" - ], - "required": false, - "group": "OPS WEB SERVICES 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 WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "The protocol used for connecting to OPS Web Services", - "type": "string", - "name": "protocol", - "aliases": [ - "prot" - ], - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "required": true, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.", - "type": "string", - "name": "subsystem", - "aliases": [ - "subs" - ], - "group": "OPS WEB SERVICES 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": "Enables OPS/MVS rules.", - "description": "Enables OPS/MVS rules.This will cause SSM to take the necessary action to enable that 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 MYRULE on ruleset OPSRULES on subsystem OPSS." - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ops", - "base" - ] - }, - "positionals": [ - { - "name": "ruleset", - "type": "string", - "description": "The rule set 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 used to authenticate to OPS Web Services", - "type": "string", - "name": "user", - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS", - "aliases": [] - }, - { - "description": "Your z/OS password used to authenticate to OPS Web Services", - "type": "string", - "name": "password", - "aliases": [ - "pass" - ], - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "The hostname of the server where OPS Web Services is running.", - "type": "string", - "name": "host", - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS", - "aliases": [] - }, - { - "description": "The port number for OPS Web Services.", - "type": "number", - "name": "port", - "aliases": [ - "p" - ], - "required": false, - "group": "OPS WEB SERVICES 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 WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "The protocol used for connecting to OPS Web Services", - "type": "string", - "name": "protocol", - "aliases": [ - "prot" - ], - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "required": true, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.", - "type": "string", - "name": "subsystem", - "aliases": [ - "subs" - ], - "group": "OPS WEB SERVICES 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 used to authenticate to OPS Web Services", - "type": "string", - "name": "user", - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "Your z/OS password used to authenticate to OPS Web Services", - "type": "string", - "name": "password", - "aliases": [ - "pass" - ], - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "The hostname of the server where OPS Web Services is running.", - "type": "string", - "name": "host", - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "The port number for OPS Web Services.", - "type": "number", - "name": "port", - "aliases": [ - "p" - ], - "required": false, - "group": "OPS WEB SERVICES 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 WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "The protocol used for connecting to OPS Web Services", - "type": "string", - "name": "protocol", - "aliases": [ - "prot" - ], - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "required": true, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.", - "type": "string", - "name": "subsystem", - "aliases": [ - "subs" - ], - "group": "OPS WEB SERVICES 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 (for example, rules or SSM resources).", - "description": "Display data associated with OPS/MVS automation elements (for example, rules or SSM resources).", - "type": "group", - "children": [ - { - "name": "resource", - "aliases": [], - "summary": "Display data associated with the specified SSM resource.", - "description": "Display data associated with the specified SSM resource. Currently, only resource state is displayed.", - "examples": [ - { - "options": "RESOURCE1 --tablename MYTABLE --subsystem OPSS", - "description": "Show current and desired state of RESOURCE1 on table MYTABLE on subsystem OPSS." - } - ], - "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 will search the SSM tables to find the resource. If the resource exists in multiple tables, the desired state of the resource will be set to the appropriate DOWN state in all the tables where the resource exists. ", - "required": false, - "aliases": [ - "table" - ], - "stringLengthRange": [ - 1, - 18 - ], - "group": "Options" - }, - { - "description": "Your z/OS user name used to authenticate to OPS Web Services", - "type": "string", - "name": "user", - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS", - "aliases": [] - }, - { - "description": "Your z/OS password used to authenticate to OPS Web Services", - "type": "string", - "name": "password", - "aliases": [ - "pass" - ], - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "The hostname of the server where OPS Web Services is running.", - "type": "string", - "name": "host", - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS", - "aliases": [] - }, - { - "description": "The port number for OPS Web Services.", - "type": "number", - "name": "port", - "aliases": [ - "p" - ], - "required": false, - "group": "OPS WEB SERVICES 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 WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "The protocol used for connecting to OPS Web Services", - "type": "string", - "name": "protocol", - "aliases": [ - "prot" - ], - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "required": true, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.", - "type": "string", - "name": "subsystem", - "aliases": [ - "subs" - ], - "group": "OPS WEB SERVICES 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. Currently, only rule status is displayed.", - "examples": [ - { - "options": "OPSRULES MYRULE --subsystem OPSS", - "description": "Show the status of MYRULE on ruleset OPSRULES on subsystem OPSS" - } - ], - "type": "command", - "handler": "", - "profile": { - "optional": [ - "ops", - "base" - ] - }, - "positionals": [ - { - "name": "ruleset", - "type": "string", - "description": "The rule set 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 used to authenticate to OPS Web Services", - "type": "string", - "name": "user", - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS", - "aliases": [] - }, - { - "description": "Your z/OS password used to authenticate to OPS Web Services", - "type": "string", - "name": "password", - "aliases": [ - "pass" - ], - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "The hostname of the server where OPS Web Services is running.", - "type": "string", - "name": "host", - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS", - "aliases": [] - }, - { - "description": "The port number for OPS Web Services.", - "type": "number", - "name": "port", - "aliases": [ - "p" - ], - "required": false, - "group": "OPS WEB SERVICES 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 WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "The protocol used for connecting to OPS Web Services", - "type": "string", - "name": "protocol", - "aliases": [ - "prot" - ], - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "required": true, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.", - "type": "string", - "name": "subsystem", - "aliases": [ - "subs" - ], - "group": "OPS WEB SERVICES 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 used to authenticate to OPS Web Services", - "type": "string", - "name": "user", - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "Your z/OS password used to authenticate to OPS Web Services", - "type": "string", - "name": "password", - "aliases": [ - "pass" - ], - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "The hostname of the server where OPS Web Services is running.", - "type": "string", - "name": "host", - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "The port number for OPS Web Services.", - "type": "number", - "name": "port", - "aliases": [ - "p" - ], - "required": false, - "group": "OPS WEB SERVICES 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 WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "The protocol used for connecting to OPS Web Services", - "type": "string", - "name": "protocol", - "aliases": [ - "prot" - ], - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "required": true, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.", - "type": "string", - "name": "subsystem", - "aliases": [ - "subs" - ], - "group": "OPS WEB SERVICES 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": "Starts an ssm resource in OPS/MVS", - "description": "Start OPS/MVS resources.", - "type": "group", - "children": [ - { - "name": "resource", - "aliases": [], - "summary": "Start the specified resource.", - "description": "Start the specified resource. The desired state of the resource willbe set to the appropriate UP state and SSM will take actions to start the resource.", - "examples": [ - { - "options": "RESOURCE1 --tablename MYTABLE --subsystem OPSS", - "description": "Start RESOURCE1 on table MYTABLE on subsystem OPSS." - }, - { - "options": "RESOURCE1 --tablename MYTABLE --subsystem OPSS -w 120", - "description": "Start RESOURCE1 on table MYTABLE on subsystem OPSS 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 - ] - } - ], - "options": [ - { - "name": "tablename", - "type": "string", - "description": "The name of the table that contains the resource. If not specified, the command will search the SSM tables to find the resource. If the resource exists in multiple tables, the desired state of the resource will be set to the appropriate DOWN state in all the tables where the resource exists. ", - "required": false, - "aliases": [ - "table" - ], - "stringLengthRange": [ - 1, - 18 - ], - "group": "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 state still do not match, the command will fail with a timeout error.", - "required": false, - "numericValueRange": [ - 1, - 86400 - ], - "group": "Options" - }, - { - "description": "Your z/OS user name used to authenticate to OPS Web Services", - "type": "string", - "name": "user", - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS", - "aliases": [] - }, - { - "description": "Your z/OS password used to authenticate to OPS Web Services", - "type": "string", - "name": "password", - "aliases": [ - "pass" - ], - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "The hostname of the server where OPS Web Services is running.", - "type": "string", - "name": "host", - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS", - "aliases": [] - }, - { - "description": "The port number for OPS Web Services.", - "type": "number", - "name": "port", - "aliases": [ - "p" - ], - "required": false, - "group": "OPS WEB SERVICES 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 WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "The protocol used for connecting to OPS Web Services", - "type": "string", - "name": "protocol", - "aliases": [ - "prot" - ], - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "required": true, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.", - "type": "string", - "name": "subsystem", - "aliases": [ - "subs" - ], - "group": "OPS WEB SERVICES 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 used to authenticate to OPS Web Services", - "type": "string", - "name": "user", - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "Your z/OS password used to authenticate to OPS Web Services", - "type": "string", - "name": "password", - "aliases": [ - "pass" - ], - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "The hostname of the server where OPS Web Services is running.", - "type": "string", - "name": "host", - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "The port number for OPS Web Services.", - "type": "number", - "name": "port", - "aliases": [ - "p" - ], - "required": false, - "group": "OPS WEB SERVICES 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 WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "The protocol used for connecting to OPS Web Services", - "type": "string", - "name": "protocol", - "aliases": [ - "prot" - ], - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "required": true, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.", - "type": "string", - "name": "subsystem", - "aliases": [ - "subs" - ], - "group": "OPS WEB SERVICES 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 OPS/MVS resources.", - "description": "Stop OPS/MVS resources.", - "type": "group", - "children": [ - { - "name": "resource", - "aliases": [], - "summary": "Stop the specified resource.", - "description": "Stop the specified resource. The desired state of the resource willbe set to the appropriate DOWN state and SSM will take actions to start the resource.", - "examples": [ - { - "options": "RESOURCE1 --tablename MYTABLE --subsystem OPSS", - "description": "Stop RESOURCE1 on table MYTABLE on subsystem OPSS." - }, - { - "options": "RESOURCE1 --tablename MYTABLE --subsystem OPSS -w 120", - "description": "Start RESOURCE1 on table MYTABLE on subsystem OPSS 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 - ] - } - ], - "options": [ - { - "name": "tablename", - "type": "string", - "description": "The name of the table that contains the resource. If not specified, the command will search the SSM tables to find the resource. If the resource exists in multiple tables, the desired state of the resource will be set to the appropriate DOWN state in all the tables where the resource exists. ", - "required": false, - "aliases": [ - "table" - ], - "stringLengthRange": [ - 1, - 18 - ], - "group": "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 state still do not match, the command will fail with a timeout error.", - "required": false, - "numericValueRange": [ - 1, - 86400 - ], - "group": "Options" - }, - { - "description": "Your z/OS user name used to authenticate to OPS Web Services", - "type": "string", - "name": "user", - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS", - "aliases": [] - }, - { - "description": "Your z/OS password used to authenticate to OPS Web Services", - "type": "string", - "name": "password", - "aliases": [ - "pass" - ], - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "The hostname of the server where OPS Web Services is running.", - "type": "string", - "name": "host", - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS", - "aliases": [] - }, - { - "description": "The port number for OPS Web Services.", - "type": "number", - "name": "port", - "aliases": [ - "p" - ], - "required": false, - "group": "OPS WEB SERVICES 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 WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "The protocol used for connecting to OPS Web Services", - "type": "string", - "name": "protocol", - "aliases": [ - "prot" - ], - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "required": true, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.", - "type": "string", - "name": "subsystem", - "aliases": [ - "subs" - ], - "group": "OPS WEB SERVICES 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 used to authenticate to OPS Web Services", - "type": "string", - "name": "user", - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "Your z/OS password used to authenticate to OPS Web Services", - "type": "string", - "name": "password", - "aliases": [ - "pass" - ], - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "The hostname of the server where OPS Web Services is running.", - "type": "string", - "name": "host", - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "The port number for OPS Web Services.", - "type": "number", - "name": "port", - "aliases": [ - "p" - ], - "required": false, - "group": "OPS WEB SERVICES 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 WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "The protocol used for connecting to OPS Web Services", - "type": "string", - "name": "protocol", - "aliases": [ - "prot" - ], - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "required": true, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.", - "type": "string", - "name": "subsystem", - "aliases": [ - "subs" - ], - "group": "OPS WEB SERVICES 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/rse-api-for-zowe-cli.jsonc b/commandGroups/rse-api-for-zowe-cli.jsonc deleted file mode 100644 index d708a13..0000000 --- a/commandGroups/rse-api-for-zowe-cli.jsonc +++ /dev/null @@ -1,13138 +0,0 @@ -// Copyright IBM Corporation 2020, 2024. All Rights Reserved. -{ - "name": "rse-api-for-zowe-cli", - "description": "Welcome to the IBM RSE API Plug-in for Zowe CLI!\n\n", - "type": "group", - "children": [ - { - "name": "auth", - "summary": "Connect to RSE API Server Authentication Service", - "description": "Connect to the RSE API Server authentication service and obtain a token. The token provides authentication to services that are supported by the RSE API. When you log in, the token is stored in your profile until it expires. Profiles store connection information, and are used if you do not supply connection information in a command. To take advantage of the token authentication service, you should omit username and password in profiles so that the token in the profile is used.", - "type": "group", - "children": [ - { - "name": "login", - "aliases": [ - "li" - ], - "summary": "Log in to an authentication service to obtain a JWT Token.", - "description": "Log in to an authentication service to obtain a JWT Token.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "rse" - ], - "optional": [ - "base" - ] - }, - "examples": [ - { - "description": "Obtain token by logging into an authentication service if username and password are not saved locally.", - "options": "--user IBMUSER --password PASSWORD" - } - ], - "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": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [], - "passOn": [], - "children": [] - }, - { - "name": "refreshToken", - "aliases": [ - "rt" - ], - "summary": "Refresh the current session and obtain a newer JWT Token.", - "description": "Refresh the current session and obtain a newer JWT Token.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "rse" - ], - "optional": [ - "base" - ] - }, - "examples": [ - { - "description": "Extend a remote session beyond the timeout period of a JWT token.", - "options": " (after login)" - } - ], - "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": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [], - "passOn": [], - "children": [] - }, - { - "name": "logout", - "aliases": [ - "lo" - ], - "summary": "Log out of the authentication service and retire the JWT Token", - "description": "Log out of the authentication service and retire the JWT Token", - "type": "command", - "handler": "", - "profile": { - "required": [ - "rse" - ], - "optional": [ - "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": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [], - "passOn": [], - "children": [] - }, - { - "name": "query", - "aliases": [ - "q" - ], - "summary": "Get back JWT Token information if it is not yet expired.", - "description": "Get back JWT Token information if it is not yet expired.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "rse" - ], - "optional": [ - "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": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [], - "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": "cancel", - "aliases": [ - "can" - ], - "type": "group", - "summary": "Cancel a job", - "description": "Cancel a single job by job ID. This cancels the job if it is running or on input.", - "children": [ - { - "name": "job", - "type": "command", - "summary": "Cancel a single job by job ID", - "description": "Cancel a single job by job ID", - "handler": "", - "profile": { - "optional": [ - "rse", - "base" - ] - }, - "positionals": [ - { - "name": "jobid", - "description": "The job ID (e.g. JOB00123) of the job. Job ID is a unique identifier for z/OS batch jobs -- no two jobs on one system can have the same ID. Note: z/OS allows you to abbreviate the job ID if desired. You can use, for example \"J123\".", - "type": "string", - "required": true - } - ], - "examples": [ - { - "description": "Cancel job with job ID JOB03456", - "options": "JOB03456" - } - ], - "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": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [] - } - ], - "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" - } - ], - "positionals": [], - "passOn": [] - }, - { - "name": "change", - "summary": "Change User Data on the Host", - "description": "Change User Data on the Host", - "type": "group", - "children": [ - { - "name": "password", - "aliases": [ - "pass" - ], - "summary": "Change z/OS User Password on the Host. User will be prompted for user name, password, and new password.", - "description": "Change z/OS User Password on the Host. User will be prompted for user name, password, and new password.", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "currentPassword", - "description": "Current password for z/OS User ID.", - "type": "string", - "required": false - }, - { - "name": "newPassword", - "description": "New password for z/OS User ID. Must be 8 characters or less.", - "type": "string", - "required": false - } - ], - "examples": [ - { - "description": "Change Password", - "options": "currentPassword newPassword" - } - ], - "profile": { - "required": [ - "rse" - ], - "optional": [ - "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": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [] - }, - { - "name": "properties", - "aliases": [ - "prop" - ], - "summary": "Change owner and permissions for a unix file", - "description": "Change owner and permissions for a unix file", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "file", - "description": "the file that will have its properties changed.", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "owner", - "aliases": [ - "o" - ], - "description": "the new owner for the file.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "group", - "aliases": [ - "g" - ], - "description": "the new group for the file.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "permissions", - "aliases": [ - "p" - ], - "description": "the new permissions for the file.", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "tag", - "aliases": [ - "t" - ], - "description": "the new tag for the file", - "type": "string", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [ - { - "description": "Change Properties", - "options": "'/u/example/file123.txt' --owner exampleOwner --group exampleGroup --permission rwxrwxrwx --tag utf8" - } - ], - "profile": { - "required": [ - "rse" - ], - "optional": [ - "base" - ] - }, - "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": "check", - "summary": "Confirm that RSE API is running on a specified system and gather information about the RSE API server and Address Space for diagnostic purposes, and information about user password expiry. Obtain and update MVS mappings file", - "description": "Confirm that RSE API is running on a specified system and gather information about the RSE API server and Address Space for diagnostic purposes, and information about user password expiry. Obtain and update MVS mappings file", - "type": "group", - "children": [ - { - "name": "status", - "summary": "Confirm that RSE API is running on a system specified in your profile and gather information about the RSE API server for diagnostic purposes. The command outputs properties of the RSE API server such as version, hostname, and the port the server is running.", - "description": "Confirm that RSE API is running on a system specified in your profile and gather information about the RSE API server for diagnostic purposes. The command outputs properties of the RSE API server such as version, hostname, and the port the server is running.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "rse" - ], - "optional": [ - "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": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [] - } - ], - "aliases": [], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "conversion-mappings", - "aliases": [ - "maps" - ], - "summary": "Download MVS mapping file.", - "description": "Download MVS mapping file.", - "type": "command", - "handler": "", - "options": [ - { - "name": "force", - "description": "This will overwrite an existing rse-mappings.json file.", - "type": "boolean", - "group": "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": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [] - } - ], - "profile": { - "required": [ - "rse" - ], - "optional": [ - "base" - ] - }, - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "system-address-space", - "aliases": [ - "sys" - ], - "summary": "Display active system address space information.", - "description": "Display active system address space information.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "rse" - ], - "optional": [ - "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": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [], - "passOn": [], - "children": [] - }, - { - "name": "job-address-space", - "aliases": [ - "jobs" - ], - "summary": "Display all active job address space information.", - "description": "Display all active job address space information.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "rse" - ], - "optional": [ - "base" - ] - }, - "options": [ - { - "name": "asid", - "description": "Address space identifier.", - "type": "boolean", - "group": "Options", - "aliases": [] - }, - { - "name": "asidx", - "description": "Address space identifier in hexadecimal.", - "type": "boolean", - "group": "Options", - "aliases": [] - }, - { - "name": "bytes", - "description": "Current real storage usage in bytes.", - "type": "boolean", - "group": "Options", - "aliases": [] - }, - { - "name": "cpu", - "description": "Accumulated CPU time consumed by and on behalf of and within the A/S, for the current job step, in microseconds (local + remote + external).", - "type": "boolean", - "group": "Options", - "aliases": [] - }, - { - "name": "cpu%", - "description": "Percent of all CPU time consumed by and on behalf of the address space during the most recent interval measured.", - "type": "boolean", - "group": "Options", - "aliases": [] - }, - { - "name": "description", - "description": "Address space position description.", - "type": "boolean", - "group": "Options", - "aliases": [] - }, - { - "name": "dp", - "description": "Address space dispatching priority in hexadecimal.", - "type": "boolean", - "group": "Options", - "aliases": [] - }, - { - "name": "elapsed", - "description": "Elapsed time the transaction has been active.", - "type": "boolean", - "group": "Options", - "aliases": [] - }, - { - "name": "frames", - "description": "Current utilization of real storage in frames.", - "type": "boolean", - "group": "Options", - "aliases": [] - }, - { - "name": "hvcomhwm", - "description": "High virtual common memory high-water mark in MB.", - "type": "boolean", - "group": "Options", - "aliases": [] - }, - { - "name": "hvcomused", - "description": "High virtual common memory size in MB.", - "type": "boolean", - "group": "Options", - "aliases": [] - }, - { - "name": "io", - "description": "EXCP rate in EXCPs per second for address space.", - "type": "boolean", - "group": "Options", - "aliases": [] - }, - { - "name": "name", - "description": "Job name.", - "type": "boolean", - "group": "Options", - "aliases": [] - }, - { - "name": "page", - "description": "Demand paging rate for address space.", - "type": "boolean", - "group": "Options", - "aliases": [] - }, - { - "name": "position", - "description": "Address space position.", - "type": "boolean", - "group": "Options", - "aliases": [] - }, - { - "name": "stepIO", - "description": "A/S EXCP (I/O) count for the current job step.", - "type": "boolean", - "group": "Options", - "aliases": [] - }, - { - "name": "subtype", - "description": "Sub-type of 1.job/initiator: JES, z/OS UNIX, or APPC, 2.started task: JES, MSTR, SYS.", - "type": "boolean", - "group": "Options", - "aliases": [] - }, - { - "name": "swapin", - "description": "Swapped-in state.", - "type": "boolean", - "group": "Options", - "aliases": [] - }, - { - "name": "sysName", - "description": "System name where job is executing.", - "type": "boolean", - "group": "Options", - "aliases": [] - }, - { - "name": "task", - "description": "A/S CPU usage % of system total in interval - task (local + remote).", - "type": "boolean", - "group": "Options", - "aliases": [] - }, - { - "name": "task%", - "description": "Accumulated CPU time consumed by and on behalf of the A/S, for the current job step, in microseconds (local + remote).", - "type": "boolean", - "group": "Options", - "aliases": [] - }, - { - "name": "type", - "description": "Type of address space.", - "type": "boolean", - "group": "Options", - "aliases": [] - }, - { - "name": "userId", - "description": "User id of owner.", - "type": "boolean", - "group": "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": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [ - { - "description": "Display all active job address space information using filters for information to be shown", - "options": "--asid --dp" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "password-expiry", - "aliases": [ - "expiry" - ], - "summary": "Displays expiration date of user id's password.", - "description": "Displays expiration date of user id's password.", - "type": "command", - "handler": "", - "profile": { - "required": [ - "rse" - ], - "optional": [ - "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": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [], - "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": "common-properties", - "aliases": [ - "cm" - ], - "summary": "Manage Common Properites", - "description": "Manage Common Properties on z/OS RSE API server.", - "type": "group", - "children": [ - { - "name": "copy", - "aliases": [ - "cp" - ], - "summary": "Copy a namespace", - "description": "Copy a Common Properties namespace.", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "fromNamespaceName", - "type": "string", - "description": "The name of the Common Properties namespace that you want to copy from.", - "required": true - }, - { - "name": "toNamespaceName", - "type": "string", - "description": "The name of the Common Properties namespace that you want to copy to.", - "required": true - } - ], - "options": [ - { - "name": "private", - "aliases": [], - "description": "The namespace is a private Common Properties namespace if specified.", - "type": "boolean", - "defaultValue": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [] - } - ], - "profile": { - "required": [ - "rse" - ], - "optional": [ - "base" - ] - }, - "examples": [ - { - "description": "copy a public namespace", - "options": "my-namespace your-namespace" - }, - { - "description": "copy a private namespace", - "options": "my-namespace your-namespace --private" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "create", - "aliases": [ - "cre" - ], - "summary": "Create a namespace", - "description": "Create a Common Properties namespace.", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "namespaceName", - "type": "string", - "description": "The name of the Common Properties namespace.", - "required": true - } - ], - "options": [ - { - "name": "private", - "aliases": [], - "description": "The namespace is a private Common Properties namespace if specified.", - "type": "boolean", - "defaultValue": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [] - } - ], - "profile": { - "required": [ - "rse" - ], - "optional": [ - "base" - ] - }, - "examples": [ - { - "description": "Create a public namespace called \"global-namespace\"", - "options": "\"global-namespace\"" - }, - { - "description": "Create a user private namespace called \"private-namespace\"", - "options": "\"private-namespace\" --private" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "delete", - "aliases": [ - "del" - ], - "summary": "Delete the namespace or a property in the namespace", - "description": "Delete the namespace or a property in the namespace if --path option is specified.", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "namespaceName", - "type": "string", - "description": "The name of the Common Properties namespace.", - "required": true - } - ], - "options": [ - { - "name": "path", - "aliases": [ - "p" - ], - "description": "The path to the property in the Common Properties namespace.", - "type": "string", - "group": "Options" - }, - { - "name": "private", - "aliases": [], - "description": "The namespace is a private Common Properties namespace if specified.", - "type": "boolean", - "defaultValue": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [] - } - ], - "profile": { - "required": [ - "rse" - ], - "optional": [ - "base" - ] - }, - "examples": [ - { - "description": "Delete a private namespace", - "options": "\"private-namespace\" --private" - }, - { - "description": "Detete a property in a namespace", - "options": "\"global-namespace\" -p /root/portnumber" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "list", - "aliases": [ - "ls" - ], - "summary": "List all namespaces", - "description": "List all public or private Common Properties namespaces.", - "type": "command", - "handler": "", - "options": [ - { - "name": "private", - "aliases": [], - "description": "The namespace is a private Common Properties namespace if specified.", - "type": "boolean", - "defaultValue": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [] - } - ], - "profile": { - "required": [ - "rse" - ], - "optional": [ - "base" - ] - }, - "examples": [ - { - "description": "list all public Common Properties namespaces", - "options": "" - }, - { - "description": "list all private Common Properties namespaces", - "options": "--private" - } - ], - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "rename", - "aliases": [], - "summary": "Rename a namespace", - "description": "Rename a Common Properties namespace.", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "beforeNamespaceName", - "type": "string", - "description": "The name of the Common Properties namespace that you want to rename.", - "required": true - }, - { - "name": "afterNamespaceName", - "type": "string", - "description": "The name you want to rename the Common Properties namespace to.", - "required": true - } - ], - "options": [ - { - "name": "private", - "aliases": [], - "description": "The namespace is a private Common Properties namespace if specified.", - "type": "boolean", - "defaultValue": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [] - } - ], - "profile": { - "required": [ - "rse" - ], - "optional": [ - "base" - ] - }, - "examples": [ - { - "description": "rename a public namespace", - "options": "my-namespace your-namespace" - }, - { - "description": "rename a private namespace", - "options": "my-namespace your-namespace --private" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "set", - "aliases": [], - "summary": "Set a namespace property", - "description": "Set a namespace property with a string, boolean, number or JSON string value.", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "namespaceName", - "type": "string", - "description": "The name of the Common Properties namespace.", - "required": true - }, - { - "name": "propertyPath", - "type": "string", - "description": "The path to the property in the Common Properties namespace.", - "required": true - }, - { - "name": "propertyValue", - "type": "string", - "description": "The property value.", - "required": true - } - ], - "options": [ - { - "name": "private", - "aliases": [], - "description": "The namespace is a private Common Properties namespace if specified.", - "type": "boolean", - "defaultValue": false, - "group": "Options" - }, - { - "name": "value-type", - "aliases": [ - "type" - ], - "description": "The property value type (string, number, boolean, json)", - "type": "string", - "defaultValue": "string", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [] - } - ], - "profile": { - "required": [ - "rse" - ], - "optional": [ - "base" - ] - }, - "examples": [ - { - "description": "set a string value to a property", - "options": "my-namespace /server/hostname www.host.com " - }, - { - "description": "set a number value to a property", - "options": "my-namespace /server/port 1234 --type number" - }, - { - "description": "set a JSON value to a property", - "options": "my-namespace /server '{\"hostname\" : \"www.host.com\", \"port\" : 1234}' --type json" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "view", - "aliases": [ - "vw" - ], - "summary": "View the namespace or a property in the namespace", - "description": "View the namespace or a property in the namespace if --path option is specified.", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "namespaceName", - "type": "string", - "description": "The name of the Common Properties namespace.", - "required": true - } - ], - "options": [ - { - "name": "path", - "aliases": [ - "p" - ], - "description": "The path to the property in the Common Properties namespace.", - "type": "string", - "defaultValue": "/", - "group": "Options" - }, - { - "name": "private", - "aliases": [], - "description": "The namespace is a private Common Properties namespace if specified.", - "type": "boolean", - "defaultValue": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [] - } - ], - "profile": { - "required": [ - "rse" - ], - "optional": [ - "base" - ] - }, - "examples": [ - { - "description": "View a property at the path in a private namespace", - "options": "my-namespace --path /hostname --private" - }, - { - "description": "View all properties in a public namespace", - "options": "my-namespace" - } - ], - "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" - } - ], - "positionals": [], - "passOn": [] - }, - { - "name": "copy", - "summary": "Copy a z/OS UNIX System Services file/directory or data set", - "description": "Copy a z/OS UNIX System Services file/directory or data set", - "type": "group", - "children": [ - { - "name": "data-set", - "aliases": [ - "ds" - ], - "summary": "Copy a data set to another data set", - "description": "Copy a data set to another data set", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "fromDataSetName", - "description": "The name of the data set that you want to copy from", - "type": "string", - "required": true - }, - { - "name": "toDataSetName", - "description": "The name of the data set that you want to copy to (partitioned data set must be preallocated to copy a member to)", - "type": "string", - "required": true - } - ], - "examples": [ - { - "description": "Copy the data set member named 'USER.FROM.SET(MEM1)' to the data set member named 'USER.TO.SET(MEM2)'", - "options": "\"USER.FROM.SET(mem1)\" \"USER.TO.SET(mem2)\"" - }, - { - "description": "Copy the sequential data set named 'USER.FROM.PDSE' to the data set member named 'USER.TO.SETPDSE'", - "options": "\"USER.FROM.PDSE\" \"USER.TO.SETPDSE\"" - } - ], - "profile": { - "required": [ - "rse" - ], - "optional": [ - "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": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [] - }, - { - "name": "uss-file", - "aliases": [ - "uss" - ], - "summary": "Copy a z/OS UNIX System Services file/directory to another directory", - "description": "Copy a z/OS UNIX System Services file/directory to another directory", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "path", - "description": "The working directory", - "type": "string", - "required": true - }, - { - "name": "destination", - "description": "The destination path of the new file to be appended to the parent path", - "type": "string", - "required": true - } - ], - "examples": [ - { - "description": "Copy the file named '/u/example1/test.txt' to the destination '/u/example2/test.txt'", - "options": "\"/u/example1/test.txt\" \"/u/example2/test.txt\"" - }, - { - "description": "Copy the directory named '/u/example1' to the destination '/u/example2'", - "options": "\"/u/example1\" \"/u/example2\"" - } - ], - "profile": { - "required": [ - "rse" - ], - "optional": [ - "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": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [] - } - ], - "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": "create", - "aliases": [ - "cre" - ], - "summary": "Create data sets", - "description": "Create data sets, data set members or z/OS UNIX System Services files and directories", - "type": "group", - "children": [ - { - "name": "data-set-partitioned", - "aliases": [ - "pds" - ], - "description": "Create partitioned data sets (PDS)", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "rse", - "base" - ] - }, - "positionals": [ - { - "name": "dataSetName", - "type": "string", - "description": "The name of the data set that you want to create", - "required": true - } - ], - "options": [ - { - "name": "allocation-unit", - "aliases": [ - "au" - ], - "description": "The allocation unit (for example, CYL for Cylinders)", - "type": "string", - "defaultValue": "TRACK", - "group": "Options" - }, - { - "name": "average-blocks", - "aliases": [ - "ab" - ], - "description": "The number of average blocks (for example, 25)", - "type": "number", - "group": "Options" - }, - { - "name": "block-size", - "aliases": [ - "bs", - "blksize" - ], - "description": "The block size for the data set (for example, 6160)", - "type": "number", - "defaultValue": 6160, - "group": "Options" - }, - { - "name": "data-set-type", - "aliases": [ - "dst", - "dsntype" - ], - "description": "The data set type", - "type": "string", - "group": "Options" - }, - { - "name": "device-type", - "aliases": [ - "dt" - ], - "description": "The device type, also known as 'unit'", - "type": "string", - "group": "Options" - }, - { - "name": "directory-blocks", - "aliases": [ - "db", - "dirblks" - ], - "description": "The number of directory blocks (for example, 25)", - "type": "number", - "defaultValue": 5, - "group": "Options" - }, - { - "name": "primary-space", - "aliases": [ - "ps" - ], - "description": "The primary space allocation (for example, 5)", - "type": "number", - "defaultValue": 1, - "group": "Options" - }, - { - "name": "record-format", - "aliases": [ - "rf", - "recfm" - ], - "description": "The record format for the data set (for example, FB for \"Fixed Block\")", - "type": "string", - "defaultValue": "FB", - "group": "Options" - }, - { - "name": "record-length", - "aliases": [ - "rl", - "lrecl" - ], - "description": "The logical record length. Analogous to the length of a line (for example, 80)", - "type": "number", - "defaultValue": 80, - "group": "Options" - }, - { - "name": "secondary-space", - "aliases": [ - "ss" - ], - "description": "The secondary space allocation (for example, 1)", - "type": "number", - "defaultValue": 1, - "group": "Options" - }, - { - "name": "show-attributes", - "aliases": [ - "a", - "pa" - ], - "description": "Show the full allocation attributes", - "type": "boolean", - "group": "Options" - }, - { - "name": "volume-serial", - "aliases": [ - "vs" - ], - "description": "The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER is analogous to a drive name on a PC.", - "type": "string", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [ - { - "description": "Create an empty PDS with default parameters", - "options": "NEW.PDS.DATASET" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "data-set-sequential", - "aliases": [ - "ps" - ], - "description": "Create physical sequential data sets (PS)", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "rse", - "base" - ] - }, - "positionals": [ - { - "name": "dataSetName", - "type": "string", - "description": "The name of the data set that you want to create", - "required": true - } - ], - "options": [ - { - "name": "allocation-unit", - "aliases": [ - "au" - ], - "description": "The allocation unit (for example, CYL for Cylinders)", - "type": "string", - "defaultValue": "CYLINDER", - "group": "Options" - }, - { - "name": "average-blocks", - "aliases": [ - "ab" - ], - "description": "The number of average blocks (for example, 25)", - "type": "number", - "group": "Options" - }, - { - "name": "block-size", - "aliases": [ - "bs", - "blksize" - ], - "description": "The block size for the data set (for example, 6160)", - "type": "number", - "defaultValue": 6160, - "group": "Options" - }, - { - "name": "device-type", - "aliases": [ - "dt" - ], - "description": "The device type, also known as 'unit'", - "type": "string", - "group": "Options" - }, - { - "name": "directory-blocks", - "aliases": [ - "db", - "dirblks" - ], - "description": "The number of directory blocks (for example, 25)", - "type": "number", - "defaultValue": 0, - "group": "Options" - }, - { - "name": "primary-space", - "aliases": [ - "ps" - ], - "description": "The primary space allocation (for example, 5)", - "type": "number", - "defaultValue": 1, - "group": "Options" - }, - { - "name": "record-format", - "aliases": [ - "rf", - "recfm" - ], - "description": "The record format for the data set (for example, FB for \"Fixed Block\")", - "type": "string", - "defaultValue": "FB", - "group": "Options" - }, - { - "name": "record-length", - "aliases": [ - "rl", - "lrecl" - ], - "description": "The logical record length. Analogous to the length of a line (for example, 80)", - "type": "number", - "defaultValue": 80, - "group": "Options" - }, - { - "name": "secondary-space", - "aliases": [ - "ss" - ], - "description": "The secondary space allocation (for example, 1)", - "type": "number", - "defaultValue": 1, - "group": "Options" - }, - { - "name": "show-attributes", - "aliases": [ - "a", - "pa" - ], - "description": "Show the full allocation attributes", - "type": "boolean", - "group": "Options" - }, - { - "name": "volume-serial", - "aliases": [ - "vs" - ], - "description": "The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER is analogous to a drive name on a PC.", - "type": "string", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [ - { - "description": "Create an empty physical sequential data set with default parameters", - "options": "NEW.PS.DATASET" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "uss-file", - "aliases": [ - "file" - ], - "description": "Create a z/OS UNIX System Services file.", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "rse", - "base" - ] - }, - "positionals": [ - { - "name": "ussPath", - "type": "string", - "description": "The name of the file.", - "required": true - } - ], - "options": [ - { - "name": "mode", - "type": "string", - "description": "File permissions, ex. `rwxrw-r--`", - "defaultValue": "rwxrw-r--", - "group": "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": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [ - { - "description": "Create a z/OS UNIX System Services file named \"test.ext\" ", - "options": "file.txt" - }, - { - "description": "Create a z/OS UNIX System Services file named \"text.txt\" with mode \"rwxrwxrwx\" ", - "options": "file.txt -m rwxrwxrwx" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "uss-directory", - "aliases": [ - "dir" - ], - "description": "Create a z/OS UNIX System Services directory.", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "rse", - "base" - ] - }, - "positionals": [ - { - "name": "ussPath", - "type": "string", - "description": "The name of the directory.", - "required": true - } - ], - "options": [ - { - "name": "mode", - "type": "string", - "description": "Directory permissions, ex. `rwxrw-r--`", - "defaultValue": "rwxrw-r--", - "group": "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": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [ - { - "description": "Create a z/OS UNIX System Services directory named \"testDir\" ", - "options": "testDir" - }, - { - "description": "Create a z/OS UNIX System Services directory named \"testDir\" with mode \"rwxrwxrwx\" ", - "options": "testDir -m rwxrwxrwx" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "data-set-member", - "aliases": [ - "member" - ], - "description": "Create a member for a Partitioned data set.", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "rse", - "base" - ] - }, - "positionals": [ - { - "name": "datasetMember", - "type": "string", - "description": "The name of the data set member that you want to create like so \"HLQ.DATASETNAME(NEWMEMBER)\".", - "required": true - } - ], - "examples": [ - { - "description": "Create a new, empty member for a PDS.", - "options": "\"HLQ.DATASETNAME(NEWMEMBER)\"" - } - ], - "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": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [] - }, - { - "name": "data-set", - "aliases": [ - "ds" - ], - "description": "Create a data set based on the properties of an existing data set", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "rse", - "base" - ] - }, - "positionals": [ - { - "name": "dataSetName", - "type": "string", - "description": "The name of the data set that you want to create", - "required": true - } - ], - "options": [ - { - "name": "allocation-unit", - "aliases": [ - "au" - ], - "description": "The allocation unit (for example, CYL for Cylinders)", - "type": "string", - "group": "Options" - }, - { - "name": "average-blocks", - "aliases": [ - "ab" - ], - "description": "The number of average blocks (for example, 25)", - "type": "number", - "group": "Options" - }, - { - "name": "block-size", - "aliases": [ - "bs", - "blksize" - ], - "description": "The block size for the data set (for example, 6160)", - "type": "number", - "group": "Options" - }, - { - "name": "device-type", - "aliases": [ - "dt" - ], - "description": "The device type, also known as 'unit'", - "type": "string", - "group": "Options" - }, - { - "name": "directory-blocks", - "aliases": [ - "db", - "dirblks" - ], - "description": "The number of directory blocks (for example, 25)", - "type": "number", - "group": "Options" - }, - { - "name": "like", - "aliases": [ - "lk" - ], - "description": "Name of an existing data set to base your new data set's properties on", - "type": "string", - "group": "Options" - }, - { - "name": "primary-space", - "aliases": [ - "ps" - ], - "description": "The primary space allocation (for example, 5)", - "type": "number", - "group": "Options" - }, - { - "name": "record-format", - "aliases": [ - "rf", - "recfm" - ], - "description": "The record format for the data set (for example, FB for \"Fixed Block\")", - "type": "string", - "group": "Options" - }, - { - "name": "record-length", - "aliases": [ - "rl", - "lrecl" - ], - "description": "The logical record length. Analogous to the length of a line (for example, 80)", - "type": "number", - "group": "Options" - }, - { - "name": "secondary-space", - "aliases": [ - "ss" - ], - "description": "The secondary space allocation (for example, 1)", - "type": "number", - "group": "Options" - }, - { - "name": "show-attributes", - "aliases": [ - "a", - "pa" - ], - "description": "Show the full allocation attributes", - "type": "boolean", - "group": "Options" - }, - { - "name": "volume-serial", - "aliases": [ - "vs" - ], - "description": "The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER is analogous to a drive name on a PC.", - "type": "string", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [ - { - "description": "Create a data set with default parameters and like flag", - "options": "NEW.DATASET --like EXISTING.DATASET" - }, - { - "description": "Create a data set with default parameters, like flag, and lrecl flag", - "options": "NEW.DATASET --like EXISTING.DATASET --lrecl 1024" - } - ], - "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" - } - ], - "positionals": [], - "passOn": [] - }, - { - "name": "delete", - "aliases": [ - "del" - ], - "type": "group", - "description": "Delete a data set or Unix System Services file", - "children": [ - { - "name": "data-set", - "aliases": [ - "ds" - ], - "description": "Delete a data set permanently", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "rse", - "base" - ] - }, - "positionals": [ - { - "name": "dataSetName", - "type": "string", - "description": "The name of the data set that you want to delete", - "required": true - } - ], - "examples": [ - { - "description": "Delete the data set named 'ibmuser.cntl'", - "options": "\"ibmuser.cntl\"" - } - ], - "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": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [] - }, - { - "name": "uss-file", - "aliases": [ - "uss" - ], - "description": "Delete a z/OS UNIX System Services file or directory permanently", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "rse", - "base" - ] - }, - "positionals": [ - { - "name": "fileName", - "type": "string", - "description": "The name of the file or directory that you want to delete", - "required": true - } - ], - "examples": [ - { - "description": "Delete the directory '/u/ibmuser/testcases'", - "options": "\"/a/ibmuser/testcases\"" - }, - { - "description": "Delete the file named '/a/ibmuser/my_text.txt'", - "options": "\"/a/ibmuser/testcases/my_text.txt\"" - } - ], - "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": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [] - }, - { - "name": "job", - "aliases": [ - "js" - ], - "type": "command", - "summary": "Delete a single job by job ID", - "description": "Delete a single job by job ID", - "handler": "", - "profile": { - "optional": [ - "rse", - "base" - ] - }, - "positionals": [ - { - "name": "jobid", - "description": "The job ID (e.g. JOB00123) of the job. Job ID is a unique identifier for z/OS batch jobs -- no two jobs on one system can have the same ID. Note: z/OS allows you to abbreviate the job ID if desired. You can use, for example \"J123\".", - "type": "string", - "required": true - } - ], - "examples": [ - { - "description": "Delete job with job ID JOB03456.", - "options": "JOB03456" - } - ], - "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": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [] - } - ], - "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": [] - }, - { - "name": "download", - "aliases": [ - "dl" - ], - "type": "group", - "summary": "Download content from z/OS data sets, UNIX System Services files, and JOB Output to your PC.", - "description": "Download content from z/OS data sets, UNIX System Services files, and JOB Output to your PC.", - "children": [ - { - "name": "data-set", - "aliases": [ - "ds" - ], - "summary": "Download content from a z/OS data set", - "description": "Download content from a z/OS data set to a local file", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "rse", - "base" - ] - }, - "positionals": [ - { - "name": "dataSetName", - "description": "The name of the data set that you want to download", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "binary", - "aliases": [ - "b" - ], - "description": "Download the file content in binary mode, which means that no data conversion is performed. The data transfer process returns each line as-is, without translation. No delimiters are added between records.", - "type": "boolean", - "group": "Options" - }, - { - "name": "encoding", - "aliases": [ - "ec" - ], - "description": "Upload the file content with encoding mode, which means that data conversion is performed using the file encoding specified.", - "type": "string", - "group": "Options" - }, - { - "name": "extension", - "aliases": [ - "e" - ], - "description": "Save the local files with a specified file extension. For example, .txt. Or \"\" for no extension. When no extension is specified, .txt is used as the default file extension.", - "type": "stringOrEmpty", - "group": "Options" - }, - { - "name": "file", - "aliases": [ - "f" - ], - "description": "The path to the local file where you want to download the content. When you omit the option, the command generates a file name automatically for you.", - "type": "string", - "group": "Options" - }, - { - "name": "mappings-file", - "aliases": [ - "maps" - ], - "description": "Location of an alternate MVS Mappings file.", - "type": "string", - "group": "Options" - }, - { - "name": "volume-serial", - "aliases": [ - "vs" - ], - "description": "The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.", - "type": "string", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [ - { - "description": "Download the data set \"ibmuser.loadlib(main)\" to the local file \"main.obj\".", - "options": "\"ibmuser.loadlib(main)\" -f main.obj" - }, - { - "description": "Download the data set \"ibmuser.loadlib(main)\" to the local file \"main.obj\" in binary mode.", - "options": "\"ibmuser.loadlib(main)\" -b \"./main.obj\"" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "all-members", - "aliases": [ - "am" - ], - "summary": "Download all members from a pds", - "description": "Download all members from a partitioned data set to a local folder", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "rse", - "base" - ] - }, - "positionals": [ - { - "name": "dataSetName", - "description": "The name of the data set from which you want to download members", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "binary", - "aliases": [ - "b" - ], - "description": "Download the file content in binary mode, which means that no data conversion is performed. The data transfer process returns each line as-is, without translation. No delimiters are added between records.", - "type": "boolean", - "group": "Options" - }, - { - "name": "directory", - "aliases": [ - "d" - ], - "description": "The directory to where you want to save the members. The command creates the directory for you when it does not already exist. By default, the command creates a folder structure based on the data set qualifiers. For example, the data set ibmuser.new.cntl's members are downloaded to ibmuser/new/cntl).", - "type": "string", - "group": "Options" - }, - { - "name": "encoding", - "aliases": [ - "ec" - ], - "description": "Upload the file content with encoding mode, which means that data conversion is performed using the file encoding specified.", - "type": "string", - "group": "Options" - }, - { - "name": "extension", - "aliases": [ - "e" - ], - "description": "Save the local files with a specified file extension. For example, .txt. Or \"\" for no extension. When no extension is specified, .txt is used as the default file extension.", - "type": "stringOrEmpty", - "group": "Options" - }, - { - "name": "mappings-file", - "aliases": [ - "maps" - ], - "description": "Location of an alternate MVS Mappings file.", - "type": "string", - "group": "Options" - }, - { - "name": "volume-serial", - "aliases": [ - "vs" - ], - "description": "The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.", - "type": "string", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [ - { - "description": "Download the members of the data set \"ibmuser.loadlib\" to the directory \"loadlib/\"", - "options": "\"ibmuser.loadlib\" -d loadlib" - }, - { - "description": "Download the members of the data set \"ibmuser.cntl\" as a .jcl to the directory \"jcl/\"", - "options": "\"ibmuser.cntl\" -e .jcl -d jcl" - }, - { - "description": "Download the members of the data set \"ibmuser.cntl\" as binary.", - "options": "\"ibmuser.cntl\" -b" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "uss-file", - "aliases": [ - "uf" - ], - "summary": "Download content from a z/OS UNIX System Services file", - "description": "Download content from a z/OS UNIX System Services file to a local file on your PC", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "rse", - "base" - ] - }, - "positionals": [ - { - "name": "ussFileName", - "description": "The name of the z/OS UNIX System Services file you want to download", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "binary", - "aliases": [ - "b" - ], - "description": "Download the file content in binary mode, which means that no data conversion is performed. The data transfer process returns each line as-is, without translation. No delimiters are added between records.", - "type": "boolean", - "group": "Options" - }, - { - "name": "encoding", - "aliases": [ - "ec" - ], - "description": "Upload the file content with encoding mode, which means that data conversion is performed using the file encoding specified.", - "type": "string", - "group": "Options" - }, - { - "name": "file", - "aliases": [ - "f" - ], - "description": "The path to the local file where you want to download the content. When you omit the option, the command generates a file name automatically for you.", - "type": "string", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [ - { - "description": "Download the file \"/a/ibmuser/my_text.txt\" to \"./my_text.txt\"", - "options": "\"/a/ibmuser/my_text.txt\" -f \"./my_text.txt\"" - }, - { - "description": "Download the file \"/a/ibmuser/my_text.txt\" to \"./my_text.txt\" in binary mode", - "options": "\"/a/ibmuser/my_text.txt\" -b -f \"./my_text.txt\"" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "output", - "aliases": [ - "o" - ], - "type": "command", - "summary": "Download all job output to a directory", - "description": "Download all job output to a local directory. Each spool DD will be downloaded to its own file in the directory.", - "handler": "", - "profile": { - "optional": [ - "rse", - "base" - ] - }, - "positionals": [ - { - "name": "jobid", - "description": "The z/OS JOBID of the job containing the spool files you want to view. No pre-validation of the JOBID is performed.", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "directory", - "aliases": [ - "d", - "dir" - ], - "description": "The local directory you would like to download the output for the job to.", - "type": "string", - "group": "Options" - }, - { - "name": "extension", - "aliases": [ - "e" - ], - "description": "A file extension to save the job output with. Defaults to '.txt'.", - "type": "string", - "group": "Options" - }, - { - "name": "omit-jobid-directory", - "aliases": [ - "ojd" - ], - "description": "If specified, job output will be saved directly to the specified directory rather than creating a subdirectory named after the ID of the job.", - "type": "boolean", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [ - { - "description": "Download all the output of the job with job ID JOB00234 to an automatically generated directory.", - "options": "JOB00234" - } - ], - "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" - } - ], - "positionals": [], - "passOn": [] - }, - { - "name": "export", - "summary": "Export Z/OS files.", - "description": "Export Z/OS files.", - "type": "group", - "children": [ - { - "name": "spool-file", - "aliases": [ - "spool", - "sf" - ], - "summary": "Export a JES job provided job name, ID, fileID, and MVS data set.", - "description": "Export a JES job provided job name, ID, fileID, and MVS data set.", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "jobName", - "description": "Job Name", - "type": "string", - "required": true - }, - { - "name": "jobId", - "description": "Job Id", - "type": "string", - "required": true - }, - { - "name": "spoolFileId", - "description": "Spool Id", - "type": "number", - "required": true - }, - { - "name": "toDataSetName", - "description": "MVS data set name to be exported to", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "allow-truncation", - "aliases": [ - "at" - ], - "description": "Allow truncation of the file if record length too small.", - "type": "boolean", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [ - { - "description": "Export spool file to sequential data set, 'HLQ.SEQDS'", - "options": "JOBNAME JOBID SPOOLID \"USER.TO.SET\"" - }, - { - "description": "Export spool file a data set member, 'HLQ.DSNAME(MEMBER)'", - "options": "JOBNAME JOBID SPOOLID \"USER.TO.PDS(MEM1)\"" - } - ], - "profile": { - "required": [ - "rse" - ], - "optional": [ - "base" - ] - }, - "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": "migrate", - "aliases": [ - "hmigr", - "hMigrate" - ], - "type": "group", - "description": "Migrate data sets.", - "children": [ - { - "name": "data-set", - "aliases": [ - "ds" - ], - "description": "Migrate a data set.", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "rse", - "base" - ] - }, - "positionals": [ - { - "name": "dataSetName", - "type": "string", - "description": "The name of the data set you want to migrate.", - "required": true - } - ], - "examples": [ - { - "description": "Migrate a data set using default options", - "options": "\"USER.DATA.SET\"" - } - ], - "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": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [] - } - ], - "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": [] - }, - { - "name": "recall", - "aliases": [ - "hrec", - "hRecall" - ], - "type": "group", - "description": "Recall migrated data sets.", - "children": [ - { - "name": "data-set", - "aliases": [ - "ds" - ], - "description": "Recall a migrated data set.", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "rse", - "base" - ] - }, - "positionals": [ - { - "name": "dataSetName", - "type": "string", - "description": "The name of the data set you want to recall.", - "required": true - } - ], - "examples": [ - { - "description": "Recall a data set using default options", - "options": "\"USER.DATA.SET\"" - } - ], - "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": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [] - } - ], - "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": [] - }, - { - "name": "issue", - "summary": "Issue TSO and UNIX commands", - "description": "Issue TSO and UNIX commands", - "type": "group", - "children": [ - { - "name": "command", - "aliases": [ - "cmd", - "tso" - ], - "summary": "Issue a TSO command, only supported in RSE API v1.0.1 and higher", - "description": "Creates a TSO address space, issues a TSO command through the newly createdaddress space, waits for the READY prompt to print the response, and terminatesthe TSO address space. All response data are returned to the user up to (but notincluding) the TSO 'READY' prompt.", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "commandText", - "description": "The TSO command to issue.", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "shell-id", - "aliases": [ - "id" - ], - "description": "Specify this if you wish to reuse a shell. Required for interactive TSO commands.", - "type": "string", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [ - { - "description": "Issue the TSO command \"status\" to display information about jobs for your user ID", - "options": "\"status\"" - }, - { - "description": "Issue an interactive TSO command with shell-id.", - "options": "\"TSO EX 'HLQ.REXX(REXPROG)'\" --shell-id myshell" - } - ], - "profile": { - "required": [ - "rse" - ], - "optional": [ - "base" - ] - }, - "passOn": [], - "children": [] - }, - { - "name": "unix", - "aliases": [ - "uss" - ], - "summary": "Issue a UNIX command", - "description": "issues a UNIX command", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "commandText", - "description": "The UNIX command to issue.", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "cwd", - "description": "Working directory in which to execute the command.", - "type": "string", - "required": true, - "group": "Required 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": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [ - { - "description": "Issue the UNIX command \"ls\" to display a list of items in the directory", - "options": "\"ls\" --cwd \"/u/ibmuser\"" - } - ], - "profile": { - "required": [ - "rse" - ], - "optional": [ - "base" - ] - }, - "passOn": [], - "children": [] - }, - { - "name": "unix-shell", - "aliases": [ - "unix-streaming", - "uss-shell" - ], - "summary": "Issue a UNIX shell command with streaming output", - "description": "issue a UNIX shell command with streaming output", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "commandText", - "description": "The UNIX command to issue.", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "cwd", - "description": "Working directory in which to execute the command.", - "type": "string", - "required": true, - "group": "Required Options", - "aliases": [] - }, - { - "name": "env", - "description": "A comma-separated list of environment variables to be set in the executing shell.", - "type": "string", - "required": false, - "group": "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": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [ - { - "description": "Issue the UNIX command to display the content of a file.", - "options": "'cat $logfile' --cwd '/u/ibmuser' --env 'logfile=output.log'" - } - ], - "profile": { - "required": [ - "rse" - ], - "optional": [ - "base" - ] - }, - "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": "list", - "aliases": [ - "ls" - ], - "summary": "List the details for data sets and the members in the data sets, z/OS UNIX System Services files and directories, and jobs and spool files.", - "description": "List z/OS UNIX System Services file and folders, data sets and data set members, or jobs and spool files. Optionally, you can list their details and attributes.", - "type": "group", - "children": [ - { - "name": "uss-files", - "aliases": [ - "uss" - ], - "summary": "List z/OS UNIX System Services files", - "description": "List z/OS UNIX System Services files and directories in a UNIX file path", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "path", - "description": "The directory containing the files and directories to be listed", - "type": "string", - "required": true - } - ], - "examples": [ - { - "description": "Show the files and directories in path '/u/ibmuser'", - "options": "\"/u/ibmuser\"" - } - ], - "profile": { - "required": [ - "rse" - ], - "optional": [ - "base" - ] - }, - "outputFormatOptions": true, - "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": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [] - }, - { - "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 - } - ], - "passOn": [], - "children": [] - }, - { - "name": "data-set", - "aliases": [ - "ds" - ], - "summary": "List data sets", - "description": "List data sets that match a pattern in the data set name", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "filter", - "description": "The name or pattern of the data set that you want to list", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "attributes", - "aliases": [ - "a" - ], - "description": "Display more information about each member. Data sets with an undefined record format display information related to executable modules. Variable and fixed block data sets display information about when the members were created and modified.", - "type": "boolean", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [ - { - "description": "Show the data set \"ibmuser.asm\"", - "options": "\"ibmuser.asm\"" - }, - { - "description": "Show attributes of the data set \"ibmuser.cntl\"", - "options": "\"ibmuser.cntl\" -a" - }, - { - "description": "Show all data sets of the user \"ibmuser\"", - "options": "\"ibmuser.*\"" - }, - { - "description": "Show attributes of all data sets of the user \"ibmuser\"", - "options": "\"ibmuser.*\" -a" - } - ], - "profile": { - "required": [ - "rse" - ], - "optional": [ - "base" - ] - }, - "passOn": [], - "children": [] - }, - { - "name": "all-members", - "aliases": [ - "am" - ], - "summary": "List all members of a pds", - "description": "List all members of a partitioned data set. To view additional information about each member, use the --attributes option under the Options section of this help text.", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "dataSetName", - "description": "The name of the data set for which you want to list the members", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "pattern", - "aliases": [ - "p" - ], - "description": "Pattern for member filter search.", - "type": "string", - "group": "Options" - }, - { - "name": "attributes", - "aliases": [ - "a" - ], - "description": "Display more information about each member.", - "type": "boolean", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [ - { - "description": "Show members of the data set \"ibmuser.asm\"", - "options": "\"ibmuser.asm\"" - } - ], - "profile": { - "required": [ - "rse" - ], - "optional": [ - "base" - ] - }, - "passOn": [], - "children": [] - }, - { - "name": "jobs", - "aliases": [ - "js" - ], - "summary": "List z/OS jobs on JES spool/queues", - "description": "List jobs on JES spool/queues. By default, the command lists jobs owned (owner) by the user specified in your profile. The default for prefix is \"*\". The default status is ALL. The command does not prevalidate your user ID. The command surfaces errors verbatim from the Jobs REST endpoints.", - "type": "command", - "handler": "", - "options": [ - { - "name": "owner", - "aliases": [ - "o" - ], - "description": "Specify the owner of the jobs you want to list. The owner is the individual/user who submitted the job OR the user ID assigned to the job. The command does not prevalidate the owner. You can specify a wildcard according to the Jobs REST endpoint documentation, which is usually in the form \"USER*\".", - "type": "string", - "group": "Options" - }, - { - "name": "prefix", - "aliases": [ - "p" - ], - "description": "Specify the job name prefix of the jobs you want to list. The command does not prevalidate the owner. You can specify a wildcard according to the Jobs REST endpoint documentation, which is usually in the form \"JOB*\".", - "type": "string", - "group": "Options" - }, - { - "name": "status", - "aliases": [ - "s" - ], - "description": "Specify if you want to list ALL jobs or only ACTIVE, OUTPUT, or INPUT jobs.", - "type": "string", - "group": "Options" - }, - { - "name": "attributes", - "aliases": [ - "a" - ], - "description": "Display more information about each job.", - "type": "boolean", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [] - }, - { - "name": "response-format-filter", - "aliases": [ - "rff" - ], - "description": "Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.", - "type": "array", - "group": "Response Format Options" - }, - { - "name": "response-format-type", - "aliases": [ - "rft" - ], - "description": "The command response output format type. Must be one of the following:\n\ntable: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.\n\nlist: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.\n\nobject: Formats output data as a list of prettified objects (or single object). Can be used in place of \"table\" to change from tabular output to a list of prettified objects.\n\nstring: Formats output data as a string. JSON objects/arrays are stringified.", - "type": "string", - "allowableValues": { - "values": [ - "table", - "list", - "object", - "string" - ], - "caseSensitive": false - }, - "group": "Response Format Options" - }, - { - "name": "response-format-header", - "aliases": [ - "rfh" - ], - "description": "If \"--response-format-type table\" is specified, include the column headers in the output.", - "type": "boolean", - "group": "Response Format Options", - "defaultValue": null - } - ], - "profile": { - "required": [ - "rse" - ], - "optional": [ - "base" - ] - }, - "examples": [ - { - "description": "List all jobs with default settings. The command returns jobs owned by your user ID with any job name", - "options": "" - }, - { - "description": "List all ACTIVE jobs owned by user IDs starting with 'ibmu' and job names starting with 'myjo'", - "options": "-o \"ibmu*\" -p \"myjo*\" -s \"ACTIVE\"" - }, - { - "description": "List all jobs with default owner and prefix settings, displaying only the job ID of each job", - "options": "--rff jobid --rft table" - } - ], - "outputFormatOptions": true, - "positionals": [], - "passOn": [], - "children": [] - }, - { - "name": "spool-files-by-jobid", - "aliases": [ - "sfbj" - ], - "type": "command", - "summary": "List spool files of a z/OS job", - "description": "Given a z/OS job JOBID, list the spool files (DDs) for a z/OS job on the JES/spool queues. The command does not pre-validate the JOBID. The command presents errors verbatim from the RSE API Jobs REST endpoints.", - "handler": "", - "profile": { - "required": [ - "rse" - ], - "optional": [ - "base" - ] - }, - "positionals": [ - { - "name": "jobid", - "description": "The z/OS JOBID of the job with the spool files you want to list. No pre-validation of the JOBID is performed.", - "type": "string", - "required": true - } - ], - "outputFormatOptions": true, - "examples": [ - { - "description": "List the spool files of the job with JOBID JOB00123", - "options": "job00123" - } - ], - "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": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [] - }, - { - "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 - } - ], - "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" - } - ], - "positionals": [], - "passOn": [] - }, - { - "name": "rename", - "aliases": [ - "rn" - ], - "summary": "Rename a Data set, Data set member, File or Directory", - "description": "Rename a Data set, Data set member,File or Directory", - "type": "group", - "children": [ - { - "name": "uss-file", - "aliases": [ - "uss" - ], - "summary": "Rename a z/OS UNIX System Services file or directory.", - "description": "Rename a z/OS UNIX System Services file or directory.", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "path", - "description": "Existing z/OS UNIX System Services file or directory Path.", - "type": "string", - "required": true - }, - { - "name": "name", - "description": "New name of z/OS UNIX System Services file or directory.", - "type": "string", - "required": true - } - ], - "examples": [ - { - "description": "Rename z/OS UNIX System Services file \"fileName\" to \"newFileName\".", - "options": "\"/u/ibmuser/fileName\" \"newFileName\"" - } - ], - "profile": { - "required": [ - "rse" - ], - "optional": [ - "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": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [] - }, - { - "name": "data-set", - "aliases": [ - "ds" - ], - "summary": "Rename a Data Set.", - "description": "Rename a Data Set.", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "dataSetName", - "description": "Existing data set name including HLQ.", - "type": "string", - "required": true - }, - { - "name": "name", - "description": "New name of data set", - "type": "string", - "required": true - } - ], - "examples": [ - { - "description": "Rename a Data Set name to a new name.", - "options": "\"hlq.dataSetName\" \"hlq.newDataSetName\"" - } - ], - "profile": { - "required": [ - "rse" - ], - "optional": [ - "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": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [] - }, - { - "name": "data-set-member", - "aliases": [ - "member" - ], - "summary": "Rename a Data Set Member.", - "description": "Rename a Data Set Member.", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "dataSetMemberName", - "description": "Existing Data Set Member name including HLQ.", - "type": "string", - "required": true - }, - { - "name": "name", - "description": "New name of data set member", - "type": "string", - "required": true - } - ], - "examples": [ - { - "description": "Rename a Data Set Member name to a new name.", - "options": "\"hlq.dataSetName(memberName)\" \"newMemberName\"" - } - ], - "profile": { - "required": [ - "rse" - ], - "optional": [ - "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": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [] - } - ], - "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": [] - }, - { - "name": "search", - "aliases": [ - "sch" - ], - "type": "group", - "summary": "Search for Unix System Services Files or Data Sets", - "description": "Search by filename, member name, and contents", - "children": [ - { - "name": "uss-file", - "aliases": [ - "uss" - ], - "type": "command", - "summary": "Search for UNIX Files by specifying the path, file name, and text pattern.", - "description": "Search for UNIX Files by specifying the path, file name, and text pattern. If Regex pattern is not used, wildcard patterns are used.", - "handler": "", - "positionals": [ - { - "name": "path", - "description": "The working directory. Example: /u/IBM/test.", - "type": "string", - "required": true - }, - { - "name": "fileName", - "description": "The name of the file to perform the action on. Example: test.txt or ***.txt", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "text", - "description": "The text pattern to be searched for in the provided file. Example: hello", - "type": "string", - "aliases": [ - "t" - ], - "group": "Options" - }, - { - "name": "regex-file-name", - "description": "Regex for filename. If Regex pattern is not used, wildcard patterns are used.", - "type": "boolean", - "defaultValue": false, - "aliases": [ - "rfn" - ], - "group": "Options" - }, - { - "name": "regex-content", - "description": "Regex for text pattern. If Regex pattern is not used, wildcard patterns are used.", - "type": "boolean", - "defaultValue": false, - "aliases": [ - "rc" - ], - "group": "Options" - }, - { - "name": "case-sensitive-file-name", - "description": "Case-sensitive search for filename", - "type": "boolean", - "defaultValue": false, - "aliases": [ - "csfn" - ], - "group": "Options" - }, - { - "name": "case-sensitive-content", - "description": "Case-sensitive search for content", - "type": "boolean", - "defaultValue": false, - "aliases": [ - "csc" - ], - "group": "Options" - }, - { - "name": "path-results-only", - "description": "Reduce the response to only the path results", - "type": "boolean", - "defaultValue": false, - "aliases": [ - "pro" - ], - "group": "Options" - }, - { - "name": "response-format-type", - "description": "The command response output format type. Must be one of the following: table, list, object, string", - "type": "string", - "aliases": [ - "rft" - ], - "defaultValue": "list", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [ - { - "description": "Search for a Unix System Services file with a file format of *.txt in /u/myuser/myfiles", - "options": "\"/u/ibmuser/\" \"*.txt\"" - } - ], - "profile": { - "required": [ - "rse" - ], - "optional": [ - "base" - ] - }, - "passOn": [], - "children": [] - }, - { - "name": "members", - "aliases": [ - "mem" - ], - "type": "command", - "summary": "Search for PDS member(s)", - "description": "Search for PDS member(s) provided the filter with a member pattern and/or content string.", - "handler": "", - "positionals": [ - { - "name": "filter", - "description": "Dataset filter string. Ex. FILTERNAME.*.", - "type": "string", - "required": true - }, - { - "name": "memberPattern", - "description": "Member name pattern. Ex. MEM or *", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "content", - "description": "Content string to be searched. Ex. HelloWorld or *", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "regex-member", - "description": "Regex for member name. If Regex pattern is not used, wildcard patterns are used.", - "type": "boolean", - "aliases": [ - "rm" - ], - "defaultValue": false, - "group": "Options" - }, - { - "name": "regex-content", - "description": "Regex for content. If Regex pattern is not used, wildcard patterns are used.", - "type": "boolean", - "aliases": [ - "rc" - ], - "defaultValue": false, - "group": "Options" - }, - { - "name": "case-sensitive-content", - "description": "Case-sensitive for content", - "type": "boolean", - "aliases": [ - "csc" - ], - "defaultValue": false, - "group": "Options" - }, - { - "name": "number-of-results", - "description": "Number of results displayed for MVS search If number-of-results is not used, default is 10000 results.", - "type": "string", - "aliases": [ - "nor" - ], - "group": "Options" - }, - { - "name": "response-format-type", - "description": "The command response output format type. Must be one of the following: table, list, object, string", - "type": "string", - "aliases": [ - "rft" - ], - "defaultValue": "list", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [ - { - "description": "Search for a Dataset Member with a filter of USER.* with member pattern TEST", - "options": "\"USER.*\" \"MEMBER\"" - } - ], - "profile": { - "required": [ - "rse" - ], - "optional": [ - "base" - ] - }, - "passOn": [], - "children": [] - }, - { - "name": "partitioned-dataset", - "aliases": [ - "pds" - ], - "type": "command", - "summary": "Search for partitioned dataset(s)", - "description": "Search for partitioned dataset(s) provided the filter with a dataset name pattern filter.", - "handler": "", - "positionals": [ - { - "name": "filter", - "description": "Dataset filter string. Ex. FILTERNAME.*.", - "type": "string", - "required": true - }, - { - "name": "dsnPattern", - "description": "Dataset name pattern. Ex. HLQ.PDS or *", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "regex-dsn", - "description": "Regex for dataset name. If Regex pattern is not used, wildcard patterns are used.", - "type": "boolean", - "aliases": [ - "rd" - ], - "defaultValue": false, - "group": "Options" - }, - { - "name": "number-of-results", - "description": "Number of results displayed for MVS search If number-of-results is not used, default is 10000 results.", - "type": "string", - "aliases": [ - "nor" - ], - "group": "Options" - }, - { - "name": "response-format-type", - "description": "The command response output format type. Must be one of the following: table, list, object, string", - "type": "string", - "aliases": [ - "rft" - ], - "defaultValue": "list", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [ - { - "description": "Search for a Partitioned Dataset USER.* with a DSN Pattern of USER.TEST.*", - "options": "\"USER.*\" \"USER.TEST.*\"" - } - ], - "profile": { - "required": [ - "rse" - ], - "optional": [ - "base" - ] - }, - "passOn": [], - "children": [] - }, - { - "name": "sequential-dataset", - "aliases": [ - "seq" - ], - "type": "command", - "summary": "Search for sequential dataset(s)", - "description": "Search for sequential dataset(s) provided the filter with a dataset name pattern and/or content string filter.", - "handler": "", - "positionals": [ - { - "name": "filter", - "description": "Dataset filter string. Ex. FILTERNAME.*.", - "type": "string", - "required": true - }, - { - "name": "dsnPattern", - "description": "Dataset name pattern. Ex. HLQ.PDS or *", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "content", - "description": "Content string to be searched. Ex. HelloWorld or *", - "type": "string", - "aliases": [ - "c" - ], - "group": "Options" - }, - { - "name": "regex-dsn", - "description": "Regex for dataset name. If Regex pattern is not used, wildcard patterns are used.", - "type": "boolean", - "aliases": [ - "rd" - ], - "defaultValue": false, - "group": "Options" - }, - { - "name": "regex-content", - "description": "Regex for content. If Regex pattern is not used, wildcard patterns are used.", - "type": "boolean", - "aliases": [ - "rc" - ], - "defaultValue": false, - "group": "Options" - }, - { - "name": "case-sensitive-content", - "description": "Case-sensitive for content", - "type": "boolean", - "aliases": [ - "csc" - ], - "defaultValue": false, - "group": "Options" - }, - { - "name": "number-of-results", - "description": "Number of results displayed for MVS search If number-of-results is not used, default is 10000 results.", - "type": "string", - "aliases": [ - "nor" - ], - "group": "Options" - }, - { - "name": "response-format-type", - "description": "The command response output format type. Must be one of the following: table, list, object, string", - "type": "string", - "aliases": [ - "rft" - ], - "defaultValue": "list", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [ - { - "description": "Search for a Sequential Dataset USER.* with a DSN Pattern of USER.TEST.*", - "options": "\"USER.*\" \"USER.TEST.*\"" - } - ], - "profile": { - "required": [ - "rse" - ], - "optional": [ - "base" - ] - }, - "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" - } - ], - "positionals": [], - "passOn": [] - }, - { - "name": "submit", - "aliases": [ - "sub" - ], - "type": "group", - "summary": "Submit z/OS jobs", - "description": "Submit jobs (JCL) contained in data sets.", - "children": [ - { - "name": "data-set", - "aliases": [ - "ds" - ], - "type": "command", - "summary": "Submit a job contained in a data set", - "description": "Submit a job (JCL) contained in a data set. The data set may be of type physical sequential or a PDS member. The command does not pre-validate the data set name. The command presents errors verbatim from the Jobs REST endpoints. For more information about Jobs API errors, see the Jobs API REST documentation.", - "handler": "", - "positionals": [ - { - "name": "dataset", - "description": "The z/OS data set containing the JCL to submit. You can specify a physical sequential data set (for example, \"DATA.SET\") or a partitioned data set qualified by a member (for example, \"DATA.SET(MEMBER)\"). ", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "view-all-spool-content", - "aliases": [ - "vasc" - ], - "description": "Print all spool output. If you use this option you will wait the job to complete.", - "type": "boolean", - "group": "Options" - }, - { - "name": "wait-for-output", - "aliases": [ - "wfo" - ], - "description": "Wait for the job to enter OUTPUT status before completing the command.", - "type": "boolean", - "group": "Options" - }, - { - "name": "wait-for-active", - "aliases": [ - "wfa" - ], - "description": "Wait for the job to enter ACTIVE status before completing the command.", - "type": "boolean", - "conflictsWith": [ - "wait-for-output", - "view-all-spool-content", - "directory" - ], - "group": "Options" - }, - { - "name": "directory", - "aliases": [ - "d" - ], - "description": "The local directory you would like to download the output of the job. Creates a subdirectory using the jobID as the name and files are titled based on DD names. If you use this option you will wait the job to complete.", - "type": "string", - "group": "Options" - }, - { - "name": "extension", - "aliases": [ - "e" - ], - "description": "A file extension to save the job output with. Default is '.txt'.", - "type": "string", - "group": "Options" - }, - { - "name": "jcl-symbols", - "aliases": [ - "js" - ], - "description": "A string of JCL symbols to use for substitution. For symbol values with no spaces: \"symbol1=value1 symbol2=value2 ...\". When a value contains spaces, enclose the value in single quotes: \"symbol1='value 1 with spaces' symbol2='value 2 with spaces'...\". To embed a single quote in a value, use two single quotes: \"NAME=O''Brian\".", - "type": "string", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [] - }, - { - "name": "response-format-filter", - "aliases": [ - "rff" - ], - "description": "Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.", - "type": "array", - "group": "Response Format Options" - }, - { - "name": "response-format-type", - "aliases": [ - "rft" - ], - "description": "The command response output format type. Must be one of the following:\n\ntable: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.\n\nlist: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.\n\nobject: Formats output data as a list of prettified objects (or single object). Can be used in place of \"table\" to change from tabular output to a list of prettified objects.\n\nstring: Formats output data as a string. JSON objects/arrays are stringified.", - "type": "string", - "allowableValues": { - "values": [ - "table", - "list", - "object", - "string" - ], - "caseSensitive": false - }, - "group": "Response Format Options" - }, - { - "name": "response-format-header", - "aliases": [ - "rfh" - ], - "description": "If \"--response-format-type table\" is specified, include the column headers in the output.", - "type": "boolean", - "group": "Response Format Options", - "defaultValue": null - } - ], - "profile": { - "optional": [ - "rse", - "base" - ] - }, - "outputFormatOptions": true, - "examples": [ - { - "options": "\"ibmuser.cntl(deploy)\"", - "description": "Submit the JCL in the data set \"ibmuser.cntl(deploy)\"" - }, - { - "options": "\"ibmuser.cntl(deploy)\" --vasc", - "description": "Submit the JCL in the data set \"ibmuser.cntl(deploy)\", wait for the job to complete and print all output from the job" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "local-file", - "aliases": [ - "lf" - ], - "type": "command", - "summary": "Submit a job contained in a local file", - "description": "Submit a job (JCL) contained in a local file. The command presents errors verbatim from the Jobs REST endpoints. For more information about Jobs API errors, see the Jobs API REST documentation.", - "handler": "", - "positionals": [ - { - "name": "localFile", - "description": "The local file containing the JCL to submit. ", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "view-all-spool-content", - "aliases": [ - "vasc" - ], - "description": "Print all spool output. If you use this option you will wait the job to complete.", - "type": "boolean", - "group": "Options" - }, - { - "name": "wait-for-output", - "aliases": [ - "wfo" - ], - "description": "Wait for the job to enter OUTPUT status before completing the command.", - "type": "boolean", - "group": "Options" - }, - { - "name": "wait-for-active", - "aliases": [ - "wfa" - ], - "description": "Wait for the job to enter ACTIVE status before completing the command.", - "type": "boolean", - "conflictsWith": [ - "wait-for-output", - "view-all-spool-content", - "directory" - ], - "group": "Options" - }, - { - "name": "directory", - "aliases": [ - "d" - ], - "description": "The local directory you would like to download the output of the job. Creates a subdirectory using the jobID as the name and files are titled based on DD names. If you use this option you will wait the job to complete.", - "type": "string", - "group": "Options" - }, - { - "name": "extension", - "aliases": [ - "e" - ], - "description": "A file extension to save the job output with. Default is '.txt'.", - "type": "string", - "group": "Options" - }, - { - "name": "jcl-symbols", - "aliases": [ - "js" - ], - "description": "A string of JCL symbols to use for substitution. For symbol values with no spaces: \"symbol1=value1 symbol2=value2 ...\". When a value contains spaces, enclose the value in single quotes: \"symbol1='value 1 with spaces' symbol2='value 2 with spaces'...\". To embed a single quote in a value, use two single quotes: \"NAME=O''Brian\".", - "type": "string", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [] - }, - { - "name": "response-format-filter", - "aliases": [ - "rff" - ], - "description": "Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.", - "type": "array", - "group": "Response Format Options" - }, - { - "name": "response-format-type", - "aliases": [ - "rft" - ], - "description": "The command response output format type. Must be one of the following:\n\ntable: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.\n\nlist: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.\n\nobject: Formats output data as a list of prettified objects (or single object). Can be used in place of \"table\" to change from tabular output to a list of prettified objects.\n\nstring: Formats output data as a string. JSON objects/arrays are stringified.", - "type": "string", - "allowableValues": { - "values": [ - "table", - "list", - "object", - "string" - ], - "caseSensitive": false - }, - "group": "Response Format Options" - }, - { - "name": "response-format-header", - "aliases": [ - "rfh" - ], - "description": "If \"--response-format-type table\" is specified, include the column headers in the output.", - "type": "boolean", - "group": "Response Format Options", - "defaultValue": null - } - ], - "profile": { - "optional": [ - "rse", - "base" - ] - }, - "outputFormatOptions": true, - "examples": [ - { - "options": "\"iefbr14.txt\"", - "description": "Submit the JCL in the file \"iefbr14.txt\"" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "stdin", - "aliases": [ - "in" - ], - "type": "command", - "summary": "Submit a job read from standard in", - "description": "Submit a job (JCL) passed to the command via the stdin stream. The command presents errors verbatim from the Jobs REST endpoints. For more information about Jobs API errors, see the Jobs API REST documentation.", - "handler": "", - "options": [ - { - "name": "view-all-spool-content", - "aliases": [ - "vasc" - ], - "description": "Print all spool output. If you use this option you will wait the job to complete.", - "type": "boolean", - "group": "Options" - }, - { - "name": "wait-for-output", - "aliases": [ - "wfo" - ], - "description": "Wait for the job to enter OUTPUT status before completing the command.", - "type": "boolean", - "group": "Options" - }, - { - "name": "wait-for-active", - "aliases": [ - "wfa" - ], - "description": "Wait for the job to enter ACTIVE status before completing the command.", - "type": "boolean", - "conflictsWith": [ - "wait-for-output", - "view-all-spool-content", - "directory" - ], - "group": "Options" - }, - { - "name": "directory", - "aliases": [ - "d" - ], - "description": "The local directory you would like to download the output of the job. Creates a subdirectory using the jobID as the name and files are titled based on DD names. If you use this option you will wait the job to complete.", - "type": "string", - "group": "Options" - }, - { - "name": "extension", - "aliases": [ - "e" - ], - "description": "A file extension to save the job output with. Default is '.txt'.", - "type": "string", - "group": "Options" - }, - { - "name": "jcl-symbols", - "aliases": [ - "js" - ], - "description": "A string of JCL symbols to use for substitution. For symbol values with no spaces: \"symbol1=value1 symbol2=value2 ...\". When a value contains spaces, enclose the value in single quotes: \"symbol1='value 1 with spaces' symbol2='value 2 with spaces'...\". To embed a single quote in a value, use two single quotes: \"NAME=O''Brian\".", - "type": "string", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [] - }, - { - "name": "response-format-filter", - "aliases": [ - "rff" - ], - "description": "Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.", - "type": "array", - "group": "Response Format Options" - }, - { - "name": "response-format-type", - "aliases": [ - "rft" - ], - "description": "The command response output format type. Must be one of the following:\n\ntable: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.\n\nlist: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.\n\nobject: Formats output data as a list of prettified objects (or single object). Can be used in place of \"table\" to change from tabular output to a list of prettified objects.\n\nstring: Formats output data as a string. JSON objects/arrays are stringified.", - "type": "string", - "allowableValues": { - "values": [ - "table", - "list", - "object", - "string" - ], - "caseSensitive": false - }, - "group": "Response Format Options" - }, - { - "name": "response-format-header", - "aliases": [ - "rfh" - ], - "description": "If \"--response-format-type table\" is specified, include the column headers in the output.", - "type": "boolean", - "group": "Response Format Options", - "defaultValue": null - } - ], - "profile": { - "optional": [ - "rse", - "base" - ] - }, - "outputFormatOptions": true, - "examples": [ - { - "options": "--wait-for-output", - "prefix": "cat \"iefbr14.txt\" |", - "description": "Submit the JCL using stdin from the command: cat \"iefbr14.txt\", and then wait for the job to enter OUTPUT status before completing the command" - }, - { - "options": "--vasc", - "prefix": "cat \"iefbr14.txt\" |", - "description": "Submit the JCL using stdin from the command: cat \"iefbr14.txt\", and then printing all spool output" - } - ], - "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" - } - ], - "positionals": [], - "passOn": [] - }, - { - "name": "upload", - "aliases": [ - "ul" - ], - "type": "group", - "description": "Upload the contents of a file to z/OS data sets or to z/OS UNIX System Services", - "children": [ - { - "name": "file-to-uss", - "aliases": [ - "ftu" - ], - "description": "Upload content to a z/OS UNIX System Services file from local file", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "rse", - "base" - ] - }, - "positionals": [ - { - "name": "inputfile", - "description": "The local file that you want to upload to a z/OS UNIX System Services file", - "type": "string", - "required": true - }, - { - "name": "USSFileName", - "description": "The name of the z/OS UNIX System Services file to which you want to upload the file", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "binary", - "aliases": [ - "b" - ], - "description": "Data content in binary mode, which means that no data conversion is performed. The data transfer process returns each record as-is, without translation. No delimiters are added between records.", - "type": "boolean", - "group": "Options" - }, - { - "name": "encoding", - "aliases": [ - "ec" - ], - "description": "Upload the file content with encoding mode, which means that data conversion is performed using the file encoding specified.", - "type": "string", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [ - { - "description": "Upload to the z/OS UNIX System Services file \"/a/ibmuser/my_text.txt\" from the file \"file.txt\"", - "options": "\"file.txt\" \"/a/ibmuser/my_text.txt\"" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "dir-to-uss", - "aliases": [ - "dtu" - ], - "summary": "Upload a local directory to a z/OS UNIX System Services directory", - "description": "Upload a local directory to a z/OS UNIX System Services directory.\n\nAn optional .zosattributes file in the source directory can be used to control file conversion and tagging.\n\nAn example .zosattributes file:{{space}}{{space}}\n# pattern local-encoding remote-encoding{{space}}{{space}}\n# Don't upload the node_modules directory{{space}}{{space}\nnode_modules -{{space}}{{space}\n# Don't upload files that start with periods{{space}}{{space}}\n.* - {{space}}{{space}\n# Upload jpg images in binary{{space}}{{space}}\n*.jpg binary binary{{space}}{{space}}\n# Convert CICS Node.js profiles to EBCDIC{{space}}{{space}}\n*.profile ISO8859-1 EBCDIC{{space}}{{space}}\n\nLines starting with the ‘#’ character are comments. Each line can specify up to three positional attributes:\n{{bullet}} A pattern to match a set of files. Pattern-matching syntax follows the same rules as those that apply in .gitignore files (note that negated patterns that begin with ‘!’ are not supported). See https://git-scm.com/docs/gitignore#_pattern_format.\nlocal-encoding, {{bullet}} A local-encoding to identify a file’s encoding on the local workstation. If '-' is specified for files that match the pattern are not transferred.\n{{bullet}} A remote-encoding to specify the file’s desired character set on z/OS UNIX System Services. This attribute must either match the local encoding or be set to EBCDIC. If set to EBCDIC, files are transferred in text mode and converted, otherwise they are transferred in binary mode. Remote files are tagged either with the remote encoding or as binary. \n \nDue to a limitation, files that are transferred in text mode are converted to the default EBCDIC code page on the z/OS system. Therefore the only EBCDIC code page to specify as the remote encoding is the default code page for your system.\n\n A .zosattributes file can either be placed in the top-level directory you want to upload, or its location can be specified by using the --attributes parameter. .zosattributes files that are placed in nested directories are ignored.\n", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "rse", - "base" - ] - }, - "positionals": [ - { - "name": "inputDir", - "description": "The local directory path that you want to upload to a z/OS UNIX System Services directory", - "type": "string", - "required": true - }, - { - "name": "USSDir", - "description": "The name of the z/OS UNIX System Services directory to which you want to upload the local directory", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "attributes", - "aliases": [ - "attrs" - ], - "description": "Path of an attributes file to control how files are uploaded", - "type": "string", - "conflictsWith": [ - "ascii-files, binary-files" - ], - "group": "Options" - }, - { - "name": "binary", - "aliases": [ - "b" - ], - "description": "Data content in binary mode, which means that no data conversion is performed. The data transfer process returns each record as-is, without translation. No delimiters are added between records.", - "type": "boolean", - "group": "Options" - }, - { - "name": "encoding", - "aliases": [ - "ec" - ], - "description": "Upload the file content with encoding mode, which means that data conversion is performed using the file encoding specified.", - "type": "string", - "group": "Options" - }, - { - "name": "max-concurrent-requests", - "aliases": [ - "mcr" - ], - "description": "Specifies the maximum number of concurrent REST API requests to upload files. Increasing the value results in faster uploads. However, increasing the value increases resource consumption on z/OS and can be prone to errors caused by making too many concurrent requests. If the upload process encounters an error, the following message displays:\nThe maximum number of TSO address spaces have been created. When you specify 0, Zowe CLI attempts to upload all members at once without a maximum number of concurrent requests. ", - "type": "number", - "defaultValue": 1, - "numericValueRange": [ - 0, - 99999 - ], - "group": "Options" - }, - { - "name": "recursive", - "aliases": [ - "r" - ], - "description": "Upload all directories recursively.", - "type": "boolean", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [ - { - "description": "Upload all files from the \"local_dir\" directory to the \"/a/ibmuser/my_dir\" z/OS UNIX System Services directory:\"", - "options": "\"local_dir\" \"/a/ibmuser/my_dir\"" - }, - { - "description": "Upload all files from the \"local_dir\" directory and all its sub-directories, to the \"/a/ibmuser/my_dir\" z/OS UNIX System Services directory:", - "options": "\"local_dir\" \"/a/ibmuser/my_dir\" --recursive" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "file-to-data-set", - "aliases": [ - "ftds" - ], - "description": "Upload the contents of a file to a z/OS data set", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "rse", - "base" - ] - }, - "positionals": [ - { - "name": "inputfile", - "description": "The local file that you want to upload to a data set", - "type": "string", - "required": true - }, - { - "name": "dataSetName", - "description": "The name of the data set to which you want to upload the file", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "binary", - "aliases": [ - "b" - ], - "description": "Data content in binary mode, which means that no data conversion is performed. The data transfer process returns each record as-is, without translation. No delimiters are added between records.", - "type": "boolean", - "group": "Options" - }, - { - "name": "encoding", - "aliases": [ - "ec" - ], - "description": "Upload the file content with encoding mode, which means that data conversion is performed using the file encoding specified.", - "type": "string", - "group": "Options" - }, - { - "name": "mappings-file", - "aliases": [ - "maps" - ], - "description": "Location of an alternate MVS Mappings file.", - "type": "string", - "group": "Options" - }, - { - "name": "volume-serial", - "aliases": [ - "vs" - ], - "description": "The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.", - "type": "string", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [ - { - "description": "Upload file contents to a sequential data set named \"ibmuser.ps\"", - "options": "\"file.txt\" \"ibmuser.ps\"" - }, - { - "description": "Upload file contents to a PDS member named \"ibmuser.pds(mem)\"", - "options": "\"file.txt\" \"ibmuser.pds(mem)\"" - } - ], - "passOn": [], - "children": [] - }, - { - "name": "dir-to-pds", - "aliases": [ - "dtp" - ], - "description": "Upload files from a local directory to a partitioned data set (PDS)", - "type": "command", - "handler": "", - "profile": { - "optional": [ - "rse", - "base" - ] - }, - "positionals": [ - { - "name": "inputdir", - "description": "The path for a local directory that you want to upload to a PDS", - "type": "string", - "required": true - }, - { - "name": "dataSetName", - "description": "The name of the partitioned data set to which you want to upload the files", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "binary", - "aliases": [ - "b" - ], - "description": "Data content in binary mode, which means that no data conversion is performed. The data transfer process returns each record as-is, without translation. No delimiters are added between records.", - "type": "boolean", - "group": "Options" - }, - { - "name": "encoding", - "aliases": [ - "ec" - ], - "description": "Upload the file content with encoding mode, which means that data conversion is performed using the file encoding specified.", - "type": "string", - "group": "Options" - }, - { - "name": "mappings-file", - "aliases": [ - "maps" - ], - "description": "Location of an alternate MVS Mappings file.", - "type": "string", - "group": "Options" - }, - { - "name": "migrated-recall", - "aliases": [ - "mr" - ], - "description": "The method by which migrated data set is handled. By default, a migrated data set is recalled synchronously. You can specify the following values: wait, nowait, error", - "type": "string", - "defaultValue": "nowait", - "group": "Options" - }, - { - "name": "volume-serial", - "aliases": [ - "vs" - ], - "description": "The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.", - "type": "string", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [ - { - "description": "Upload a directory named \"src\" to a PDS named \"ibmuser.src\"", - "options": "\"src\" \"ibmuser.src\"" - }, - { - "description": "Upload a directory named \"src\" to a migrated PDS named \"ibmuser.src\" and wait for it to be recalled", - "options": "\"src\" \"ibmuser.src\" --mr wait" - } - ], - "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" - } - ], - "positionals": [], - "passOn": [] - }, - { - "name": "view", - "aliases": [ - "vw" - ], - "type": "group", - "summary": "View details of a z/OS job", - "description": "View details of z/OS jobs on spool/JES queues.", - "children": [ - { - "name": "job-status-by-jobid", - "aliases": [ - "jsbj" - ], - "type": "command", - "summary": "View status details of a z/OS job", - "description": "View status details of a single z/OS job on spool/JES queues. The command does not prevalidate the JOBID. The command presents errors verbatim from the Jobs REST endpoints (expect for \"no jobs found\").", - "handler": "", - "options": [ - { - "name": "attributes", - "aliases": [ - "a" - ], - "description": "Display more information about the job.", - "type": "boolean", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [] - }, - { - "name": "response-format-filter", - "aliases": [ - "rff" - ], - "description": "Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.", - "type": "array", - "group": "Response Format Options" - }, - { - "name": "response-format-type", - "aliases": [ - "rft" - ], - "description": "The command response output format type. Must be one of the following:\n\ntable: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.\n\nlist: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.\n\nobject: Formats output data as a list of prettified objects (or single object). Can be used in place of \"table\" to change from tabular output to a list of prettified objects.\n\nstring: Formats output data as a string. JSON objects/arrays are stringified.", - "type": "string", - "allowableValues": { - "values": [ - "table", - "list", - "object", - "string" - ], - "caseSensitive": false - }, - "group": "Response Format Options" - }, - { - "name": "response-format-header", - "aliases": [ - "rfh" - ], - "description": "If \"--response-format-type table\" is specified, include the column headers in the output.", - "type": "boolean", - "group": "Response Format Options", - "defaultValue": null - } - ], - "profile": { - "optional": [ - "rse", - "base" - ] - }, - "positionals": [ - { - "name": "jobid", - "description": "The z/OS JOBID of the job you want to view. No prevalidation of the JOBID is performed.", - "type": "string", - "required": true - } - ], - "examples": [ - { - "options": "j123", - "description": "View status and other details of the job with the job ID JOB00123" - }, - { - "options": "j123 --rff status --rft string", - "description": "Print only the status (for example, \"OUTPUT\" or \"ACTIVE\") of the job with the job ID JOB00123" - } - ], - "outputFormatOptions": true, - "passOn": [], - "children": [] - }, - { - "name": "spool-file-by-id", - "aliases": [ - "sfbi" - ], - "type": "command", - "summary": "View a spool file from a z/OS job", - "description": "View the contents of a spool file from a z/OS job on spool/JES queues. The command does not pre-validate the JOBID or spool ID. The command presents errors verbatim from the Jobs REST endpoints.", - "handler": "", - "profile": { - "optional": [ - "rse", - "base" - ] - }, - "positionals": [ - { - "name": "jobid", - "description": "The z/OS JOBID of the job containing the spool file you want to view. No pre-validation of the JOBID is performed.", - "type": "string", - "required": true - }, - { - "name": "spoolfileid", - "description": "The spool file ID number for the spool file to view. Use the \"zowe rse list spool-files-by-jobid\" command to obtain spool ID numbers.No pre-validation of the ID is performed.", - "type": "number", - "required": true - } - ], - "examples": [ - { - "description": "View the spool file with ID 4 for the job with job ID JOB00123", - "options": "JOB00123 4" - } - ], - "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": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [] - }, - { - "name": "job-step-info", - "aliases": [ - "jsi" - ], - "type": "command", - "summary": "View Step Info of z/OS Jobs", - "description": "View Step Info of specified job provided JOBNAME and JOBID", - "handler": "", - "positionals": [ - { - "name": "jobname", - "description": "The z/OS Job Name of the job containing the step information you want to view.", - "type": "string", - "required": true - }, - { - "name": "jobid", - "description": "The z/OS JobId of the job containing the step information you want to view.", - "type": "string", - "required": true - } - ], - "examples": [ - { - "description": "Get Step Info of job JOBNAME IBMUSER JOBID JOB00134", - "options": "JOBNAME JOBID" - } - ], - "profile": { - "required": [ - "rse" - ], - "optional": [ - "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": "rse-profile", - "aliases": [ - "rse-p" - ], - "group": "Profile Options", - "description": "The name of a (rse) 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": [] - } - ], - "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": [] - } - ], - "summary": "IBM RSE API Plug-in for Zowe CLI", - "aliases": [ - "rse" - ], - "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/sysview.jsonc b/commandGroups/sysview.jsonc deleted file mode 100644 index ed28328..0000000 --- a/commandGroups/sysview.jsonc +++ /dev/null @@ -1,1341 +0,0 @@ -// 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 diff --git a/commandGroups/zjcl-expert.jsonc b/commandGroups/zjcl-expert.jsonc deleted file mode 100644 index 6a7baa0..0000000 --- a/commandGroups/zjcl-expert.jsonc +++ /dev/null @@ -1,1185 +0,0 @@ -// PID 5698-020 -// Copyright Teracloud ApS 2023 -{ - "name": "zjcl-expert", - "description": "IBM Z JCL Expert Plug-in for Zowe CLI", - "type": "group", - "children": [ - { - "name": "remote-ds", - "aliases": [ - "ds" - ], - "summary": "Validate a remote data set.", - "description": "Wraps an SSH call to JCLX on the remote system to validate the specified remote data set.", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "dsn", - "description": "The name of the data set to be analysed on the remote system.", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "output", - "aliases": [ - "o" - ], - "allowableValues": { - "values": [ - "json", - "text" - ] - }, - "description": "The output format provided upon completion.", - "defaultValue": "json", - "type": "string", - "group": "Options" - }, - { - "name": "alias", - "aliases": [ - "a" - ], - "description": "An alias to give the file name during analysis.", - "type": "string", - "group": "Options" - }, - { - "name": "dsn-check", - "allowableValues": { - "values": [ - "ON", - "OFF" - ], - "caseSensitive": false - }, - "aliases": [ - "c" - ], - "description": "Turn on or off DSN and USS file existence checking during analysis.", - "defaultValue": "ON", - "type": "string", - "group": "Options" - }, - { - "name": "rules", - "aliases": [ - "r" - ], - "description": "The absolute path of the remote rules file used to define user site rules during analysis.", - "type": "string", - "group": "Options" - }, - { - "name": "job-class", - "aliases": [ - "j" - ], - "description": "The default job class to use during JCL analysis if none is provided.", - "type": "string", - "group": "Options" - }, - { - "name": "log-level", - "allowableValues": { - "values": [ - "TRACE", - "DEBUG", - "INFO", - "WARN", - "ERROR", - "FATAL" - ], - "caseSensitive": true - }, - "aliases": [ - "l" - ], - "description": "The level of diagnostic logging to be performed during analysis. Messages at this level and above are written to stderr if no log file is specified.", - "defaultValue": "FATAL", - "type": "string", - "group": "Options" - }, - { - "name": "log-file", - "aliases": [ - "d" - ], - "description": "The relative path of a local file that log messages are output to. If the file already exists it will be overwritten.", - "type": "string", - "group": "Options" - }, - { - "name": "remote-home-dir", - "description": "The home directory of IBM Z JCL Expert in USS on your remote system. If this option is not set, the plug-in will rely on the PATH variable in the remote user environment.", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "remote-temp-dir", - "description": "The directory where all temporary files are created and deleted by the IBM Z JCL Expert Zowe CLI plugin. Temporary files are cleaned up after each operation. Defaults to \"/tmp\" if not specified.", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "language", - "description": "The language to be used by IBM Z JCL Expert when invoked. This option will be ignored if remoteHomeDir is not specified.", - "type": "string", - "allowableValues": { - "values": [ - "ENG", - "JPN" - ] - }, - "defaultValue": "ENG", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "response-encoding", - "description": "The encoding to translate the remote response from. An empty string value or 'binary' will result in no encoding translation. Defaults to 'utf-8' if not provided.", - "type": "string", - "defaultValue": "utf-8", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "The z/OSMF server port.", - "type": "number", - "defaultValue": 443, - "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": "ssh-port", - "aliases": [ - "S" - ], - "description": "The z/OS SSH server port.", - "type": "number", - "defaultValue": 22, - "group": "z/OS Ssh Connection Options" - }, - { - "name": "privateKey", - "aliases": [ - "key", - "pk" - ], - "description": "Path to a file containing your private key, that must match a public key stored in the server for authentication", - "type": "string", - "group": "z/OS Ssh Connection Options" - }, - { - "name": "keyPassphrase", - "aliases": [ - "passphrase", - "kp" - ], - "description": "Private key passphrase, which unlocks the private key.", - "type": "string", - "group": "z/OS Ssh Connection Options" - }, - { - "name": "handshakeTimeout", - "aliases": [ - "timeout", - "to" - ], - "description": "How long in milliseconds to wait for the SSH handshake to complete.", - "type": "number", - "group": "z/OS Ssh 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": "jclx-profile", - "aliases": [ - "jclx-p" - ], - "group": "Profile Options", - "description": "The name of a (jclx) 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": "ssh-profile", - "aliases": [ - "ssh-p" - ], - "group": "Profile Options", - "description": "The name of a (ssh) 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": "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" - } - ], - "profile": { - "optional": [ - "jclx", - "zosmf", - "ssh", - "base" - ] - }, - "passOn": [], - "children": [] - }, - { - "name": "remote-fs", - "aliases": [ - "fs" - ], - "summary": "Validate a remote file.", - "description": "Wraps an SSH call to JCLX on the remote system to validate the specified remote zFS file.", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "filePath", - "description": "The absolute file path of the USS file to be analysed on the remote system.", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "output", - "aliases": [ - "o" - ], - "allowableValues": { - "values": [ - "json", - "text" - ] - }, - "description": "The output format provided upon completion.", - "defaultValue": "json", - "type": "string", - "group": "Options" - }, - { - "name": "alias", - "aliases": [ - "a" - ], - "description": "An alias to give the file name during analysis.", - "type": "string", - "group": "Options" - }, - { - "name": "dsn-check", - "allowableValues": { - "values": [ - "ON", - "OFF" - ], - "caseSensitive": false - }, - "aliases": [ - "c" - ], - "description": "Turn on or off DSN and USS file existence checking during analysis.", - "defaultValue": "ON", - "type": "string", - "group": "Options" - }, - { - "name": "rules", - "aliases": [ - "r" - ], - "description": "The absolute path of the remote rules file used to define user site rules during analysis.", - "type": "string", - "group": "Options" - }, - { - "name": "job-class", - "aliases": [ - "j" - ], - "description": "The default job class to use during JCL analysis if none is provided.", - "type": "string", - "group": "Options" - }, - { - "name": "log-level", - "allowableValues": { - "values": [ - "TRACE", - "DEBUG", - "INFO", - "WARN", - "ERROR", - "FATAL" - ], - "caseSensitive": true - }, - "aliases": [ - "l" - ], - "description": "The level of diagnostic logging to be performed during analysis. Messages at this level and above are written to stderr if no log file is specified.", - "defaultValue": "FATAL", - "type": "string", - "group": "Options" - }, - { - "name": "log-file", - "aliases": [ - "d" - ], - "description": "The relative path of a local file that log messages are output to. If the file already exists it will be overwritten.", - "type": "string", - "group": "Options" - }, - { - "name": "remote-home-dir", - "description": "The home directory of IBM Z JCL Expert in USS on your remote system. If this option is not set, the plug-in will rely on the PATH variable in the remote user environment.", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "remote-temp-dir", - "description": "The directory where all temporary files are created and deleted by the IBM Z JCL Expert Zowe CLI plugin. Temporary files are cleaned up after each operation. Defaults to \"/tmp\" if not specified.", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "language", - "description": "The language to be used by IBM Z JCL Expert when invoked. This option will be ignored if remoteHomeDir is not specified.", - "type": "string", - "allowableValues": { - "values": [ - "ENG", - "JPN" - ] - }, - "defaultValue": "ENG", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "response-encoding", - "description": "The encoding to translate the remote response from. An empty string value or 'binary' will result in no encoding translation. Defaults to 'utf-8' if not provided.", - "type": "string", - "defaultValue": "utf-8", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "The z/OSMF server port.", - "type": "number", - "defaultValue": 443, - "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": "ssh-port", - "aliases": [ - "S" - ], - "description": "The z/OS SSH server port.", - "type": "number", - "defaultValue": 22, - "group": "z/OS Ssh Connection Options" - }, - { - "name": "privateKey", - "aliases": [ - "key", - "pk" - ], - "description": "Path to a file containing your private key, that must match a public key stored in the server for authentication", - "type": "string", - "group": "z/OS Ssh Connection Options" - }, - { - "name": "keyPassphrase", - "aliases": [ - "passphrase", - "kp" - ], - "description": "Private key passphrase, which unlocks the private key.", - "type": "string", - "group": "z/OS Ssh Connection Options" - }, - { - "name": "handshakeTimeout", - "aliases": [ - "timeout", - "to" - ], - "description": "How long in milliseconds to wait for the SSH handshake to complete.", - "type": "number", - "group": "z/OS Ssh 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": "jclx-profile", - "aliases": [ - "jclx-p" - ], - "group": "Profile Options", - "description": "The name of a (jclx) 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": "ssh-profile", - "aliases": [ - "ssh-p" - ], - "group": "Profile Options", - "description": "The name of a (ssh) 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": "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" - } - ], - "profile": { - "optional": [ - "jclx", - "zosmf", - "ssh", - "base" - ] - }, - "passOn": [], - "children": [] - }, - { - "name": "local", - "aliases": [ - "l" - ], - "summary": "Validate a local file that contains JCL.", - "description": "Wraps an SSH call to JCLX on the remote system to validate the specified local file containing JCL.", - "type": "command", - "handler": "", - "positionals": [ - { - "name": "filePath", - "description": "The relative file path of the local file to be analysed on the remote system.", - "type": "existingLocalFile", - "required": true - } - ], - "options": [ - { - "name": "output", - "aliases": [ - "o" - ], - "allowableValues": { - "values": [ - "json", - "text" - ] - }, - "description": "The output format provided upon completion.", - "defaultValue": "json", - "type": "string", - "group": "Options" - }, - { - "name": "alias", - "aliases": [ - "a" - ], - "description": "An alias to give the file name during analysis.", - "type": "string", - "group": "Options" - }, - { - "name": "dsn-check", - "allowableValues": { - "values": [ - "ON", - "OFF" - ], - "caseSensitive": false - }, - "aliases": [ - "c" - ], - "description": "Turn on or off DSN and USS file existence checking during analysis.", - "defaultValue": "ON", - "type": "string", - "group": "Options" - }, - { - "name": "rules", - "aliases": [ - "r" - ], - "description": "The absolute path of the remote rules file used to define user site rules during analysis.", - "type": "string", - "group": "Options" - }, - { - "name": "local-rules", - "aliases": [ - "e" - ], - "description": "The relative path to a local rules file that will be uploaded as a temporary file and used to define user site rules during analysis.", - "type": "existingLocalFile", - "group": "Options" - }, - { - "name": "job-class", - "aliases": [ - "j" - ], - "description": "The default job class to use during JCL analysis if none is provided.", - "type": "string", - "group": "Options" - }, - { - "name": "log-level", - "allowableValues": { - "values": [ - "TRACE", - "DEBUG", - "INFO", - "WARN", - "ERROR", - "FATAL" - ], - "caseSensitive": true - }, - "aliases": [ - "l" - ], - "description": "The level of diagnostic logging to be performed during analysis. Messages at this level and above are written to stderr if no log file is specified.", - "defaultValue": "FATAL", - "type": "string", - "group": "Options" - }, - { - "name": "log-file", - "aliases": [ - "d" - ], - "description": "The relative path of a local file that log messages are output to. If the file already exists it will be overwritten.", - "type": "string", - "group": "Options" - }, - { - "name": "remote-home-dir", - "description": "The home directory of IBM Z JCL Expert in USS on your remote system. If this option is not set, the plug-in will rely on the PATH variable in the remote user environment.", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "remote-temp-dir", - "description": "The directory where all temporary files are created and deleted by the IBM Z JCL Expert Zowe CLI plugin. Temporary files are cleaned up after each operation. Defaults to \"/tmp\" if not specified.", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "language", - "description": "The language to be used by IBM Z JCL Expert when invoked. This option will be ignored if remoteHomeDir is not specified.", - "type": "string", - "allowableValues": { - "values": [ - "ENG", - "JPN" - ] - }, - "defaultValue": "ENG", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "response-encoding", - "description": "The encoding to translate the remote response from. An empty string value or 'binary' will result in no encoding translation. Defaults to 'utf-8' if not provided.", - "type": "string", - "defaultValue": "utf-8", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "The z/OSMF server port.", - "type": "number", - "defaultValue": 443, - "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": "ssh-port", - "aliases": [ - "S" - ], - "description": "The z/OS SSH server port.", - "type": "number", - "defaultValue": 22, - "group": "z/OS Ssh Connection Options" - }, - { - "name": "privateKey", - "aliases": [ - "key", - "pk" - ], - "description": "Path to a file containing your private key, that must match a public key stored in the server for authentication", - "type": "string", - "group": "z/OS Ssh Connection Options" - }, - { - "name": "keyPassphrase", - "aliases": [ - "passphrase", - "kp" - ], - "description": "Private key passphrase, which unlocks the private key.", - "type": "string", - "group": "z/OS Ssh Connection Options" - }, - { - "name": "handshakeTimeout", - "aliases": [ - "timeout", - "to" - ], - "description": "How long in milliseconds to wait for the SSH handshake to complete.", - "type": "number", - "group": "z/OS Ssh 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": "jclx-profile", - "aliases": [ - "jclx-p" - ], - "group": "Profile Options", - "description": "The name of a (jclx) 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": "ssh-profile", - "aliases": [ - "ssh-p" - ], - "group": "Profile Options", - "description": "The name of a (ssh) 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": "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" - } - ], - "onlyOneOf": [ - "rules", - "local-rules" - ], - "profile": { - "optional": [ - "jclx", - "zosmf", - "ssh", - "base" - ] - }, - "passOn": [], - "children": [] - } - ], - "aliases": [ - "jclx" - ], - "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/profiles/create/ca7.jsonc b/profiles/create/ca7.jsonc deleted file mode 100644 index 98f9e35..0000000 --- a/profiles/create/ca7.jsonc +++ /dev/null @@ -1,157 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "ca7-profile", - "aliases": [ - "ca7" - ], - "summary": "Create a ca7 profile", - "description": "A CA7 profile is required to issue commands in the CA7 command group. The CA7 profile contains your host and port for the CA7 instance of your choice.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config init' command", - "customize": { - "profileTypeIdentifier": "ca7" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new ca7 profile. You can load this profile by using the name on commands that support the \"--ca7-profile\" option.", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": true, - "group": "CA7 Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": true, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "CA7 Connection Options" - }, - { - "name": "overwrite", - "aliases": [ - "ow" - ], - "description": "Overwrite the ca7 profile when a profile of the same name exists.", - "type": "boolean", - "group": "Options" - }, - { - "name": "disable-defaults", - "aliases": [ - "dd" - ], - "description": "Disable populating profile values of undefined properties with default values.", - "type": "boolean", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/create/caview.jsonc b/profiles/create/caview.jsonc deleted file mode 100644 index 652e024..0000000 --- a/profiles/create/caview.jsonc +++ /dev/null @@ -1,152 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "caview-profile", - "aliases": [ - "caview" - ], - "summary": "Create a caview profile", - "description": "Configuration profile for View", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config init' command", - "customize": { - "profileTypeIdentifier": "caview" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new caview profile. You can load this profile by using the name on commands that support the \"--caview-profile\" option.", - "type": "string", - "required": true - } - ], - "options": [ - { - "type": "string", - "name": "protocol", - "description": "Protocol of the target View REST API instance.", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "defaultValue": "https", - "group": "Options", - "aliases": [] - }, - { - "type": "string", - "name": "host", - "aliases": [ - "hostname" - ], - "description": "Hostname or ip address of the target View REST API instance.", - "required": false, - "group": "Options" - }, - { - "type": "number", - "name": "port", - "description": "Port of the target View REST API instance.", - "numericValueRange": [ - 0, - 65535 - ], - "required": false, - "defaultValue": 443, - "group": "Options", - "aliases": [] - }, - { - "type": "string", - "name": "base-path", - "description": "Context name of the target View REST API instance.", - "required": false, - "defaultValue": "web-viewer", - "group": "Options", - "aliases": [] - }, - { - "type": "string", - "name": "user", - "aliases": [ - "username" - ], - "description": "User name used to authenticate against the target View REST API instance.", - "required": false, - "group": "Options" - }, - { - "type": "string", - "name": "password", - "description": "Password used to authenticate against the target View REST API instance.", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "overwrite", - "aliases": [ - "ow" - ], - "description": "Overwrite the caview profile when a profile of the same name exists.", - "type": "boolean", - "group": "Options" - }, - { - "name": "disable-defaults", - "aliases": [ - "dd" - ], - "description": "Disable populating profile values of undefined properties with default values.", - "type": "boolean", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "myProfile --hostname mf.company.org --protocol http --port 80 --username johndoe --password secret", - "description": "Create a profile for View™ Plug-in for Zowe CLI named 'myProfile' to connect to 'mf.company.org' over HTTP on port 80 using the 'johndoe' account." - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/create/dbm-db2-options.jsonc b/profiles/create/dbm-db2-options.jsonc deleted file mode 100644 index 43ac387..0000000 --- a/profiles/create/dbm-db2-options.jsonc +++ /dev/null @@ -1,286 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "dbm-db2-options-profile", - "aliases": [ - "dbm-db2-options" - ], - "summary": "Create a dbm-db2-options profile", - "description": "The DBM-Db2 options profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes execution-dependent details.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config init' command", - "customize": { - "profileTypeIdentifier": "dbm-db2-options" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new dbm-db2-options profile. You can load this profile by using the name on commands that support the \"--dbm-db2-options-profile\" option.", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "authid", - "aliases": [ - "a" - ], - "description": "Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.", - "required": false, - "type": "string", - "group": "Options" - }, - { - "name": "change-set", - "aliases": [ - "cs" - ], - "description": "Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.\n\n Format:\n \n \n\nFor more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote: If change-set and change-set-file are both specified, specifications in change-set-file take precedence. ", - "required": false, - "type": "string", - "group": "Options" - }, - { - "name": "change-set-values", - "aliases": [ - "csv" - ], - "description": "Specifies the global change specifications that modify Db2 object attributes during a command execution.\n\n Format:\n \n \n \nThe consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in the and . The first occurrence in multiple specifications for the same has the highest precedence.\n \nFor a list of global change set attributes, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nExample:\n \nThe following example demonstrates changes to the table schema (creator) and tablespace names:\n \nTBCR TEST% PROD%\nTBTS TESTTS% PRODTS%\n\nNote:\n- If change-set and change-set-file are both specified, specifications in change-set-file take precedence.\n- The changeSetValues options-profile option has the same behavior as the change-set-file command option. ", - "required": false, - "type": "array", - "group": "Options" - }, - { - "name": "delete-work-datasets", - "aliases": [ - "dwd" - ], - "description": "Specifies whether to delete work data sets on a mainframe after the request is fulfilled.", - "required": false, - "type": "boolean", - "defaultValue": null, - "group": "Options" - }, - { - "name": "description", - "aliases": [ - "d" - ], - "description": "Specifies a 1- to 25-character description for the RC/Migrator compare strategy.", - "required": false, - "type": "string", - "group": "Options" - }, - { - "name": "id", - "description": "Specifies the 1- to 8-character name of the RC/Migrator compare strategy that is created on the target Db2 subsystem during a command execution.\n \n Format: The name must begin with a non-numeric character and contain the following characters only: uppercase letters from A to Z, numbers from 0 to 9, and special characters $, #, and @. ", - "required": false, - "type": "string", - "group": "Options", - "aliases": [] - }, - { - "name": "job-cards", - "aliases": [ - "jc" - ], - "description": "Specifies a string array of z/OS JCL JOB statements.", - "required": false, - "type": "array", - "group": "Options" - }, - { - "name": "match-set", - "aliases": [ - "ms" - ], - "description": "Specifies the creator and name of an existing RC/Migrator automapping mask set. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. Matching determines whether the 'change-set' or 'rule-set' options are applied.\n\n Format:\n\n\n\nFor more information about mask services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n\nNote: If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence. ", - "required": false, - "type": "string", - "group": "Options" - }, - { - "name": "match-set-values", - "aliases": [ - "msv" - ], - "description": "Specifies the mapping mask specifications. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. For example, a mask specification can account for different schema naming patterns across environments. Matching determines whether the 'change-set' or 'rule-set' options are applied.\n \n Format:\n\n ;\n\nSTOGROUP \nDATABASE \nTABLESPACE \nTABLE \nINDEX \nVIEW \nSYNONYM \nALIAS \nTRIGGER \nSEQUENCE \nFUNCTION \nPROCEDURE \n \nNote:\n- must be between 1 and 128 characters. For DATABASE and TABLESPACE, must be between 1 and 8 characters.\n- must be between 1 and 128 characters.\n- must be between 1 and 64 characters.\n \nA mask specification can include the following wildcard characters:\n \nPercent sign (%) indicates that zero or more characters can occupy that position and all remaining positions to the end of the name, or to the next character. The percent sign can be used anywhere in the name. However, the source and target characters must match exactly.\n \nHyphen or dash (-) indicates that any character can occupy that position, but a character must exist at that position, and the source and target character must match exactly. The hyphen can be repeated in several places in the name.\n \nAsterisk (*) indicates matching values. An asterisk cannot be used with other characters.\n \nUse a semicolon to separate mask specifications. Multiple mask specifications for the same object type are supported.\n\nExample:\n \nThe following example demonstrates different ways of matching the table MYNAME.MYTABLE to the table YOURNAME.YOURTABLE:\n \nTABLE MY%.%TABLE YOUR%.%TABLE; \nTABLE MYN-M-.MYT% YOURN-M-.YOURT%;\nTABLE MYNAME.MYTABLE YOURNAME.YOURTABLE; \nTABLE *.MYTABLE *.YOURTABLE;\n\nFor a list of mask specifications, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote:\n- If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence.\n- The matchSetValues options-profile option has the same behavior as the match-set-file command option. ", - "required": false, - "type": "array", - "group": "Options" - }, - { - "name": "modification", - "aliases": [ - "m" - ], - "description": "Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.\n \n For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt ", - "required": false, - "type": "string", - "group": "Options" - }, - { - "name": "overwrite-output-files", - "aliases": [ - "oof" - ], - "description": "Specifies whether to overwrite output files if they exist.", - "required": false, - "type": "boolean", - "defaultValue": null, - "group": "Options" - }, - { - "name": "rule-set", - "aliases": [ - "rs" - ], - "description": "Specifies the creator and name of an existing RC/Migrator rule set that overrides Db2 object attributes in the target Db2 subsystem with the corresponding values from the input DDL file. The changes only apply to existing objects, as determined by match-set processing.\n\n Format:\n\n\n \nFor more information about rule database services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig ", - "required": false, - "type": "string", - "group": "Options" - }, - { - "name": "sqlid", - "aliases": [ - "s" - ], - "description": "Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.", - "required": false, - "type": "string", - "group": "Options" - }, - { - "name": "source-db2", - "aliases": [ - "sd" - ], - "description": "Specifies the source Db2 subsystem or data sharing group where the objects that you want to use in a command are located.\n \n Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used. ", - "required": false, - "type": "string", - "group": "Options" - }, - { - "name": "target-db2", - "aliases": [ - "td" - ], - "description": "Specifies the target Db2 subsystem or data sharing group where you want to use a command.\n \n Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used. ", - "required": false, - "type": "string", - "group": "Options" - }, - { - "name": "termination-character", - "aliases": [ - "tc" - ], - "description": "Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.", - "required": false, - "type": "string", - "stringLengthRange": [ - 1, - 1 - ], - "group": "Options" - }, - { - "name": "type", - "aliases": [ - "t" - ], - "description": "Specifies the type of DDL statements that you want to generate. You can generate CREATE or DROP statements.", - "required": false, - "type": "string", - "allowableValues": { - "values": [ - "drop", - "create" - ] - }, - "group": "Options" - }, - { - "name": "verify", - "aliases": [ - "v" - ], - "description": "Specifies whether to verify that the objects to be created do not exist on the Db2 subsystem and that the related objects that are required for successful creation of the objects exist on the Db2 subsystem or in the input DDL.\n \n Default value: no ", - "required": false, - "type": "string", - "allowableValues": { - "values": [ - "yes", - "no" - ] - }, - "group": "Options" - }, - { - "name": "work-dataset-prefix", - "aliases": [ - "wdp" - ], - "description": "Specifies the prefix (high-level qualifier) in z/OS work data set names.", - "required": false, - "type": "string", - "group": "Options" - }, - { - "name": "overwrite", - "aliases": [ - "ow" - ], - "description": "Overwrite the dbm-db2-options profile when a profile of the same name exists.", - "type": "boolean", - "group": "Options" - }, - { - "name": "disable-defaults", - "aliases": [ - "dd" - ], - "description": "Disable populating profile values of undefined properties with default values.", - "type": "boolean", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/create/dbm-db2.jsonc b/profiles/create/dbm-db2.jsonc deleted file mode 100644 index d4474bc..0000000 --- a/profiles/create/dbm-db2.jsonc +++ /dev/null @@ -1,278 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "dbm-db2-profile", - "aliases": [ - "dbm-db2" - ], - "summary": "Create a dbm-db2 profile", - "description": "The DBM-Db2 profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes server connection, z/OS execution, and user-dependent details.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config init' command", - "customize": { - "profileTypeIdentifier": "dbm-db2" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new dbm-db2 profile. You can load this profile by using the name on commands that support the \"--dbm-db2-profile\" option.", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the DBM Data Service REST API server host name or TCP/IP address to use.", - "required": false, - "type": "string", - "group": "DBM-Db2 Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the DBM Data Service REST API server TCP/IP port number.", - "required": false, - "type": "number", - "defaultValue": 7300, - "group": "DBM-Db2 Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Specifies the mainframe user name that you want to use to connect to the mainframe systems during execution of the Zowe CLI commands. This user name can be the same as your TSO login ID.", - "required": false, - "type": "string", - "group": "DBM-Db2 Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Specifies the mainframe password for the user name that is used to connect to the mainframe systems during execution of the CLI commands. This password can be the same as your TSO password.", - "required": false, - "type": "string", - "group": "DBM-Db2 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 Options", - "defaultValue": "https", - "aliases": [] - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Determines whether the dbm-db2 command is accepted or rejected when a self-signed certificate is returned by the DBM Data Service.", - "required": false, - "type": "boolean", - "defaultValue": true, - "group": "DBM-Db2 Options" - }, - { - "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 Options", - "defaultValue": { - "ssid1": "env1@host1:port1", - "ssid2": "env2@host2:port2" - } - }, - { - "name": "job-cards", - "aliases": [ - "jc" - ], - "description": "Specifies a string array of z/OS JCL JOB statements.", - "required": false, - "type": "array", - "group": "DBM-Db2 Options", - "defaultValue": [ - "//DB2DVOPS JOB CLASS=A,", - "// MSGCLASS=X" - ] - }, - { - "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 Options", - "defaultValue": "${user}.dbmdb2" - }, - { - "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 Options", - "defaultValue": true - }, - { - "name": "overwrite-output-files", - "aliases": [ - "oof" - ], - "description": "Specifies whether to overwrite output files if they exist.", - "required": false, - "type": "boolean", - "group": "DBM-Db2 Options", - "defaultValue": false - }, - { - "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 Options", - "defaultValue": "${user}" - }, - { - "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 Options", - "defaultValue": "${user}" - }, - { - "name": "termination-character", - "aliases": [ - "tc" - ], - "description": "Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.", - "required": false, - "type": "string", - "stringLengthRange": [ - 1, - 1 - ], - "group": "DBM-Db2 Options", - "defaultValue": ";" - }, - { - "name": "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 Options" - }, - { - "name": "overwrite", - "aliases": [ - "ow" - ], - "description": "Overwrite the dbm-db2 profile when a profile of the same name exists.", - "type": "boolean", - "group": "Options" - }, - { - "name": "disable-defaults", - "aliases": [ - "dd" - ], - "description": "Disable populating profile values of undefined properties with default values.", - "type": "boolean", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "profile_name1", - "description": "Create a DBM-Db2 profile named profile_name1 and default values for all the options" - }, - { - "options": "dbm123 --host dbm123 --port 1443 --user db2user --password myp4ss", - "description": "Create a DBM-Db2 profile named dbm123 that connects to the DBM Data Service at host dbm123 and port 1443 as user db2user and password myp4ss" - }, - { - "options": "dbm124 --host dbm124 --user db2user --password myp4ss --reject-unauthorized false", - "description": "Create a DBM-Db2 profile named dbm124 that connects to the DBM Data Service at host dbm124 and the default port as user db2user and password myp4ss, and allow self-signed certificates" - }, - { - "options": "dbm125 --host dbm125 --port 1443 --environment-list \"SUBA:prod@host1.com:322,SUBB:test@host2.net:522\"", - "description": "Create a DBM-Db2 profile named dbm125 that connects to the DBM Data Service at host dbm125 and port 1443 and requires a user and password to be specified on every dbm-db2 command. DBM Data Service access to Db2 subsystems SUBA and SUBB uses prod@host1.com:322 and test@host2.com:522, respectively" - }, - { - "options": "dbm126 --job-cards \"//DB2DVOPS JOB (123456789),'DB2 PROVISIONING',NOTIFY=&SYSUID,\" \"// CLASS=A,MSGCLASS=X,MSGLEVEL=(1,1),\" \"// REGION=0M,TIME=NOLIMIT\"", - "description": "Create a DBM-Db2 profile named dbm126 that uses specified job cards for every mainframe job" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/create/ebg.jsonc b/profiles/create/ebg.jsonc deleted file mode 100644 index 4a0111b..0000000 --- a/profiles/create/ebg.jsonc +++ /dev/null @@ -1,147 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "ebg-profile", - "aliases": [ - "ebg" - ], - "summary": "Create a ebg profile", - "description": "An EBG profile is required to issue commands in the ebg command group. The EBG profile contains the connection details for the Endevor Bridge for Git server of your choice.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config init' command", - "customize": { - "profileTypeIdentifier": "ebg" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new ebg profile. You can load this profile by using the name on commands that support the \"--ebg-profile\" option.", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "The Endevor Bridge for Git SCM protocol. \n\nDefault value: https", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The Endevor Bridge for Git hostname.", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "The Endevor Bridge for Git port.", - "type": "number", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Endevor Bridge for Git username (your git username).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "token", - "aliases": [ - "t" - ], - "description": "Git personal access token (it can be obtained from your Git Enterprise Server).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: false", - "type": "boolean", - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "overwrite", - "aliases": [ - "ow" - ], - "description": "Overwrite the ebg profile when a profile of the same name exists.", - "type": "boolean", - "group": "Options" - }, - { - "name": "disable-defaults", - "aliases": [ - "dd" - ], - "description": "Disable populating profile values of undefined properties with default values.", - "type": "boolean", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/create/endevor-location.jsonc b/profiles/create/endevor-location.jsonc deleted file mode 100644 index f593384..0000000 --- a/profiles/create/endevor-location.jsonc +++ /dev/null @@ -1,231 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "endevor-location-profile", - "aliases": [ - "endevor-location" - ], - "summary": "Create a endevor-location profile", - "description": "The Endevor element location, where you specify your working environment, system and subsystem", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config init' command", - "customize": { - "profileTypeIdentifier": "endevor-location" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new endevor-location profile. You can load this profile by using the name on commands that support the \"--endevor-location-profile\" option.", - "type": "string", - "required": true - } - ], - "options": [ - { - "description": "The STC/datasource of the session", - "type": "string", - "name": "instance", - "aliases": [ - "i" - ], - "defaultValue": "ENDEVOR", - "group": "Options" - }, - { - "description": "The Endevor environment where your project resides", - "type": "string", - "name": "environment", - "aliases": [ - "env" - ], - "defaultValue": "DEV", - "stringLengthRange": [ - 1, - 8 - ], - "group": "Options" - }, - { - "description": "The Endevor system where the element resides", - "type": "string", - "name": "system", - "aliases": [ - "sys" - ], - "stringLengthRange": [ - 1, - 8 - ], - "group": "Options" - }, - { - "description": "The Endevor subsystem where your element resides", - "type": "string", - "name": "subsystem", - "aliases": [ - "sub" - ], - "stringLengthRange": [ - 1, - 8 - ], - "group": "Options" - }, - { - "description": "Name of the Endevor element's type", - "type": "string", - "name": "type", - "aliases": [ - "typ" - ], - "stringLengthRange": [ - 1, - 8 - ], - "group": "Options" - }, - { - "description": "The Endevor stage where your project resides", - "type": "string", - "name": "stage-number", - "aliases": [ - "sn" - ], - "allowableValues": { - "values": [ - "1", - "2" - ] - }, - "group": "Options" - }, - { - "description": "The Endevor comment you want to use when performing an action", - "type": "string", - "name": "comment", - "aliases": [ - "com" - ], - "stringLengthRange": [ - 1, - 40 - ], - "group": "Options" - }, - { - "description": "The Endevor CCID you want to use when performing an action", - "type": "string", - "name": "ccid", - "aliases": [ - "cci" - ], - "stringLengthRange": [ - 1, - 12 - ], - "group": "Options" - }, - { - "description": "The return code of Endevor that defines a failed action", - "type": "number", - "name": "maxrc", - "defaultValue": 8, - "group": "Options", - "aliases": [] - }, - { - "description": "Always override element signout, without having to specify the override signout option on each command", - "type": "boolean", - "name": "override-signout", - "aliases": [ - "os" - ], - "defaultValue": false, - "group": "Options" - }, - { - "name": "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", - "type-name", - "file-ext", - "mixed" - ], - "caseSensitive": false - }, - "defaultValue": "mixed", - "group": "Options" - }, - { - "name": "overwrite", - "aliases": [ - "ow" - ], - "description": "Overwrite the endevor-location profile when a profile of the same name exists.", - "type": "boolean", - "group": "Options" - }, - { - "name": "disable-defaults", - "aliases": [ - "dd" - ], - "description": "Disable populating profile values of undefined properties with default values.", - "type": "boolean", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "ndvrLoc --env ENV --sys SYS --sub SUBSYS --typ COBOL --sn 1 -i ENDEVOR", - "description": "Create a location profile called 'ndvrLoc' to work at Endevor location ENV/1/SYS/SUBSYS, with elements of type COBOL, using Endevor web services configuration ENDEVOR" - }, - { - "options": "ndvrLoc2 --env ENV --sys SYS --sub SUBSYS --sn 1 --com 'sample comment' --cci 'CCID'", - "description": "Create a location profile called 'ndvrLoc2' to work at Endevor location ENV/1/SYS/SUBSYS, using CCID 'CCID' and comment 'sample comment'" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/create/endevor.jsonc b/profiles/create/endevor.jsonc deleted file mode 100644 index 3a45722..0000000 --- a/profiles/create/endevor.jsonc +++ /dev/null @@ -1,168 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "endevor-profile", - "aliases": [ - "endevor" - ], - "summary": "Create a endevor profile", - "description": "The endevor profile schema, where you specify your endevor session information and credentials", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config init' command", - "customize": { - "profileTypeIdentifier": "endevor" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new endevor profile. You can load this profile by using the name on commands that support the \"--endevor-profile\" option.", - "type": "string", - "required": true - } - ], - "options": [ - { - "description": "The hostname of the endevor session", - "type": "string", - "name": "host", - "aliases": [ - "hostname" - ], - "group": "Options" - }, - { - "description": "The port number of the endevor session", - "type": "number", - "name": "port", - "aliases": [ - "p" - ], - "group": "Options" - }, - { - "description": "The username of the endevor session", - "type": "string", - "name": "user", - "aliases": [ - "username" - ], - "group": "Options" - }, - { - "description": "The password of the user", - "type": "string", - "name": "password", - "aliases": [ - "pass" - ], - "group": "Options" - }, - { - "description": "The protocol used for connecting to Endevor Rest API", - "type": "string", - "name": "protocol", - "aliases": [ - "prot" - ], - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "Options" - }, - { - "description": "The base path used for connecting to Endevor Rest API", - "type": "string", - "name": "base-path", - "aliases": [ - "bp" - ], - "defaultValue": "EndevorService/api/v2", - "group": "Options" - }, - { - "description": "If set, the server certificate is verified against the list of supplied CAs", - "type": "boolean", - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "group": "Options" - }, - { - "description": "The default path where any reports will be written to, either absolute or relative to current directory", - "type": "string", - "name": "report-dir", - "aliases": [ - "rd" - ], - "defaultValue": ".", - "group": "Options" - }, - { - "name": "overwrite", - "aliases": [ - "ow" - ], - "description": "Overwrite the endevor profile when a profile of the same name exists.", - "type": "boolean", - "group": "Options" - }, - { - "name": "disable-defaults", - "aliases": [ - "dd" - ], - "description": "Disable populating profile values of undefined properties with default values.", - "type": "boolean", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "ndvrSample --host ndvr123 --port 8080 --user ibmuser --password myp4ss --prot http --base-path EndevorService/api/v2 --reject-unauthorized false", - "description": "Create an endevor profile called 'ndvrSample' to connect to Endevor web services at host ndvr123 and port 8080,using http protocol, with / EndevorService/api/v2 base path, allowing self-signed certificates" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/create/fmp.jsonc b/profiles/create/fmp.jsonc deleted file mode 100644 index 4b562db..0000000 --- a/profiles/create/fmp.jsonc +++ /dev/null @@ -1,174 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "fmp-profile", - "aliases": [ - "fmp" - ], - "summary": "Create a fmp profile", - "description": "File Master Plus profile schema.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config init' command", - "customize": { - "profileTypeIdentifier": "fmp" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new fmp profile. You can load this profile by using the name on commands that support the \"--fmp-profile\" option.", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies File Master Plus server host name.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies File Master Plus server port.", - "type": "number", - "defaultValue": 51914, - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Specifies Mainframe user name. May be the same as TSO login.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Specifies Mainframe password. May be the same as TSO password.", - "type": "string", - "required": false, - "group": "FMP Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies File Master Plus REST API protocol.", - "type": "string", - "defaultValue": "https", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "FMP Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "required": false, - "group": "FMP 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 FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "FMP Connection Options" - }, - { - "name": "overwrite", - "aliases": [ - "ow" - ], - "description": "Overwrite the fmp profile when a profile of the same name exists.", - "type": "boolean", - "group": "Options" - }, - { - "name": "disable-defaults", - "aliases": [ - "dd" - ], - "description": "Disable populating profile values of undefined properties with default values.", - "type": "boolean", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "fmp123 --host fmphost --port 19853 --user mfuser --password m4pass --protocol http", - "description": "Create a fmp profile with http protocol" - }, - { - "options": "fmp234 --host fmphost --port 19854 --user mfuser --password m4pass --protocol https --reject-unauthorized false", - "description": "Create a fmp profile with https protocol and allow self-signed certificates" - }, - { - "options": "fmpAPIML --host fmpAPIML --port 2020 --user mfuser --pass mfp4ss --protocol https --reject-unauthorized false --base-path /api/v1/serviceID", - "description": "Create a fmp profile with API Mediation layer" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/create/idms.jsonc b/profiles/create/idms.jsonc deleted file mode 100644 index 342e2fc..0000000 --- a/profiles/create/idms.jsonc +++ /dev/null @@ -1,155 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "idms-profile", - "aliases": [ - "idms" - ], - "summary": "Create a idms profile", - "description": "An IDMS profile is required to issue IDMS CLI commands. The IDMS profile contains your host and port information", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config init' command", - "customize": { - "profileTypeIdentifier": "idms" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new idms profile. You can load this profile by using the name on commands that support the \"--idms-profile\" option.", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Host name of the IDMS REST API service", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Port for the IDMS REST API service", - "type": "number", - "group": "IDMS Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Mainframe user name, which can be the same as your TSO login ID", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe password, which can be the same as your TSO password", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "datasource", - "aliases": [ - "d" - ], - "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer", - "type": "string", - "group": "IDMS Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates", - "type": "boolean", - "defaultValue": true, - "group": "IDMS Connection Options" - }, - { - "name": "overwrite", - "aliases": [ - "ow" - ], - "description": "Overwrite the idms profile when a profile of the same name exists.", - "type": "boolean", - "group": "Options" - }, - { - "name": "disable-defaults", - "aliases": [ - "dd" - ], - "description": "Disable populating profile values of undefined properties with default values.", - "type": "boolean", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "idms11 --host zos123 --port 1234 --user myuid --password mypass --base-path api/v1/caidms --reject-unauthorized false", - "description": "Create an IDMS profile called 'idms11' to connect to IDMS API services at host zos123 and port 1234, with base path api/v1/caidms and allow self-signed certificates" - }, - { - "options": "idms99 --host zos123 --port 1234 --user myuid --password mypass --datasource SYS195 --reject-unauthorized false", - "description": "Create an IDMS profile called 'idms99' to connect to IDMS API services at host zos123 and port 1234, specify a default data source SYS195 to be used by JDBC to identify a target system and allow self-signed certificates" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/create/jclcheck.jsonc b/profiles/create/jclcheck.jsonc deleted file mode 100644 index 910cc6b..0000000 --- a/profiles/create/jclcheck.jsonc +++ /dev/null @@ -1,182 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "jclcheck-profile", - "aliases": [ - "jclcheck" - ], - "summary": "Create a jclcheck profile", - "description": "A JCLCheck profile is required to issue commands in the jcl command group that interact with JCLCheck. The JCLCheck profile contains your host and port for the JCLCheck instance of your choice.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config init' command", - "customize": { - "profileTypeIdentifier": "jclcheck" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new jclcheck profile. You can load this profile by using the name on commands that support the \"--jclcheck-profile\" option.", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the JCLCheck API service that is running on the mainframe system.", - "required": false, - "group": "JCLCheck Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the JCLCheck API service that is running on the mainframe system.", - "defaultValue": 12697, - "required": false, - "group": "JCLCheck Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the JCLCheck API service that is running on the mainframe system.", - "required": false, - "group": "JCLCheck Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the JCLCheck API service that is running on the mainframe system.", - "required": false, - "group": "JCLCheck Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "defaultValue": "cajclcheck/api/v1", - "required": false, - "group": "JCLCheck Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "required": false, - "group": "JCLCheck Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for JCLCheck connection (http or https).", - "type": "string", - "defaultValue": "https", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "JCLCheck Connection Options" - }, - { - "name": "jclcheck-options", - "aliases": [ - "jo" - ], - "description": "The desired set of JCLCheck runtime options. Specify the options exactly as you would on the PARM= or OPTIONS DD on a batch run of JCLCheck. See the JCLCheck runtime options documentation for details on available runtime options. If you specify options that change the format of the JCLCheck reports, you should request '--raw-output'. Changing the format of the report will affect the ability to produce a structured API response.", - "type": "stringOrEmpty", - "required": false, - "group": "JCLCheck Connection Options" - }, - { - "name": "overwrite", - "aliases": [ - "ow" - ], - "description": "Overwrite the jclcheck profile when a profile of the same name exists.", - "type": "boolean", - "group": "Options" - }, - { - "name": "disable-defaults", - "aliases": [ - "dd" - ], - "description": "Disable populating profile values of undefined properties with default values.", - "type": "boolean", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "jcl123 --host zos123 --port 1234 --user ibmuser --pass myp4ss", - "description": "Create a JCLCheck profile named 'jcl123' to run JCLCheck at host zos123 and port 1234" - }, - { - "options": "jcl123 --host zos123 --port 1234 --user ibmuser --pass myp4ss --jo \"NOAS NOAU NOHCD NOJCL NORES NOSIGN\"", - "description": "Create a JCLCheck profile with default set of JCLCheck runtime options specified" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/create/jclx.jsonc b/profiles/create/jclx.jsonc deleted file mode 100644 index 2667dd4..0000000 --- a/profiles/create/jclx.jsonc +++ /dev/null @@ -1,120 +0,0 @@ -// PID 5698-020 -// Copyright Teracloud ApS 2023 -{ - "name": "jclx-profile", - "aliases": [ - "jclx" - ], - "summary": "Create a jclx profile", - "description": "Configuration profile for the IBM Z JCL Expert Zowe CLI plugin.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config init' command", - "customize": { - "profileTypeIdentifier": "jclx" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new jclx profile. You can load this profile by using the name on commands that support the \"--jclx-profile\" option.", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "remote-home-dir", - "description": "The home directory of IBM Z JCL Expert in USS on your remote system. If this option is not set, the plug-in will rely on the PATH variable in the remote user environment.", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "remote-temp-dir", - "description": "The directory where all temporary files are created and deleted by the IBM Z JCL Expert Zowe CLI plugin. Temporary files are cleaned up after each operation. Defaults to \"/tmp\" if not specified.", - "type": "string", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "language", - "description": "The language to be used by IBM Z JCL Expert when invoked. This option will be ignored if remoteHomeDir is not specified.", - "type": "string", - "allowableValues": { - "values": [ - "ENG", - "JPN" - ] - }, - "defaultValue": "ENG", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "response-encoding", - "description": "The encoding to translate the remote response from. An empty string value or 'binary' will result in no encoding translation. Defaults to 'utf-8' if not provided.", - "type": "string", - "defaultValue": "utf-8", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "overwrite", - "aliases": [ - "ow" - ], - "description": "Overwrite the jclx profile when a profile of the same name exists.", - "type": "boolean", - "group": "Options" - }, - { - "name": "disable-defaults", - "aliases": [ - "dd" - ], - "description": "Disable populating profile values of undefined properties with default values.", - "type": "boolean", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/create/mat.jsonc b/profiles/create/mat.jsonc deleted file mode 100644 index 1353b39..0000000 --- a/profiles/create/mat.jsonc +++ /dev/null @@ -1,171 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "mat-profile", - "aliases": [ - "mat" - ], - "summary": "Create a mat profile", - "description": "MAT Analyze CLI profile schema.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config init' command", - "customize": { - "profileTypeIdentifier": "mat" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new mat profile. You can load this profile by using the name on commands that support the \"--mat-profile\" option.", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies the protocol defined for the MAT REST API server (http or https).", - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "defaultValue": "https", - "group": "MAT Profile Options" - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the server port (e.g. 8080).", - "type": "number", - "group": "MAT Profile Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Your mainframe username.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "password", - "aliases": [ - "pw" - ], - "description": "Your mainframe password.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "MAT Profile Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "MAT Profile Options" - }, - { - "name": "listingDir", - "aliases": [ - "ldir" - ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", - "type": "string", - "required": false, - "group": "MAT Profile Options" - }, - { - "name": "overwrite", - "aliases": [ - "ow" - ], - "description": "Overwrite the mat profile when a profile of the same name exists.", - "type": "boolean", - "group": "Options" - }, - { - "name": "disable-defaults", - "aliases": [ - "dd" - ], - "description": "Disable populating profile values of undefined properties with default values.", - "type": "boolean", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "matprofile --o http --H localhost --P 1234 --u user --pw pass --base-path 'API\\MAT'", - "description": "Create a MAT profile called 'matprofile' using your MAT configuration and REST API details, with the MAT REST API server integrated with the Zowe API Mediation Layer" - }, - { - "options": "matprofile --o http --H localhost --P 1234 --u user --pw pass --listingDir 'c:\\listings'", - "description": "Create a MAT profile called 'matprofile' using your MAT configuration and the details of the MAT REST API server without integration with the Zowe API Mediation Layer,and define the 'c:\\listings' directory to store program listings for instant analysis from your VS Code IDE" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/create/omspool.jsonc b/profiles/create/omspool.jsonc deleted file mode 100644 index f4fee24..0000000 --- a/profiles/create/omspool.jsonc +++ /dev/null @@ -1,152 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "omspool-profile", - "aliases": [ - "omspool" - ], - "summary": "Create a omspool profile", - "description": "Configuration profile for Spool, where you specify information about your Spool instance", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config init' command", - "customize": { - "profileTypeIdentifier": "omspool" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new omspool profile. You can load this profile by using the name on commands that support the \"--omspool-profile\" option.", - "type": "string", - "required": true - } - ], - "options": [ - { - "description": "z/OS TSO/E accounting information.", - "type": "string", - "name": "account", - "aliases": [ - "a" - ], - "required": true, - "group": "SPOOL OPTIONS" - }, - { - "description": "High level qualifier of Spool installation.", - "type": "string", - "name": "spoolhlq", - "aliases": [ - "hlq" - ], - "stringLengthRange": [ - 1, - 35 - ], - "required": true, - "group": "SPOOL OPTIONS" - }, - { - "description": "Spool subsystem name.", - "type": "string", - "name": "subsys", - "aliases": [ - "sub" - ], - "stringLengthRange": [ - 1, - 4 - ], - "defaultValue": "ESF", - "group": "SPOOL OPTIONS" - }, - { - "description": "The SYSTSPRT data set allocated by CAI.CBQ4JCL(BQ4JZOWE). It must be unique for each Zowe CLI user interacting with Spool.", - "type": "string", - "name": "outds", - "aliases": [ - "out" - ], - "stringLengthRange": [ - 1, - 44 - ], - "required": true, - "group": "SPOOL OPTIONS" - }, - { - "description": "The data set containing ESFZOWE REXX exec.", - "type": "string", - "name": "clist", - "aliases": [ - "cl" - ], - "stringLengthRange": [ - 1, - 44 - ], - "required": true, - "group": "SPOOL OPTIONS" - }, - { - "name": "overwrite", - "aliases": [ - "ow" - ], - "description": "Overwrite the omspool profile when a profile of the same name exists.", - "type": "boolean", - "group": "Options" - }, - { - "name": "disable-defaults", - "aliases": [ - "dd" - ], - "description": "Disable populating profile values of undefined properties with default values.", - "type": "boolean", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "myProfile --account 1234567890 --spoolhlq SPOOL.HLQ --subsys ESF1 --outds OUTPUT.RESPONSE.DS --clist USER.CLIST", - "description": "Create a profile for Spool named 'myProfile' with TSO account information '1234567890', Spool installation high level qualifier of 'SPOOL.HLQ', subsystem name 'ESF1', output response data set 'OUTPUT.RESPONSE.DS', and data set 'USER.CLIST', containing ESFZOWE REXX exec" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/create/ops.jsonc b/profiles/create/ops.jsonc deleted file mode 100644 index b80fe05..0000000 --- a/profiles/create/ops.jsonc +++ /dev/null @@ -1,159 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "ops-profile", - "aliases": [ - "ops" - ], - "summary": "Create a ops profile", - "description": "The OPS Web Services session profile schema, where you specify your session information and credentials", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config init' command", - "customize": { - "profileTypeIdentifier": "ops" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new ops profile. You can load this profile by using the name on commands that support the \"--ops-profile\" option.", - "type": "string", - "required": true - } - ], - "options": [ - { - "description": "The hostname of the server where OPS Web Services is running.", - "type": "string", - "name": "host", - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS", - "aliases": [] - }, - { - "description": "The port number for OPS Web Services.", - "type": "number", - "name": "port", - "aliases": [ - "p" - ], - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "Your z/OS user name used to authenticate to OPS Web Services", - "type": "string", - "name": "user", - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS", - "aliases": [] - }, - { - "description": "Your z/OS password used to authenticate to OPS Web Services", - "type": "string", - "name": "password", - "aliases": [ - "pass" - ], - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "The protocol used for connecting to OPS Web Services", - "type": "string", - "name": "protocol", - "aliases": [ - "prot" - ], - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "required": true, - "group": "OPS WEB SERVICES 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 WEB SERVICES CONNECTION OPTIONS" - }, - { - "description": "Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.", - "type": "string", - "name": "subsystem", - "aliases": [ - "subs" - ], - "group": "OPS WEB SERVICES CONNECTION OPTIONS" - }, - { - "name": "overwrite", - "aliases": [ - "ow" - ], - "description": "Overwrite the ops profile when a profile of the same name exists.", - "type": "boolean", - "group": "Options" - }, - { - "name": "disable-defaults", - "aliases": [ - "dd" - ], - "description": "Disable populating profile values of undefined properties with default values.", - "type": "boolean", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "myLPAR --host lpar123 --port 8080 --user ibmuser --password !@#$^ --prot http --reject-unauthorized false", - "description": "Create an OPS profile called 'myLPAR' to connect to OPS Web Services at host lpar123 and port 8080, using http protocol, allowing self-signed certificates" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/create/pma.jsonc b/profiles/create/pma.jsonc deleted file mode 100644 index 5668a73..0000000 --- a/profiles/create/pma.jsonc +++ /dev/null @@ -1,145 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "pma-profile", - "aliases": [ - "pma" - ], - "summary": "Create a pma profile", - "description": "MAT Detect CLI profile schema.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config init' command", - "customize": { - "profileTypeIdentifier": "pma" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new pma profile. You can load this profile by using the name on commands that support the \"--pma-profile\" option.", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "job_acct", - "aliases": [ - "ja" - ], - "description": "Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)", - "type": "string", - "required": true, - "group": "PMA Connection Options" - }, - { - "name": "job_class", - "aliases": [ - "jc" - ], - "description": "Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9) ", - "type": "string", - "required": true, - "stringLengthRange": [ - 1, - 1 - ], - "group": "PMA Connection Options" - }, - { - "name": "job_mclass", - "aliases": [ - "jmc" - ], - "description": "Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9) ", - "type": "string", - "defaultValue": "A", - "required": false, - "stringLengthRange": [ - 1, - 1 - ], - "group": "PMA Connection Options" - }, - { - "name": "job_load", - "aliases": [ - "jl" - ], - "description": "Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD) ", - "type": "string", - "required": true, - "group": "PMA Connection Options" - }, - { - "name": "job_pmahlq", - "aliases": [ - "jph" - ], - "description": "Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data", - "type": "string", - "required": true, - "group": "PMA Connection Options" - }, - { - "name": "overwrite", - "aliases": [ - "ow" - ], - "description": "Overwrite the pma profile when a profile of the same name exists.", - "type": "boolean", - "group": "Options" - }, - { - "name": "disable-defaults", - "aliases": [ - "dd" - ], - "description": "Disable populating profile values of undefined properties with default values.", - "type": "boolean", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "pma123 --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ", - "description": "Create a PMA profile called pma123 using your valid jobcard and PMA configuration details" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/create/rse.jsonc b/profiles/create/rse.jsonc deleted file mode 100644 index a35d80c..0000000 --- a/profiles/create/rse.jsonc +++ /dev/null @@ -1,192 +0,0 @@ -// Copyright IBM Corporation 2020, 2024. All Rights Reserved. -{ - "name": "rse-profile", - "aliases": [ - "rse" - ], - "summary": "Create a rse profile", - "description": "A profile to issue commands to a z/OS system with a working Zowe REST server,Mediation Layer, or IBM RSE (Remote System Explorer) API server installation.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config init' command", - "customize": { - "profileTypeIdentifier": "rse" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new rse profile. You can load this profile by using the name on commands that support the \"--rse-profile\" option.", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The z/OS host name running the Zowe REST API.", - "type": "string", - "group": "Zowe REST Connection Options" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "The server port used by the REST API.", - "type": "number", - "defaultValue": 6800, - "group": "Zowe REST Connection Options" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "The user name for the Zowe REST API operations.", - "type": "string", - "group": "Zowe REST Connection Options" - }, - { - "name": "password", - "aliases": [ - "pass" - ], - "description": "The password of the user for the Zowe REST API operations.", - "type": "string", - "group": "Zowe REST Connection Options" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "defaultValue": true, - "group": "Zowe REST Connection Options" - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path of the API for the REST API operations.", - "type": "string", - "defaultValue": "rseapi", - "group": "Zowe REST Connection Options" - }, - { - "name": "protocol", - "aliases": [ - "protocol" - ], - "description": "http or https, depending whether a TLS handshake is required to access REST API.", - "type": "string", - "defaultValue": "https", - "group": "Zowe REST Connection Options" - }, - { - "name": "encoding", - "aliases": [ - "ec" - ], - "description": "The encoding for download and upload of z/OS data set and USS files. The encoding should be specified in the form of \"IBM-1047\".", - "type": "string", - "group": "Zowe REST Connection Options" - }, - { - "name": "tokenType", - "aliases": [ - "tt" - ], - "description": "JWT token type assigned to profile when \"zowe rse auth login\" is used for authentication.", - "type": "string", - "group": "Zowe REST Connection Options" - }, - { - "name": "tokenValue", - "aliases": [ - "tv" - ], - "description": "JWT token value assigned to profile when \"zowe rse auth login\" is used for authentication.", - "type": "string", - "group": "Zowe REST Connection Options" - }, - { - "name": "tokenExpiration", - "aliases": [ - "te" - ], - "description": "JWT token expiration assigned to profile when \"zowe rse auth login\" is used for authentication.", - "type": "number", - "group": "Zowe REST Connection Options" - }, - { - "name": "overwrite", - "aliases": [ - "ow" - ], - "description": "Overwrite the rse profile when a profile of the same name exists.", - "type": "boolean", - "group": "Options" - }, - { - "name": "disable-defaults", - "aliases": [ - "dd" - ], - "description": "Disable populating profile values of undefined properties with default values.", - "type": "boolean", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "myRseApiProfile --host zos123 --port 6800 --user ibmuser --pass myp4ss --bp rseapi --protocol http --ru false", - "description": "Create an RSE API profile named 'myRseApiProfile' to connect to z/OS using the RSE API server at host zos123 that runs on port 6800 and has a base path of 'rseapi' and uses the 'http' protocol. An example base URL to RSE API would be: 'http://zos123:6800/rseapi/api/v1/'" - }, - { - "options": "myZoweRestProfile --host zos123 --port 8443 --user ibmuser --pass myp4ss --ru false --protocol https --ec IBM-285", - "description": "Create a profile named 'myZoweRestProfile' to connect to z/OS using the Zowe REST APIs at host zos123 that runs the Zowe REST API server on port 8443, requires a TLS handshake using 'https' with SSL certificates, and has a default encoding of IBM-285. An example base URL to Zowe REST API would be: 'https://zos123:6800/api/v1/'" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/create/sysview-format.jsonc b/profiles/create/sysview-format.jsonc deleted file mode 100644 index e76d30a..0000000 --- a/profiles/create/sysview-format.jsonc +++ /dev/null @@ -1,142 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "sysview-format-profile", - "aliases": [ - "sysview-format" - ], - "summary": "Create a sysview-format profile", - "description": "The SYSVIEW format profile schema, where you specify display settings", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config init' command", - "customize": { - "profileTypeIdentifier": "sysview-format" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new sysview-format profile. You can load this profile by using the name on commands that support the \"--sysview-format-profile\" option.", - "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": "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": "overwrite", - "aliases": [ - "ow" - ], - "description": "Overwrite the sysview-format profile when a profile of the same name exists.", - "type": "boolean", - "group": "Options" - }, - { - "name": "disable-defaults", - "aliases": [ - "dd" - ], - "description": "Disable populating profile values of undefined properties with default values.", - "type": "boolean", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "myFormat --cf commandName screenTitle --overview false --info true --pretty true --biz true", - "description": "Create a SYSVIEW format profile to display the context fields 'commandName' and 'screenTitle', the information area, and not the overview area for all requests. Data will be formatted, and '0's will be blanked" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/create/sysview.jsonc b/profiles/create/sysview.jsonc deleted file mode 100644 index 2e5124d..0000000 --- a/profiles/create/sysview.jsonc +++ /dev/null @@ -1,158 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "sysview-profile", - "aliases": [ - "sysview" - ], - "summary": "Create a sysview profile", - "description": "The SYSVIEW session profile schema, where you specify your session information and credentials", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config init' command", - "customize": { - "profileTypeIdentifier": "sysview" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new sysview profile. You can load this profile by using the name on commands that support the \"--sysview-profile\" option.", - "type": "string", - "required": true - } - ], - "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": "overwrite", - "aliases": [ - "ow" - ], - "description": "Overwrite the sysview profile when a profile of the same name exists.", - "type": "boolean", - "group": "Options" - }, - { - "name": "disable-defaults", - "aliases": [ - "dd" - ], - "description": "Disable populating profile values of undefined properties with default values.", - "type": "boolean", - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "description": "Create a SYSVIEW profile called 'myLPAR' to connect to the SYSVIEW REST API at host lpar123, port 8080, and ssid ABCD", - "options": "myLPAR --host lpar123 --port 8080 --user ibmuser --password !@#$^ --ssid ABCD" - }, - { - "description": "You already have a base profile with username and password. Create a SYSVIEW profile to specify host lpar123 and port 8080, using the default ssid of GSVX", - "options": "myLPAR2 --host lpar123 --port 8080" - }, - { - "description": "You already have a base profile to connect to an API Mediation Layer and use SSO tokens. Create a SYSVIEW profile to point to the SYSVIEW REST API by specifying the base path /my-sysview-instance/api/v1", - "options": "myLPAR3 --base-path /my-sysview-instance/api/v1" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/delete/ca7.jsonc b/profiles/delete/ca7.jsonc deleted file mode 100644 index 5fbf998..0000000 --- a/profiles/delete/ca7.jsonc +++ /dev/null @@ -1,76 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "ca7-profile", - "aliases": [ - "ca7" - ], - "summary": "Delete a ca7 profile.", - "description": "Delete a ca7 profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.", - "type": "command", - "handler": "", - "deprecatedReplacement": "Edit your Zowe V2 configuration\n zowe.config.json", - "customize": { - "profileTypeIdentifier": "ca7" - }, - "options": [ - { - "name": "force", - "aliases": [], - "description": "Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the ca7 profile to be deleted. You can also load this profile by using the name on commands that support the \"--ca7-profile\" option.", - "type": "string", - "required": true - } - ], - "examples": [ - { - "options": "profilename", - "description": "Delete a ca7 profile named profilename" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/delete/caview.jsonc b/profiles/delete/caview.jsonc deleted file mode 100644 index 5486fd9..0000000 --- a/profiles/delete/caview.jsonc +++ /dev/null @@ -1,76 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "caview-profile", - "aliases": [ - "caview" - ], - "summary": "Delete a caview profile.", - "description": "Delete a caview profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.", - "type": "command", - "handler": "", - "deprecatedReplacement": "Edit your Zowe V2 configuration\n zowe.config.json", - "customize": { - "profileTypeIdentifier": "caview" - }, - "options": [ - { - "name": "force", - "aliases": [], - "description": "Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the caview profile to be deleted. You can also load this profile by using the name on commands that support the \"--caview-profile\" option.", - "type": "string", - "required": true - } - ], - "examples": [ - { - "options": "profilename", - "description": "Delete a caview profile named profilename" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/delete/dbm-db2-options.jsonc b/profiles/delete/dbm-db2-options.jsonc deleted file mode 100644 index b4c417d..0000000 --- a/profiles/delete/dbm-db2-options.jsonc +++ /dev/null @@ -1,76 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "dbm-db2-options-profile", - "aliases": [ - "dbm-db2-options" - ], - "summary": "Delete a dbm-db2-options profile.", - "description": "Delete a dbm-db2-options profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.", - "type": "command", - "handler": "", - "deprecatedReplacement": "Edit your Zowe V2 configuration\n zowe.config.json", - "customize": { - "profileTypeIdentifier": "dbm-db2-options" - }, - "options": [ - { - "name": "force", - "aliases": [], - "description": "Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the dbm-db2-options profile to be deleted. You can also load this profile by using the name on commands that support the \"--dbm-db2-options-profile\" option.", - "type": "string", - "required": true - } - ], - "examples": [ - { - "options": "profilename", - "description": "Delete a dbm-db2-options profile named profilename" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/delete/dbm-db2.jsonc b/profiles/delete/dbm-db2.jsonc deleted file mode 100644 index a8722c6..0000000 --- a/profiles/delete/dbm-db2.jsonc +++ /dev/null @@ -1,76 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "dbm-db2-profile", - "aliases": [ - "dbm-db2" - ], - "summary": "Delete a dbm-db2 profile.", - "description": "Delete a dbm-db2 profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.", - "type": "command", - "handler": "", - "deprecatedReplacement": "Edit your Zowe V2 configuration\n zowe.config.json", - "customize": { - "profileTypeIdentifier": "dbm-db2" - }, - "options": [ - { - "name": "force", - "aliases": [], - "description": "Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the dbm-db2 profile to be deleted. You can also load this profile by using the name on commands that support the \"--dbm-db2-profile\" option.", - "type": "string", - "required": true - } - ], - "examples": [ - { - "options": "profilename", - "description": "Delete a dbm-db2 profile named profilename" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/delete/ebg.jsonc b/profiles/delete/ebg.jsonc deleted file mode 100644 index 3ab3187..0000000 --- a/profiles/delete/ebg.jsonc +++ /dev/null @@ -1,76 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "ebg-profile", - "aliases": [ - "ebg" - ], - "summary": "Delete a ebg profile.", - "description": "Delete a ebg profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.", - "type": "command", - "handler": "", - "deprecatedReplacement": "Edit your Zowe V2 configuration\n zowe.config.json", - "customize": { - "profileTypeIdentifier": "ebg" - }, - "options": [ - { - "name": "force", - "aliases": [], - "description": "Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the ebg profile to be deleted. You can also load this profile by using the name on commands that support the \"--ebg-profile\" option.", - "type": "string", - "required": true - } - ], - "examples": [ - { - "options": "profilename", - "description": "Delete a ebg profile named profilename" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/delete/endevor-location.jsonc b/profiles/delete/endevor-location.jsonc deleted file mode 100644 index 090a0ec..0000000 --- a/profiles/delete/endevor-location.jsonc +++ /dev/null @@ -1,76 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "endevor-location-profile", - "aliases": [ - "endevor-location" - ], - "summary": "Delete a endevor-location profile.", - "description": "Delete a endevor-location profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.", - "type": "command", - "handler": "", - "deprecatedReplacement": "Edit your Zowe V2 configuration\n zowe.config.json", - "customize": { - "profileTypeIdentifier": "endevor-location" - }, - "options": [ - { - "name": "force", - "aliases": [], - "description": "Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the endevor-location profile to be deleted. You can also load this profile by using the name on commands that support the \"--endevor-location-profile\" option.", - "type": "string", - "required": true - } - ], - "examples": [ - { - "options": "profilename", - "description": "Delete a endevor-location profile named profilename" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/delete/endevor.jsonc b/profiles/delete/endevor.jsonc deleted file mode 100644 index 7d1e084..0000000 --- a/profiles/delete/endevor.jsonc +++ /dev/null @@ -1,76 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "endevor-profile", - "aliases": [ - "endevor" - ], - "summary": "Delete a endevor profile.", - "description": "Delete a endevor profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.", - "type": "command", - "handler": "", - "deprecatedReplacement": "Edit your Zowe V2 configuration\n zowe.config.json", - "customize": { - "profileTypeIdentifier": "endevor" - }, - "options": [ - { - "name": "force", - "aliases": [], - "description": "Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the endevor profile to be deleted. You can also load this profile by using the name on commands that support the \"--endevor-profile\" option.", - "type": "string", - "required": true - } - ], - "examples": [ - { - "options": "profilename", - "description": "Delete a endevor profile named profilename" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/delete/fmp.jsonc b/profiles/delete/fmp.jsonc deleted file mode 100644 index b5b486c..0000000 --- a/profiles/delete/fmp.jsonc +++ /dev/null @@ -1,76 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "fmp-profile", - "aliases": [ - "fmp" - ], - "summary": "Delete a fmp profile.", - "description": "Delete a fmp profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.", - "type": "command", - "handler": "", - "deprecatedReplacement": "Edit your Zowe V2 configuration\n zowe.config.json", - "customize": { - "profileTypeIdentifier": "fmp" - }, - "options": [ - { - "name": "force", - "aliases": [], - "description": "Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the fmp profile to be deleted. You can also load this profile by using the name on commands that support the \"--fmp-profile\" option.", - "type": "string", - "required": true - } - ], - "examples": [ - { - "options": "profilename", - "description": "Delete a fmp profile named profilename" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/delete/idms.jsonc b/profiles/delete/idms.jsonc deleted file mode 100644 index 10d1062..0000000 --- a/profiles/delete/idms.jsonc +++ /dev/null @@ -1,76 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "idms-profile", - "aliases": [ - "idms" - ], - "summary": "Delete a idms profile.", - "description": "Delete a idms profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.", - "type": "command", - "handler": "", - "deprecatedReplacement": "Edit your Zowe V2 configuration\n zowe.config.json", - "customize": { - "profileTypeIdentifier": "idms" - }, - "options": [ - { - "name": "force", - "aliases": [], - "description": "Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the idms profile to be deleted. You can also load this profile by using the name on commands that support the \"--idms-profile\" option.", - "type": "string", - "required": true - } - ], - "examples": [ - { - "options": "profilename", - "description": "Delete a idms profile named profilename" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/delete/jclcheck.jsonc b/profiles/delete/jclcheck.jsonc deleted file mode 100644 index 4c39d7a..0000000 --- a/profiles/delete/jclcheck.jsonc +++ /dev/null @@ -1,76 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "jclcheck-profile", - "aliases": [ - "jclcheck" - ], - "summary": "Delete a jclcheck profile.", - "description": "Delete a jclcheck profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.", - "type": "command", - "handler": "", - "deprecatedReplacement": "Edit your Zowe V2 configuration\n zowe.config.json", - "customize": { - "profileTypeIdentifier": "jclcheck" - }, - "options": [ - { - "name": "force", - "aliases": [], - "description": "Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the jclcheck profile to be deleted. You can also load this profile by using the name on commands that support the \"--jclcheck-profile\" option.", - "type": "string", - "required": true - } - ], - "examples": [ - { - "options": "profilename", - "description": "Delete a jclcheck profile named profilename" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/delete/jclx.jsonc b/profiles/delete/jclx.jsonc deleted file mode 100644 index 11684f7..0000000 --- a/profiles/delete/jclx.jsonc +++ /dev/null @@ -1,76 +0,0 @@ -// PID 5698-020 -// Copyright Teracloud ApS 2023 -{ - "name": "jclx-profile", - "aliases": [ - "jclx" - ], - "summary": "Delete a jclx profile.", - "description": "Delete a jclx profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.", - "type": "command", - "handler": "", - "deprecatedReplacement": "Edit your Zowe V2 configuration\n zowe.config.json", - "customize": { - "profileTypeIdentifier": "jclx" - }, - "options": [ - { - "name": "force", - "aliases": [], - "description": "Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the jclx profile to be deleted. You can also load this profile by using the name on commands that support the \"--jclx-profile\" option.", - "type": "string", - "required": true - } - ], - "examples": [ - { - "options": "profilename", - "description": "Delete a jclx profile named profilename" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/delete/mat.jsonc b/profiles/delete/mat.jsonc deleted file mode 100644 index 29527bd..0000000 --- a/profiles/delete/mat.jsonc +++ /dev/null @@ -1,76 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "mat-profile", - "aliases": [ - "mat" - ], - "summary": "Delete a mat profile.", - "description": "Delete a mat profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.", - "type": "command", - "handler": "", - "deprecatedReplacement": "Edit your Zowe V2 configuration\n zowe.config.json", - "customize": { - "profileTypeIdentifier": "mat" - }, - "options": [ - { - "name": "force", - "aliases": [], - "description": "Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the mat profile to be deleted. You can also load this profile by using the name on commands that support the \"--mat-profile\" option.", - "type": "string", - "required": true - } - ], - "examples": [ - { - "options": "profilename", - "description": "Delete a mat profile named profilename" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/delete/omspool.jsonc b/profiles/delete/omspool.jsonc deleted file mode 100644 index bdc7d0f..0000000 --- a/profiles/delete/omspool.jsonc +++ /dev/null @@ -1,76 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "omspool-profile", - "aliases": [ - "omspool" - ], - "summary": "Delete a omspool profile.", - "description": "Delete a omspool profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.", - "type": "command", - "handler": "", - "deprecatedReplacement": "Edit your Zowe V2 configuration\n zowe.config.json", - "customize": { - "profileTypeIdentifier": "omspool" - }, - "options": [ - { - "name": "force", - "aliases": [], - "description": "Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the omspool profile to be deleted. You can also load this profile by using the name on commands that support the \"--omspool-profile\" option.", - "type": "string", - "required": true - } - ], - "examples": [ - { - "options": "profilename", - "description": "Delete a omspool profile named profilename" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/delete/ops.jsonc b/profiles/delete/ops.jsonc deleted file mode 100644 index eaada51..0000000 --- a/profiles/delete/ops.jsonc +++ /dev/null @@ -1,76 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "ops-profile", - "aliases": [ - "ops" - ], - "summary": "Delete a ops profile.", - "description": "Delete a ops profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.", - "type": "command", - "handler": "", - "deprecatedReplacement": "Edit your Zowe V2 configuration\n zowe.config.json", - "customize": { - "profileTypeIdentifier": "ops" - }, - "options": [ - { - "name": "force", - "aliases": [], - "description": "Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the ops profile to be deleted. You can also load this profile by using the name on commands that support the \"--ops-profile\" option.", - "type": "string", - "required": true - } - ], - "examples": [ - { - "options": "profilename", - "description": "Delete a ops profile named profilename" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/delete/pma.jsonc b/profiles/delete/pma.jsonc deleted file mode 100644 index cc1222d..0000000 --- a/profiles/delete/pma.jsonc +++ /dev/null @@ -1,76 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "pma-profile", - "aliases": [ - "pma" - ], - "summary": "Delete a pma profile.", - "description": "Delete a pma profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.", - "type": "command", - "handler": "", - "deprecatedReplacement": "Edit your Zowe V2 configuration\n zowe.config.json", - "customize": { - "profileTypeIdentifier": "pma" - }, - "options": [ - { - "name": "force", - "aliases": [], - "description": "Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the pma profile to be deleted. You can also load this profile by using the name on commands that support the \"--pma-profile\" option.", - "type": "string", - "required": true - } - ], - "examples": [ - { - "options": "profilename", - "description": "Delete a pma profile named profilename" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/delete/rse.jsonc b/profiles/delete/rse.jsonc deleted file mode 100644 index 5248900..0000000 --- a/profiles/delete/rse.jsonc +++ /dev/null @@ -1,75 +0,0 @@ -// Copyright IBM Corporation 2020, 2024. All Rights Reserved. -{ - "name": "rse-profile", - "aliases": [ - "rse" - ], - "summary": "Delete a rse profile.", - "description": "Delete a rse profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.", - "type": "command", - "handler": "", - "deprecatedReplacement": "Edit your Zowe V2 configuration\n zowe.config.json", - "customize": { - "profileTypeIdentifier": "rse" - }, - "options": [ - { - "name": "force", - "aliases": [], - "description": "Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the rse profile to be deleted. You can also load this profile by using the name on commands that support the \"--rse-profile\" option.", - "type": "string", - "required": true - } - ], - "examples": [ - { - "options": "profilename", - "description": "Delete a rse profile named profilename" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/delete/sysview-format.jsonc b/profiles/delete/sysview-format.jsonc deleted file mode 100644 index 7778657..0000000 --- a/profiles/delete/sysview-format.jsonc +++ /dev/null @@ -1,76 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "sysview-format-profile", - "aliases": [ - "sysview-format" - ], - "summary": "Delete a sysview-format profile.", - "description": "Delete a sysview-format profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.", - "type": "command", - "handler": "", - "deprecatedReplacement": "Edit your Zowe V2 configuration\n zowe.config.json", - "customize": { - "profileTypeIdentifier": "sysview-format" - }, - "options": [ - { - "name": "force", - "aliases": [], - "description": "Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the sysview-format profile to be deleted. You can also load this profile by using the name on commands that support the \"--sysview-format-profile\" option.", - "type": "string", - "required": true - } - ], - "examples": [ - { - "options": "profilename", - "description": "Delete a sysview-format profile named profilename" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/delete/sysview.jsonc b/profiles/delete/sysview.jsonc deleted file mode 100644 index a094beb..0000000 --- a/profiles/delete/sysview.jsonc +++ /dev/null @@ -1,76 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "sysview-profile", - "aliases": [ - "sysview" - ], - "summary": "Delete a sysview profile.", - "description": "Delete a sysview profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.", - "type": "command", - "handler": "", - "deprecatedReplacement": "Edit your Zowe V2 configuration\n zowe.config.json", - "customize": { - "profileTypeIdentifier": "sysview" - }, - "options": [ - { - "name": "force", - "aliases": [], - "description": "Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the sysview profile to be deleted. You can also load this profile by using the name on commands that support the \"--sysview-profile\" option.", - "type": "string", - "required": true - } - ], - "examples": [ - { - "options": "profilename", - "description": "Delete a sysview profile named profilename" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/list/ca7.jsonc b/profiles/list/ca7.jsonc deleted file mode 100644 index 3024a27..0000000 --- a/profiles/list/ca7.jsonc +++ /dev/null @@ -1,75 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "ca7-profiles", - "aliases": [ - "ca7" - ], - "summary": "List profiles of the type ca7.", - "description": "A CA7 profile is required to issue commands in the CA7 command group. The CA7 profile contains your host and port for the CA7 instance of your choice.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config list' command", - "customize": { - "profileTypeIdentifier": "ca7" - }, - "options": [ - { - "name": "show-contents", - "aliases": [ - "sc" - ], - "description": "List ca7 profiles and their contents. All profile details will be printed as part of command output.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "", - "description": "List profiles of type ca7" - }, - { - "options": "--sc", - "description": "List profiles of type ca7 and display their contents" - } - ], - "positionals": [], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/list/caview.jsonc b/profiles/list/caview.jsonc deleted file mode 100644 index 6a6436d..0000000 --- a/profiles/list/caview.jsonc +++ /dev/null @@ -1,75 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "caview-profiles", - "aliases": [ - "caview" - ], - "summary": "List profiles of the type caview.", - "description": "Configuration profile for View", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config list' command", - "customize": { - "profileTypeIdentifier": "caview" - }, - "options": [ - { - "name": "show-contents", - "aliases": [ - "sc" - ], - "description": "List caview profiles and their contents. All profile details will be printed as part of command output.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "", - "description": "List profiles of type caview" - }, - { - "options": "--sc", - "description": "List profiles of type caview and display their contents" - } - ], - "positionals": [], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/list/dbm-db2-options.jsonc b/profiles/list/dbm-db2-options.jsonc deleted file mode 100644 index ee5347f..0000000 --- a/profiles/list/dbm-db2-options.jsonc +++ /dev/null @@ -1,75 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "dbm-db2-options-profiles", - "aliases": [ - "dbm-db2-options" - ], - "summary": "List profiles of the type dbm-db2-options.", - "description": "The DBM-Db2 options profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes execution-dependent details.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config list' command", - "customize": { - "profileTypeIdentifier": "dbm-db2-options" - }, - "options": [ - { - "name": "show-contents", - "aliases": [ - "sc" - ], - "description": "List dbm-db2-options profiles and their contents. All profile details will be printed as part of command output.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "", - "description": "List profiles of type dbm-db2-options" - }, - { - "options": "--sc", - "description": "List profiles of type dbm-db2-options and display their contents" - } - ], - "positionals": [], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/list/dbm-db2.jsonc b/profiles/list/dbm-db2.jsonc deleted file mode 100644 index 467bc6d..0000000 --- a/profiles/list/dbm-db2.jsonc +++ /dev/null @@ -1,75 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "dbm-db2-profiles", - "aliases": [ - "dbm-db2" - ], - "summary": "List profiles of the type dbm-db2.", - "description": "The DBM-Db2 profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes server connection, z/OS execution, and user-dependent details.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config list' command", - "customize": { - "profileTypeIdentifier": "dbm-db2" - }, - "options": [ - { - "name": "show-contents", - "aliases": [ - "sc" - ], - "description": "List dbm-db2 profiles and their contents. All profile details will be printed as part of command output.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "", - "description": "List profiles of type dbm-db2" - }, - { - "options": "--sc", - "description": "List profiles of type dbm-db2 and display their contents" - } - ], - "positionals": [], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/list/ebg.jsonc b/profiles/list/ebg.jsonc deleted file mode 100644 index 2be6293..0000000 --- a/profiles/list/ebg.jsonc +++ /dev/null @@ -1,75 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "ebg-profiles", - "aliases": [ - "ebg" - ], - "summary": "List profiles of the type ebg.", - "description": "An EBG profile is required to issue commands in the ebg command group. The EBG profile contains the connection details for the Endevor Bridge for Git server of your choice.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config list' command", - "customize": { - "profileTypeIdentifier": "ebg" - }, - "options": [ - { - "name": "show-contents", - "aliases": [ - "sc" - ], - "description": "List ebg profiles and their contents. All profile details will be printed as part of command output.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "", - "description": "List profiles of type ebg" - }, - { - "options": "--sc", - "description": "List profiles of type ebg and display their contents" - } - ], - "positionals": [], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/list/endevor-location.jsonc b/profiles/list/endevor-location.jsonc deleted file mode 100644 index 2c02183..0000000 --- a/profiles/list/endevor-location.jsonc +++ /dev/null @@ -1,75 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "endevor-location-profiles", - "aliases": [ - "endevor-location" - ], - "summary": "List profiles of the type endevor-location.", - "description": "The Endevor element location, where you specify your working environment, system and subsystem", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config list' command", - "customize": { - "profileTypeIdentifier": "endevor-location" - }, - "options": [ - { - "name": "show-contents", - "aliases": [ - "sc" - ], - "description": "List endevor-location profiles and their contents. All profile details will be printed as part of command output.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "", - "description": "List profiles of type endevor-location" - }, - { - "options": "--sc", - "description": "List profiles of type endevor-location and display their contents" - } - ], - "positionals": [], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/list/endevor.jsonc b/profiles/list/endevor.jsonc deleted file mode 100644 index 7f6e3ca..0000000 --- a/profiles/list/endevor.jsonc +++ /dev/null @@ -1,75 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "endevor-profiles", - "aliases": [ - "endevor" - ], - "summary": "List profiles of the type endevor.", - "description": "The endevor profile schema, where you specify your endevor session information and credentials", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config list' command", - "customize": { - "profileTypeIdentifier": "endevor" - }, - "options": [ - { - "name": "show-contents", - "aliases": [ - "sc" - ], - "description": "List endevor profiles and their contents. All profile details will be printed as part of command output.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "", - "description": "List profiles of type endevor" - }, - { - "options": "--sc", - "description": "List profiles of type endevor and display their contents" - } - ], - "positionals": [], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/list/fmp.jsonc b/profiles/list/fmp.jsonc deleted file mode 100644 index f65f2f6..0000000 --- a/profiles/list/fmp.jsonc +++ /dev/null @@ -1,75 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "fmp-profiles", - "aliases": [ - "fmp" - ], - "summary": "List profiles of the type fmp.", - "description": "File Master Plus profile schema.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config list' command", - "customize": { - "profileTypeIdentifier": "fmp" - }, - "options": [ - { - "name": "show-contents", - "aliases": [ - "sc" - ], - "description": "List fmp profiles and their contents. All profile details will be printed as part of command output.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "", - "description": "List profiles of type fmp" - }, - { - "options": "--sc", - "description": "List profiles of type fmp and display their contents" - } - ], - "positionals": [], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/list/idms.jsonc b/profiles/list/idms.jsonc deleted file mode 100644 index 3efe73e..0000000 --- a/profiles/list/idms.jsonc +++ /dev/null @@ -1,75 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "idms-profiles", - "aliases": [ - "idms" - ], - "summary": "List profiles of the type idms.", - "description": "An IDMS profile is required to issue IDMS CLI commands. The IDMS profile contains your host and port information", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config list' command", - "customize": { - "profileTypeIdentifier": "idms" - }, - "options": [ - { - "name": "show-contents", - "aliases": [ - "sc" - ], - "description": "List idms profiles and their contents. All profile details will be printed as part of command output.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "", - "description": "List profiles of type idms" - }, - { - "options": "--sc", - "description": "List profiles of type idms and display their contents" - } - ], - "positionals": [], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/list/jclcheck.jsonc b/profiles/list/jclcheck.jsonc deleted file mode 100644 index 020a5e3..0000000 --- a/profiles/list/jclcheck.jsonc +++ /dev/null @@ -1,75 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "jclcheck-profiles", - "aliases": [ - "jclcheck" - ], - "summary": "List profiles of the type jclcheck.", - "description": "A JCLCheck profile is required to issue commands in the jcl command group that interact with JCLCheck. The JCLCheck profile contains your host and port for the JCLCheck instance of your choice.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config list' command", - "customize": { - "profileTypeIdentifier": "jclcheck" - }, - "options": [ - { - "name": "show-contents", - "aliases": [ - "sc" - ], - "description": "List jclcheck profiles and their contents. All profile details will be printed as part of command output.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "", - "description": "List profiles of type jclcheck" - }, - { - "options": "--sc", - "description": "List profiles of type jclcheck and display their contents" - } - ], - "positionals": [], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/list/jclx.jsonc b/profiles/list/jclx.jsonc deleted file mode 100644 index 557f4f7..0000000 --- a/profiles/list/jclx.jsonc +++ /dev/null @@ -1,75 +0,0 @@ -// PID 5698-020 -// Copyright Teracloud ApS 2023 -{ - "name": "jclx-profiles", - "aliases": [ - "jclx" - ], - "summary": "List profiles of the type jclx.", - "description": "Configuration profile for the IBM Z JCL Expert Zowe CLI plugin.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config list' command", - "customize": { - "profileTypeIdentifier": "jclx" - }, - "options": [ - { - "name": "show-contents", - "aliases": [ - "sc" - ], - "description": "List jclx profiles and their contents. All profile details will be printed as part of command output.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "", - "description": "List profiles of type jclx" - }, - { - "options": "--sc", - "description": "List profiles of type jclx and display their contents" - } - ], - "positionals": [], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/list/mat.jsonc b/profiles/list/mat.jsonc deleted file mode 100644 index 4a3bfd1..0000000 --- a/profiles/list/mat.jsonc +++ /dev/null @@ -1,75 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "mat-profiles", - "aliases": [ - "mat" - ], - "summary": "List profiles of the type mat.", - "description": "MAT Analyze CLI profile schema.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config list' command", - "customize": { - "profileTypeIdentifier": "mat" - }, - "options": [ - { - "name": "show-contents", - "aliases": [ - "sc" - ], - "description": "List mat profiles and their contents. All profile details will be printed as part of command output.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "", - "description": "List profiles of type mat" - }, - { - "options": "--sc", - "description": "List profiles of type mat and display their contents" - } - ], - "positionals": [], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/list/omspool.jsonc b/profiles/list/omspool.jsonc deleted file mode 100644 index 48bcc42..0000000 --- a/profiles/list/omspool.jsonc +++ /dev/null @@ -1,75 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "omspool-profiles", - "aliases": [ - "omspool" - ], - "summary": "List profiles of the type omspool.", - "description": "Configuration profile for Spool, where you specify information about your Spool instance", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config list' command", - "customize": { - "profileTypeIdentifier": "omspool" - }, - "options": [ - { - "name": "show-contents", - "aliases": [ - "sc" - ], - "description": "List omspool profiles and their contents. All profile details will be printed as part of command output.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "", - "description": "List profiles of type omspool" - }, - { - "options": "--sc", - "description": "List profiles of type omspool and display their contents" - } - ], - "positionals": [], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/list/ops.jsonc b/profiles/list/ops.jsonc deleted file mode 100644 index 47f5b38..0000000 --- a/profiles/list/ops.jsonc +++ /dev/null @@ -1,75 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "ops-profiles", - "aliases": [ - "ops" - ], - "summary": "List profiles of the type ops.", - "description": "The OPS Web Services session profile schema, where you specify your session information and credentials", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config list' command", - "customize": { - "profileTypeIdentifier": "ops" - }, - "options": [ - { - "name": "show-contents", - "aliases": [ - "sc" - ], - "description": "List ops profiles and their contents. All profile details will be printed as part of command output.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "", - "description": "List profiles of type ops" - }, - { - "options": "--sc", - "description": "List profiles of type ops and display their contents" - } - ], - "positionals": [], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/list/pma.jsonc b/profiles/list/pma.jsonc deleted file mode 100644 index e8d4b96..0000000 --- a/profiles/list/pma.jsonc +++ /dev/null @@ -1,75 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "pma-profiles", - "aliases": [ - "pma" - ], - "summary": "List profiles of the type pma.", - "description": "MAT Detect CLI profile schema.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config list' command", - "customize": { - "profileTypeIdentifier": "pma" - }, - "options": [ - { - "name": "show-contents", - "aliases": [ - "sc" - ], - "description": "List pma profiles and their contents. All profile details will be printed as part of command output.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "", - "description": "List profiles of type pma" - }, - { - "options": "--sc", - "description": "List profiles of type pma and display their contents" - } - ], - "positionals": [], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/list/rse.jsonc b/profiles/list/rse.jsonc deleted file mode 100644 index 68419ef..0000000 --- a/profiles/list/rse.jsonc +++ /dev/null @@ -1,74 +0,0 @@ -// Copyright IBM Corporation 2020, 2024. All Rights Reserved. -{ - "name": "rse-profiles", - "aliases": [ - "rse" - ], - "summary": "List profiles of the type rse.", - "description": "A profile to issue commands to a z/OS system with a working Zowe REST server,Mediation Layer, or IBM RSE (Remote System Explorer) API server installation.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config list' command", - "customize": { - "profileTypeIdentifier": "rse" - }, - "options": [ - { - "name": "show-contents", - "aliases": [ - "sc" - ], - "description": "List rse profiles and their contents. All profile details will be printed as part of command output.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "", - "description": "List profiles of type rse" - }, - { - "options": "--sc", - "description": "List profiles of type rse and display their contents" - } - ], - "positionals": [], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/list/sysview-format.jsonc b/profiles/list/sysview-format.jsonc deleted file mode 100644 index c527409..0000000 --- a/profiles/list/sysview-format.jsonc +++ /dev/null @@ -1,75 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "sysview-format-profiles", - "aliases": [ - "sysview-format" - ], - "summary": "List profiles of the type sysview-format.", - "description": "The SYSVIEW format profile schema, where you specify display settings", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config list' command", - "customize": { - "profileTypeIdentifier": "sysview-format" - }, - "options": [ - { - "name": "show-contents", - "aliases": [ - "sc" - ], - "description": "List sysview-format profiles and their contents. All profile details will be printed as part of command output.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "", - "description": "List profiles of type sysview-format" - }, - { - "options": "--sc", - "description": "List profiles of type sysview-format and display their contents" - } - ], - "positionals": [], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/list/sysview.jsonc b/profiles/list/sysview.jsonc deleted file mode 100644 index 2b58bf2..0000000 --- a/profiles/list/sysview.jsonc +++ /dev/null @@ -1,75 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "sysview-profiles", - "aliases": [ - "sysview" - ], - "summary": "List profiles of the type sysview.", - "description": "The SYSVIEW session profile schema, where you specify your session information and credentials", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config list' command", - "customize": { - "profileTypeIdentifier": "sysview" - }, - "options": [ - { - "name": "show-contents", - "aliases": [ - "sc" - ], - "description": "List sysview profiles and their contents. All profile details will be printed as part of command output.", - "type": "boolean", - "required": false, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "", - "description": "List profiles of type sysview" - }, - { - "options": "--sc", - "description": "List profiles of type sysview and display their contents" - } - ], - "positionals": [], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/set-default/ca7.jsonc b/profiles/set-default/ca7.jsonc deleted file mode 100644 index acf7056..0000000 --- a/profiles/set-default/ca7.jsonc +++ /dev/null @@ -1,68 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "ca7-profile", - "aliases": [ - "ca7" - ], - "summary": "Set the default\n profiles for the ca7 group", - "description": "The ca7 set default-profiles command allows you to set the default profiles for this command group. When a ca7 command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "options": [ - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specify a\n profile for default usage within the ca7 group. When you issue commands within the ca7 group without a profile specified as part of the command, the default will be loaded instead.", - "type": "string", - "required": true - } - ], - "customize": { - "profileTypeIdentifier": "ca7" - }, - "examples": [ - { - "options": "profilename", - "description": "Set the default profile for type ca7 to the profile named 'profilename'" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/set-default/caview.jsonc b/profiles/set-default/caview.jsonc deleted file mode 100644 index c50a986..0000000 --- a/profiles/set-default/caview.jsonc +++ /dev/null @@ -1,68 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "caview-profile", - "aliases": [ - "caview" - ], - "summary": "Set the default\n profiles for the caview group", - "description": "The caview set default-profiles command allows you to set the default profiles for this command group. When a caview command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "options": [ - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specify a\n profile for default usage within the caview group. When you issue commands within the caview group without a profile specified as part of the command, the default will be loaded instead.", - "type": "string", - "required": true - } - ], - "customize": { - "profileTypeIdentifier": "caview" - }, - "examples": [ - { - "options": "profilename", - "description": "Set the default profile for type caview to the profile named 'profilename'" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/set-default/dbm-db2-options.jsonc b/profiles/set-default/dbm-db2-options.jsonc deleted file mode 100644 index 8c2edbe..0000000 --- a/profiles/set-default/dbm-db2-options.jsonc +++ /dev/null @@ -1,68 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "dbm-db2-options-profile", - "aliases": [ - "dbm-db2-options" - ], - "summary": "Set the default\n profiles for the dbm-db2-options group", - "description": "The dbm-db2-options set default-profiles command allows you to set the default profiles for this command group. When a dbm-db2-options command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "options": [ - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specify a\n profile for default usage within the dbm-db2-options group. When you issue commands within the dbm-db2-options group without a profile specified as part of the command, the default will be loaded instead.", - "type": "string", - "required": true - } - ], - "customize": { - "profileTypeIdentifier": "dbm-db2-options" - }, - "examples": [ - { - "options": "profilename", - "description": "Set the default profile for type dbm-db2-options to the profile named 'profilename'" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/set-default/dbm-db2.jsonc b/profiles/set-default/dbm-db2.jsonc deleted file mode 100644 index c2575fa..0000000 --- a/profiles/set-default/dbm-db2.jsonc +++ /dev/null @@ -1,68 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "dbm-db2-profile", - "aliases": [ - "dbm-db2" - ], - "summary": "Set the default\n profiles for the dbm-db2 group", - "description": "The dbm-db2 set default-profiles command allows you to set the default profiles for this command group. When a dbm-db2 command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "options": [ - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specify a\n profile for default usage within the dbm-db2 group. When you issue commands within the dbm-db2 group without a profile specified as part of the command, the default will be loaded instead.", - "type": "string", - "required": true - } - ], - "customize": { - "profileTypeIdentifier": "dbm-db2" - }, - "examples": [ - { - "options": "profilename", - "description": "Set the default profile for type dbm-db2 to the profile named 'profilename'" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/set-default/ebg.jsonc b/profiles/set-default/ebg.jsonc deleted file mode 100644 index a5e9123..0000000 --- a/profiles/set-default/ebg.jsonc +++ /dev/null @@ -1,68 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "ebg-profile", - "aliases": [ - "ebg" - ], - "summary": "Set the default\n profiles for the ebg group", - "description": "The ebg set default-profiles command allows you to set the default profiles for this command group. When a ebg command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "options": [ - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specify a\n profile for default usage within the ebg group. When you issue commands within the ebg group without a profile specified as part of the command, the default will be loaded instead.", - "type": "string", - "required": true - } - ], - "customize": { - "profileTypeIdentifier": "ebg" - }, - "examples": [ - { - "options": "profilename", - "description": "Set the default profile for type ebg to the profile named 'profilename'" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/set-default/endevor-location.jsonc b/profiles/set-default/endevor-location.jsonc deleted file mode 100644 index f0bf5a3..0000000 --- a/profiles/set-default/endevor-location.jsonc +++ /dev/null @@ -1,68 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "endevor-location-profile", - "aliases": [ - "endevor-location" - ], - "summary": "Set the default\n profiles for the endevor-location group", - "description": "The endevor-location set default-profiles command allows you to set the default profiles for this command group. When a endevor-location command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "options": [ - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specify a\n profile for default usage within the endevor-location group. When you issue commands within the endevor-location group without a profile specified as part of the command, the default will be loaded instead.", - "type": "string", - "required": true - } - ], - "customize": { - "profileTypeIdentifier": "endevor-location" - }, - "examples": [ - { - "options": "profilename", - "description": "Set the default profile for type endevor-location to the profile named 'profilename'" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/set-default/endevor.jsonc b/profiles/set-default/endevor.jsonc deleted file mode 100644 index 60ea35e..0000000 --- a/profiles/set-default/endevor.jsonc +++ /dev/null @@ -1,68 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "endevor-profile", - "aliases": [ - "endevor" - ], - "summary": "Set the default\n profiles for the endevor group", - "description": "The endevor set default-profiles command allows you to set the default profiles for this command group. When a endevor command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "options": [ - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specify a\n profile for default usage within the endevor group. When you issue commands within the endevor group without a profile specified as part of the command, the default will be loaded instead.", - "type": "string", - "required": true - } - ], - "customize": { - "profileTypeIdentifier": "endevor" - }, - "examples": [ - { - "options": "profilename", - "description": "Set the default profile for type endevor to the profile named 'profilename'" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/set-default/fmp.jsonc b/profiles/set-default/fmp.jsonc deleted file mode 100644 index 26ae367..0000000 --- a/profiles/set-default/fmp.jsonc +++ /dev/null @@ -1,68 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "fmp-profile", - "aliases": [ - "fmp" - ], - "summary": "Set the default\n profiles for the fmp group", - "description": "The fmp set default-profiles command allows you to set the default profiles for this command group. When a fmp command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "options": [ - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specify a\n profile for default usage within the fmp group. When you issue commands within the fmp group without a profile specified as part of the command, the default will be loaded instead.", - "type": "string", - "required": true - } - ], - "customize": { - "profileTypeIdentifier": "fmp" - }, - "examples": [ - { - "options": "profilename", - "description": "Set the default profile for type fmp to the profile named 'profilename'" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/set-default/idms.jsonc b/profiles/set-default/idms.jsonc deleted file mode 100644 index 41bcc30..0000000 --- a/profiles/set-default/idms.jsonc +++ /dev/null @@ -1,68 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "idms-profile", - "aliases": [ - "idms" - ], - "summary": "Set the default\n profiles for the idms group", - "description": "The idms set default-profiles command allows you to set the default profiles for this command group. When a idms command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "options": [ - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specify a\n profile for default usage within the idms group. When you issue commands within the idms group without a profile specified as part of the command, the default will be loaded instead.", - "type": "string", - "required": true - } - ], - "customize": { - "profileTypeIdentifier": "idms" - }, - "examples": [ - { - "options": "profilename", - "description": "Set the default profile for type idms to the profile named 'profilename'" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/set-default/jclcheck.jsonc b/profiles/set-default/jclcheck.jsonc deleted file mode 100644 index 08ba4c1..0000000 --- a/profiles/set-default/jclcheck.jsonc +++ /dev/null @@ -1,68 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "jclcheck-profile", - "aliases": [ - "jclcheck" - ], - "summary": "Set the default\n profiles for the jclcheck group", - "description": "The jclcheck set default-profiles command allows you to set the default profiles for this command group. When a jclcheck command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "options": [ - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specify a\n profile for default usage within the jclcheck group. When you issue commands within the jclcheck group without a profile specified as part of the command, the default will be loaded instead.", - "type": "string", - "required": true - } - ], - "customize": { - "profileTypeIdentifier": "jclcheck" - }, - "examples": [ - { - "options": "profilename", - "description": "Set the default profile for type jclcheck to the profile named 'profilename'" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/set-default/jclx.jsonc b/profiles/set-default/jclx.jsonc deleted file mode 100644 index 80deec9..0000000 --- a/profiles/set-default/jclx.jsonc +++ /dev/null @@ -1,68 +0,0 @@ -// PID 5698-020 -// Copyright Teracloud ApS 2023 -{ - "name": "jclx-profile", - "aliases": [ - "jclx" - ], - "summary": "Set the default\n profiles for the jclx group", - "description": "The jclx set default-profiles command allows you to set the default profiles for this command group. When a jclx command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "options": [ - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specify a\n profile for default usage within the jclx group. When you issue commands within the jclx group without a profile specified as part of the command, the default will be loaded instead.", - "type": "string", - "required": true - } - ], - "customize": { - "profileTypeIdentifier": "jclx" - }, - "examples": [ - { - "options": "profilename", - "description": "Set the default profile for type jclx to the profile named 'profilename'" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/set-default/mat.jsonc b/profiles/set-default/mat.jsonc deleted file mode 100644 index bf4fa61..0000000 --- a/profiles/set-default/mat.jsonc +++ /dev/null @@ -1,68 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "mat-profile", - "aliases": [ - "mat" - ], - "summary": "Set the default\n profiles for the mat group", - "description": "The mat set default-profiles command allows you to set the default profiles for this command group. When a mat command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "options": [ - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specify a\n profile for default usage within the mat group. When you issue commands within the mat group without a profile specified as part of the command, the default will be loaded instead.", - "type": "string", - "required": true - } - ], - "customize": { - "profileTypeIdentifier": "mat" - }, - "examples": [ - { - "options": "profilename", - "description": "Set the default profile for type mat to the profile named 'profilename'" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/set-default/omspool.jsonc b/profiles/set-default/omspool.jsonc deleted file mode 100644 index 992b013..0000000 --- a/profiles/set-default/omspool.jsonc +++ /dev/null @@ -1,68 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "omspool-profile", - "aliases": [ - "omspool" - ], - "summary": "Set the default\n profiles for the omspool group", - "description": "The omspool set default-profiles command allows you to set the default profiles for this command group. When a omspool command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "options": [ - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specify a\n profile for default usage within the omspool group. When you issue commands within the omspool group without a profile specified as part of the command, the default will be loaded instead.", - "type": "string", - "required": true - } - ], - "customize": { - "profileTypeIdentifier": "omspool" - }, - "examples": [ - { - "options": "profilename", - "description": "Set the default profile for type omspool to the profile named 'profilename'" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/set-default/ops.jsonc b/profiles/set-default/ops.jsonc deleted file mode 100644 index ab56b81..0000000 --- a/profiles/set-default/ops.jsonc +++ /dev/null @@ -1,68 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "ops-profile", - "aliases": [ - "ops" - ], - "summary": "Set the default\n profiles for the ops group", - "description": "The ops set default-profiles command allows you to set the default profiles for this command group. When a ops command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "options": [ - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specify a\n profile for default usage within the ops group. When you issue commands within the ops group without a profile specified as part of the command, the default will be loaded instead.", - "type": "string", - "required": true - } - ], - "customize": { - "profileTypeIdentifier": "ops" - }, - "examples": [ - { - "options": "profilename", - "description": "Set the default profile for type ops to the profile named 'profilename'" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/set-default/pma.jsonc b/profiles/set-default/pma.jsonc deleted file mode 100644 index a35426a..0000000 --- a/profiles/set-default/pma.jsonc +++ /dev/null @@ -1,68 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "pma-profile", - "aliases": [ - "pma" - ], - "summary": "Set the default\n profiles for the pma group", - "description": "The pma set default-profiles command allows you to set the default profiles for this command group. When a pma command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "options": [ - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specify a\n profile for default usage within the pma group. When you issue commands within the pma group without a profile specified as part of the command, the default will be loaded instead.", - "type": "string", - "required": true - } - ], - "customize": { - "profileTypeIdentifier": "pma" - }, - "examples": [ - { - "options": "profilename", - "description": "Set the default profile for type pma to the profile named 'profilename'" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/set-default/rse.jsonc b/profiles/set-default/rse.jsonc deleted file mode 100644 index 6a38290..0000000 --- a/profiles/set-default/rse.jsonc +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright IBM Corporation 2020, 2024. All Rights Reserved. -{ - "name": "rse-profile", - "aliases": [ - "rse" - ], - "summary": "Set the default\n profiles for the rse group", - "description": "The rse set default-profiles command allows you to set the default profiles for this command group. When a rse command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "options": [ - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specify a\n profile for default usage within the rse group. When you issue commands within the rse group without a profile specified as part of the command, the default will be loaded instead.", - "type": "string", - "required": true - } - ], - "customize": { - "profileTypeIdentifier": "rse" - }, - "examples": [ - { - "options": "profilename", - "description": "Set the default profile for type rse to the profile named 'profilename'" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/set-default/sysview-format.jsonc b/profiles/set-default/sysview-format.jsonc deleted file mode 100644 index 0fd3cdd..0000000 --- a/profiles/set-default/sysview-format.jsonc +++ /dev/null @@ -1,68 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "sysview-format-profile", - "aliases": [ - "sysview-format" - ], - "summary": "Set the default\n profiles for the sysview-format group", - "description": "The sysview-format set default-profiles command allows you to set the default profiles for this command group. When a sysview-format command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "options": [ - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specify a\n profile for default usage within the sysview-format group. When you issue commands within the sysview-format group without a profile specified as part of the command, the default will be loaded instead.", - "type": "string", - "required": true - } - ], - "customize": { - "profileTypeIdentifier": "sysview-format" - }, - "examples": [ - { - "options": "profilename", - "description": "Set the default profile for type sysview-format to the profile named 'profilename'" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/set-default/sysview.jsonc b/profiles/set-default/sysview.jsonc deleted file mode 100644 index 29ae7a3..0000000 --- a/profiles/set-default/sysview.jsonc +++ /dev/null @@ -1,68 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "sysview-profile", - "aliases": [ - "sysview" - ], - "summary": "Set the default\n profiles for the sysview group", - "description": "The sysview set default-profiles command allows you to set the default profiles for this command group. When a sysview command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "options": [ - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [ - { - "name": "profileName", - "description": "Specify a\n profile for default usage within the sysview group. When you issue commands within the sysview group without a profile specified as part of the command, the default will be loaded instead.", - "type": "string", - "required": true - } - ], - "customize": { - "profileTypeIdentifier": "sysview" - }, - "examples": [ - { - "options": "profilename", - "description": "Set the default profile for type sysview to the profile named 'profilename'" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/update/ca7.jsonc b/profiles/update/ca7.jsonc deleted file mode 100644 index 39b7140..0000000 --- a/profiles/update/ca7.jsonc +++ /dev/null @@ -1,154 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "ca7-profile", - "aliases": [ - "ca7" - ], - "summary": "Update a ca7 profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates.", - "description": "A CA7 profile is required to issue commands in the CA7 command group. The CA7 profile contains your host and port for the CA7 instance of your choice.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "customize": { - "profileTypeIdentifier": "ca7" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new ca7 profile. You can load this profile by using the name on commands that support the \"--ca7-profile\" option.", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the CA7 API service that is running on the mainframe system.", - "required": false, - "group": "CA7 Connection Options", - "absenceImplications": null, - "implies": null - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the CA7 API service that is running on the mainframe system.", - "required": false, - "group": "CA7 Connection Options", - "absenceImplications": null, - "implies": null - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": false, - "group": "CA7 Connection Options", - "absenceImplications": null, - "implies": null - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the CA7 API service that is running on the mainframe system.", - "required": false, - "group": "CA7 Connection Options", - "absenceImplications": null, - "implies": null - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "CA7 Connection Options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for CA7 connection (http or https).", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "CA7 Connection Options", - "absenceImplications": null, - "implies": null - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "group": "CA7 Connection Options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/update/caview.jsonc b/profiles/update/caview.jsonc deleted file mode 100644 index a016060..0000000 --- a/profiles/update/caview.jsonc +++ /dev/null @@ -1,137 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "caview-profile", - "aliases": [ - "caview" - ], - "summary": "Update a caview profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates.", - "description": "Configuration profile for View", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "customize": { - "profileTypeIdentifier": "caview" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new caview profile. You can load this profile by using the name on commands that support the \"--caview-profile\" option.", - "type": "string", - "required": true - } - ], - "options": [ - { - "type": "string", - "name": "protocol", - "description": "Protocol of the target View REST API instance.", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "absenceImplications": null, - "implies": null, - "group": "Options", - "aliases": [] - }, - { - "type": "string", - "name": "host", - "aliases": [ - "hostname" - ], - "description": "Hostname or ip address of the target View REST API instance.", - "required": false, - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "type": "number", - "name": "port", - "description": "Port of the target View REST API instance.", - "numericValueRange": [ - 0, - 65535 - ], - "required": false, - "absenceImplications": null, - "implies": null, - "group": "Options", - "aliases": [] - }, - { - "type": "string", - "name": "base-path", - "description": "Context name of the target View REST API instance.", - "required": false, - "absenceImplications": null, - "implies": null, - "group": "Options", - "aliases": [] - }, - { - "type": "string", - "name": "user", - "aliases": [ - "username" - ], - "description": "User name used to authenticate against the target View REST API instance.", - "required": false, - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "type": "string", - "name": "password", - "description": "Password used to authenticate against the target View REST API instance.", - "required": false, - "absenceImplications": null, - "implies": null, - "group": "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" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/update/dbm-db2-options.jsonc b/profiles/update/dbm-db2-options.jsonc deleted file mode 100644 index 0922372..0000000 --- a/profiles/update/dbm-db2-options.jsonc +++ /dev/null @@ -1,304 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "dbm-db2-options-profile", - "aliases": [ - "dbm-db2-options" - ], - "summary": "Update a dbm-db2-options profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates.", - "description": "The DBM-Db2 options profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes execution-dependent details.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "customize": { - "profileTypeIdentifier": "dbm-db2-options" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new dbm-db2-options profile. You can load this profile by using the name on commands that support the \"--dbm-db2-options-profile\" option.", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "authid", - "aliases": [ - "a" - ], - "description": "Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.", - "required": false, - "type": "string", - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "name": "change-set", - "aliases": [ - "cs" - ], - "description": "Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.\n\n Format:\n \n \n\nFor more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote: If change-set and change-set-file are both specified, specifications in change-set-file take precedence. ", - "required": false, - "type": "string", - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "name": "change-set-values", - "aliases": [ - "csv" - ], - "description": "Specifies the global change specifications that modify Db2 object attributes during a command execution.\n\n Format:\n \n \n \nThe consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in the and . The first occurrence in multiple specifications for the same has the highest precedence.\n \nFor a list of global change set attributes, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nExample:\n \nThe following example demonstrates changes to the table schema (creator) and tablespace names:\n \nTBCR TEST% PROD%\nTBTS TESTTS% PRODTS%\n\nNote:\n- If change-set and change-set-file are both specified, specifications in change-set-file take precedence.\n- The changeSetValues options-profile option has the same behavior as the change-set-file command option. ", - "required": false, - "type": "array", - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "name": "delete-work-datasets", - "aliases": [ - "dwd" - ], - "description": "Specifies whether to delete work data sets on a mainframe after the request is fulfilled.", - "required": false, - "type": "boolean", - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "name": "description", - "aliases": [ - "d" - ], - "description": "Specifies a 1- to 25-character description for the RC/Migrator compare strategy.", - "required": false, - "type": "string", - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "name": "id", - "description": "Specifies the 1- to 8-character name of the RC/Migrator compare strategy that is created on the target Db2 subsystem during a command execution.\n \n Format: The name must begin with a non-numeric character and contain the following characters only: uppercase letters from A to Z, numbers from 0 to 9, and special characters $, #, and @. ", - "required": false, - "type": "string", - "absenceImplications": null, - "implies": null, - "group": "Options", - "aliases": [] - }, - { - "name": "job-cards", - "aliases": [ - "jc" - ], - "description": "Specifies a string array of z/OS JCL JOB statements.", - "required": false, - "type": "array", - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "name": "match-set", - "aliases": [ - "ms" - ], - "description": "Specifies the creator and name of an existing RC/Migrator automapping mask set. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. Matching determines whether the 'change-set' or 'rule-set' options are applied.\n\n Format:\n\n\n\nFor more information about mask services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n\nNote: If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence. ", - "required": false, - "type": "string", - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "name": "match-set-values", - "aliases": [ - "msv" - ], - "description": "Specifies the mapping mask specifications. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. For example, a mask specification can account for different schema naming patterns across environments. Matching determines whether the 'change-set' or 'rule-set' options are applied.\n \n Format:\n\n ;\n\nSTOGROUP \nDATABASE \nTABLESPACE \nTABLE \nINDEX \nVIEW \nSYNONYM \nALIAS \nTRIGGER \nSEQUENCE \nFUNCTION \nPROCEDURE \n \nNote:\n- must be between 1 and 128 characters. For DATABASE and TABLESPACE, must be between 1 and 8 characters.\n- must be between 1 and 128 characters.\n- must be between 1 and 64 characters.\n \nA mask specification can include the following wildcard characters:\n \nPercent sign (%) indicates that zero or more characters can occupy that position and all remaining positions to the end of the name, or to the next character. The percent sign can be used anywhere in the name. However, the source and target characters must match exactly.\n \nHyphen or dash (-) indicates that any character can occupy that position, but a character must exist at that position, and the source and target character must match exactly. The hyphen can be repeated in several places in the name.\n \nAsterisk (*) indicates matching values. An asterisk cannot be used with other characters.\n \nUse a semicolon to separate mask specifications. Multiple mask specifications for the same object type are supported.\n\nExample:\n \nThe following example demonstrates different ways of matching the table MYNAME.MYTABLE to the table YOURNAME.YOURTABLE:\n \nTABLE MY%.%TABLE YOUR%.%TABLE; \nTABLE MYN-M-.MYT% YOURN-M-.YOURT%;\nTABLE MYNAME.MYTABLE YOURNAME.YOURTABLE; \nTABLE *.MYTABLE *.YOURTABLE;\n\nFor a list of mask specifications, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig\n \nNote:\n- If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence.\n- The matchSetValues options-profile option has the same behavior as the match-set-file command option. ", - "required": false, - "type": "array", - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "name": "modification", - "aliases": [ - "m" - ], - "description": "Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.\n \n For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt ", - "required": false, - "type": "string", - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "name": "overwrite-output-files", - "aliases": [ - "oof" - ], - "description": "Specifies whether to overwrite output files if they exist.", - "required": false, - "type": "boolean", - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "name": "rule-set", - "aliases": [ - "rs" - ], - "description": "Specifies the creator and name of an existing RC/Migrator rule set that overrides Db2 object attributes in the target Db2 subsystem with the corresponding values from the input DDL file. The changes only apply to existing objects, as determined by match-set processing.\n\n Format:\n\n\n \nFor more information about rule database services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig ", - "required": false, - "type": "string", - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "name": "sqlid", - "aliases": [ - "s" - ], - "description": "Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.", - "required": false, - "type": "string", - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "name": "source-db2", - "aliases": [ - "sd" - ], - "description": "Specifies the source Db2 subsystem or data sharing group where the objects that you want to use in a command are located.\n \n Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used. ", - "required": false, - "type": "string", - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "name": "target-db2", - "aliases": [ - "td" - ], - "description": "Specifies the target Db2 subsystem or data sharing group where you want to use a command.\n \n Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used. ", - "required": false, - "type": "string", - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "name": "termination-character", - "aliases": [ - "tc" - ], - "description": "Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.", - "required": false, - "type": "string", - "stringLengthRange": [ - 1, - 1 - ], - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "name": "type", - "aliases": [ - "t" - ], - "description": "Specifies the type of DDL statements that you want to generate. You can generate CREATE or DROP statements.", - "required": false, - "type": "string", - "allowableValues": { - "values": [ - "drop", - "create" - ] - }, - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "name": "verify", - "aliases": [ - "v" - ], - "description": "Specifies whether to verify that the objects to be created do not exist on the Db2 subsystem and that the related objects that are required for successful creation of the objects exist on the Db2 subsystem or in the input DDL.\n \n Default value: no ", - "required": false, - "type": "string", - "allowableValues": { - "values": [ - "yes", - "no" - ] - }, - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "name": "work-dataset-prefix", - "aliases": [ - "wdp" - ], - "description": "Specifies the prefix (high-level qualifier) in z/OS work data set names.", - "required": false, - "type": "string", - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/update/dbm-db2.jsonc b/profiles/update/dbm-db2.jsonc deleted file mode 100644 index 548d31f..0000000 --- a/profiles/update/dbm-db2.jsonc +++ /dev/null @@ -1,269 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "dbm-db2-profile", - "aliases": [ - "dbm-db2" - ], - "summary": "Update a dbm-db2 profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates.", - "description": "The DBM-Db2 profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes server connection, z/OS execution, and user-dependent details.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "customize": { - "profileTypeIdentifier": "dbm-db2" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new dbm-db2 profile. You can load this profile by using the name on commands that support the \"--dbm-db2-profile\" option.", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the DBM Data Service REST API server host name or TCP/IP address to use.", - "required": false, - "type": "string", - "group": "DBM-Db2 Options", - "absenceImplications": null, - "implies": null - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the DBM Data Service REST API server TCP/IP port number.", - "required": false, - "type": "number", - "group": "DBM-Db2 Options", - "absenceImplications": null, - "implies": null - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Specifies the mainframe user name that you want to use to connect to the mainframe systems during execution of the Zowe CLI commands. This user name can be the same as your TSO login ID.", - "required": false, - "type": "string", - "group": "DBM-Db2 Options", - "absenceImplications": null, - "implies": null - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Specifies the mainframe password for the user name that is used to connect to the mainframe systems during execution of the CLI commands. This password can be the same as your TSO password.", - "required": false, - "type": "string", - "group": "DBM-Db2 Options", - "absenceImplications": null, - "implies": null - }, - { - "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 Options", - "absenceImplications": null, - "implies": null, - "aliases": [] - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Determines whether the dbm-db2 command is accepted or rejected when a self-signed certificate is returned by the DBM Data Service.", - "required": false, - "type": "boolean", - "group": "DBM-Db2 Options", - "absenceImplications": null, - "implies": null - }, - { - "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 Options", - "absenceImplications": null, - "implies": null - }, - { - "name": "job-cards", - "aliases": [ - "jc" - ], - "description": "Specifies a string array of z/OS JCL JOB statements.", - "required": false, - "type": "array", - "group": "DBM-Db2 Options", - "absenceImplications": null, - "implies": null - }, - { - "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 Options", - "absenceImplications": null, - "implies": null - }, - { - "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 Options", - "absenceImplications": null, - "implies": null - }, - { - "name": "overwrite-output-files", - "aliases": [ - "oof" - ], - "description": "Specifies whether to overwrite output files if they exist.", - "required": false, - "type": "boolean", - "group": "DBM-Db2 Options", - "absenceImplications": null, - "implies": null - }, - { - "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 Options", - "absenceImplications": null, - "implies": null - }, - { - "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 Options", - "absenceImplications": null, - "implies": null - }, - { - "name": "termination-character", - "aliases": [ - "tc" - ], - "description": "Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.", - "required": false, - "type": "string", - "stringLengthRange": [ - 1, - 1 - ], - "group": "DBM-Db2 Options", - "absenceImplications": null, - "implies": null - }, - { - "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 Options", - "absenceImplications": null, - "implies": null - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "profile_name1 --work-dataset-prefix NEWPREFX.DDL", - "description": "Update a DBM-Db2 profile named profile_name1 with a new work data set prefix" - }, - { - "options": "dbm123 --user newuser --password newp4ss", - "description": "Update a DBM-Db2 profile named dbm123 with a new username and password" - }, - { - "options": "dbm124 --environment-list \"SUBA:prod@host4.com:322,SUBC:stage@host3.net:722\"", - "description": "Update a DBM-Db2 profile named dbm124 with a new environment list. Existing subsystem SUBA will be updated with a new hostname \"host4\" and subsystem SUBC will be added to the list" - }, - { - "options": "dbm125 --job-cards \"//NEWJOBNM JOB (123456789),\" \"// CLASS=A,MSGCLASS=X,MSGLEVEL=(1,1),\"", - "description": "Update a DBM-Db2 profile named dbm125 with new job cards" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/update/ebg.jsonc b/profiles/update/ebg.jsonc deleted file mode 100644 index 554771c..0000000 --- a/profiles/update/ebg.jsonc +++ /dev/null @@ -1,141 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "ebg-profile", - "aliases": [ - "ebg" - ], - "summary": "Update a ebg profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates.", - "description": "An EBG profile is required to issue commands in the ebg command group. The EBG profile contains the connection details for the Endevor Bridge for Git server of your choice.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "customize": { - "profileTypeIdentifier": "ebg" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new ebg profile. You can load this profile by using the name on commands that support the \"--ebg-profile\" option.", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "The Endevor Bridge for Git SCM protocol. \n\nDefault value: https", - "type": "string", - "required": false, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "absenceImplications": null, - "implies": null - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The Endevor Bridge for Git hostname.", - "type": "string", - "required": false, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "absenceImplications": null, - "implies": null - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "The Endevor Bridge for Git port.", - "type": "number", - "required": false, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "absenceImplications": null, - "implies": null - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Endevor Bridge for Git username (your git username).", - "type": "string", - "required": false, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "absenceImplications": null, - "implies": null - }, - { - "name": "token", - "aliases": [ - "t" - ], - "description": "Git personal access token (it can be obtained from your Git Enterprise Server).", - "type": "string", - "required": false, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "absenceImplications": null, - "implies": null - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: false", - "type": "boolean", - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/update/endevor-location.jsonc b/profiles/update/endevor-location.jsonc deleted file mode 100644 index b1bcf19..0000000 --- a/profiles/update/endevor-location.jsonc +++ /dev/null @@ -1,231 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "endevor-location-profile", - "aliases": [ - "endevor-location" - ], - "summary": "Update a endevor-location profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates.", - "description": "The Endevor element location, where you specify your working environment, system and subsystem", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "customize": { - "profileTypeIdentifier": "endevor-location" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new endevor-location profile. You can load this profile by using the name on commands that support the \"--endevor-location-profile\" option.", - "type": "string", - "required": true - } - ], - "options": [ - { - "description": "The STC/datasource of the session", - "type": "string", - "name": "instance", - "aliases": [ - "i" - ], - "required": false, - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "description": "The Endevor environment where your project resides", - "type": "string", - "name": "environment", - "aliases": [ - "env" - ], - "stringLengthRange": [ - 1, - 8 - ], - "required": false, - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "description": "The Endevor system where the element resides", - "type": "string", - "name": "system", - "aliases": [ - "sys" - ], - "stringLengthRange": [ - 1, - 8 - ], - "required": false, - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "description": "The Endevor subsystem where your element resides", - "type": "string", - "name": "subsystem", - "aliases": [ - "sub" - ], - "stringLengthRange": [ - 1, - 8 - ], - "required": false, - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "description": "Name of the Endevor element's type", - "type": "string", - "name": "type", - "aliases": [ - "typ" - ], - "stringLengthRange": [ - 1, - 8 - ], - "required": false, - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "description": "The Endevor stage where your project resides", - "type": "string", - "name": "stage-number", - "aliases": [ - "sn" - ], - "allowableValues": { - "values": [ - "1", - "2" - ] - }, - "required": false, - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "description": "The Endevor comment you want to use when performing an action", - "type": "string", - "name": "comment", - "aliases": [ - "com" - ], - "stringLengthRange": [ - 1, - 40 - ], - "required": false, - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "description": "The Endevor CCID you want to use when performing an action", - "type": "string", - "name": "ccid", - "aliases": [ - "cci" - ], - "stringLengthRange": [ - 1, - 12 - ], - "required": false, - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "description": "The return code of Endevor that defines a failed action", - "type": "number", - "name": "maxrc", - "required": false, - "absenceImplications": null, - "implies": null, - "group": "Options", - "aliases": [] - }, - { - "description": "Always override element signout, without having to specify the override signout option on each command", - "type": "boolean", - "name": "override-signout", - "aliases": [ - "os" - ], - "required": false, - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "name": "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", - "type-name", - "file-ext", - "mixed" - ], - "caseSensitive": false - }, - "required": false, - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/update/endevor.jsonc b/profiles/update/endevor.jsonc deleted file mode 100644 index 5e15487..0000000 --- a/profiles/update/endevor.jsonc +++ /dev/null @@ -1,165 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "endevor-profile", - "aliases": [ - "endevor" - ], - "summary": "Update a endevor profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates.", - "description": "The endevor profile schema, where you specify your endevor session information and credentials", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "customize": { - "profileTypeIdentifier": "endevor" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new endevor profile. You can load this profile by using the name on commands that support the \"--endevor-profile\" option.", - "type": "string", - "required": true - } - ], - "options": [ - { - "description": "The hostname of the endevor session", - "type": "string", - "name": "host", - "aliases": [ - "hostname" - ], - "required": false, - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "description": "The port number of the endevor session", - "type": "number", - "name": "port", - "aliases": [ - "p" - ], - "required": false, - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "description": "The username of the endevor session", - "type": "string", - "name": "user", - "aliases": [ - "username" - ], - "required": false, - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "description": "The password of the user", - "type": "string", - "name": "password", - "aliases": [ - "pass" - ], - "required": false, - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "description": "The protocol used for connecting to Endevor Rest API", - "type": "string", - "name": "protocol", - "aliases": [ - "prot" - ], - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "required": false, - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "description": "The base path used for connecting to Endevor Rest API", - "type": "string", - "name": "base-path", - "aliases": [ - "bp" - ], - "required": false, - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "description": "If set, the server certificate is verified against the list of supplied CAs", - "type": "boolean", - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "required": false, - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "description": "The default path where any reports will be written to, either absolute or relative to current directory", - "type": "string", - "name": "report-dir", - "aliases": [ - "rd" - ], - "required": false, - "absenceImplications": null, - "implies": null, - "group": "Options" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/update/fmp.jsonc b/profiles/update/fmp.jsonc deleted file mode 100644 index 081ceac..0000000 --- a/profiles/update/fmp.jsonc +++ /dev/null @@ -1,154 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "fmp-profile", - "aliases": [ - "fmp" - ], - "summary": "Update a fmp profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates.", - "description": "File Master Plus profile schema.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "customize": { - "profileTypeIdentifier": "fmp" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new fmp profile. You can load this profile by using the name on commands that support the \"--fmp-profile\" option.", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies File Master Plus server host name.", - "type": "string", - "required": false, - "group": "FMP Connection Options", - "absenceImplications": null, - "implies": null - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies File Master Plus server port.", - "type": "number", - "required": false, - "group": "FMP Connection Options", - "absenceImplications": null, - "implies": null - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Specifies Mainframe user name. May be the same as TSO login.", - "type": "string", - "required": false, - "group": "FMP Connection Options", - "absenceImplications": null, - "implies": null - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Specifies Mainframe password. May be the same as TSO password.", - "type": "string", - "required": false, - "group": "FMP Connection Options", - "absenceImplications": null, - "implies": null - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies File Master Plus REST API protocol.", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "FMP Connection Options", - "absenceImplications": null, - "implies": null - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "required": false, - "group": "FMP Connection Options", - "absenceImplications": null, - "implies": null - }, - { - "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 FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "FMP Connection Options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/update/idms.jsonc b/profiles/update/idms.jsonc deleted file mode 100644 index a808480..0000000 --- a/profiles/update/idms.jsonc +++ /dev/null @@ -1,153 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "idms-profile", - "aliases": [ - "idms" - ], - "summary": "Update a idms profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates.", - "description": "An IDMS profile is required to issue IDMS CLI commands. The IDMS profile contains your host and port information", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "customize": { - "profileTypeIdentifier": "idms" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new idms profile. You can load this profile by using the name on commands that support the \"--idms-profile\" option.", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Host name of the IDMS REST API service", - "type": "string", - "group": "IDMS Connection Options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Port for the IDMS REST API service", - "type": "number", - "group": "IDMS Connection Options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Mainframe user name, which can be the same as your TSO login ID", - "type": "string", - "group": "IDMS Connection Options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Mainframe password, which can be the same as your TSO password", - "type": "string", - "group": "IDMS Connection Options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "datasource", - "aliases": [ - "d" - ], - "description": "Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API", - "type": "string", - "group": "IDMS Connection Options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer", - "type": "string", - "group": "IDMS Connection Options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates", - "type": "boolean", - "group": "IDMS Connection Options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "idms99 --datasource SYS100", - "description": "Update an IDMS profile called 'idms99' with a new default data source SYS100" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/update/jclcheck.jsonc b/profiles/update/jclcheck.jsonc deleted file mode 100644 index 816e061..0000000 --- a/profiles/update/jclcheck.jsonc +++ /dev/null @@ -1,166 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "jclcheck-profile", - "aliases": [ - "jclcheck" - ], - "summary": "Update a jclcheck profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates.", - "description": "A JCLCheck profile is required to issue commands in the jcl command group that interact with JCLCheck. The JCLCheck profile contains your host and port for the JCLCheck instance of your choice.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "customize": { - "profileTypeIdentifier": "jclcheck" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new jclcheck profile. You can load this profile by using the name on commands that support the \"--jclcheck-profile\" option.", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "host", - "aliases": [ - "H" - ], - "type": "string", - "description": "Host name of the JCLCheck API service that is running on the mainframe system.", - "required": false, - "group": "JCLCheck Connection Options", - "absenceImplications": null, - "implies": null - }, - { - "name": "port", - "aliases": [ - "P" - ], - "type": "number", - "description": "Port for the JCLCheck API service that is running on the mainframe system.", - "required": false, - "group": "JCLCheck Connection Options", - "absenceImplications": null, - "implies": null - }, - { - "name": "user", - "aliases": [ - "u" - ], - "type": "string", - "description": "User name for authenticating connections to the JCLCheck API service that is running on the mainframe system.", - "required": false, - "group": "JCLCheck Connection Options", - "absenceImplications": null, - "implies": null - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "type": "string", - "description": "Password for authenticating connections to the JCLCheck API service that is running on the mainframe system.", - "required": false, - "group": "JCLCheck Connection Options", - "absenceImplications": null, - "implies": null - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "required": false, - "group": "JCLCheck Connection Options", - "absenceImplications": null, - "implies": null - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "required": false, - "group": "JCLCheck Connection Options", - "absenceImplications": null, - "implies": null - }, - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies protocol to use for JCLCheck connection (http or https).", - "type": "string", - "required": false, - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "group": "JCLCheck Connection Options", - "absenceImplications": null, - "implies": null - }, - { - "name": "jclcheck-options", - "aliases": [ - "jo" - ], - "description": "The desired set of JCLCheck runtime options. Specify the options exactly as you would on the PARM= or OPTIONS DD on a batch run of JCLCheck. See the JCLCheck runtime options documentation for details on available runtime options. If you specify options that change the format of the JCLCheck reports, you should request '--raw-output'. Changing the format of the report will affect the ability to produce a structured API response.", - "type": "stringOrEmpty", - "required": false, - "group": "JCLCheck Connection Options", - "absenceImplications": null, - "implies": null - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/update/jclx.jsonc b/profiles/update/jclx.jsonc deleted file mode 100644 index 20c9516..0000000 --- a/profiles/update/jclx.jsonc +++ /dev/null @@ -1,108 +0,0 @@ -// PID 5698-020 -// Copyright Teracloud ApS 2023 -{ - "name": "jclx-profile", - "aliases": [ - "jclx" - ], - "summary": "Update a jclx profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates.", - "description": "Configuration profile for the IBM Z JCL Expert Zowe CLI plugin.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "customize": { - "profileTypeIdentifier": "jclx" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new jclx profile. You can load this profile by using the name on commands that support the \"--jclx-profile\" option.", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "remote-home-dir", - "description": "The home directory of IBM Z JCL Expert in USS on your remote system. If this option is not set, the plug-in will rely on the PATH variable in the remote user environment.", - "type": "string", - "required": false, - "absenceImplications": null, - "implies": null, - "group": "Options", - "aliases": [] - }, - { - "name": "remote-temp-dir", - "description": "The directory where all temporary files are created and deleted by the IBM Z JCL Expert Zowe CLI plugin. Temporary files are cleaned up after each operation. Defaults to \"/tmp\" if not specified.", - "type": "string", - "required": false, - "absenceImplications": null, - "implies": null, - "group": "Options", - "aliases": [] - }, - { - "name": "language", - "description": "The language to be used by IBM Z JCL Expert when invoked. This option will be ignored if remoteHomeDir is not specified.", - "type": "string", - "allowableValues": { - "values": [ - "ENG", - "JPN" - ] - }, - "required": false, - "absenceImplications": null, - "implies": null, - "group": "Options", - "aliases": [] - }, - { - "name": "response-encoding", - "description": "The encoding to translate the remote response from. An empty string value or 'binary' will result in no encoding translation. Defaults to 'utf-8' if not provided.", - "type": "string", - "required": false, - "absenceImplications": null, - "implies": null, - "group": "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" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/update/mat.jsonc b/profiles/update/mat.jsonc deleted file mode 100644 index 4498cfd..0000000 --- a/profiles/update/mat.jsonc +++ /dev/null @@ -1,164 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "mat-profile", - "aliases": [ - "mat" - ], - "summary": "Update a mat profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates.", - "description": "MAT Analyze CLI profile schema.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "customize": { - "profileTypeIdentifier": "mat" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new mat profile. You can load this profile by using the name on commands that support the \"--mat-profile\" option.", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "protocol", - "aliases": [ - "o" - ], - "description": "Specifies the protocol defined for the MAT REST API server (http or https).", - "type": "string", - "allowableValues": { - "values": [ - "http", - "https" - ] - }, - "group": "MAT Profile Options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).", - "type": "string", - "group": "MAT Profile Options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "Specifies the server port (e.g. 8080).", - "type": "number", - "group": "MAT Profile Options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Your mainframe username.", - "type": "string", - "group": "MAT Profile Options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "password", - "aliases": [ - "pw" - ], - "description": "Your mainframe password.", - "type": "string", - "group": "MAT Profile Options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.", - "type": "string", - "group": "MAT Profile Options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "group": "MAT Profile Options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "listingDir", - "aliases": [ - "ldir" - ], - "description": "Specifies the directory where you want to store the registered program listings (e.g. 'c:\\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.", - "type": "string", - "required": false, - "group": "MAT Profile Options", - "absenceImplications": null, - "implies": null - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/update/omspool.jsonc b/profiles/update/omspool.jsonc deleted file mode 100644 index 175cfa8..0000000 --- a/profiles/update/omspool.jsonc +++ /dev/null @@ -1,160 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "omspool-profile", - "aliases": [ - "omspool" - ], - "summary": "Update a omspool profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates.", - "description": "Configuration profile for Spool, where you specify information about your Spool instance", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "customize": { - "profileTypeIdentifier": "omspool" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new omspool profile. You can load this profile by using the name on commands that support the \"--omspool-profile\" option.", - "type": "string", - "required": true - } - ], - "options": [ - { - "description": "z/OS TSO/E accounting information.", - "type": "string", - "name": "account", - "aliases": [ - "a" - ], - "required": false, - "group": "SPOOL OPTIONS", - "absenceImplications": null, - "implies": null - }, - { - "description": "High level qualifier of Spool installation.", - "type": "string", - "name": "spoolhlq", - "aliases": [ - "hlq" - ], - "stringLengthRange": [ - 1, - 35 - ], - "required": false, - "group": "SPOOL OPTIONS", - "absenceImplications": null, - "implies": null - }, - { - "description": "Spool subsystem name.", - "type": "string", - "name": "subsys", - "aliases": [ - "sub" - ], - "stringLengthRange": [ - 1, - 4 - ], - "group": "SPOOL OPTIONS", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "description": "The SYSTSPRT data set allocated by CAI.CBQ4JCL(BQ4JZOWE). It must be unique for each Zowe CLI user interacting with Spool.", - "type": "string", - "name": "outds", - "aliases": [ - "out" - ], - "stringLengthRange": [ - 1, - 44 - ], - "required": false, - "group": "SPOOL OPTIONS", - "absenceImplications": null, - "implies": null - }, - { - "description": "The data set containing ESFZOWE REXX exec.", - "type": "string", - "name": "clist", - "aliases": [ - "cl" - ], - "stringLengthRange": [ - 1, - 44 - ], - "required": false, - "group": "SPOOL OPTIONS", - "absenceImplications": null, - "implies": null - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "myProfile --account 3213213210", - "description": "Update the TSO account information to '3213213210' for Spool profile named 'myProfile'" - }, - { - "options": "myProfile --spoolhlq SPOOL.HLQ", - "description": "Update high level qualifier of the Spool installation to 'SPOOL.HLQ' for Spool profile named 'myProfile'" - }, - { - "options": "myProfile --subsys ESF2", - "description": "Update the Spool subsystem name to 'ESF2' for Spool profile named 'myProfile'" - }, - { - "options": "myProfile --outds OUTPUT.RESPONSE.DS.NEW", - "description": "Update the output response data set to 'OUTPUT.RESPONSE.DS.NEW' for Spool profile named 'myProfile'" - }, - { - "options": "myProfile --clist USER.CLIST", - "description": "Update the data set containing ESFZOWE REXX exec to 'USER.CLIST' for Spool profile named 'myProfile'" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/update/ops.jsonc b/profiles/update/ops.jsonc deleted file mode 100644 index 976c49e..0000000 --- a/profiles/update/ops.jsonc +++ /dev/null @@ -1,159 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "ops-profile", - "aliases": [ - "ops" - ], - "summary": "Update a ops profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates.", - "description": "The OPS Web Services session profile schema, where you specify your session information and credentials", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "customize": { - "profileTypeIdentifier": "ops" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new ops profile. You can load this profile by using the name on commands that support the \"--ops-profile\" option.", - "type": "string", - "required": true - } - ], - "options": [ - { - "description": "The hostname of the server where OPS Web Services is running.", - "type": "string", - "name": "host", - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS", - "absenceImplications": null, - "implies": null, - "aliases": [] - }, - { - "description": "The port number for OPS Web Services.", - "type": "number", - "name": "port", - "aliases": [ - "p" - ], - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS", - "absenceImplications": null, - "implies": null - }, - { - "description": "Your z/OS user name used to authenticate to OPS Web Services", - "type": "string", - "name": "user", - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS", - "absenceImplications": null, - "implies": null, - "aliases": [] - }, - { - "description": "Your z/OS password used to authenticate to OPS Web Services", - "type": "string", - "name": "password", - "aliases": [ - "pass" - ], - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS", - "absenceImplications": null, - "implies": null - }, - { - "description": "The protocol used for connecting to OPS Web Services", - "type": "string", - "name": "protocol", - "aliases": [ - "prot" - ], - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - }, - "required": false, - "group": "OPS WEB SERVICES CONNECTION OPTIONS", - "absenceImplications": null, - "implies": null - }, - { - "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" - ], - "group": "OPS WEB SERVICES CONNECTION OPTIONS", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "description": "Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.", - "type": "string", - "name": "subsystem", - "aliases": [ - "subs" - ], - "group": "OPS WEB SERVICES CONNECTION OPTIONS", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "myLPAR --host lpar456", - "description": "Update an OPS profile called 'myLPAR' to connect to OPS Web Services at host lpar456" - }, - { - "options": "myLPAR --user user101 --password Km5sv78", - "description": "Update an OPS profile called 'myLPAR' to have username user101 with password Km5sv78" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/update/pma.jsonc b/profiles/update/pma.jsonc deleted file mode 100644 index a970b81..0000000 --- a/profiles/update/pma.jsonc +++ /dev/null @@ -1,130 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "pma-profile", - "aliases": [ - "pma" - ], - "summary": "Update a pma profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates.", - "description": "MAT Detect CLI profile schema.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "customize": { - "profileTypeIdentifier": "pma" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new pma profile. You can load this profile by using the name on commands that support the \"--pma-profile\" option.", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "job_acct", - "aliases": [ - "ja" - ], - "description": "Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)", - "type": "string", - "required": false, - "group": "PMA Connection Options", - "absenceImplications": null, - "implies": null - }, - { - "name": "job_class", - "aliases": [ - "jc" - ], - "description": "Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9) ", - "type": "string", - "required": false, - "stringLengthRange": [ - 1, - 1 - ], - "group": "PMA Connection Options", - "absenceImplications": null, - "implies": null - }, - { - "name": "job_mclass", - "aliases": [ - "jmc" - ], - "description": "Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9) ", - "type": "string", - "required": false, - "stringLengthRange": [ - 1, - 1 - ], - "group": "PMA Connection Options", - "absenceImplications": null, - "implies": null - }, - { - "name": "job_load", - "aliases": [ - "jl" - ], - "description": "Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD) ", - "type": "string", - "required": false, - "group": "PMA Connection Options", - "absenceImplications": null, - "implies": null - }, - { - "name": "job_pmahlq", - "aliases": [ - "jph" - ], - "description": "Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data", - "type": "string", - "required": false, - "group": "PMA Connection Options", - "absenceImplications": null, - "implies": null - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/update/rse.jsonc b/profiles/update/rse.jsonc deleted file mode 100644 index e1746a2..0000000 --- a/profiles/update/rse.jsonc +++ /dev/null @@ -1,193 +0,0 @@ -// Copyright IBM Corporation 2020, 2024. All Rights Reserved. -{ - "name": "rse-profile", - "aliases": [ - "rse" - ], - "summary": "Update a rse profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates.", - "description": "A profile to issue commands to a z/OS system with a working Zowe REST server,Mediation Layer, or IBM RSE (Remote System Explorer) API server installation.", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "customize": { - "profileTypeIdentifier": "rse" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new rse profile. You can load this profile by using the name on commands that support the \"--rse-profile\" option.", - "type": "string", - "required": true - } - ], - "options": [ - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The z/OS host name running the Zowe REST API.", - "type": "string", - "group": "Zowe REST Connection Options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "The server port used by the REST API.", - "type": "number", - "group": "Zowe REST Connection Options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "The user name for the Zowe REST API operations.", - "type": "string", - "group": "Zowe REST Connection Options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "password", - "aliases": [ - "pass" - ], - "description": "The password of the user for the Zowe REST API operations.", - "type": "string", - "group": "Zowe REST Connection Options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates.", - "type": "boolean", - "group": "Zowe REST Connection Options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "base-path", - "aliases": [ - "bp" - ], - "description": "The base path of the API for the REST API operations.", - "type": "string", - "group": "Zowe REST Connection Options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "protocol", - "aliases": [ - "protocol" - ], - "description": "http or https, depending whether a TLS handshake is required to access REST API.", - "type": "string", - "group": "Zowe REST Connection Options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "encoding", - "aliases": [ - "ec" - ], - "description": "The encoding for download and upload of z/OS data set and USS files. The encoding should be specified in the form of \"IBM-1047\".", - "type": "string", - "group": "Zowe REST Connection Options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "tokenType", - "aliases": [ - "tt" - ], - "description": "JWT token type assigned to profile when \"zowe rse auth login\" is used for authentication.", - "type": "string", - "group": "Zowe REST Connection Options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "tokenValue", - "aliases": [ - "tv" - ], - "description": "JWT token value assigned to profile when \"zowe rse auth login\" is used for authentication.", - "type": "string", - "group": "Zowe REST Connection Options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "tokenExpiration", - "aliases": [ - "te" - ], - "description": "JWT token expiration assigned to profile when \"zowe rse auth login\" is used for authentication.", - "type": "number", - "group": "Zowe REST Connection Options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/update/sysview-format.jsonc b/profiles/update/sysview-format.jsonc deleted file mode 100644 index 648d482..0000000 --- a/profiles/update/sysview-format.jsonc +++ /dev/null @@ -1,145 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "sysview-format-profile", - "aliases": [ - "sysview-format" - ], - "summary": "Update a sysview-format profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates.", - "description": "The SYSVIEW format profile schema, where you specify display settings", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "customize": { - "profileTypeIdentifier": "sysview-format" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new sysview-format profile. You can load this profile by using the name on commands that support the \"--sysview-format-profile\" option.", - "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", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "overview", - "aliases": [ - "o" - ], - "description": "Display the overview section", - "type": "boolean", - "group": "display options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "info", - "aliases": [ - "i" - ], - "description": "Display the information area, if any", - "type": "boolean", - "group": "display options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "pretty", - "aliases": [ - "p" - ], - "description": "Display formatted data", - "type": "boolean", - "group": "display options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "blank-if-zero", - "aliases": [ - "biz", - "b" - ], - "description": "Show a blank space instead of '0' values", - "type": "boolean", - "group": "display options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "truncate", - "aliases": [ - "tr" - ], - "description": "Truncate displays that are too wide for the console", - "type": "boolean", - "group": "display options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "options": "myFormat --info false", - "description": "Update a SYSVIEW format profile called 'myFormat' to not display the information area." - }, - { - "options": "myFormat -p --biz false", - "description": "Update a SYSVIEW format profile called 'myFormat' to format data but not blank out '0's." - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/profiles/update/sysview.jsonc b/profiles/update/sysview.jsonc deleted file mode 100644 index 69b3ebb..0000000 --- a/profiles/update/sysview.jsonc +++ /dev/null @@ -1,155 +0,0 @@ -// Copyright (c) 2024 Broadcom. All Rights Reserved. The term -// "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. -{ - "name": "sysview-profile", - "aliases": [ - "sysview" - ], - "summary": "Update a sysview profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates.", - "description": "The SYSVIEW session profile schema, where you specify your session information and credentials", - "type": "command", - "handler": "", - "deprecatedReplacement": "The 'config set' command", - "customize": { - "profileTypeIdentifier": "sysview" - }, - "positionals": [ - { - "name": "profileName", - "description": "Specifies the name of the new sysview profile. You can load this profile by using the name on commands that support the \"--sysview-profile\" option.", - "type": "string", - "required": true - } - ], - "options": [ - { - "description": "The hostname of the SYSVIEW REST API", - "type": "string", - "name": "host", - "aliases": [ - "H" - ], - "group": "sysview connection options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "description": "The port number of the SYSVIEW REST API", - "type": "number", - "name": "port", - "aliases": [ - "P" - ], - "group": "sysview connection options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "description": "Your z/OS username used to authenticate to the SYSVIEW REST API", - "type": "string", - "name": "user", - "aliases": [ - "u" - ], - "group": "sysview connection options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "description": "Your z/OS password used to authenticate to the SYSVIEW REST API", - "type": "string", - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "group": "sysview connection options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "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", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "description": "SSID of the SYSVIEW instance. Default value: GSVX", - "type": "string", - "name": "ssid", - "group": "sysview connection options", - "required": false, - "absenceImplications": null, - "implies": null, - "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" - ], - "group": "sysview connection options", - "required": false, - "absenceImplications": null, - "implies": null - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "examples": [ - { - "description": "Update a SYSVIEW profile called 'myLPAR' to connect to SYSVIEW REST API at host lpar456", - "options": "myLPAR --host lpar456" - }, - { - "description": "Update a SYSVIEW profile called 'myLPAR' to have username user101 with password Km5sv78", - "options": "myLPAR --user user101 --password Km5sv78" - } - ], - "passOn": [], - "children": [] -} \ No newline at end of file diff --git a/scripts/merge.ts b/scripts/merge.ts index d7eed85..270fb37 100644 --- a/scripts/merge.ts +++ b/scripts/merge.ts @@ -17,12 +17,6 @@ import { jsonc as JSONC } from 'jsonc'; // Set up directories const zoweTreeFile = join(__dirname, "..", "commandTree.json"); const commandGroupsDirectory = join(__dirname, "..", "commandGroups"); - const profilesDirectory = join(__dirname, "..", "profiles"); - const profilesCreateDirectory = join(profilesDirectory, "create"); - const profilesDeleteDirectory = join(profilesDirectory, "delete"); - const profilesListDirectory = join(profilesDirectory, "list"); - const profilesSetDefaultDirectory = join(profilesDirectory, "set-default"); - const profilesUpdateDirectory = join(profilesDirectory, "update"); // Read the file const zoweTreeFileJSON = JSONC.parse(readFileSync(zoweTreeFile).toString()); @@ -47,100 +41,6 @@ import { jsonc as JSONC } from 'jsonc'; } } - // Add the missing profiles - for (const commandGroup of commandTree.children) { - if (commandGroup.name === "profiles") { - for (const child of commandGroup.children) { - if (child.name === "create") { - if (existsSync(profilesCreateDirectory)) { - const files = readdirSync(profilesCreateDirectory); - for (const file of files) { - const profile = JSONC.parse(readFileSync(join(profilesCreateDirectory, file)).toString()); - let conflict = false; - for (const compareProfile of child.children) { - if (profile.name === compareProfile.name) { conflict = true; } - } - if (!conflict) { - child.children.push(profile); - console.log("Profile " + profile.name + " was added to profiles create successfully."); - } else { - console.log("Profile " + profile.name + " was not added to profiles create due to a conflicting profile."); - } - } - } - } else if (child.name === "delete") { - if (existsSync(profilesDeleteDirectory)) { - const files = readdirSync(profilesDeleteDirectory); - for (const file of files) { - const profile = JSONC.parse(readFileSync(join(profilesDeleteDirectory, file)).toString()); - let conflict = false; - for (const compareProfile of child.children) { - if (profile.name === compareProfile.name) { conflict = true; } - } - if (!conflict) { - child.children.push(profile); - console.log("Profile " + profile.name + " was added to profiles delete successfully."); - } else { - console.log("Profile " + profile.name + " was not added to profiles delete due to a conflicting profile."); - } - } - } - } else if (child.name === "list") { - if (existsSync(profilesListDirectory)) { - const files = readdirSync(profilesListDirectory); - for (const file of files) { - const profile = JSONC.parse(readFileSync(join(profilesListDirectory, file)).toString()); - let conflict = false; - for (const compareProfile of child.children) { - if (profile.name === compareProfile.name) { conflict = true; } - } - if (!conflict) { - child.children.push(profile); - console.log("Profile " + profile.name + " was added to profiles list successfully."); - } else { - console.log("Profile " + profile.name + " was not added to profiles list due to a conflicting profile."); - } - } - } - } else if (child.name === "set-default") { - if (existsSync(profilesSetDefaultDirectory)) { - const files = readdirSync(profilesSetDefaultDirectory); - for (const file of files) { - const profile = JSONC.parse(readFileSync(join(profilesSetDefaultDirectory, file)).toString()); - let conflict = false; - for (const compareProfile of child.children) { - if (profile.name === compareProfile.name) { conflict = true; } - } - if (!conflict) { - child.children.push(profile); - console.log("Profile " + profile.name + " was added to profiles set-default successfully."); - } else { - console.log("Profile " + profile.name + " was not added to profiles set-default due to a conflicting profile."); - } - } - } - } else if (child.name === "update") { - if (existsSync(profilesUpdateDirectory)) { - const files = readdirSync(profilesUpdateDirectory); - for (const file of files) { - const profile = JSONC.parse(readFileSync(join(profilesUpdateDirectory, file)).toString()); - let conflict = false; - for (const compareProfile of child.children) { - if (profile.name === compareProfile.name) { conflict = true; } - } - if (!conflict) { - child.children.push(profile); - console.log("Profile " + profile.name + " was added to profiles update successfully."); - } else { - console.log("Profile " + profile.name + " was not added to profiles update due to a conflicting profile."); - } - } - } - } - } - } - } - // Write data back to file zoweTreeFileJSON.data = commandTree; const dataToWrite = JSONC.stringify(zoweTreeFileJSON, (key, value) => (key !== "handler") ? value : "", 2); diff --git a/scripts/trim.ts b/scripts/trim.ts index 8780ca8..a6bad9a 100644 --- a/scripts/trim.ts +++ b/scripts/trim.ts @@ -22,10 +22,7 @@ const wrap = require("word-wrap"); const zoweTreeFileJSON = JSONC.parse(readFileSync(zoweTreeFile).toString()); const commandTree = zoweTreeFileJSON.data; const commandGroups = zoweFileJSON.commandGroups; - const profiles = zoweFileJSON.profiles; - let commandGroupsFound = 0; - let profilesFound = 0; // Prepare to add copyrights to files let copyright: string; @@ -42,19 +39,7 @@ const wrap = require("word-wrap"); // Set up the directories, make sure they exist. const commandGroupsDirectory = join(__dirname, "..", "commandGroups"); - const profilesDirectory = join(__dirname, "..", "profiles"); - const profilesCreateDirectory = join(profilesDirectory, "create"); - const profilesDeleteDirectory = join(profilesDirectory, "delete"); - const profilesListDirectory = join(profilesDirectory, "list"); - const profilesSetDefaultDirectory = join(profilesDirectory, "set-default"); - const profilesUpdateDirectory = join(profilesDirectory, "update"); if (!existsSync(commandGroupsDirectory)) { mkdirSync(commandGroupsDirectory); } - if (!existsSync(profilesDirectory)) { mkdirSync(profilesDirectory); } - if (!existsSync(profilesCreateDirectory)) { mkdirSync(profilesCreateDirectory); } - if (!existsSync(profilesDeleteDirectory)) { mkdirSync(profilesDeleteDirectory); } - if (!existsSync(profilesListDirectory)) { mkdirSync(profilesListDirectory); } - if (!existsSync(profilesSetDefaultDirectory)) { mkdirSync(profilesSetDefaultDirectory); } - if (!existsSync(profilesUpdateDirectory)) { mkdirSync(profilesUpdateDirectory); } // Save the command groups for (const commandGroupSearching of commandGroups) { @@ -70,85 +55,8 @@ const wrap = require("word-wrap"); } } - // Save the profiles - const profileSuffix = "-profile"; - for (const profileSearching of profiles) { - let found = 0; - for (const commandGroup of commandTree.children) { - if (commandGroup.name === "profiles") { - // We found the profiles command group - find create, list, delete, set-default, update - for (const child of commandGroup.children) { - if (child.name === "create") { - // Profiles create - for (const profileType of child.children) { - if (profileType.name === profileSearching + profileSuffix) { - // We found the requested profile. Save it and break out of the inner loop. - const profilesCreateFilePath = join(profilesCreateDirectory, profileSearching + ".jsonc"); - commonWriteFileSync(profilesCreateFilePath, profileType, copyright); - console.log("Profile " + profileSearching + " was found and saved to: " + resolve(profilesCreateFilePath)); - found++; - break; - } - } - } else if (child.name === "delete") { - // Profiles delete - for (const profileType of child.children) { - if (profileType.name === profileSearching + profileSuffix) { - // We found the requested profile. Save it and break out of the inner loop. - const profilesDeleteFilePath = join(profilesDeleteDirectory, profileSearching + ".jsonc"); - commonWriteFileSync(profilesDeleteFilePath, profileType, copyright); - console.log("Profile " + profileSearching + " was found and saved to: " + resolve(profilesDeleteFilePath)); - found++; - break; - } - } - } else if (child.name === "list") { - // Profiles list - for (const profileType of child.children) { - if (profileType.name === profileSearching + profileSuffix + "s") { - // We found the requested profile. Save it and break out of the inner loop. - // Yes, we add s, and that is intended. - const profilesListFilePath = join(profilesListDirectory, profileSearching + ".jsonc"); - commonWriteFileSync(profilesListFilePath, profileType, copyright); - console.log("Profile " + profileSearching + " was found and saved to: " + resolve(profilesListFilePath)); - found++; - break; - } - } - } else if (child.name === "set-default") { - // Profiles set-default - for (const profileType of child.children) { - if (profileType.name === profileSearching + profileSuffix) { - // We found the requested profile. Save it and break out of the inner loop. - const profilesSetDefaultFilePath = join(profilesSetDefaultDirectory, profileSearching + ".jsonc"); - commonWriteFileSync(profilesSetDefaultFilePath, profileType, copyright); - console.log("Profile " + profileSearching + " was found and saved to: " + resolve(profilesSetDefaultFilePath)); - found++; - break; - } - } - } else if (child.name === "update") { - // Profiles update - for (const profileType of child.children) { - if (profileType.name === profileSearching + profileSuffix) { - // We found the requested profile. Save it and break out of the inner loop. - const profilesUpdateFilePath = join(profilesUpdateDirectory, profileSearching + ".jsonc"); - commonWriteFileSync(profilesUpdateFilePath, profileType, copyright); - console.log("Profile " + profileSearching + " was found and saved to: " + resolve(profilesUpdateFilePath)); - found++; - break; - } - } - } - } - } - } - if (found === 5) { profilesFound++; } - } - console.log("Script completed."); if (commandGroupsFound !== commandGroups.length) { console.log("Not all requested command groups were found. Please review script output."); } - if (profilesFound !== profiles.length) { console.log("Not all requested profile commands were found. Please review script output."); } })().catch((error) => { console.log(error); process.exit(1); diff --git a/zowe.template.json b/zowe.template.json index edbfc1d..4bd6eca 100644 --- a/zowe.template.json +++ b/zowe.template.json @@ -1,4 +1,3 @@ { - "commandGroups": [""], - "profiles": [""] + "commandGroups": [""] } \ No newline at end of file