From 564ed8c467ce11d5961fb4ed12ffa64b94629ed9 Mon Sep 17 00:00:00 2001 From: Seth Grover Date: Fri, 7 Jul 2023 07:41:17 -0600 Subject: [PATCH] work in progress for auto-population, idaholab/Malcolm#135 --- docs/asset-interaction-analysis.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/asset-interaction-analysis.md b/docs/asset-interaction-analysis.md index c9b1995bc..72cc151e5 100644 --- a/docs/asset-interaction-analysis.md +++ b/docs/asset-interaction-analysis.md @@ -92,7 +92,7 @@ The following elements of the NetBox data model are used by Malcolm for Asset In ## Populate NetBox inventory via passively-gathered network traffic metadata -If the `LOGSTASH_NETBOX_AUTO_POPULATE` [environment variable in `./config/logstash.env`](malcolm-config.md#MalcolmConfigEnvVars) is set to `true`, [uninventoried](#NetBoxCompare) devices observed in known network segments will be automatically created in the NetBox inventory based on the information available. +If the `LOGSTASH_NETBOX_AUTO_POPULATE` [environment variable in `./config/logstash.env`](malcolm-config.md#MalcolmConfigEnvVars) is set to `true`, [uninventoried](#NetBoxCompare) devices observed in known network segments will be automatically created in the NetBox inventory based on the information available. This value is set to `true` by answering **Y** to "Should Malcolm automatically populate NetBox inventory based on observed network traffic?" during [configuration](malcolm-config.md#ConfigAndTuning). However, careful consideration should be made before enabling this feature: the purpose of an asset management system is to document the intended state of a network: with Malcolm configured to populate NetBox with the live network state, a network misconfiguration fault could result in an **incorrect documented configuration**.