@broadcom/ca7-for-zowe-cli/lib/cli/commands/items/PostPrscf.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.PostPrscfDefinition = void 0;
exports.PostPrscfDefinition = {
    name: "prscf",
    aliases: ["prf"],
    summary: "Issue PRSCF command for CA 7 instance specified in path",
    description: "The PRSCF command frees a shared, exclusive, or RCT resource that is connected to a job that:\n" +
        "\n" +
        "Is executing\n" +
        "Is in ABEND status in the request queue\n" +
        "Has already executed and purged from the request queue\n" +
        "PRSCF can also remove a virtual resource from consideration of a job currently in the active workload and waiting to execute.",
    examples: [
        {
            options: "--ca7Id Instance1 --job PAYROLL",
            description: "Frees resources for Job PAYROLL on Instance1"
        }
    ],
    type: "command",
    handler: __dirname + "/PostPrscf.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: "job",
            description: " Specifies the CA Workload Automation CA 7 Edition job name or number to which the resource is attached." +
                "\n    jobnumber" +
                "\nIndicates a specific CA 7 job number." +
                "\n    Limits:" +
                "\n 1 to 4 numeric characters" +
                "\n",
            type: "string",
            required: false
        },
        {
            name: "rsrc",
            description: "Specifies the fully qualified resource name to free." +
                "\nYou can optionally specify * to indicate to free all resources that are connected to the job." +
                "\nLimits:" +
                "\n1 to 44 alphanumeric characters",
            type: "string",
            required: false
        },
        {
            name: "force",
            description: "(Optional) FORCE=YES indicates that CA WA CA 7 Edition is not to evaluate" +
                "\nthe availability of the named resources for this run of the job only." +
                "\nThis run of the job does not use the named resources." +
                "\nThis keyword can be used on an exception basis to let a job in a W-RSRC status bypass VRM checking for one or more resources defined for it on the RM.1 panel.",
            type: "string",
            required: false
        }
    ]
};
//# sourceMappingURL=PostPrscf.definition.js.map