@broadcom/ca7-for-zowe-cli/lib/cli/commands/items/PostHold.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.PostHoldDefinition = void 0;
exports.PostHoldDefinition = {
    name: "hold",
    aliases: ["hod"],
    summary: "Issue HOLD command for CA 7 instance specified in path",
    description: "The HOLD command interrupts the normal scheduling progress by holding the forward movement of a job.\n" +
        "The command can also hold the contents of an entire queue.\n" +
        "This function is available on the QM.1 panel with a FILL value of H.\n" +
        "Depending on the timing and whether you have any other predecessor situations, the QM.3 panel can sometimes accomplish this process.",
    examples: [
        {
            options: "--ca7Id Instance1 --ca7# 29",
            description: "Hold the CA7 number 29 on Instance1"
        }
    ],
    type: "command",
    handler: __dirname + "/PostHold.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: "Defines the individual job number to hold. Omit if Q is specified." +
                "\n    jobnumber" +
                "\nDefines the job number of the job to hold." +
                "\n    Limits:" +
                "\n 1 to 4 numeric characters" +
                "\n Required: Yes, unless the Q parameter is used." +
                "\n",
            type: "string",
            required: false
        },
        {
            name: "q",
            description: "Specifies to hold the contents of an entire queue." +
                "\nPossible values:" +
                "\n    REQ" +
                "\nSpecifies to hold all jobs currently in the request queue.    RDY" +
                "\nSpecifies to hold all jobs currently in the ready queue.Required: Yes, unless job number is used." +
                "\n",
            type: "string",
            required: false
        }
    ]
};
//# sourceMappingURL=PostHold.definition.js.map