@broadcom/ca7-for-zowe-cli/lib/cli/commands/cmds/Cancel.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.CancelDefinition = void 0;
exports.CancelDefinition = {
    name: "cancel",
    aliases: ["c"],
    summary: "Cancels a job request to CA 7",
    description: "For CPU jobs, the CANCEL command only removes the job from the queues.\n" +
        "For XPJOB jobs, the CANCEL command removes the job from the queues.\n" +
        "For agent definition jobs (AGJOBs), the CANCEL command sends a request to the agent and removes the job from the queues.",
    examples: [
        {
            options: "--ca7num 0016",
            description: "Cancel ca7 number, 0016"
        }
    ],
    type: "command",
    handler: __dirname + "/Cancel.handler",
    profile: {
        optional: ["ca7"]
    },
    options: [
        {
            name: "ca7num",
            description: "ca7num=0016\n\n" +
                "Defines the unique CA 7 job number (leading zeros are not required) for the job to cancel.\n" +
                "Limits: 1 to 4 numeric characters",
            type: "string",
            required: true
        },
        {
            name: "force",
            description: "Specifies to force the cancellation of the job.\n" +
                "Use of this option can potentially cause CA WA CA 7 Edition to abend; therefore, only use it as a last resort.",
            type: "string"
        },
        {
            name: "reason",
            description: "Defines the reason for the job cancellation.\n\n" +
                "Limits: 1 to 40 alphanumeric characters\n" +
                "Required: No (depending on initialization options)",
            type: "string"
        }
    ]
};
//# sourceMappingURL=Cancel.definition.js.map