Skip to content

diagnostic_package_status_get

Admin

Returns info about the current state of diagnostic package data collection process.

Note

This method is not supported when using Remote Access. Nevertheless, diagnostic package data collection on the remote device is available using the local device. See diagnostic_package_start documentation.

Params

attribute description
process_id
string		 An ID of the data collection process. If specified an error is returned if no process with such ID exists. If unspecified the status of an existing process is returned if it exists regardless of its ID.

Return

attribute description
process
Process		 Information about the data collection process. Its presence indicates there is a pending or finished data collection process.
return_code
'success'|'error'		 Indicates if the process was succesfull. If missing or null, the process is still pending.
output
Output		 Information about the generated diagnostic package. Must be present if return_code=success.

Process

attribute description
process_id*
string		 An ID of the started data collection process
start_time*
unsigned int		 A Unix timestamp when diagnostic package data collection was started
input*
Input		 The parameters with which diagnostic package data collection was started

Input

attribute description
verbosity*
'base'|'verbose'		 The data verbosity
configuration*
bool		 Include configuration
event_logs*
bool		 Include event logs
statistics*
bool		 Include statistics
status*
bool		 Include status information
system_log*
bool		 Include system logs
user_credentials*
bool		 Include user credentials
target
string		 IP address of the diagnostic package origin remote device. If not set, local device is used.
encryption_passphrase
string		 A passphrase used to encrypt the package. If not sent, the file will not be encrypted. Null in returned parameters.

Output

attribute description
delete_time*
unsigned int		 A Unix timestamp when diagnostic package will be automatically deleted unless it is deleted before as a consequence of it being downloaded
size*
unsigned int		 Size of the diagnostic package saved in device in bytes

Example

{
  "process": {
    "process_id": "abc123",
    "start_time": 1649399400,
    "input": {
      "verbosity": "base",
      "configuration": true,
      "event_logs": true,
      "statistics": true,
      "status": true,
      "system_log": true,
      "user_credentials": false,
      "target": "1.1.1.1",
      "encryption_passphrase": null
    }
  },
  "return_code": "success",
  "output": {
    "size": 21736,
    "delete_time": 1649723207
  }
}