@broadcom/ca7-for-zowe-cli/lib/cli/commands/items/PostCancel.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.PostCancelDefinition = void 0;
exports.PostCancelDefinition = {
    name: "cancel",
    aliases: ["cal"],
    summary: "Issue CANCEL command for CA 7 instance specified in path",
    description: "The CANCEL command deletes jobs from the CA Workload Automation CA 7® Edition queues.\n" +
        "\n" +
        "For CPU jobs, the CANCEL command only removes the job from the queues.\n" +
        "Cancelation of a job in the active queue or ready queue (if it has been submitted)\n" +
        "does not cause termination of the job's execution.\n" +
        "CPU jobs that can be executing have to be canceled from the operating system separately.\n" +
        "Execution must be terminated from an OS system console.\n" +
        "For XPJOB jobs, the CANCEL command removes the job from the queues.\n" +
        "If the XPDEF initialization option XPKILL is set to YES,\n" +
        "and the XPJOB job has been submitted to the target node but is still in the ready queue or the active queue,\n" +
        "a cancel request is created and sent to the target node.\n" +
        "Some remote CA Scheduling Agents support the cancel request, and the request cancels or 'kills' the process execution.\n" +
        "It is not the responsibility of CA WA CA 7 Edition to verify that the target platform supports the kill facility.\n" +
        "If the cancel request was not transmitted, an error message appears in the browse and log data.\n" +
        "For agent definition jobs (AGJOBs), the CANCEL command sends a request to the agent and removes the job from the queues.\n" +
        "If the agent is not active at the time of the CANCEL request, the message is queued and sent when the agent becomes active.\n" +
        "If the XPDEF initialization option XPKILL is set to NO, the XPJOB is canceled from the queues, and no cancel request is sent to the target platform.\n" +
        "To view the XPKILL option, enter the command /DISPLAY,ST=XPS.\n" +
        "\n" +
        "This function is available on the QM.1, QM.6, and QM.7 panels as option C.\n" +
        "The CANCEL command has three formats, depending on the queues in which the task resides.",
    examples: [
        {
            options: "--ca7Id Instance1 --ca7# 0016",
            description: "Cancels a job request for Instance1 and ca7 number 0016 from CA 7"
        }
    ],
    type: "command",
    handler: __dirname + "/PostCancel.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 cancel, and the value must be a CA 7 job number." +
                "\n ",
            type: "string",
            required: false
        },
        {
            name: "force",
            description: "(Optional) Specifies to force the cancellation of the job." +
                "\nIf you want to cancel the job to dump the log data set, specify FORCE=YES to prevent the job from being resubmitted." +
                "\nUse FORCE=YES when a job to be canceled shows a status of SKELETON or RETRY." +
                "\nUse FORCE=YES to cancel a job with connected resources." +
                "\nWarning! Use of this option can potentially cause CA WA CA 7 Edition to abend; therefore, only use it as a last resort. ",
            type: "string",
            required: false
        },
        {
            name: "reason",
            description: "(Optional) Defines the reason for the job cancellation." +
                "\nDepending on the initialization file CANCEL statement value, this reason can be required or optional." +
                "\nIf it is required but not given, a message prompts the user to provide it." +
                "\nThe text is entered into the run log entry for this occurrence of this job and is displayed on any subsequent LRLOG inquiries." +
                "\nLimits:" +
                "\n 1 to 40 alphanumeric characters" +
                "\n Required:" +
                "\n No (depending on initialization options)",
            type: "string",
            required: false
        }
    ]
};
//# sourceMappingURL=PostCancel.definition.js.map