Discovery Options
Reference for all discovery options used by multi-VLAN discovery. For the setup context in which these options are used, see Discovery over VXLAN or Discovery over Trunk Port.
To run a discovery job in multi-VLAN mode, set the discovery option type to VXLAN or VLAN and
provide the remaining parameters listed below. If type is omitted or set to any other value, the
job runs as a standard discovery and the multi-VLAN parameters are ignored.
Note
All discovery options listed below must use the EQUAL comparison operator. Other operators are
not supported for multi-VLAN discovery parameters.
Common options
These options apply to both VXLAN and VLAN mode.
| Key | Required | Description | Example value |
|---|---|---|---|
type |
Yes | Marks the job as a multi-VLAN discovery job. Set to VXLAN for a VXLAN overlay or VLAN for an 802.1Q trunk port. |
VXLAN |
segmentId |
Yes | Identifier of the target VLAN. In VXLAN mode this is the VXLAN Network Identifier (VNI) configured on the user-side VXLAN endpoint. In VLAN mode this is the 802.1Q VLAN ID carried on the trunk port. |
200 |
parentInterfaceName |
Conditional | Name of the interface on the Asset Gateway host that carries the traffic: the underlay interface in VXLAN mode, or the interface connected to the trunk port in VLAN mode. Either parentInterfaceName or parentInterfaceIP must be provided; supplying both is optional. See Securing VXLAN Traffic for the VPN case. |
enp2s0 |
parentInterfaceIP |
Conditional | IP address of the interface on the Asset Gateway host that carries the traffic. | 192.168.4.19 |
vlanSubnet |
Yes | Subnet of the remote VLAN, in CIDR notation. Used to assign the probeIP to the interface created for the job and to route discovery traffic into the VLAN. |
192.168.2.0/24 |
probeIP |
Yes | IP address assigned to the interface created for the job and used as the source address for discovery probes. Must belong to vlanSubnet, must be free inside the target VLAN, and must not conflict with any existing host. |
192.168.2.47 |
networkScannerName |
No | Name of the container that runs the network scan. Supply it when the container cannot be resolved from the assetLinkId, for example when the Asset Link delegates the scan to a separate tool. If supplied, the assetLinkId is not used for container resolution. See Overriding the container name. |
SimaticAutomationTool |
VXLAN-only options
These options describe the tunnel endpoint. They apply only when type is set to VXLAN and are
ignored in VLAN mode.
| Key | Required | Description | Example value |
|---|---|---|---|
remoteIP |
Yes | IP address of the user-side VXLAN endpoint (VTEP) that terminates the tunnel and forwards traffic into the target VLAN. | 192.168.4.1 |
vxlanDstPort |
No | UDP destination port used by the VXLAN tunnel. Must match the port configured on the remote endpoint. Defaults to 4789. |
4789 |
Which options change per job
segmentId, vlanSubnet, and probeIP identify the target VLAN and therefore differ for every job.
The remaining options describe the Asset Gateway host and the remote endpoint and normally stay the
same across all jobs that share the same parent interface or the same VXLAN endpoint.
networkScannerName depends only on the Asset Link that is used and stays the same across all jobs
that target that Asset Link.