Diagnostic/snap/{snapPath}: GET

Downloads the specific snap file which comprises the diagnostic data to troubleshoot issues in the system.

Availability

Available on all IBM Storage Scale editions.

Description

The GET diagnostic/snap/{snapPath} request downloads a specific snap file from the default directory /tmp/gpfs.snapOut. For more information about the fields in the returned data structure, see gpfs.snap command.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v2/diagnostic/snap/{snapPath}

where

snap/{snapPath}: Specifies the snap file that is to be downloaded. Required.

Request headers

Accept: application/octet-stream

Parameters

The following parameters can be used in the request URL to customize the request:

Table 1. List of parameters
Parameter name	Description and applicable keywords	Required/optional
snapPath	The snap file path provided as a URL	Required.

Request data

No request data.

Response data

No response data.

Examples

The following example downloads the snap file.

Request data:

curl -k -u 'username:password' -X GET --header 'Accept: application/octet-stream' --header 'Authorization: Basic YWRtaW46YWRtaW4wMDE=' 'https://198.51.100.1:443/scalemgmt/v2/diagnostic/snap/%2Ftmp%2Fgpfs.snapOut%2F355725%2Fall.20210128084441.355725.tar' >/tmp/snap.tar'

Response data:

The snap file is downloaded.