Package wt.jmx.core.mbeans

Interface TechSupport2MBean

All Known Subinterfaces:
TechSupportMBean
public interface TechSupport2MBean
Provides operation(s) to send data and files to PTC technical support.

Supported API: true

Extendable: true

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getMaxAgeInDaysOfLogsToSend()
    Maximum age (in days) of log files to send

    Supported API: true
    void
    sendFilesToSupport(long callNumber)
    Send JMX management bean (MBean) data and registered log directories to PTC technical support for all nodes in the cluster.
    void
    sendFilesToSupport(long callNumber, String description, boolean sendMBeans, boolean sendLogDirs, int maxAgeInDays, int minAgeInDays, boolean forFullCluster)
    Send JMX management bean (MBean) data and/or registered log directories to PTC technical support.
    void
    setMaxAgeInDaysOfLogsToSend(int maxAgeInDaysOfLogsToSend)
    Maximum age (in days) of log files to send

    Supported API: true

  • Method Details

    • getMaxAgeInDaysOfLogsToSend

      int getMaxAgeInDaysOfLogsToSend()
      Maximum age (in days) of log files to send

      Supported API: true

    • setMaxAgeInDaysOfLogsToSend

      void setMaxAgeInDaysOfLogsToSend(int maxAgeInDaysOfLogsToSend)
      Maximum age (in days) of log files to send

      Supported API: true

    • sendFilesToSupport

      @MBeanOperationImpact(0) void sendFilesToSupport(long callNumber) throws Exception
      Send JMX management bean (MBean) data and registered log directories to PTC technical support for all nodes in the cluster. Logs older than MaxAgeInDaysOfLogsToSend are not sent.

      Supported API: true
      Parameters:
      callNumber - Number of PTC technical support call this data is related to (without the leading "C")
      Throws:
      Exception

    • sendFilesToSupport

      @MBeanOperationImpact(0) void sendFilesToSupport(long callNumber, String description, boolean sendMBeans, boolean sendLogDirs, int maxAgeInDays, int minAgeInDays, boolean forFullCluster) throws Exception
      Send JMX management bean (MBean) data and/or registered log directories to PTC technical support.

      Supported API: true
      Parameters:
      callNumber - Number of PTC technical support call this data is related to (without the leading "C")
      description - Description or comment to associate with this data
      sendMBeans - JMX management bean (MBean) data dumps should be generated and sent
      sendLogDirs - Whether registered logs directories should be sent
      maxAgeInDays - Maximum age in days of logs to send (by modification date), non-positive values are interpreted as MaxAgeInDaysOfLogsToSend
      minAgeInDays - Minimum age in days of logs to send (by modification date)
      forFullCluster - Whether send operation should be performed for each node in the cluster
      Throws:
      Exception