/mgmt/status/default/FailureNotificationStatus2 GET

Use the HTTP GET method with the /mgmt/status/default/FailureNotificationStatus2 resource to request information about generated failure notifications. A report is only available when the upload report option is enabled.

Resource URL

https://host:port/mgmt/status/default/FailureNotificationStatus2
Where port is 5554 by default.

Request headers

The following header must be sent with the request:
Authorization
This header must be sent to perform authentication.

Request body format

None.

Security requirements

The caller must be authenticated as an appliance user with sufficient authority. For more information about security, see Types of user and how they are authenticated and User authorization, credential mapping, and access profiles.

Response status codes

200
Status 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.

Response headers

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

Response body format

The response is in JSON format. The response lists recently generated reports:
Date
String.
Date and time the error report was created, in the format of YYYYMMDDHHMMSSMILTMZ where MIL is millisecond and TMZ is timezone.
Reason
String.
Event that triggered the creation of this error report:
  • crash System crash occurred
  • watchdog System deadlock situation occurred
  • low-memory System crash occurred due to memory exhaustion
  • low-descriptor System crash or deadlock occurred due to file descriptor exhaustion
  • user-requested User requested must-gather via generate error report
  • on-startup User requested on startup, reboot and reload using the failure notification always-on-startup configuration toggle
  • on-shutdown User requested on shutdown using the failure notification always-on-shutdown configuration toggle
  • throttle System throttler initiated reload
  • descriptor-error System crash occurred due to file descriptor used or closed after already closed
  • unknown System generated the report
UploadStatus
String.
Upload attempted success or failure status.
  • success Error report creation and upload successful
  • failure Error report upload or creation failed
  • inProgress Error report upload is in-progress and will complete shortly
Location
String.
Location the error report was written to.

Examples

The following example requests information about recently uploaded reports.

The following URL is used with the HTTP GET method:
https://localhost:5554/mgmt/status/default/FailureNotificationStatus2
The following listing shows a received response:
{
  "_links": {
    "self": {
      "href": "/mgmt/status/default/FailureNotificationStatus2"
    },
    "doc": {
      "href": "/mgmt/docs/status/FailureNotificationStatus2"
    }
  },
  "FailureNotificationStatus2": [
    {
      "Date": "20160507223218839BST",
      "Reason": "user-requested",
      "UploadStatus": "failure",
      "Location": "temporary:///error-report.7800537.20160507223218839BST.txt.gz"
    },
    {
      "Date": "20160809125843057BST",
      "Reason": "user-requested",
      "UploadStatus": "in-progress",
      "Location": "temporary:///error-report.7800537.20160809125843057BST.txt.gz"
    },
    {
      "Date": "20160809170210103BST",
      "Reason": "user-requested",
      "UploadStatus": "in-progress",
      "Location": "temporary:///error-report.7800537.20160809170210103BST.txt.gz"
    },
    {
      "Date": "20160809170717028BST",
      "Reason": "crash",
      "UploadStatus": "in-progress",
      "Location": "temporary:///error-report.7800537.20160809170717028BST.txt.gz"
    }
  ]
}