@broadcom/ca7-for-zowe-cli/lib/cli/jobDefinition/items/PostExclusiveResource.definition.js

CA 7 Workload Automation Plug-in for Zowe CLI

"use strict";
/*
* Copyright © 202X Broadcom Inc. and/or its subsidiaries
* © 202X Broadcom Inc and/or its subsidiaries; All rights reserved
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.PostExclusiveResourceDefinition = void 0;
exports.PostExclusiveResourceDefinition = {
    name: "create-exclusive-resource",
    aliases: ["cer"],
    summary: "Add Exclusive resource to a job definition",
    description: "Add Exclusive Resource",
    examples: [
        {
            options: "--job JOBAA --schid 23 --rn SCHENV.VARNAME --free F --sn JS010 ",
            description: "Creates a job named JOBAA with resource name SCHENV.VARNAME of free type F, step name JS010 and schedule id 23"
        }
    ],
    type: "command",
    handler: __dirname + "/PostExclusiveResource.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)F = 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 unsuccessfullyN = 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 resourceY = 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=PostExclusiveResource.definition.js.map