@zowe/cics-for-zowe-sdk/lib/utils/ResourceActions.d.ts

Zowe SDK for IBM CICS Transaction Server

/**
 * This program and the accompanying materials are made available under the terms of the
 * Eclipse Public License v2.0 which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-v20.html
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Copyright Contributors to the Zowe Project.
 *
 */
import type { AbstractSession } from "@zowe/imperative";
import type { ICMCIApiResponse } from "../doc/ICMCIApiResponse";
/**
 * Base parameters for resource actions
 */
export interface IResourceActionParms {
    /** The name of the resource */
    name: string;
    /** The CICS region name */
    regionName: string;
    /** The CICSPlex name (optional) */
    cicsPlex?: string;
    /** The CSD group name (optional) */
    csdGroup?: string;
}
/**
 * Performs a generic action on a CICS resource
 * @param session - The CMCI session
 * @param resourceType - The CMCI resource type (e.g., "CICSLocalFile")
 * @param action - The action to perform (e.g., "CLOSE", "OPEN")
 * @param params - The resource parameters
 * @param criteriaField - The resource selection criteria field (e.g., "FILE")
 * @param additionalParams - Additional action-specific parameters (e.g., { name: "BUSY", value: "WAIT" })
 * @returns The CMCI API response
 */
export declare function performAction(session: AbstractSession, resourceType: string, action: string, params: IResourceActionParms, criteriaField: string, additionalParams?: {
    name: string;
    value: string;
}): Promise<ICMCIApiResponse>;