@broadcom/ca7-for-zowe-cli/lib/cli/commands/items/PostRequeue.definition.js

CA 7 Workload Automation Plug-in for Zowe CLI

"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.PostRequeueDefinition = void 0;
exports.PostRequeueDefinition = {
    name: "requeue",
    aliases: ["req"],
    summary: "Issue REQUEUE command for CA 7 instance specified in path",
    description: "The REQUEUE top line command moves jobs from the ready or active queues back to the request queue.\n" +
        "This command allows the use of the CA Workload Automation CA 7 Edition job restart facilities\n" +
        "after certain JCL, CPU, or node/agent failures, or job cancellation out of a CPU through the OS console.\n" +
        "This function is available as the Q option in the QM.1 CPU Jobs Status Prompt panel.",
    examples: [
        {
            options: "--ca7Id Instance1",
            description: "Requeue the top line command on Instance1"
        }
    ],
    type: "command",
    handler: __dirname + "/PostRequeue.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: "agent",
            description: "(Optional) Indicates the agent name or mask that an agent name must match for an agent job" +
                "\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:" +
                "\n1 to 16 alphanumeric charactersDefault:" +
                "\n* (all agent names)",
            type: "string",
            required: false
        },
        {
            name: "cpu",
            description: "(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",
            required: false
        },
        {
            name: "force",
            description: "(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" +
                "\n can 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:" +
                "\nCMP is the only value",
            type: "string",
            required: false
        },
        {
            name: "ca7#",
            description: "(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",
            required: false
        },
        {
            name: "jobname",
            aliases: ["jn"],
            description: "(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",
            required: false
        },
        {
            name: "longjobname",
            aliases: ["lon"],
            description: "(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:" +
                "\n1 to 64 alphanumeric characters",
            type: "string",
            required: false
        },
        {
            name: "mainid",
            description: "(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:    ALL   Indicates that all MAINIDs are considered.     SYn    Where n indicates a CPU assigned number as defined in the initialization file CPU statement." +
                "\n    The value of n can range from 1 to 7.    /SYn" +
                "\nWhere n indicates a CPU assigned number. The / indicates \"not this MAINID.\"" +
                "\nThe value of n can range from 1 to 7.Limits:" +
                "\n1 to 4 alphanumeric characters",
            type: "string",
            required: false
        },
        {
            name: "node",
            description: "(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",
            required: false
        },
        {
            name: "q",
            description: "(Optional) Used with JOB to indicate in which queue the job search is to occur. Possible values: ACT" +
                "\n    The active queue.RDY" +
                "\n    The ready queue",
            type: "string",
            required: false
        },
        {
            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." +
                "\n",
            type: "string",
            required: false
        }
    ]
};
//# sourceMappingURL=PostRequeue.definition.js.map