@broadcom/ca7-for-zowe-cli/lib/cli/commands/cmds/Restart.definition.js

CA 7 Workload Automation Plug-in for Zowe CLI

"use strict";
/*
* Copyright © 202X Broadcom Inc. and/or its subsidiaries
* © 202X Broadcom Inc and/or its subsidiaries; All rights reserved
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.RestartDefinition = void 0;
exports.RestartDefinition = {
    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: __dirname + "/Restart.handler",
    profile: {
        optional: ["ca7"]
    },
    options: [
        {
            name: "ca7num",
            description: "ca7num=0016\n\n" +
                "Defines the name of the job to Restart.\n" +
                "Indicates the individual job to Restart, and the value must be a CA 7 job number.",
            type: "string",
            required: true
        },
        {
            name: "bypgdg",
            aliases: ["bp"],
            description: "bypgdg={NO|YES|VER|CAT}\n\n" +
                "Indicates whether CA Workload Automation Restart Option for z/OS Schedulers bypasses GDG logic on a restart/rerun.\n" +
                "Value can be NO, YES, VER, or CAT.\n\n" +
                "Default: CA Workload Automation Restart Option for z/OS Schedulers default value",
            type: "string"
        },
        {
            name: "condcd",
            aliases: ["cc"],
            description: "condcd=nnnn\n\n" +
                "Indicates an optional CA Workload Automation Restart Option for z/OS Schedulers condition code\n" +
                "that the CA Workload Automation Restart Option for z/OS Schedulers step sets when the rerun is executed.\n\n" +
                "This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use\n" +
                "and CA Workload Automation CA 7® Edition is inserting the RMS step.\n" +
                "See the INSERT-RMS field on the DB.1 panel.\n\n" +
                "Limits: 1 to 4 numeric characters from 0 to 4095",
            type: "string"
        },
        {
            name: "forcecomp",
            aliases: ["fc"],
            description: "forcecomp={NO|YES}\n\n" +
                "Indicates whether to flag the job as a normal completion.\n" +
                "If FORCECOMP=YES, the previous abnormal status of the job is ignored.\n\n" +
                "Normal job completion processing is performed instead of a restart.\n" +
                "Value can be NO or YES. NO is the default.",
            type: "string"
        },
        {
            name: "lcc",
            description: "lc=nnnn\n\n" +
                "Indicates an optional condition code value that replaces the last \n" +
                "condition code value for the step that the LSTP references and, optionally, LPSTP keywords.\n\n" +
                "This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.\n\n" +
                "Default: 0\n" +
                "Limits: 1 to 4 numeric characters from 0 to 4095",
            type: "string"
        },
        {
            name: "lstp",
            description: "lstp=JS050\n\n" +
                "Indicates an optional step name that has its last condition code value reset in the\n" +
                "CA Workload Automation Restart Option for z/OS Schedulers CMT.\n\n" +
                "Code LSTP and LCC when LPSTP is specified.\n" +
                "LSTP 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\n" +
                "This option is honored only when CA Workload Automation Restart Option for z/OS Schedulers is in use.\n\n" +
                "Limits: 1 to 8 alphanumeric characters",
            type: "string"
        },
        {
            name: "lpstp",
            description: "lpstp=COPY010\n\n" +
                "Indicates an optional step name referencing a procedure that has its last condition code value reset\n" +
                "in the CA Workload Automation Restart Option for z/OS Schedulers CMT.\n\n" +
                "If LPSTP is used, also code LSTP and LCC.\n" +
                "This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.\n\n" +
                "Limits: 1 to 8 alphanumeric characters",
            type: "string"
        },
        {
            name: "procstrt",
            aliases: ["ps"],
            description: "procstrt=procname\n\n" +
                "Indicates an optional step name referencing a procedure where processing is to start.\n" +
                "If PROCESS=R and PROCSTRT are used, also code STPSTRT.\n\n" +
                "This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.\n\n" +
                "Limits: 1 to 8 alphanumeric characters",
            type: "string"
        },
        {
            name: "procend",
            aliases: ["pe"],
            description: "procend=procname\n\n" +
                "Indicates an optional step name referencing a procedure where processing is to end.\n\n " +
                "If PROCESS=R and PROCEND are used, code STPEND.\n" +
                "This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.\n\n" +
                "Limits: 1 to 8 alphanumeric characters",
            type: "string"
        },
        {
            name: "process",
            description: "process=code\n\n" +
                "Indicates an optional CA Workload Automation Restart Option for z/OS Schedulers processing function code character to use in the restart/rerun.\n\n" +
                "This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use\n" +
                "and CA WA CA 7 Edition is inserting the RMS step.\n\n" +
                "See the INSERT-RMS field on the DB.1 panel. Value can be F, P, S, N, O, or R.\n\n" +
                "Default: P\n" +
                "Limits: 1 alphabetic character",
            type: "string"
        },
        {
            name: "reason",
            aliases: ["r"],
            description: "reason=text\n\n" +
                "Specifies a reason for the restart.\n" +
                "If the CA Workload Automation Restart Option for z/OS Schedulers Reason-for-Rerun module is available,\n" +
                "a code of up to four characters can be input and it is expanded.\n\n" +
                "Any reason input or expanded is copied to the run log.\n\n" +
                "This field is optional unless CA Workload Automation Restart Option for z/OS Schedulers requires a reason or\n" +
                "REASON=YES was specified in the RESTART statement in the initialization file.\n\n" +
                "Limits: 1 to 40 alphanumeric characters",
            type: "string"
        },
        {
            name: "stpend",
            aliases: ["se"],
            description: "stpend=stepname\n\n" +
                "Indicates an optional step name or number at which processing is to end.\n" +
                "If not specified, the last step of the job is assumed to be the ending step.\n\n" +
                "Code STPEND when PROCEND is specified.\n" +
                "This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.\n\n" +
                "Limits: 1 to 8 alphanumeric characters",
            type: "string"
        },
        {
            name: "stpstrt",
            aliases: ["ss"],
            description: "stpstrt={stepname|*CMT*|*RERUN*|*RESUBP*}\n\n" +
                "Indicates an optional step name or number at which processing is to start.\n" +
                "If STPSTRT is not coded, the first step of the job is assigned to be the starting step.\n\n" +
                "Code STPSTRT when PROCSTRT is specified. This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.\n" +
                "It can be one of\n\n" +
                "stepname\n" +
                "Specifies the step name or number at which processing is to start.\n\n" +
                "*CMT*\n" +
                "Indicates that the job is to restart with the step values currently on the CMT record.\n\n" +
                "*RERUN*\n" +
                "Indicates to rerun t the total job. If there are no restartable steps, specify RERUN.\n\n" +
                "*RESUBP*\n" +
                "Indicates that the CMT record of the job is set to production, and then the job is submitted.",
            type: "string"
        },
        {
            name: "sup11stp",
            aliases: ["su"],
            description: "sup11stp={NO|YES}\n\n" +
                "Indicates whether to suppress the insertion of the CA Workload Automation Restart Option for z/OS Schedulers RMS step.\n\n" +
                "If the job is resubmitted with SUP11STP=YES, the CA Workload Automation Restart Option for z/OS Schedulers step is not inserted.\n\n" +
                "Only valid if CA WA CA 7 Edition is inserting the CA Workload Automation Restart Option for z/OS Schedulers step.\n\n" +
                "See the INSERT-RMS field on the DB.1 panel.\n" +
                "Value can be NO or YES. NO is the default.",
            type: "string"
        },
        {
            name: "usage",
            description: "usage=code\n\n" +
                "Indicates an optional CA Workload Automation Restart Option for z/OS Schedulers\n" +
                "usage code of the character to use in the restart/rerun.\n\n" +
                "For the values, see the CA Workload Automation Restart Option for z/OS Schedulers documentation.\n\n" +
                "This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use and\n" +
                "CA WA CA 7 Edition is inserting the RMS step.\n\n" +
                "See the INSERT-RMS field on the DB.1 panel.\n" +
                "Limits: 1 alphanumeric character",
            type: "string"
        },
        {
            name: "ca11rstp",
            aliases: ["c"],
            description: "ca11rstp={Y|YES}\n\n" +
                "Displays the CA11 restart step. Value can be Y or YES.",
            type: "string"
        }
    ]
};
//# sourceMappingURL=Restart.definition.js.map