Skip to content

Quarantine a device with Crux Admin

Crux Admin lists your organization's devices inside ATAK and lets you quarantine or release one. Quarantine withdraws the device's key, so its tunnel stops and stays down until you release the device. Nothing is installed or changed on the handset that you quarantine, and other devices aren't affected.

Before you begin

Make sure that you have the following:

  • ATAK-CIV with the Crux Admin plugin installed and loaded. Its download address is on the overview page. Install and load it the same way as the Crux plugin, in steps 2 and 4 of Install on a handset.
  • An internet connection. Crux Admin doesn't need a tunnel.
  • A Crux org-admin account that doesn't use multi-factor authentication. Crux Admin signs in with a user ID and password only.
  • An admin-setup.conf file in the handset's Downloads folder.

Write admin-setup.conf

The file holds the address of your Crux API and the account's sign-in details. Save the following as admin-setup.conf, where CRUX_URL is the address of your Crux web UI:

[Admin]
Api = CRUX_URL/api
User = ADMIN_USER_ID
Password = ADMIN_PASSWORD

The Api value ends in /api. Don't copy the address from a handset's crux-setup.conf, which ends in /api/g and refuses admin sign-ins.

Warning

This file contains a live org-admin password. Send it over a channel that you'd trust with a credential, separately from the plugin download link, and change the password if a copy goes astray.

You can load the same file on any number of handsets, as many times as you need. Everyone who loads it acts as that one account.

Load the configuration

  1. In ATAK, tap ☰, then Crux Admin.
  2. Tap Load Config (admin-setup.conf).
  3. In the file browser, go to Downloads and tap admin-setup.conf.

Crux Admin signs in and lists your organization's devices. Each device shows its SKA-Platform name, which starts with atak-, with its Crux host name beneath.

Quarantine a device

  1. Find the device by its Crux host name. Callsigns aren't shown.
  2. Tap Quarantine next to the device.
  3. Check the device name in the confirmation, then confirm.

The device shows QUARANTINED, and its button changes to Unquarantine.

Within about ten seconds, the handset can no longer renew its key, and its tunnel stops passing traffic. The Crux pane on that handset can still show Connected, with a byte count that no longer changes. To confirm that the quarantine worked, watch the device's marker go stale on another handset's map.

Release a device

  1. Tap Unquarantine next to the device.
  2. Check the device name in the confirmation, then confirm.

The handset recovers on its own, and nobody needs to touch it. The tunnel returns within 5 minutes. If it doesn't, see Troubleshooting.

Use the Crux web UI instead

The same two actions are in the Crux web UI. Go to Hosts, select the host, then select the Device link in the host panel.