Network and MikroTik
This page describes how COD collects switches and routers, how the topology is built from that data, what you need to set up and where the limits are.
What the module does is described on the module page.
As of: November 2026, COD 3.8.6
Documentation contents
- Overview
- Getting started
- Requirements
- Names and addresses
- Network devices
- Time and DNS
- Installation
- Deployment shapes
- Initial setup
- Updates
- Modules
- Network and MikroTik
- Automation
- NAC
- TACACS+
- Firewall
- Captive Portal
- Monitoring
- Backup
- Hypervisor
- OTP
- Passkeepr
- GRC
- Inventory and CMDB import
- Troubleshooting
- Security
- Versions
- Version history
- Support
Documentation
- Overview
- Getting started
- Requirements
- Names and addresses
- Network devices
- Time and DNS
- Installation
- Deployment shapes
- Initial setup
- Updates
- Modules
- Network and MikroTik
- Automation
- NAC
- TACACS+
- Firewall
- Captive Portal
- Monitoring
- Backup
- Hypervisor
- OTP
- Passkeepr
- GRC
- Inventory and CMDB import
- Troubleshooting
- Security
- Versions
- Version history
- Support
Overview
| Item | Value |
|---|---|
| Purpose | Collects ports, VLANs, clients, LLDP neighbours, PoE and routes. Layer 2 and layer 3 map, Route Trace, Port History, SSH terminal |
| Collection | Nine vendors: Allied Telesis, Arista, Aruba (CX, AOS-S), Cisco (IOS, IOS XE, Nexus), Extreme, Juniper, MikroTik, Ruijie, Sophos |
| Configuration | Three vendors: Allied Telesis, Cisco, Ruijie. See Automation |
| Protocols | SNMP v1 and v2c, SSH, optionally a vendor API. For MikroTik also the RouterOS REST interface |
| Direction | The COD server opens all connections to the devices. No agent runs on the devices |
| Collector | Runs inside the COD backend on the COD server. Not a separate service, not a separate server |
| Credentials | SNMP community, SSH user and password, enable password if needed, optionally API user and API password. COD stores them encrypted |
| Firewall rules | Customers and partners receive the list of connections and firewall rules as part of the project. |
Requirements
On the device
| Requirement | Why |
|---|---|
| SNMP v1 or v2c with a community, read-only. The port MIB (IF-MIB) must respond | Port discovery and port status. If SNMP port discovery fails, the whole query counts as failed |
| SSH server enabled, a dedicated user for COD, paging can be turned off | Reads LLDP, clients, VLANs and routes through the CLI. Terminal |
| LLDP transmit and receive on all switch and router ports | Edges in the layer 2 map come only from LLDP |
| LLDP TLVs system-name, system-description, system-capabilities, management-address, port-description | Without system-name the device has no name for its neighbours |
| Hostname on the device equals the asset name in COD | COD matches LLDP neighbours to an asset by their system name |
| Fixed management address, static or by DHCP reservation | The network object is tied to the IP address |
| Device access restricted to the source address of the COD server | All queries come from the COD server |
| Rights of the COD user: read access for collection | You receive the minimum rights as part of the project. |
Note: With SNMP v1 and v2c the community travels unencrypted over the network. Allow SNMP only in the management network and restrict access with an access list to the source address of the COD server.
In COD
- Network module enabled for the tenant, rights granted for the location.
- Asset with the network flag, the correct vendor and the correct model with its family. Vendor and family decide which collector runs. An unknown vendor results in an error.
- Asset name at most 50 characters, unique across the installation.
- For the layer 3 map: the “Routing” switch on the network object.
- For the terminal: the Remote module and a user name on the network object.
- Whether SSH keys can be used instead of passwords is clarified in the project.
Internet access
Once a week COD downloads the list of MAC vendors from the internet. The “Vendor Dashboard” uses it to identify the vendors of clients. A proxy must not block this download. You receive the address as part of the project.
The full checklist for your devices is in Preparing network devices. How to name devices is described in Names and addresses.
Setup
- Create or import the asset. Set vendor, family and model from the catalogue.
- Turn on the network flag on the asset.
- Create the network object: IP address, credentials and the query types SNMP, SSH and, if needed, API.
- Turn on “Routing” if the device routes and should appear in the layer 3 map.
- After the first query, check the status of the object. If it shows “port discovery failed”, check SNMP first.
- Check the layer 2 map. If an edge is missing, compare the neighbour’s LLDP system name with the asset name.
Fields of the network object
| Field | Meaning |
|---|---|
| Asset | the related asset |
| IP address | management address of the device |
| SSH port | port of the SSH service on the device |
| User, password | SSH login |
| Enable password | only needed if the enable secret differs from the login password, for example on Cisco |
| SNMP community | community for SNMP v1 or v2c |
| Switches SNMP, SSH, API | which query types COD uses for this device |
| Switch Routing | collect routes and addresses for the layer 3 map |
| Update cron | separate schedule for the full query of this device |
| API port, API user, API password | access to the vendor API. The API port has no default |
| SSH host key, key exchange, cipher | SSH algorithms for older devices. Only an administrator sets these fields |
Vendor API
For some vendors the collector also uses the device API. Example Aruba CX: COD talks to the switch’s REST interface over HTTPS, on the port given in the API port field. Enter API port, API user and API password and turn on API.
MikroTik
You keep RouterOS routers in the MikroTik module in a router list of their own. The module provides the router nodes of the layer 3 map.
| Item | Value |
|---|---|
| Purpose | Routes for the layer 3 map, live views, WinBox address, SSH terminal |
| Sync | through the router’s REST interface. For the MikroTik sync, the router’s REST interface must be reachable for COD. You receive the details as part of the project. |
| Terminal | SSH from the COD server to the router |
| Direction | COD server to router |
| Rights | a dedicated user for COD with REST access and few rights. You receive the minimum rights as part of the project. |
Preparing the router
- Make the router’s REST interface reachable for COD and restrict access with an address list to the source address of the COD server. You receive the details as part of the project.
- Enable SSH and restrict it in the same way.
- Create a dedicated user for COD. Give it only the rights the sync needs.
- Add the router to the router list of the MikroTik module.
MikroTik in the layer 2 map
A router in the MikroTik list is not automatically a network object. How to keep MikroTik routers in the layer 2 map is clarified in the project.
Further notes
- Edit a router only while it is reachable. Editing a router that is offline deletes its stored routes.
- RouterOS has no TACACS+ client of its own. Manage logins to the router with RouterOS tools.
- Your partner gives you guide values for many devices.
Technical details
Collector and polling
| Value | Default |
|---|---|
| Port status via SNMP | every 30 seconds |
| Full query | on a schedule (“Update cron” in the backend configuration), can be overridden per device |
| Clients of a switch | additionally at most every 5 minutes |
| Query timeout | after 20 minutes |
| Concurrent sessions (SNMP, SSH, API) | at most 5, set in “Backend config”, section “Network” |
| Topology cache | 6 hours, rebuild no sooner than after 5 minutes |
| Port History | 90 days |
| Capacity per collector | Your partner gives you guide values for many devices. |
Note: Saving in “Backend config” restarts COD for all users. If you do not confirm the change, COD returns to the previous setting after 120 seconds.
Layer 2 topology
- Nodes are the network objects.
- Edges come from the LLDP neighbours of switches and routers.
- COD matches a neighbour to an asset by its LLDP system name. The comparison is exact.
- The map shows speed and LACP status of the links.
- You draw devices without LLDP into the map by hand.
Layer 3 topology
- Nodes are routing switches with the “Routing” switch, routers from the MikroTik module and firewalls from the Firewall module.
- Route Trace follows the routes across these devices.
- COD collects IPv4 routes from the global routing table.
Clients
- COD reads the clients of each switch with MAC and IP address.
- The “Vendor Dashboard” assigns clients to a vendor using the MAC vendor list.
- From the client list you start ping and port scan. Both run from the COD server against the client address.
Terminal and web interface
- The terminal is an SSH session in a browser window. The COD server opens the connection to the device with the stored credentials.
- Browser and COD use WebSocket for this. A reverse proxy in front of COD must pass WebSocket and server-sent events. You receive a sample configuration as part of the project.
- The terminal offers no RDP or VNC.
- “Open web UI” only opens a link in the user’s browser. The browser must reach the device itself.
Known limits
| Limit | What you can do |
|---|---|
| A layer 2 edge appears only if the LLDP system name exactly matches an asset name | One name for each device in all systems. See Names and addresses |
| Devices without LLDP do not appear in the map automatically | Draw them by hand. Monitor their availability through Monitoring |
| Switches without a port MIB stay at “port discovery failed” | Keep such devices as an asset without a network object, or use devices with IF-MIB |
| A query counts as failed if SNMP port discovery fails, even if SSH worked | Check community, access list and SNMP reachability from the COD server first |
| SNMP only in v1 and v2c | Read-only community, management network, access list to the source address of the COD server |
| Layer 3 only with IPv4 and only with the global routing table | Document routes in VRFs and IPv6 routes separately |
| Only an administrator sets SSH algorithms for older devices | Involve an administrator for such devices |
| COD does not pick up changes to addresses and credentials by itself | Update COD after every change on the device |
| Rights apply per location, not per device | Split locations the way you want to grant rights |
| Editing a MikroTik router that is offline deletes its stored routes | Edit routers only while they are reachable |
| No TACACS+ for MikroTik | Manage logins to the router with RouterOS tools |
| MikroTik routers in the layer 2 map | Clarify this in the project. |
Further reading
- Network module page
- Preparing network devices
- Names and addresses
- What your network needs for the Network module
- Configuring switches with the Automation module
- Troubleshooting
- Questions about the modules
- Handout “Preparing COD: requirements” as a PDF on the Downloads page
- Support: your partner is your first point of contact. Technical questions to extocode go through the helpdesk form.