HP OneView REST API Reference

appliance/support-dumps
appliance-support-dumps.html[10/17/2013 10:35:51 AM]
Updated: October 16, 2013 4:24
MDT
API Specifications Create Read Update Delete
/rest/appliance/support-dumps POST
/rest/appliance/support-dumps/{dumpFileName}.{suffix} GET
Resource Model
DumpGenerationInfo
DumpDataInfo
HP OneView REST API Reference
appliance/support-dumps
This is the support-dumps service for generating and downloading support dumps from an appliance.
URI: /rest/appliance/support-dumps
Method API
POST Generates the dump. It takes errorCode as input in the form of DumpGenerationInfo. It is a
synchronous call. If successful, it returns dump file information in the form of DumpDataInfo. On
failure, it returns an error object. An encrypted dump is always created if the appliance or any
appliance services are in error state.
Request Header Attributes Description
REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the
current release, this must be set to "X-API-Version:3"
Request Body Attributes Description
DumpGenerationInfo Required Contains errorCode, encrypt, directory and
product information
Response Description
DumpDataInfo Information about dump data created
Response Codes
REST API Response Codes
Examples
POST https://{appl}/rest/appliance/support-dumps
for example:
The following POST request generates a support dump.
An example URI with request body is shown below.
POST https://{appl}/rest/appliance/support-dumps
{
"errorCode":"CI",
"encrypt":true,
"product":"test",
"directory":["/ci/logs/","/var/tmp/"]
}
URI for downloading the dump is in the dump file information of
response body.