@broadcom/ca7-for-zowe-cli/lib/cli/jobDefinition/items/PutExclusiveResource_1.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.PutExclusiveResource_1Definition = void 0;
exports.PutExclusiveResource_1Definition = {
    name: "update-exclusive-resource_1",
    aliases: ["uer1"],
    summary: "Modify Exclusive resource for a job definition for DEFAULT_INSTANCE",
    description: "Modify an Exclusive resource for the definition of a job",
    examples: [
        {
            options: "--job JOBA --rn RESOURCE.NAME --free F --sn JS011 --schid 42",
            description: "Updates a job named JOBA with resource name RESOURCE.NAME, of free type F, and schedule id 42 to job with step name JS011"
        }
    ],
    type: "command",
    handler: __dirname + "/PutExclusiveResource_1.handler",
    profile: {
        optional: ["ca7"]
    },
    options: [
        {
            name: "job",
            description: "Specifies the job name on which the indicated function is performed." +
                "\nLimits: 1 to 8 alphanumeric characters",
            type: "string",
            required: true
        },
        {
            name: "schid",
            description: "(Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message." +
                "\nDefault: 0, which indicates that the requirement holds for all schedule IDs" +
                "\nLimits: 1 to 3 numeric characters from 0 through 999",
            type: "string",
            required: false
        },
        {
            name: "resource-name",
            aliases: ["rn"],
            description: "Specifies the resource name being connected to the job." +
                "\nLimits: 1 to 44 characters, the first character must be non-blank, and no embedded blanks",
            type: "string",
            required: true
        },
        {
            name: "step-name",
            aliases: ["sn"],
            description: "(Optional) Specifies the resource is freed at the conclusion of the named job step." +
                "\nLimits: 1 to 8 alphanumeric characters" +
                "\nNotes:The step-name parameter applies to the first occurrence of the stepname that is encountered in the job stream. This includes any reference to the stepname embedded in a PROCThe only valid stepname would be for steps with PGM= coded, not for stepnames executing a PROCIf a job is restarted in a step after this step-name, the resource does not go through free processing until the job completesA step flush condition does not post the step-name process",
            type: "string",
            required: false
        },
        {
            name: "free",
            description: "Determines how VRM manages resource availability at job submission and job/step completion." +
                "\nValid values are:" +
                "\nA = Specifies the resource is only freed if any step in the job abends (abend or condition code checking)" +
                "\nF = Specifies the resource is freed when job ends, either successfully or unsuccessfully. If the step-name parameter is specified, free the resource when the specified step completes, either successfully or unsuccessfully" +
                "\nN = Specifies do not free the resource at successful job completion. The resource can be freed with the PRSCF command. A cancel of the job also frees the resource" +
                "\nY = Specifies to free the resource at successful job completion. If the step-name parameter is specified, free the resource when the specified step completes successfully (does not abend)",
            type: "string",
            required: true
        }
    ]
};
//# sourceMappingURL=PutExclusiveResource_1.definition.js.map