GET /ffdc/endpoint/<UUID>

Use the GET method to collect and export the first failure data capture (FFDC) data for a specific managed device (CMM, server, storage device, or switch).

This method returns a URI that contains the job ID for the job that is created to perform this request. You can use GET /tasks/<job_list> to monitor the status and progress of the job.

Authentication

Authentication with user name and password is required.

Request URL

GET https://<management_server_IP>/ffdc/endpoint/<UUID>

where <UUID> is the UUID of the target device. To obtain the device UUID, use the GET /cmms, GET /nodes, or GET /switches method.

Query parameters

You must specify at least one of the following query parameters.

Parameters Required / Optional Description
componentName=<name> Optional Component name of the device. This is usually the name that is displayed in the devices list on the Service and Support page in the web interface.
fileUID=<file_ID> Optional Unique identifier of an already-downloaded FFDC file
The following example exports FFDC data for the SN component:
GET https://192.0.2.0/ffdc/device/183F4A35B84C47FC820F11989D2CEA27?componentName=SN

Response codes

Code Description
201 Created. A new task was created on server.
400 Bad request. An invalid parameter was specified.
404 Not found. The file was not found on the server.
500 Internal server error

Response body

If the request was successful (if the response code is 200), the following attribute is returned in the response body.

Attributes Type Description
jobURL String URL for this job, including the job ID

If the request failed (if the response code is 400, 404, or 500), the following attributes are returned in the response body.

Attributes Type Description
result String Results of the request. This can be one of the following values.
  • success. The request completed successfully.
  • failed. The request failed. A descriptive error message was returned.
  • warning. The request completed with a warning. A descriptive error message was returned.
messages Array of objects Information about one or more messages
  id String Message identifier of a returned message
  text String Message text associated with the message identifier
  explanation String Additional information to clarify the reason for the message
  recovery Array of objects Recovery information
    text String User actions that can be taken to recover from the event
    URL String Link to the help system for more information, if available

Response example

The following example is returned if the request was successful. This example shows the URI that is returned which contains the job ID that you can use to monitor the job's progress and status. In this example, the job ID is 16.

{ "jobURL":"/jobs/16" }
The following example is returned if the request failed.
{
   "result":"fail",
   "messages":[{
      "explanation":"The required archive might have been erased.",
      "id":"FQXHMSS1064J",
      "recovery":{  
         "text":"Please retry to download the archive.",
         "url":"",
      }
      "text":"The required archive is not available."
   }]
}