@broadcom/sysview-for-zowe-cli/lib/api/doc/ISysviewCommandParms.d.ts

Zowe CLI plugin for SYSVIEW

/**
 * Interface for parameters to the SYSVIEW issue command API
 */
export interface ISysviewCommandParms {
    /**
     * The captured command name
     * Example:  ACTIVITY
     */
    capturecommand?: string;
    /**
     * The description of the Capture
     */
    captureDescription?: string;
    /**
     * Capture data set name from which to retrieve captured commands
     * Example:  MY.CAPDATA.T100608.D200326
     */
    capturedsn?: string;
    /**
     * The list of SYSVIEW commands to be executed as an Event Capture.
     * This takes the same form as a CAPLIB member.
     */
    captureFile?: string;
    /**
     * Row number of command within capture data set
     */
    capturerow?: number;
    /**
     * Screen name, for commands which have multiple screens
     */
    capturescreen?: string;
    /**
     * The captured command screen title or a user supplied title specified on the CAPIMMED command
     */
    capturetitle?: string;
    /**
     * Command(s) to be issued
     * (If more than one command, separated by a semi-colon)
     * Example:  ACTIVITY;SORT CPU%25 D
     * Note: Special characters like percent (%) need to use URL encoding format of %nn, where nn is the hex number of the ASCII character
     */
    command?: string;
    /**
     * Fields to be returned (by name)
     * example: ["jobname", "cpu"]
     */
    fields?: string[];
    /**
     * Starting row to be returned
     */
    rowstart?: number;
    /**
     * Ending row to be returned
     */
    rowend?: number;
    /**
     * Command data types to be returned (separated by a semi-colon).
     * Valid parameters:
     *
     * CONTEXT - command context data
     *
     * OVERVIEW - overview area data
     *
     * INFOALL - equivalent to INFOFLDS;INFOROWS;INFODATA
     *
     * INFOFLDS - information area field descriptions
     *
     * INFOROWS - information area rows as text
     *
     * INFODATA - information values as keyword/value pairs
     *
     * DATAALL - equivalent to DATAFLDS;DATAROWS
     *
     * DATAFLDS - data area field descriptions
     *
     * DATAROWS - data row values
     *
     * STATUS - return field statuses along with row values.
     *
     */
    types?: string[];
    /**
     * The SSID of the SYSVIEW instance to issue the command against
     */
    ssid?: string;
    /**
     * The number of seconds to wait before timing out
     */
    timeout?: number;
}