@broadcom/ca7-for-zowe-cli/lib/cli/commands/items/PostSubtm.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.PostSubtmDefinition = void 0;
exports.PostSubtmDefinition = {
    name: "subtm",
    aliases: ["subtm"],
    summary: "Issue SUBTM command for CA 7 instance specified in path",
    description: "The SUBTM command modifies the required submit time-of-day for a job in the request queue. These modifications are permitted:\n" +
        "\n" +
        "Add a specific submit time requirement where none was previously defined.\n" +
        "Remove a defined submit time requirement.\n" +
        "Change an existing submit time requirement to either earlier or later than defined.",
    examples: [
        {
            options: "--ca7# 0123 --ca7Id Instance1",
            description: "Modifies submit time for the job with ca7 number 0123 on default instance"
        }
    ],
    type: "command",
    handler: __dirname + "/PostSubtm.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 or which you want to add, modify, or remove a submit time-of-day requirement.Limits:" +
                "\n1 to 4 alphanumeric characters",
            type: "string",
            required: false
        },
        {
            name: "time",
            description: "(Optional) Specifies the new submit time-of-day in hours and minutes." +
                "\nTIME is required to add a submit time-of-day requirement when none exists or to change an existing requirement." +
                "\nIf TIME is omitted, an existing submit time-of-day restriction is removed. Format:hhmm" +
                "\nDefines the time-of-day where hh is hours (0 through 24) and " +
                "\nmm is minutes (00 through 59). Maximum is 2400." +
                "\nIf the value given is less than the current time (when the command is processed), the submit day is incremented by one.",
            type: "string",
            required: false
        },
        {
            name: "date",
            description: "(Optional) Specifies new submit date in Julian date format." +
                "\nIf DATE is not specified, default is the current date." +
                "\n If DATE is specified, TIME is then required." +
                "\nLimits:" +
                "\n If used, specify DOTM or TIME.        yyddd    Defines the Julian date to submit the job.",
            type: "string",
            required: false
        }
    ]
};
//# sourceMappingURL=PostSubtm.definition.js.map