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

Zowe CLI plugin for SYSVIEW

/**
 * Context information from a SYSVIEW command can be found in various parts of the display.
 * For example, the command’s screen title, the date and time, any displayed message,
 * the current jobname displayed often in the information area.
 * All of this information along with system name, LPAR, etc. are placed in the
 * context section of the response message.
 */
export interface ISysviewContext {
    /****************************************
     *		z/os information				*
     ****************************************/
    /**
     * Name of the zSystem hardware. Ex: "MF04"
     */
    hardwareName: string;
    /**
     * Name of the SYSPLEX. Ex: "PLEXC1"
     */
    sysplexName: string;
    /**
     * Name of the LPAR. Ex: "CA32"
     */
    lparName: string;
    /**
     * Name of the system. Ex: "CA32"
     */
    systemName: string;
    /**
     * The SMF Id for the system. Ex: "CA32"
     */
    smfId: string;
    /**
     * The JES name.  Ex: "JES2"
     */
    jesName: string;
    /**
     * JES Node. Ex: "USILCA11"
     */
    jesNode: string;
    /**
     * The User Id for the Virtual Machine.
     */
    vmUserId: string;
    /****************************************
     *		SYSVIEW information				*
     ****************************************/
    /**
     * The product name: "SYSVIEW"
     */
    productName: string;
    /**
     * The product release.  Ex: "16.0a"
     */
    productRelease: string;
    /**
     * The product build. Ex: "0990"
     */
    productBuild: string;
    /**
     * The product's subsystem Id.  Ex: "SYSV"
     */
    productSsId: string;
    /**
     * The product interface. Ex: "SERVER"
     */
    productInterface: string;
    /**
     * The UserId used to execute the command. Ex: "PICAN02"
     */
    productUserId: string;
    /**
     * The product's address space.  Ex: "SYSVDEVU"
     */
    productJobName: string;
    /**
     * The home address space for the product job.  Ex: "SYSVDEVU"
     */
    homeJobName: string;
    /**
     * The home address space's JES job Id.  Ex: "STC18128"
     */
    homeJobId: string;
    /**
     * The home address space's Address Space Id (ASID).  Ex: "021C"
     */
    homeAsId: string;
    /****************************************
     *		command information				*
     ****************************************/
    /**
     * The current address space which is the target for the command.  Ex: "CICS1"
     */
    currentJobName: string;
    /**
     * The current address space's JES job Id. Ex: "STC00145"
     */
    currentJobId: string;
    /**
     * The current address space's Address Space Id.  Ex: "021A"
     */
    currentAsId: string;
    /**
     * The current target address space type. Ex: "MQ"
     */
    currentAsiType: string;
    /**
     * The current target address space subtype. Ex: "QMGR"
     */
    currentAsiSubType: string;
    /**
     * The current TCB address. Ex: "007C8998"
     */
    currentTCB: string;
    /**
     * The current hexadecimal process id. Ex: "0505A788"
     */
    currentProcessId: string;
    /**
     * The command whose data was captured.  Ex: "ASLIST"
     */
    commandName: string;
    /**
     * The format for the command whose data was captured.  Ex: ""
     */
    commandFormat: string;
    /**
     * The screen for the command whose data was captured.  Ex: ""
     */
    commandScreen: string;
    /**
     *
     */
    commandDateTime: string;
    /**
     * The screen title for the command whose data was captured. Ex: "Address Space List"
     */
    screenTitle: string;
    /**
     * The message that was generated for the command whose data was captured. Ex: ""
     */
    message: string;
    /**
     *
     */
    messageReturnCode: string;
    /****************************************
     *		data information				*
     ****************************************/
    /**
     * The number of rows whose highest field status is NONE.  Ex: "2425"
     */
    conditionNone: string;
    /**
     * The number of rows whose highest field status is NORMAL.  Ex:"0"
     */
    conditionNormal: string;
    /**
     * The number of rows whose highest field status is HIGH.  Ex:"0"
     */
    conditionHigh: string;
    /**
     * The number of rows whose highest field status is WARNING.  Ex:"6"
     */
    conditionWarning: string;
    /**
     * The number of rows whose highest field status is PROBLEM.  Ex:"17"
     */
    conditionProblem: string;
    /**
     * The number of information area fields. Ex: "24"
     */
    infoFields: string;
    /**
     * The number of information area rows.  Ex: "5"
     */
    infoRows: string;
    /**
     * The number of data area fields. Ex: "47"
     */
    dataFields: string;
    /**
     * The number of data area rows. Ex: "2448"
     */
    dataRows: string;
    /**
     *
     */
    dataRowsTruncated: string;
    /**
     * Index signature.
     */
    [key: string]: any;
}