@broadcom/ca7-for-zowe-cli/lib/cli/commands/items/PostAddRq.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.PostAddRqDefinition = void 0;
exports.PostAddRqDefinition = {
    name: "addrq",
    aliases: ["ar"],
    summary: "Issue ADDRQ command for CA 7 instance specified in path",
    description: "The ADDRQ command manually adds temporary, one-time, preexecution user or predecessor job requirements.\n" +
        "These requirements must be added to the job while it is in the CA Workload Automation CA 7 Edition\n" +
        "request queue. These added requirements apply only to the current run of the job.\n" +
        "You must manually satisfy user requirements with the QM.2 panel (POST) or XRQ command before the job executes.\n" +
        "Predecessor job requirements are satisfied automatically when the predecessor job completes successfully.",
    examples: [
        {
            options: "--ca7# 0016 --ca7Id Instance1",
            description: "Adds the job requirement ca7 number, 0016 from CA 7 on Instance1"
        }
    ],
    type: "command",
    handler: __dirname + "/PostAddRq.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 job to which you want to add the job requirement." +
                "\nThe job must be in the request queue. " +
                "\n    jobnumber" +
                "\nDefines the CA 7 job number to which you want to add the requirement for this run of the job." +
                "\n    Limits:" +
                "\n 1 to 4 numeric characters" +
                "\n",
            type: "string",
            required: false
        },
        {
            name: "depjob",
            description: "Defines a temporary one-time job dependency requirement." +
                "\n The DEPJOB value specifies the job name that must complete execution or must be manually posted complete before the job identified by JOB is eligible for submission. " +
                "\nDEPJOB is required unless USR is used, in which case, omit DEPJOB." +
                "\nThis requirement is satisfied automatically when the predecessor job completes." +
                "\nOnly in unusual situations would this requirement must be satisfied manually. That is, any time that a normal completion did not occur." +
                "\n Required: Yes, unless USR is used." +
                "\nLimits:" +
                "\n1 to 8 alphanumeric characters",
            type: "string",
            required: false
        },
        {
            name: "usr",
            description: "Defines the description of a temporary, one-time user requirement.." +
                "\nThis requirement must be manually satisfied before the job identified by JOB is eligible for submission. " +
                "\nIf any commas are included as part of the text, enclose the entire requirements text in parentheses." +
                "\nThis requirement is satisfied automatically when the predecessor job completes." +
                "\nOnly in unusual situations would this requirement must be satisfied manually. That is, any time that a normal completion did not occur." +
                "\n Required: USR is required unless DEPJOB is used, in which case, omit USR." +
                "\nLimits:" +
                "\n1 to 36 alphanumeric characters",
            type: "string",
            required: false
        }
    ]
};
//# sourceMappingURL=PostAddRq.definition.js.map