@broadcom/ca7-for-zowe-cli
Version:
CA 7 Workload Automation Plug-in for Zowe CLI
232 lines • 12.7 kB
JavaScript
"use strict";
/*
* Copyright (c) 2025 Broadcom. All Rights Reserved. The term
* "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
*
* This software and all information contained therein is
* confidential and proprietary and shall not be duplicated,
* used, disclosed, or disseminated in any way except as
* authorized by the applicable license agreement, without the
* express written permission of Broadcom. All authorized
* reproductions must be marked with this language.
*
* EXCEPT AS SET FORTH IN THE APPLICABLE LICENSE AGREEMENT, TO
* THE EXTENT PERMITTED BY APPLICABLE LAW, BROADCOM PROVIDES THIS
* SOFTWARE WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT
* LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR
* FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT WILL BROADCOM
* BE LIABLE TO THE END USER OR ANY THIRD PARTY FOR ANY LOSS OR
* DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS SOFTWARE,
* INCLUDING WITHOUT LIMITATION, LOST PROFITS, BUSINESS
* INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF BROADCOM IS
* EXPRESSLY ADVISED OF SUCH LOSS OR DAMAGE.
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.PostRestartDefinition = void 0;
exports.PostRestartDefinition = {
name: "restart",
aliases: ["ret"],
summary: "Issue RESTART command for CA 7 instance specified in path",
description: "The RESTART top line command restarts a job awaiting restart in the request queue.\n" +
"This function is available as the F option on the QM.1 CPU Jobs Status Prompt panel.\n" +
"You can also use QM.4 CPU Job in the Restart Status Prompt panel to accomplish a job restart.\n" +
"If CA Workload Automation Restart Option for z/OS Schedulers is used, the CMT is updated with the appropriate restart data.\n" +
"If CA Workload Automation Restart Option for z/OS Schedulers is not installed,\n" +
"the starting and ending steps, USAGE, PROCESS, CONDCD, or SUP11STP have no significance.\n" +
"\n" +
"The cross-platform jobs never use CA Workload Automation Restart Option for z/OS Schedulers services for restart functions.",
examples: [
{
options: "--ca7# AJOB* --ca7Id Instance1",
description: "Restarts a job awaiting restart in the request queue for jobs AJOB* on instance1"
}
],
type: "command",
handler: __dirname + "/PostRestart.handler",
profile: {
optional: ["ca7"]
},
options: [
{
name: "ca7Id",
description: "CA7ONL Instance",
type: "string",
required: true
},
{
name: "key",
description: "The command transaction key",
type: "string",
required: false
},
{
name: "ca7#",
description: "Indicates the individual job to restart, and the value must be a CA 7 job number." +
"\n ",
type: "string",
required: false
},
{
name: "bypgdg",
description: "(Optional) Indicates whether CA Workload Automation Restart_XXX Option for z/OS Schedulers bypasses GDG logic on a restart/rerun." +
"\n Value can be NO, YES, VER, or CAT." +
"\nDefault: CA Workload Automation Restart_XXX Option for z/OS Schedulers default value",
type: "string",
required: false
},
{
name: "condcd",
description: "(Optional) Indicates an optional CA Workload Automation Restart_XXX Option for z/OS Schedulers condition code" +
"\n that the CA Workload Automation Restart_XXX Option for z/OS Schedulers step sets when the rerun is executed." +
"\nThis option is honored only if CA Workload Automation Restart_XXX 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." +
"\nLimits:" +
"\n 1 to 4 numeric characters from 0 to 4095",
type: "string",
required: false
},
{
name: "forcecomp",
description: "(Optional) Indicates whether to flag the job as a normal completion." +
"\nIf FORCECOMP=YES, the previous abnormal status of the job is ignored." +
"\nNormal job completion processing is performed instead of a restart." +
"\nValue can be NO or YES. NO is the default.",
type: "string",
required: false
},
{
name: "lcc",
description: "(Optional) Indicates an optional condition code value that replaces the last condition code value for the step that the LSTP references and," +
"\noptionally, LPSTP keywords." +
"\nThis option is honored only if CA Workload Automation Restart_XXX Option for z/OS Schedulers is in use." +
"\nDefault: 0" +
"\nLimits:" +
"\n 1 to 4 numeric characters from 0 to 4095",
type: "string",
required: false
},
{
name: "lstp",
description: "(Optional) Indicates an optional step name that has its last condition code value reset in the " +
"\nCA Workload Automation Restart_XXX Option for z/OS Schedulers CMT." +
"\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." +
"\nThis option is honored only when CA Workload Automation Restart_XXX Option for z/OS Schedulers is in use." +
"\nLimits:" +
"\n 1 to 8 alphanumeric characters",
type: "string",
required: false
},
{
name: "lpstp",
description: "(Optional) Indicates an optional step name referencing a procedure that has its last condition code value reset" +
"\nin the CA Workload Automation Restart_XXX Option for z/OS Schedulers CMT." +
"\nIf LPSTP is used, also code LSTP and LCC." +
"\nThis option is honored only if CA Workload Automation Restart_XXX Option for z/OS Schedulers is in use." +
"\nLimits:" +
"\n 1 to 8 alphanumeric characters",
type: "string",
required: false
},
{
name: "procstrt",
description: "(Optional) Indicates an optional step name referencing a procedure where processing is to start." +
"\nIf PROCESS=R and PROCSTRT are used, also code STPSTRT." +
"\nThis option is honored only if CA Workload Automation Restart_XXX Option for z/OS Schedulers is in use." +
"\nLimits:" +
"\n 1 to 8 alphanumeric characters",
type: "string",
required: false
},
{
name: "procend",
description: "(Optional) Indicates an optional step name referencing a procedure where processing is to end." +
"\nIf PROCESS=R and PROCEND are used, code STPEND." +
"\nThis option is honored only if CA Workload Automation Restart_XXX Option for z/OS Schedulers is in use." +
"\nLimits:" +
"\n 1 to 8 alphanumeric characters",
type: "string",
required: false
},
{
name: "process",
description: "(Optional) Indicates an optional CA Workload Automation Restart_XXX Option for z/OS Schedulers processing function code character to use in the restart/rerun." +
"\nThis option is honored only if CA Workload Automation Restart_XXX Option for z/OS Schedulers is in use" +
"\nand CA WA CA 7 Edition is inserting the RMS step." +
"\nSee the INSERT-RMS field on the DB.1 panel. Value can be F, P, S, N, O, or R." +
"\nDefault: P" +
"\nLimits:" +
"\n 1 alphabetic character",
type: "string",
required: false
},
{
name: "reason",
description: "(Optional) Specifies a reason for the restart." +
"\nIf the CA Workload Automation Restart_XXX 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." +
"\nAny reason input or expanded is copied to the run log." +
"\nThis field is optional unless CA Workload Automation Restart_XXX Option for z/OS Schedulers requires a reason or" +
"\nREASON=YES was specified in the RESTART statement in the initialization file." +
"\nLimits:" +
"\n 1 to 40 alphanumeric characters",
type: "string",
required: false
},
{
name: "stpend",
description: "(Optional) Indicates an optional step name or number at which processing is to end." +
"\nf not specified, the last step of the job is assumed to be the ending step." +
"\nCode STPEND when PROCEND is specified." +
"\nThis option is honored only if CA Workload Automation Restart_XXX Option for z/OS Schedulers is in use." +
"\nLimits:" +
"\n 1 to 8 alphanumeric characters",
type: "string",
required: false
},
{
name: "stpstrt",
description: "(Optional) Indicates 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." +
"\nCode STPSTRT when PROCSTRT is specified. This option is honored only if CA Workload Automation Restart_XXX Option for z/OS Schedulers is in use." +
"\nIt can be one of stepname" +
"\n Specifies the step name or number at which processing is to start. *CMT*" +
"\n Indicates that the job is to restart with the step values currently on the CMT record. *RERUN*" +
"\n Indicates to rerun t the total job. If there are no restartable steps, specify *RERUN*. *RESUBP*" +
"\n Indicates that the CMT record of the job is set to production, and then the job is submitted.",
type: "string",
required: false
},
{
name: "sup11stp",
description: "(Optional) Indicates whether to suppress the insertion of the CA Workload Automation Restart_XXX Option for z/OS Schedulers RMS step." +
"\nIf the job is resubmitted with SUP11STP=YES, the CA Workload Automation Restart_XXX Option for z/OS Schedulers step is not inserted." +
"\nOnly valid if CA WA CA 7 Edition is inserting the CA Workload Automation Restart_XXX Option for z/OS Schedulers step." +
"\nSee the INSERT-RMS field on the DB.1 panel." +
"\nValue can be NO or YES. NO is the default.",
type: "string",
required: false
},
{
name: "usage",
description: "(Optional) Indicates an optional CA Workload Automation Restart_XXX Option for z/OS Schedulers usage code of the character to use in the restart/rerun." +
"\nFor the values, see the CA Workload Automation Restart_XXX Option for z/OS Schedulers documentation." +
"\nThis option is honored only if CA Workload Automation Restart_XXX Option for z/OS Schedulers is in use and" +
"\nCA WA CA 7 Edition is inserting the RMS step." +
"\nSee the INSERT-RMS field on the DB.1 panel." +
"\nLimits:" +
"\n 1 alphanumeric character",
type: "string",
required: false
},
{
name: "ca11rstp",
description: "(Optional) Indicates that the RESTART command should return the job jobstep.procstep information from the CA Workload Automation Restart_XXX Option for z/OS Schedulers (CA-11) database (if available) in a SRJ2-55 message." +
"\nYES or Y are the only valid values. If YES or Y is specified, no other keywords are allowed, and no attempt is made to restart the job.",
type: "string",
required: false
}
]
};
//# sourceMappingURL=PostRestart.definition.js.map