@zosconnect/zosconnect-zowe-cli/lib/api/service/ZosConnectService.d.ts

z/OS Connect EE Plugin for Zowe CLI

/// <reference types="node" />
import { ZosConnectSession } from "../../ZosConnectSession";
import { Service } from "./Service";
export declare class ZosConnectService {
    /**
     * Get a list of the Services installed in the server.
     *
     * @param session The session to use for connection information.
     */
    static list(session: ZosConnectSession): Promise<Service[]>;
    /**
     * Install a new service into the Server.
     *
     * @param session The session to use for connection information.
     * @param sarFile The SAR file to install.
     */
    static install(session: ZosConnectSession, sarFile: Buffer): Promise<Service>;
    /**
     * Update the named Service.
     *
     * @param session The Isession to use for connection information.
     * @param serviceName The name of the Service to update.
     * @param sarFile The SAR file containing the new Service information.
     */
    static update(session: ZosConnectSession, serviceName: string, sarFile: Buffer): Promise<Service>;
    /**
     * Delete the named Service from the server.
     *
     * @param session The Isession to use for connection information.
     * @param serviceName The name of the Service to delete.
     * @param force Whether the Service should be deleted regardless of status.
     */
    static delete(session: ZosConnectSession, serviceName: string, force: boolean): Promise<void>;
    /**
     * Set a Service as Started.
     *
     * @param session The ZosConnectSession to use for connection information.
     * @param serviceName The name of the Service.
     */
    static start(session: ZosConnectSession, serviceName: string): Promise<void>;
    /**
     * Set a Service as Stopped.
     *
     * @param session The ZosConnectSession to use for connection information.
     * @param serviceName The name of the Service.
     */
    static stop(session: ZosConnectSession, serviceName: string): Promise<void>;
    /**
     * Get detailed information about a Service.
     *
     * @param session The ZosConnectSession to use for connection information.
     * @param serviceName The name of the Service.
     */
    static info(session: ZosConnectSession, serviceName: string): Promise<Service>;
}