/mgmt/config/default/ErrorReportSettings GET

https://host:port/mgmt/config/default/ErrorReportSettings

Where port is 5554 by default.

The following header must be sent with the request:

Authorization

This header must be sent to perform authentication.

200

Information retrieved successfully.

400

Invalid data provided.

401

Not authenticated.

The caller must be authenticated as an appliance user. See Types of user and how they are authenticated for more information.

403

Not authorized.

The caller is authenticated but does not the authority to perform this action. See User authorization, credential mapping, and access profiles for more information.

Content-Type

This header is returned with a value of application/json.

The response is in JSON format. The response includes the following fields:

mAdminState

String.

The administrative state of the failure notification settings, can be one of the following values:

• enabled
• disabled

UserSummary

String.

Free form text field for user comment.

UploadReport

String.

Set to "on" or "off". Set to "on" to upload to a specific location. Details of the upload destination are specified in the Protocol field. The default value is "on".

UseSmtp

String.

Set to "on" or "off". Set to "on" to send an email error report at start up only. Mutually exclusive with UploadReport. (To send an email error report at other times, set UploadReport to "on" and Protocol to "smpt".) The default value is "off".

InternalState

String.

Set to "on" or "off". Set to "on" to include the internal state of the appliance in the error report. The internal state can be useful in diagnosing the cause of the error. The default value is "off".

FFDCPacketCapture

String

Set to "on" or "off". Set to "on" to enable network packet capture for all interfaces including the internal loopback interface. When enabled, this feature runs continuously. If the appliance encounters a problem or a user triggers the generation of an error report, the error report includes the data from this packet capture data. This data helps to determine the messages that the appliance was processing when it encountered the problem. The default value is "off".

FFDCEventLogCapture

String

Set to "on" or "off". Set to "on" to use background log capture. This feature enables the capture of all log and trace points with minimal overhead. When enabled, this feature runs continuously. If the appliance encounters a problem or a user triggers the generation of an error report, the error report includes data from this log capture. This data can help IBM Support identify the problem. The default value is "off".

These messages are independent of messages written to log and trace targets.

FFDCMemoryLeakCapture

String

Set to "on" or "off". Set to "on" to enable automatic leak detection. This feature finds gradual memory leaks that occur steadily over time. This feature does not help in situations where messages are larger than the appliance can parse. The default value is "off".

When enabled, and if memory falls below an internal threshold, the appliance tracks all memory allocations. When the appliance reaches a critical condition that will lead to a crash, it generates an error report that contains information about memory allocation.

The configuration of the throttle Settings affects this feature. The throttle settings can prevent the appliance from reaching the internal threshold.

AlwaysOnStartup

String

Set to "on" or "off". Set to "on" to specify that the appliance generates an error report when it reboots or reloads. If this feature is enabled, logs are collected before they are overwritten when the system reloads. When the appliance reboots or reloads and when using the upload error report feature, the status provider lists on-start as the reason code. If the appliance reloads due to a crash, the status provider lists crash as the reason code. The default value is "on".

AlwaysOnShutdown

String

Set to "on" or "off". Set to "on" to specify that the appliance generates an error report when it shuts down. When the appliance shuts down and when using the upload error report feature, the status provider lists on-shutdown as the reason code. If the appliance shuts down due to a crash, the status provider lists crash as the reason code. The default value is "on".

Protocol

String

Specifies the protocol to use to write error reports. Set to one of the following values:

mqdiag

Error reports are written to the local mqdiag directory.

temporary

Error reports are written to the local temporary directory.

smtp

Error reports are sent as emails.

The default value is "mqdiag".

LocationIdentifier

String

Text to include as the subject of an email if the error report is sent as an email. Only available when UseSmtp is set to "on".

SmtpServer

String

The host name or IP address of the SMTP server. Required if UseSmtp is set to "on" or if Protocol is set to "smtp".

EmailAddress

String

The email address to send the error report to. Required if UseSmtp is set to "on" or if Protocol is set to "smtp".

EmailSenderAddress

String

The sender address for the email. Required if UseSmtp is set to "on" or if Protocol is set to "smtp".

ReportHistoryKept

Integer

The maximum number of local error reports to maintain when using the upload error report feature. After reaching this limit, the next local error report overwrites the oldest local error report. The value is between 2 and 10. The default value is 5.

This feature only applies to locally stored error reports, including temporary and mqdiag.

The following URL is used with the HTTP GET method:

GET /mgmt/config/default/ErrorReportSettings

The following listing shows the received response:

{
    "_links": {
        "self": {
            "href": "/mgmt/config/default/ErrorReportSettings"
        },
        "doc": {
            "href": "/mgmt/docs/config/ErrorReportSettings"
        }
    },
    "ErrorReportSettings": {
        "name": "Error-Report",
        "_links": {
            "self": {
                "href": "/mgmt/config/default/ErrorReportSettings/Error-Report"
            },
            "doc": {
                "href": "/mgmt/docs/config/ErrorReportSettings"
            }
        },
        "mAdminState": "enabled",
        "UploadReport": "off",
        "UseSmtp": "off",
        "InternalState": "on",
        "FFDCPacketCapture": "off",
        "FFDCEventLogCapture": "off",
        "FFDCMemoryLeakCapture": "off",
        "AlwaysOnStartup": "off",
        "AlwaysOnShutdown": "on",
        "Protocol": "mqdiag",
        "ReportHistoryKept": 5
    }
}