@broadcom/ca7-for-zowe-cli/lib/cli/agent-credentials/items/DeleteAgentCredentials.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.DeleteAgentCredentialsDefinition = void 0;
exports.DeleteAgentCredentialsDefinition = {
    name: "deleteAgentCredentials",
    aliases: ["dag"],
    summary: "Delete Agent credentials for CA 7 instance specified in path",
    description: "Delete the Agent credentials associated with a user ID, Agent name, job type and source.",
    examples: [
        {
            options: "--userid wlaagent --ca7Id INSTANCE1",
            description: "Delete the Agent credentials associated with a user wlaagent for INSTANCE1"
        }
    ],
    type: "command",
    handler: __dirname + "/DeleteAgentCredentials.handler",
    profile: {
        optional: ["ca7"]
    },
    options: [
        {
            name: "ca7Id",
            description: "CA7ONL Instance",
            type: "string",
            required: true
        },
        {
            name: "userid",
            description: "Specifies a user ID that is passed with a password to an agent for authorization." +
                "\nLimits:" +
                "\n1 to 128 characters. The wildcard characters * and ? are not permitted",
            type: "string",
            required: true
        },
        {
            name: "agent",
            description: "Specifies the agent that is the target of a job submission and where the user ID and password authorization takes place." +
                "\n" +
                "\nLimits: 1 to 16 characters. The wildcard characters * and ? are not permitted" +
                "\n" +
                "\nExample: WINAGENT001",
            type: "string",
            required: false
        },
        {
            name: "jobType",
            description: "Specifies the job type of the job that requires a user ID and password authorization." +
                "\n" +
                "\nLimits: 1 to 16 characters. The wildcard characters * and ? are not permitted" +
                "\n" +
                "\nExample: NT_JOB",
            type: "string",
            required: false
        },
        {
            name: "source",
            description: "Specifies the source field for a job that requires a user ID and password authorization. This property applies to agent job types which allow CONNECTIONUSER or PROXYUSER C-LANG statements." +
                "\n" +
                "\nLimits: 1 to 64 characters. The wildcard characters * and ? are not permitted" +
                "\n" +
                "\nExample: example.domain.com",
            type: "string",
            required: false
        }
    ]
};
//# sourceMappingURL=DeleteAgentCredentials.definition.js.map