Enabled for swap

This section discusses how to enable swaps in VHQ as well as a demonstrational video on how to complete this action.

Keywords

Also called: device swap, swap approval. Search terms: enabled for swap, unauthorized device swap request, swapped out.

What is device swapping?

Devices associated with a device ID can be swapped — useful when a device is sent for maintenance and a backup device is provided with the same device ID. The device ID is mandatory for a swap. For the swap to take place, the Enabled for Swap option in VHQ > Device Profile must be checked.

If the VHQ server receives a message from another device trying to use the same device ID, it detects this as a swap request. If Enabled for Swap is not enabled for the device currently using that device ID, the VHQ server rejects the new device's message and generates the Unauthorized Device Swap Request alert.

VHQ allows you to set a device ID on devices that don't already have one, whether adding devices manually or through file import (XML or CSV).

No two active devices can share the same device ID, though you can configure two devices with the same ID as long as only one is active. This lets you enable a device for swap: when a new device registers with the same device ID, the older device is marked inactive and swapped.

There are two devices with serial numbers SN1 and SN2:

• SN1 (000-002-052) mapped to Device ID D1
• SN2 (000-002-053) mapped to Device ID D2

When device ID D2 swaps with D1, SN1 is mapped to device ID D2, and device ID D1 automatically creates a Template file storing its details (including all auto-download jobs related to D1). SN2 no longer shows a device ID in Device Search, and its Device Profile screen displays the device ID as N/A. D2's auto-download jobs are assigned to SN1, and D1 and D2's manual download jobs are removed.

Enable a device for swap

When you want to swap an existing device with a new one, the Enabled for Swap option must be checked on the existing device's Device Profile. Once checked, the VHQ server accepts a registration request from another device using the same device ID, and the original device enters the Swapped Out state.

1

Set Swap Approval Required

Before enabling a device for swap, set Swap Approval Required to True in Administration > System Configuration.

If you can't see the Swap Approval Required configuration, go to Administration > System Configuration and apply the following to the database: Internal use = 0, Visibility Type = 1, Display category Name = system, Display config Name = Swap Approval Required.

2

Enable the checkbox

Select the Enabled for Swap checkbox on the Device Profile screen.

Based on the MBT (Model Boarding Template), the implementation team prepares a Device Profile Template with a Visible attribute set to 1. The Swap Approval Required configuration must also be set to True to view the Enabled for Swap checkbox.

Swapping scenarios

Swapping a device model with a different model is restricted — devices can only be swapped with another device of the same model. Example: a Vx570 device can only be swapped with another Vx570, not any other model.

Device swapping automatically assigns and downloads the old device's software to the new device as soon as it registers with the same device ID.

Consider existing device A being swapped with device B under the same device ID:

• Device A is marked Inactive, with sub status set to Swapped Out.
• Device A's device ID is set to blank.
• Any software assignment or reference set for device A is removed.
• Parameters and reference set are copied from device A to device B; parameter editing is supported for devices that inherit a reference set or package.
• Parameters must be downloaded to device B even if its application version is already in sync with the server.

Device Profile displays details of both the new and swapped devices. You can view swap history by device ID and serial number in the Reports tab.

Device swapping can happen during any communication — Events, Maintenance Heartbeat, or Regular Heartbeat — but not while a device is in the Deleted or Blacklisted status. The device ID remains unique within the same model among active devices.

VHQ Device Swap Demo

View the video below for a demonstration of how to enable swaps in VHQ. See the VHQ Demo Videos section for more videos.