Device Diagnostics - Page 2

The list of available diagnostic actions includes:

Action Name

Description

Get App Parameter Files

VHQ Agent in the device will get the Parameter files and send it to the VHQ Server either during the next heartbeat or the next maintenance window or on the specified date and time.

Get Device Profile

VHQ Agent in the device will get the Device Profile details and send it to the VHQ Server, either during the next heartbeat or the next maintenance window, depending on which one of these two options is selected.

NOTE: The VHQ Server automatically collects the device profile information from all devices in the following scenarios:

a. Each time a device is rebooted.

b. Each time the VHQ Agent performs a key-exchange operation with VHQ Server.

c. Once in 24 hours.

Get Diagnostics Data

VHQ Agent in the device will get the Diagnostic Data details and send it to the VHQ Server, either during the next heartbeat or the next maintenance window, based on which of these two options are selected.

NOTE: The Get Diagnostic Data diagnostic action is supported only if the license for the VHQ Diagnostic module has been activated.

The VHQ Server automatically collects the diagnostic data from all devices, each time a device is rebooted, as well as once every 24 hours.

Get OS Config File

For the Get OS Config file operation, the VHQ Agent will retrieve the following files from the device and upload it to VHQ Server as a zip file. Once this action is completed, click View Result Details link next to this action in the Diagnostic History tab in the Device Profile screen to download this file.

For MX8 devices, the files that are uploaded are: /mnt/sram/config.*

For MX9 devices, the files that are uploaded are: /mnt/flash/config/config.system /mnt/flash/config/config.network /mnt/flash/config/config.usr1

Get OS Logs

For the Get OS Logs operation, the VHQ Agent will retrieve the following files from the device and upload it to the VHQ Server as a ZIP file. Once this action is completed, click View Result Details link next to this action in the Diagnostic History tab in the Device Profile screen to download this file.

For MX8 devices, the files that are uploaded are: /tmp/dmesg /var/log/messages.* /mnt/sram/messages* /mnt/sram/VHQ/VHQlog* /etc/osupgrade.log /etc/*version.

For MX9 devices, the files that are uploaded are: /tmp/dmesg /tmp/diag_counters /var/log/messages /etc/issue /etc/*version /tmp/package_list /mnt/flash/logs/ /root/crt/certfile.sys /tmp/DUMP-*

NOTE: The VHQ Agent log files are also captured as part of Get OS Logs operation.

Get User Logs

For the Get User Logs operation, the VHQ Agent will retrieve the following files from the device and then upload it to the VHQ Server as a ZIP file. Once this action is completed, click View Result Details link next to this action in the Diagnostic History tab in the Device Profile screen to download this file.

For MX8 the files that are uploaded are: /home/usr1/*.log and /home/usr1/messages*

For MX9 the files that are uploaded are: /home/usr1/logs/*

NOTE: Ensure that the log files created by applications under the /home/usr1 directory have Read permission sets for all users. This is required as the VHQ Agent can read these log files and upload these log files to the VHQ server.

List User Files

For the List user files operation, the VHQ Agent will upload a text file that contains the details of certain user files on the device. Once this action is completed, click on the View Result Details link next to this action in the Diagnostic History tab in the Device Profile screen to download this file.

For MX8 and MX9 devices, the details of all files and folders under the /home/usr1 directory are included in the text file that is uploaded to VHQ Server.

Reboot

VHQ Agent will reboot the device.

NOTE: If you want to schedule the Reboot or Restart Applications diagnostic actions, please ensure that these actions are scheduled separately and NOT along with other diagnostic actions. Once these actions have been completed, then you can schedule other diagnostic actions for the given device.

EXAMPLE: If you want to schedule the Capture Screen, Get OS Logs and Reboot diagnostic actions for a device, please ensure that you first schedule the Capture Screen and Get OS Logs diagnostic actions and only then schedule the Reboot diagnostic action. Since the VHQ Agent in the device will execute the actions in the order in which the actions were scheduled, the Reboot diagnostic action will be performed after the other two actions and it will all work correctly.

The Reboot diagnostic action must be scheduled separately and NOT along with other diagnostic actions. Once this diagnostic action has been completed, then you can schedule other diagnostic actions for the given device.

5. You can choose the actions to be performed at the following options:

  1. Maintenance Window: The selected action will be scheduled to the devices when they send their next Maintenance Heartbeat message to the VHQ server.
  2. Next Contact: The selected action will be scheduled to the devices when they send their next Heartbeat message to the VHQ server.
  3. Date and Time is provided (which refers to device local date and time), then the selected action will be scheduled at this time, even if it occurs during the business hours of the user.

NOTE:

  • Scheduling multiple diagnostic action features is supported only for the devices with VHQ Agent version 1.06.0007 or higher.
  • Diagnostic actions like Reboot can be performed in any order if the VHQ Agent version of the device is 1.06.0007 or later.
  1. You can schedule recurring diagnostics actions. The options available are None, Hourly, Daily, Weekly or Monthly. You can select from these different actions for each of your recurring actions. The Action Recurrence option is available only when you select the date and time for the available action to be scheduled.
    1. None: Indicates no occurrence of diagnostic actions.
    2. Hourly: Indicates the selected diagnostic action to be scheduled hourly. You can set the hours for the actions to recur or set the number of occurrences after which the action ends or schedule the action to end at particular date and time.
    3. Daily: Indicates the selected diagnostic action to be scheduled every day.
    4. Weekly: Indicates the selected diagnostic action to be scheduled once in a week.
    5. Monthly: Indicates the selected diagnostic action to be scheduled every month.
  1. Click View Results link under Results column to view the status of the devices on the completion of the diagnostic action.
  1. Succeeded Devices: Indicates the list of devices successfully performed this action and it has notified the VHQ Server about the successful completion of this diagnostic action.
  2. Failed Devices: Indicates the list of devices unable to successfully perform this action and notify the VHQ Server.

NOTE:
Diagnostics action can be cancelled after receiving the Heartbeat, and also when it is in recurrence state.

A Diagnostic action with a future action time is treated as two Operation Sets on the device, where the first Operation Set is the Diagnostic action and the second is recurrence. In such a scenario, if the Diagnostic action has started, you can still cancel recurrence operation sets prior to the install time. When you opt to cancel the recurrence operation, then the VHQ Agent will return a status as Success with additional information field set to Cancel Operation Successful.

Once an operation set begins to execute, it cannot be cancelled.