Skip to main content

1E SDK

Security.ModifyQuarantineWhitelist

Method

ModifyQuarantineWhitelist

Module

Security

Library

Security

Action

Allows connections from additional specified IP addresses to an already-quarantined device. This allows security tools other than Tachyon to diagnose and protect the device.

It is an error, and the method will fail, if the device is not already in a quarantined 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

AddedIpAddresses (string): A comma-separated list of IPv4 addresses. Allow connections from these devices as well as those already in the quarantine whitelist.

Return values

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

Example

Allow connections from device at IP address 10.10.99.150 in addition to those already allowed.

Security.ModifyQuarantineWhitelist(AddedIpAddresses: "10.10.99.150");

Platforms

  • Windows

Notes

In this section: