diff --git a/commandGroups/ca7.jsonc b/commandGroups/ca7.jsonc new file mode 100644 index 0000000..6ccce35 --- /dev/null +++ b/commandGroups/ca7.jsonc @@ -0,0 +1,22929 @@ +// Copyright (c) 2022 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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, + { + "name": "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, + { + "name": "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, + { + "name": "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, + { + "name": "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, + { + "name": "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, + { + "name": "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, + { + "name": "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, + { + "name": "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, + { + "name": "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, + { + "name": "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, + { + "name": "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, + { + "name": "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, + { + "name": "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, + { + "name": "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, + { + "name": "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + } + ], + "summary": "CA7 Plugin for ZOWE CLI", + "aliases": [ + "7" + ], + "options": [ + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [], + "passOn": [] +} \ No newline at end of file diff --git a/commandGroups/file-master-plus.jsonc b/commandGroups/file-master-plus.jsonc new file mode 100644 index 0000000..fba64b7 --- /dev/null +++ b/commandGroups/file-master-plus.jsonc @@ -0,0 +1,6636 @@ +// Copyright (c) 2022 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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, + { + "name": "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, + { + "name": "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, + { + "name": "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, + { + "name": "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + } + ], + "summary": "Advanced file management and data manipulation", + "aliases": [ + "fmp" + ], + "options": [ + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [], + "passOn": [] +} \ No newline at end of file diff --git a/commandGroups/mat-pma-util.jsonc b/commandGroups/mat-pma-util.jsonc new file mode 100644 index 0000000..c73831c --- /dev/null +++ b/commandGroups/mat-pma-util.jsonc @@ -0,0 +1,2398 @@ +// Copyright (c) 2022 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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [], + "passOn": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [], + "passOn": [] + } + ], + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [], + "passOn": [] +} \ No newline at end of file diff --git a/commandGroups/mat.jsonc b/commandGroups/mat.jsonc new file mode 100644 index 0000000..0492d52 --- /dev/null +++ b/commandGroups/mat.jsonc @@ -0,0 +1,3697 @@ +// Copyright (c) 2022 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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": [ + "cm" + ], + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [], + "passOn": [] + }, + { + "name": "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [], + "passOn": [] + }, + { + "name": "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [], + "passOn": [] + } + ], + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [] + } + ], + "summary": "Manage monitor profiles and analyze the measurement data using MAT", + "aliases": [ + "mat" + ], + "options": [ + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [], + "passOn": [] +} \ No newline at end of file diff --git a/commandGroups/ops.jsonc b/commandGroups/ops.jsonc new file mode 100644 index 0000000..c8fe802 --- /dev/null +++ b/commandGroups/ops.jsonc @@ -0,0 +1,1965 @@ +// Copyright (c) 2022 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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "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", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [] + } + ], + "summary": "Zowe CLI Plug-in for OPS/MVS®", + "options": [ + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [], + "passOn": [] +} \ No newline at end of file diff --git a/profiles/create/ca7.jsonc b/profiles/create/ca7.jsonc new file mode 100644 index 0000000..80b09d7 --- /dev/null +++ b/profiles/create/ca7.jsonc @@ -0,0 +1,157 @@ +// Copyright (c) 2022 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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "passOn": [], + "children": [] +} \ No newline at end of file diff --git a/profiles/create/fmp.jsonc b/profiles/create/fmp.jsonc new file mode 100644 index 0000000..3412e52 --- /dev/null +++ b/profiles/create/fmp.jsonc @@ -0,0 +1,174 @@ +// Copyright (c) 2022 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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "examples": [ + { + "options": "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/mat.jsonc b/profiles/create/mat.jsonc new file mode 100644 index 0000000..9ce7743 --- /dev/null +++ b/profiles/create/mat.jsonc @@ -0,0 +1,171 @@ +// Copyright (c) 2022 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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "examples": [ + { + "options": "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/ops.jsonc b/profiles/create/ops.jsonc new file mode 100644 index 0000000..b0d898a --- /dev/null +++ b/profiles/create/ops.jsonc @@ -0,0 +1,159 @@ +// Copyright (c) 2022 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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "examples": [ + { + "options": "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 new file mode 100644 index 0000000..b269f27 --- /dev/null +++ b/profiles/create/pma.jsonc @@ -0,0 +1,145 @@ +// Copyright (c) 2022 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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "examples": [ + { + "options": "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/delete/ca7.jsonc b/profiles/delete/ca7.jsonc new file mode 100644 index 0000000..d7a0d97 --- /dev/null +++ b/profiles/delete/ca7.jsonc @@ -0,0 +1,76 @@ +// Copyright (c) 2022 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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [ + { + "name": "profileName", + "description": "Specifies the name of the 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/fmp.jsonc b/profiles/delete/fmp.jsonc new file mode 100644 index 0000000..4553cc8 --- /dev/null +++ b/profiles/delete/fmp.jsonc @@ -0,0 +1,76 @@ +// Copyright (c) 2022 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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [ + { + "name": "profileName", + "description": "Specifies the name of the 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/mat.jsonc b/profiles/delete/mat.jsonc new file mode 100644 index 0000000..4da6a6c --- /dev/null +++ b/profiles/delete/mat.jsonc @@ -0,0 +1,76 @@ +// Copyright (c) 2022 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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [ + { + "name": "profileName", + "description": "Specifies the name of the 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/ops.jsonc b/profiles/delete/ops.jsonc new file mode 100644 index 0000000..6b1f0b7 --- /dev/null +++ b/profiles/delete/ops.jsonc @@ -0,0 +1,76 @@ +// Copyright (c) 2022 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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [ + { + "name": "profileName", + "description": "Specifies the name of the 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 new file mode 100644 index 0000000..a92df88 --- /dev/null +++ b/profiles/delete/pma.jsonc @@ -0,0 +1,76 @@ +// Copyright (c) 2022 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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [ + { + "name": "profileName", + "description": "Specifies the name of the 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/list/ca7.jsonc b/profiles/list/ca7.jsonc new file mode 100644 index 0000000..4539532 --- /dev/null +++ b/profiles/list/ca7.jsonc @@ -0,0 +1,75 @@ +// Copyright (c) 2022 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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "examples": [ + { + "options": "", + "description": "List profiles of type 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/fmp.jsonc b/profiles/list/fmp.jsonc new file mode 100644 index 0000000..ffd5ac8 --- /dev/null +++ b/profiles/list/fmp.jsonc @@ -0,0 +1,75 @@ +// Copyright (c) 2022 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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "examples": [ + { + "options": "", + "description": "List profiles of type 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/mat.jsonc b/profiles/list/mat.jsonc new file mode 100644 index 0000000..9769c8d --- /dev/null +++ b/profiles/list/mat.jsonc @@ -0,0 +1,75 @@ +// Copyright (c) 2022 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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "examples": [ + { + "options": "", + "description": "List profiles of type 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/ops.jsonc b/profiles/list/ops.jsonc new file mode 100644 index 0000000..814f518 --- /dev/null +++ b/profiles/list/ops.jsonc @@ -0,0 +1,75 @@ +// Copyright (c) 2022 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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "examples": [ + { + "options": "", + "description": "List profiles of type 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 new file mode 100644 index 0000000..b11ddd3 --- /dev/null +++ b/profiles/list/pma.jsonc @@ -0,0 +1,75 @@ +// Copyright (c) 2022 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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "examples": [ + { + "options": "", + "description": "List profiles of type 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/set-default/ca7.jsonc b/profiles/set-default/ca7.jsonc new file mode 100644 index 0000000..371569a --- /dev/null +++ b/profiles/set-default/ca7.jsonc @@ -0,0 +1,68 @@ +// Copyright (c) 2022 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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [ + { + "name": "profileName", + "description": "Specify a\n profile for default usage within the 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/fmp.jsonc b/profiles/set-default/fmp.jsonc new file mode 100644 index 0000000..f8b477c --- /dev/null +++ b/profiles/set-default/fmp.jsonc @@ -0,0 +1,68 @@ +// Copyright (c) 2022 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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [ + { + "name": "profileName", + "description": "Specify a\n profile for default usage within the 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/mat.jsonc b/profiles/set-default/mat.jsonc new file mode 100644 index 0000000..d0abe81 --- /dev/null +++ b/profiles/set-default/mat.jsonc @@ -0,0 +1,68 @@ +// Copyright (c) 2022 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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [ + { + "name": "profileName", + "description": "Specify a\n profile for default usage within the 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/ops.jsonc b/profiles/set-default/ops.jsonc new file mode 100644 index 0000000..df8a14a --- /dev/null +++ b/profiles/set-default/ops.jsonc @@ -0,0 +1,68 @@ +// Copyright (c) 2022 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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [ + { + "name": "profileName", + "description": "Specify a\n profile for default usage within the 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 new file mode 100644 index 0000000..103128f --- /dev/null +++ b/profiles/set-default/pma.jsonc @@ -0,0 +1,68 @@ +// Copyright (c) 2022 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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [ + { + "name": "profileName", + "description": "Specify a\n profile for default usage within the 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/update/ca7.jsonc b/profiles/update/ca7.jsonc new file mode 100644 index 0000000..b9537d5 --- /dev/null +++ b/profiles/update/ca7.jsonc @@ -0,0 +1,154 @@ +// Copyright (c) 2022 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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "passOn": [], + "children": [] +} \ No newline at end of file diff --git a/profiles/update/fmp.jsonc b/profiles/update/fmp.jsonc new file mode 100644 index 0000000..91695d8 --- /dev/null +++ b/profiles/update/fmp.jsonc @@ -0,0 +1,154 @@ +// Copyright (c) 2022 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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "passOn": [], + "children": [] +} \ No newline at end of file diff --git a/profiles/update/mat.jsonc b/profiles/update/mat.jsonc new file mode 100644 index 0000000..25e5421 --- /dev/null +++ b/profiles/update/mat.jsonc @@ -0,0 +1,164 @@ +// Copyright (c) 2022 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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "passOn": [], + "children": [] +} \ No newline at end of file diff --git a/profiles/update/ops.jsonc b/profiles/update/ops.jsonc new file mode 100644 index 0000000..a3bcf25 --- /dev/null +++ b/profiles/update/ops.jsonc @@ -0,0 +1,159 @@ +// Copyright (c) 2022 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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "examples": [ + { + "options": "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 new file mode 100644 index 0000000..932012a --- /dev/null +++ b/profiles/update/pma.jsonc @@ -0,0 +1,130 @@ +// Copyright (c) 2022 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": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-examples", + "group": "Global options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "passOn": [], + "children": [] +} \ No newline at end of file