Skip to main content

GET /ffdc/endpoint/{uuid}

Use this 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 username 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.

ParametersRequired / OptionalDescription
componentName={name}OptionalComponent 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}OptionalUnique 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

Request body​

None

Response codes​

CodeDescriptionComments
201CreatedOne or more new resources were successfully created.
400Bad RequestA query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
404Not foundA specified resource cannot be found. A descriptive error message is returned in the response body.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body​

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

AttributesTypeDescription
jobURLStringURL for this job, including the job ID
The following example is returned if the request is 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" }

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

AttributesTypeDescription
resultStringResults 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.
messagesArray of objectsInformation about one or more messages
 idStringMessage identifier of a returned message
 textStringMessage text associated with the message identifier
 explanationStringAdditional information to clarify the reason for the message
 recoveryArray of objectsRecovery information
  textStringUser actions that can be taken to recover from the event
  URLStringLink to the help system for more information, if available
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."
   }]
}