Skip to main content

1E SDK

Security.UnquarantineDevice

Method

UnquarantineDevice

Module

Security

Library

Security

Action

Allows devices to communicate with devices other than the Tachyon Switch and Background channel servers.

This is intended to be used after QuarantineDevice.

Changes made to routing tables, the hosts file, or IPv6 bindings during quarantine will be lost, as the agent will attempt to revert modifications it made back to a pre-quarantine state.

Warning

Ensure you understand the impact of using the Quarantine feature.

The quarantine methods are not suitable for use from Tachyon Instruction Management Studio (TIMS), mainly because of what they do (cut off the device from most connections) but also because no Tachyon Switch is involved with TIMS. If you must use this method in TIMS (which is not recommended) then you will need to give a true value to the Force parameter.

For more information about using the Quarantine feature, please refer to Tachyon Explorer - Tachyon Quarantine.1E Quarantine

Parameters

Reboot (bool, optional, default false): Reboot the device after Unquarantine.

Return values

Status (string): The quarantine status. If the response is a success, this will be NotQuarantined.

Note

If the device was already in a quarantined state, the action is successful but nothing is returned ("success no content").

Example

Security.UnquarantineDevice();

Security.UnquarantineDevice(Reboot: true);

Platforms

  • Windows

Notes

  • Quarantine requires working persistent storage.

    • If persistent storage is removed or corrupted during quarantine, the agent will be unable to revert to an unmodified state.

  • Upgrading the agent whilst under quarantine is not supported or recommended.

  • Rebooting device after the Unquarantine operation can solve localhost connection issues

In this section: