Online Help

Tools Reference (admin)

Reference for the per-Site Tools catalog: catalog management, invocation model, and RBAC.

Admin Center > Site Settings > Customization > Tools.

Catalog scope

  • The catalog is per-Site. Tools defined in one Site are not visible in another.
  • The catalog is a mix of fourteen built-in entries (shipped with AlloyScan, not editable) and zero or more custom entries (defined by the Site Administrator).

For the operator-facing list of the fourteen built-ins, their purpose, and typical OS scope, see Built-in Tools Reference in the User Guide.

Custom tool fields

Field Required Description
Name yes The label that appears on the Tools menu on a device form.
Invocation template yes The command the Alloy Integration Launcher runs on the operator's workstation. May reference device attributes via placeholders (the exact placeholder syntax may vary by deployment).
Target OS gating yes Restricts which devices show the tool, based on the audited operating system.

Note: Additional optional fields on the custom-tool form may vary by deployment.

Invocation model

Every Tool — built-in or custom — runs through the same path:

  1. The operator clicks the tool on a device form.
  2. The browser passes the tool definition and the device's address parameters to the Alloy Integration Launcher running on the operator's workstation.
  3. The Launcher invokes the local executable named in the invocation template, substituting the device attributes into the arguments.
  4. The local executable connects to the device.

Two operational consequences follow from this model:

  • The Launcher must be installed on each operator's workstation. Without it, the Tools menu does nothing.
  • The local executable named in the invocation must be installed and reachable on the operator's workstation. AlloyScan does not ship the local clients (Remote Desktop, VNC viewer, terminal, ping, traceroute, etc.).

Constraints

  • Tools execute on the operator's workstation, not on the audited endpoint or on AlloyScan's servers.
  • AlloyScan does not retain output from a tool invocation and does not log per-invocation results.
  • Built-in tools cannot be edited or deleted; they can only be hidden from operators by adjusting the device-OS gating that AlloyScan applies automatically.
  • Custom tools persist until explicitly deleted by an administrator.

RBAC

Action Site Administrator Site User
Open the catalog yes no
Add custom tool yes no
Edit custom tool yes no
Delete custom tool yes no
Invoke a tool from a device form yes yes