Skip to main content
Version: 0.10

Modules

A module is an optional part of the console that works on top of the asset inventory. The inventory, scanning, integrations and reports are always there; a module adds analysis for one specific question, such as which assets have gone quiet or which paid licences nobody uses.

Modules are switched per tenant. Every tenant can use a different set, and a module a tenant does not use stays out of its navigation entirely.

The modules​

ModuleWhat it answersFed by
CoverageHow much of the inventory each agent integration covers, and which assets it missesElastic Agent, CrowdStrike, Nessus Agents
DecommissioningWhich assets no integration has seen for a while, and the clean-up that followsEvery discovery integration the tenant runs
License OptimizationWhich paid seats nobody uses, what they cost, and what removing them savesAtlassian Users, Azure Users
VulnerabilitiesWhat the vulnerability scanners found, open and fixed, against each asset's owner, department, location and criticalityTenable Security Center

In the console the modules sit in the sidebar under Modules. Each module reads data the tenant's integrations have already brought into the inventory: a module never connects to a source system itself, so it shows nothing until the integrations that feed it have run.

Switching modules for a tenant​

Every module is on for a tenant until someone switches it off.

  1. Open the tenant and go to Settings → Global.
  2. Find the Modules card. It lists every module with its description, when it was last changed (or Never) and an Enabled switch.
  3. Flip the switch. The change is saved at once; there is no separate save button.

Everyone with access to the tenant can see the card. Only the people described below can flip a switch; everyone else sees the switches disabled and the note "Only a tenant manager or this tenant's Project Admin can switch modules."

Who can switch modules​

WhoWhy
A user whose global role grants Tenant Management with write accessThe same right that lets them edit the tenant's name
A user who holds the built-in Project Admin role on that tenantThe tenant's own administrator

The Project Admin rule applies to the built-in role only. A custom tenant role with the same permissions does not give the right to switch modules.

What happens when a module is off​

Switching a module off hides it and stops it working, but deletes nothing.

  • Navigation: the module leaves the sidebar and search for everyone on the tenant.
  • Direct links: someone who opens the module from a bookmark or a shared link sees a page saying "Module is switched off", with a link to the tenant settings (if they may switch it) or a pointer to the Project Admin, and a link back to the dashboard.
  • API: every request to the module's endpoints for that tenant (/api/v1/modules/<module>/...) is refused with HTTP 403 and the message "The Module module is disabled for this tenant".
  • Queued evaluations: a Decommissioning or License Optimization evaluation that was queued before the module was switched off is not run. It is recorded as failed with the same message.
  • Data: settings, stored evaluations, decisions and audit logs are kept. Switching the module back on brings everything back as it was.
Background workers

Decommissioning and License Optimization evaluations are carried out by background workers on the Velum Edge server, one evaluation at a time. A deployment can switch these workers off in its server configuration (they are on by default); evaluations requested while they are off stay queued.

Permissions inside a module​

Switching a module on does not change who can use it. Access inside each module follows the tenant role permissions:

ModuleTo viewTo change settings and act
CoverageModule Coverage read, plus Asset Management read for the count and chart tilesModule Coverage write
DecommissioningAsset Management readAsset Management write
License OptimizationAsset Management readAsset Management write
VulnerabilitiesAsset Management readAsset Management write

See Roles and permissions for the built-in roles and what they grant.