POST /api/lunasa/hsms/{hsmid}/supportInfo

Generates a supportInfo.txt file.The supportInfo.txt file includes detailed information about the state and settings of the HSM, as well as other important appliance information, such as the network settings and negotiated link status. This can later be downloaded in the archive form. [see GET /users/{userid}/files]
Note: The file or the response will be available in a compressed (.tgz) format.

User Privileges

Users with the following role privileges can perform this command:

admin
operator
monitor

Parameters

hsmid

The serial number of the HSM of interest.

Use: Required

JSON Schema:

   Object
   type: integer
   format: int64
   minimum: 1
   maximum: 9999999999

Responses

200

Success.

400

FRAMEWORK_BAD_REQUEST

Returned when the input data does not conform to the required validation schema.

404

HSMPLUGIN_INVALID_HSM

HSM does not exist.

Log Event

An 'AdminAPI' log entry will be generated on requesting this resource in the lunalogs.

Example Request

    POST
    https://1.2.3.4:8443/api/lunasa/hsms/{hsmid}/supportInfo
    {
    }

Example Response

{
}