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

Gets hsm supportInfo.txt file in the archive form. This 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 resource has been disabled for Rest API version equivalent to or greater than 12.

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: int
   range of value: 1 - 999999

Responses

200

A binary stream that represents the hsm supportInfo text file. This archive is in compressed tar format (tgz).

JSON Schema:

        <binary stream>

404

HSMPLUGIN_INVALID_HSM

HSM does not exist.

HSMPLUGIN_NO_SUPPORTFILE_AVAILABLE

No supportFile available. Please generate one.

[see POST /api/lunasa/hsms/{hsmid}/supportInfo]

Log Event

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

Example Request

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

Example Response

A binary stream, in compressed format containing the supportInfo text file.

NOTE : Use this resource to download the file for REST API version greater than or equivalent to 12.

GET /users/{userid}/files/{fileid}/download