@broadcom/ca7-for-zowe-cli/lib/cli/commands/cmds/Requeue.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.RequeueDefinition = void 0;
exports.RequeueDefinition = {
    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: __dirname + "/Requeue.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\n" +
                "before it is moved back to the request queue, is given a restart requirement, and is flagged as having been requeued.\n" +
                "AGENT cannot be used with CPU, MAINID, or NODE.\n" +
                "For any agent job that is requeued, a cancel request is sent to the agent running the job.\n" +
                "The status of the agent or the computer on which the agent is running determines whether the request is honored.\n" +
                "Limits: 1 to 16 alphanumeric charactersDefault: * (all agent names)",
            type: "string"
        },
        {
            name: "cpu",
            description: "example: 34\n" +
                "(Optional) Used with JOB to specify the CPU ID of active queue jobs that are to be requeued.\n" +
                "The value identifies the CPU and corresponds to the CPU field displayed on the LQ command (the SMF identifier).\n" +
                "CPU cannot be used with MAINID, NODE, or AGENT.\n" +
                "The 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.\n" +
                "Limits:\n" +
                "1 to 4 numeric characters",
            type: "string"
        },
        {
            name: "force",
            description: "example: CMP\n" +
                "(Optional) Resumes job completion for stranded jobs.\n" +
                "When 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.\n" +
                "But, if a job cannot be moved because of an I/O error or an out-of-space condition on the request queue,\n" +
                "the job may be stranded in the ready or active queue, unable to complete\n" +
                "Once the request queue error is corrected, you can use REQUEUE with FORCE=CMP to resume job completion for these jobs.\n" +
                "Limits: CMP is the only value",
            type: "string"
        },
        {
            name: "ca7num",
            description: "example: 0029\n" +
                "(Optional) Indicates the job number\n" +
                "must match before it is moved back to the request queue, is given a restart requirement, and is flagged as having been requeued.\n" +
                "If JOB is used alone, both the active and ready queues are searched for the specified job number.\n" +
                "If JOB is used with Q, the search is restricted to the indicated queue. jobname,jobnumber and longjobname are mutually exclusive\n" +
                "Default:\n" +
                "* (all jobs)Limits:\n" +
                "1 to 8 alphanumeric characters",
            type: "string",
            conflictsWith: ["jobname", "longjobname"]
        },
        {
            name: "jobname",
            aliases: ["jn"],
            description: "example: PAYROLL\n" +
                "(Optional) Indicates the job name, or mask that a job name\n" +
                "must match before it is moved back to the request queue, is given a restart requirement, and is flagged as having been requeued.\n" +
                "If JOB is used alone, both the active and ready queues are searched for the specified job.\n" +
                "If JOB is used with Q, the search is restricted to the indicated queue. jobname,jobnumber and longjobname are mutually exclusive.\n" +
                "Default:\n" +
                "* (all jobs)Limits:\n" +
                "1 to 8 alphanumeric characters",
            type: "string"
        },
        {
            name: "longjobname",
            aliases: ["ljn"],
            description: "example: ALONGJOBNAME\n" +
                "(Optional) Indicates the long job name or mask that a long job name must match before\n" +
                "it is moved back to the request queue, is given a restart requirement, and is flagged as having been requeued.\n" +
                "If JOBL is used alone, both the active and ready queues are searched for the specified long job name.\n" +
                "If JOBL is used with Q, the search is restricted to the indicated queue.jobname,jobnumber and longjobname are mutually exclusive\n" +
                "Limits: 1 to 64 alphanumeric characters",
            type: "string"
        },
        {
            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.\n" +
                "Value must be specified as a single MAINID name.\n" +
                "MAINID cannot be used with CPU, NODE, or AGENT.\n" +
                "The 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_\n" +
                "The name must be one of the following values:\n" +
                "ALL Indicates that all MAINIDs are considered.\n" +
                "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.\n" +
                "/SYn\n" +
                "Where n indicates a CPU assigned number. The / indicates “not this MAINID.\n" +
                "The value of n can range from 1 to 7.\n" +
                "Limits: 1 to 4 alphanumeric characters",
            type: "string"
        },
        {
            name: "node",
            description: "example: NODEXP\n" +
                "(Optional) Indicates the node name or mask that a node name must match for an XPJOB job,\n" +
                "before it is moved back to the request queue, is given a restart requirement, and is flagged as having been requeued.\n" +
                "NODE cannot be used with CPU, MAINID, or AGENT.\n" +
                "For 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).\n" +
                "The status of the node or the computer that the node points to, determines whether the request is honored.\n" +
                "Limits:\n" +
                "1 to 8 alphanumeric characters",
            type: "string"
        },
        {
            name: "q",
            description: "q=RDY\n\n" +
                "Used with JOB to indicate in which queue the job search is to occur\n" +
                "ACT The active queue. RDY The ready queue.",
            type: "string"
        },
        {
            name: "type",
            description: "(Optional) Flags the job after it returns to the request queue with a status of JCLERR instead of REQUE.\n" +
                "If not coded, the status reflects REQUE.",
            type: "string"
        }
    ],
    profile: {
        optional: ["ca7"]
    }
};
//# sourceMappingURL=Requeue.definition.js.map