Skip to main content

1E 8.1 (on-premises)

Security.GetQuarantineStatus

Method

GetQuarantineStatus

Module

Security

Library

Security

Action

Gets the current quarantine status of the device.

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.

Parameters

Return values

Status (string): The quarantine status. This can be one of four values:

  • Quarantined: The device is currently under quarantine

  • NotQuarantined: The device is not currently under quarantine

  • UnknownValue: The device may be under quarantine, but persistent storage may be damaged, as some values are unexpected

  • UnknownNoSPS: The device is unable to read its persistent storage. Quarantine status is unknown, and the device cannot be quarantined (or unquarantined) until persistent storage is available.

Example

Security.GetQuarantineStatus();

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.

In this section: