@broadcom/ca7-for-zowe-cli/lib/cli/jobDefinition/items/PostVariableResource.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.PostVariableResourceDefinition = void 0;
exports.PostVariableResourceDefinition = {
    name: "post-variable-resource",
    aliases: ["pvr"],
    summary: "Add Variable resource to a job definition for CA 7 instance specified in path",
    description: "Add a Variable resource to the definition of a job",
    examples: [
        {
            options: "--job JOBAA --schid 23 --rn SCHENV.VARNAME --ca7Id INSTANCE1 ",
            description: "Creates a job named JOBAA with resource name SCHENV.VARNAME and schedule id 23 for INSTANCE1"
        }
    ],
    type: "command",
    handler: __dirname + "/PostVariableResource.handler",
    profile: {
        optional: ["ca7"]
    },
    options: [
        {
            name: "ca7Id",
            description: "CA7ONL Instance",
            type: "string",
            required: true
        },
        {
            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." +
                "\nA 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." +
                "\nAn 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: \"SCHENV.\" followed by 1 to 16 alphanumeric and @, #, $, _ characters",
            type: "string",
            required: true
        }
    ]
};
//# sourceMappingURL=PostVariableResource.definition.js.map