Set custom UUIDs for asset correlation
If your assets are identified with additional Universally Unique Identifiers (UUIDs) beyond what Nexpose is designed to scan for, you can configure your Security Console to explicitly evaluate these custom UUIDs for asset correlation purposes.
You can define and configure custom UUIDs in the CustomEnvironment.properties
file in the installation directory of your Security Console.
Is this procedure for the same file I already have on my Scan Engines?
No. While the Security Console and any deployed Scan Engines can both have a CustomEnvironment.properties
file set, Nexpose uses them for different purposes. The custom UUID procedure detailed in this document is strictly for the Security Console’s CustomEnvironment.properties
file.
How to set custom UUIDs
Complete these steps to define a list of custom UUIDs that your Security Console should integrate after a scan:
- Access the host machine of the Security Console using SSH or your preferred method.
- Locate the
CustomEnvironment.properties
file within the Security Console installation directory. Default locations for this directory are as follows:- Linux -
/opt/rapid7/nexpose/nsc
- Windows -
C:\Program Files\rapid7\nexpose\nsc
- Linux -
Can’t find this file?
If the CustomEnvironment.properties
file does not exist, create it with a text editor.
- Append the following
com.rapid7.asset.agent.ids=
command to theCustomEnvironment.properties
file on a new line and specify your custom UUIDs. Separate multiple UUIDs with commas:
com.rapid7.asset.agent.ids=sourceID1,sourceID2,sourceID3
- If desired, append the following additional
com.rapid7.asset.agent.ids.display=
command on a new line to set display names for each of your custom UUIDs. If set, these values will be shown to you in Nexpose on your asset detail pages. Just like the previous command, separate multiple UUID display names with commas:
com.rapid7.asset.agent.ids.display=sourceID1:DisplayName
- Review your custom UUID definition list for accuracy. The following example shows what a final list could look like in
CustomEnvironment.properties
:
com.rapid7.asset.agent.ids=taniumagntid,azurecustid,otherID
com.rapid7.asset.agent.ids.display=taniumagntid:Tanium,otherID:MyProduct
- Save and close
CustomEnvironment.properties
to finish.
Custom UUIDs are set!
Nexpose can now use your custom UUID list for asset correlation.