@broadcom/ca7-for-zowe-cli/lib/cli/agent/items/PutStopAgent.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.PutStopAgentDefinition = void 0;
exports.PutStopAgentDefinition = {
    name: "stopAgent",
    aliases: ["sag"],
    summary: "Stop Agent for CA 7 instance specified in path",
    description: "Stop an Agent. This operation will stop the specified Agent.\n" +
        "\n" +
        "Note: WARNING: If successful, the Agent will be stopped and no longer available to accept work. The Agent must be manually started.",
    examples: [
        {
            options: "--agname AGENTTEST --ca7Id INSTANCE1",
            description: "Stop Agent AGENTTEST for INSTANCE1"
        }
    ],
    type: "command",
    handler: __dirname + "/PutStopAgent.handler",
    profile: {
        optional: ["ca7"]
    },
    options: [
        {
            name: "ca7Id",
            description: "CA7ONL Instance",
            type: "string",
            required: true
        },
        {
            name: "agent-name",
            aliases: ["agname"],
            description: "Specifies the name of the Agent for which to retrieve additional details." +
                "\nLimits: 1 to 16 alphanumeric characters",
            type: "string",
            required: true
        },
        {
            name: "os",
            description: "Specifies the operating system of the Agent as known by the Scheduler." +
                "\nWindowsLinuxUnixetc.Default: Linux",
            type: "string",
            required: false
        }
    ]
};
//# sourceMappingURL=PutStopAgent.definition.js.map