@broadcom/ca7-for-zowe-cli/lib/cli/jobDefinition/items/PostCorequisiteResource.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.PostCorequisiteResourceDefinition = void 0;
exports.PostCorequisiteResourceDefinition = {
    name: "create-corequisite-resource",
    aliases: ["ccr"],
    summary: "Add Corequisite resource to a job definition",
    description: "Add Corequisite Resource",
    examples: [
        {
            options: "--jn JOBAA --schid 23 --rn SCHENV.VARNAME --rw I",
            description: "Creates a job named JOBAA with resource name SCHENV.VARNAME, schedule id 23 and job is submitted only if the resource is not active"
        }
    ],
    type: "command",
    handler: __dirname + "/PostCorequisiteResource.handler",
    profile: {
        optional: ["ca7"]
    },
    options: [
        {
            name: "job-name",
            aliases: ["jn"],
            description: "Specifies the job name on which the indicated function is performed." +
                "\nLimits: 1 to 8 alphanumeric characters",
            type: "string",
            required: true
        },
        {
            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 nonblank, and no embedded blanks" +
                "\nException: If the resource connection is made to a resource count resource," +
                "\nthe resource name can be from 1 to 39 characters followed by a / (slash) and" +
                "\n a 1 through 4 numeric value indicating the number of occurrences for the resource that the job uses." +
                "\n",
            type: "string",
            required: true
        },
        {
            name: "schid",
            description: "(Optional) Specifies the schedule ID (of this job) for which a user requirement is applied." +
                "\nA zero default cannot be specified for one connection and a nonzero schedule ID used for" +
                "\na subsequent connection to the same job with the same user requirement description." +
                "\n An attempt to make such a connection results in an error message that is issued." +
                "\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: "ready-when",
            aliases: ["rw"],
            description: "Determines how VRM manages resource availability at job submission and job/step completion." +
                "\nDefault: A" +
                "\nValid values are:" +
                "\nA" +
                "\nSpecifies the job is submitted only if the resource is active (as established by the PRSQA command).I" +
                "\nSpecifies the job is submitted only if the resource is not active.",
            type: "string",
            required: false
        }
    ]
};
//# sourceMappingURL=PostCorequisiteResource.definition.js.map