@broadcom/ca7-for-zowe-cli/lib/cli/commands/items/PostSubmit.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.PostSubmitDefinition = void 0;
exports.PostSubmitDefinition = {
    name: "submit",
    aliases: ["sub"],
    summary: "Issue SUBMIT command for CA 7 instance specified in path",
    description: "The SUBMIT top line command modifies and expedites the process of job submission for jobs already residing in the queues.\n" +
        "This processing can be accomplished in two ways:\n" +
        "\n" +
        "All outstanding input requirements for the specified jobs can be posted as satisfied.\n" +
        "Optionally, by specifying EXPRESS=YES, a priority can be set for a specific job.\n" +
        "This priority ensures that the job is submitted ahead of other jobs also ready for submission.\n" +
        "Note:\n" +
        "EXPRESS=YES has no effect when workload balancing is being used.",
    examples: [
        {
            options: "--ca7# 0123 --ca7Id Instance1",
            description: "Submits the job with ca7 number 0123 on Instance1"
        }
    ],
    type: "command",
    handler: __dirname + "/PostSubmit.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: "Specifies the CA 7 job number of the job whose requirements you want to post as satisfied.Limits:" +
                "\n1 to 4 alphanumeric characters",
            type: "string",
            required: false
        },
        {
            name: "express",
            description: "(Optional) Indicates to place the job ahead of all other jobs (those jobs without EXPRESS=YES) for submission." +
                "\nThe value must be coded as shown. Not valid if workload balancing is being used." +
                "\nUse of EXPRESS=YES does not establish an increased execution priority for a job." +
                "\nRather, it ensures that nonexpress jobs are not submitted ahead of a job that is flagged as an express job.",
            type: "string",
            required: false
        }
    ]
};
//# sourceMappingURL=PostSubmit.definition.js.map