Skip to content

diagnostic_package_start

Admin

Starts collecting data for a downloadable diagnostic package file.

If a diagnostic package already exists in device, it must be overwritten.

If diagnostic package data collection is in progress, an error must be returned.

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 target parameter bellow.

Params

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.

Return

attribute description
process_id*
string
An ID of the started process