Preparing network devices
This page describes what your network devices must support for COD and how to check it.
As of: November 2026, COD 3.8.6
Documentation
Overview
COD reads and controls network devices through standard protocols. COD installs no agents on the devices.
| Protocol | Purpose | Direction | Required |
|---|---|---|---|
| LLDP | Device neighbours, edges of the layer 2 map | between the devices. COD reads the neighbours over SSH or a vendor API | required for the topology |
| SNMP v1 or v2c | Port discovery, port status, uptime | COD to the device | required for the Network module |
| SSH | Neighbours, clients, VLANs, routes, terminal, backup, configuration | COD, Backup service or Ansible service to the device | required |
| Vendor API | Discovery through the vendor's interface | COD to the device | optional |
| RADIUS | Network access with NAC | Device to the NAC service | with NAC |
| TACACS+ | Administrator login on the device | Device to the TACACS+ service | with TACACS+ |
Customers and partners receive the list of connections and firewall rules as part of the project.
COD discovers devices from nine vendors: Allied Telesis, Arista, Aruba, Cisco, Extreme, Juniper, MikroTik, Ruijie and Sophos. Allied Telesis, Cisco and Ruijie can also be configured.
LLDP
| Requirement | Why | Check |
|---|---|---|
| Send and receive LLDP on all ports of switches and routers | Edges of the layer 2 map come from LLDP only | The device's neighbour view shows the neighbours |
| TLV system-name | COD matches a neighbour to an asset by its system name only. Without a system name the device is nameless to its neighbours | The neighbouring device's neighbour view shows the system name |
| TLVs system-description, system-capabilities, management-address, port-description | Complete information on neighbour and port | The neighbour view shows description, capabilities, address and port |
| System name equal to the asset name in COD, character for character | otherwise no edge | Compare the system name in the neighbour view with the asset name |
Devices without LLDP, such as cameras, storage systems or building technology, do not appear in the topology automatically. You can draw these devices in by hand. You monitor their availability through the Zabbix connection.
More on naming: One name for everything
SNMP
COD queries SNMP in versions 1 and 2c with a community.
| Requirement | Why | Check |
|---|---|---|
| SNMP v1 or v2c with a community | Port discovery, port status and uptime | SNMP query from the COD server |
| Read-only community | COD only reads over SNMP | Community on the device without write access |
| Access list for the COD source address, plus the Zabbix proxy if Zabbix polls the device over SNMP | The community is transmitted without encryption | A query from another address is rejected |
| SNMP only in the management network or through VPN | Limits who can read the community | Network plan and access lists |
| The port MIB (IF-MIB) responds | Without it, port discovery fails | An SNMP query of the IF-MIB from the COD server returns the ports |
Polling: COD polls port status every 30 seconds. The full query runs on a schedule that can be set per device. Port history goes back 90 days.
| Limit | What you can do |
|---|---|
| COD queries SNMP in versions 1 and 2c | Use a read-only community, restrict it to the COD source address, allow SNMP only in the management network or through VPN |
| If SNMP port discovery fails, the whole query counts as failed, even if SSH worked | Check SNMP and the access list first |
| Small switches without a port MIB stay in the status "port discovery failed" | Keep these devices as assets and draw them in the topology by hand |
SSH
| Requirement | Why | Check |
|---|---|---|
| SSH server enabled on the device | Neighbours, clients, VLANs, routes, terminal, backup and configuration run over SSH | Log in from the COD server |
| A dedicated user for COD, not a personal account | Traceability in the device log | Logins in the device log |
| Read rights for discovery and backup, configuration rights only for automation | Rights as small as possible. You receive the minimum rights as part of the project. | Run the discovery commands as this user |
| SSH only from the management network and from the source address of COD and the module servers | Limits the attack surface | A login from another address is rejected |
| Paging can be switched off | COD reads command output in one piece | Long output without interruption |
| Login with user name and password | The network object stores user name and password. Whether SSH keys can be used instead of passwords is clarified in the project. | |
| Enable password only if the enable secret differs from the login password, for example on Cisco | Access to privileged mode |
Older devices: on the network object you can set the SSH host key, key exchange and cipher. An administrator makes this setting in COD.
Session limit: many devices allow only a limited number of simultaneous SSH sessions. By default the COD collector opens at most 5 sessions at a time. If many backups run against the same target, stagger the start times.
| Limit | What you can do |
|---|---|
| Configuration backup requires SSH or SFTP on the device | Clarify devices without SSH with your partner in advance |
Vendor API
For some vendors, COD can use the vendor's interface instead of the CLI. On the network object, enter the API port, API user and API password, and switch on "API". One example is Aruba CX with its REST interface over HTTPS.
RADIUS with NAC
| Requirement | Why | Check |
|---|---|---|
| The device supports 802.1X or MAC authentication | Basis of NAC | Data sheet or device configuration |
| RADIUS source address equal to the device's management address | Otherwise no NAC sessions appear on the port | NAC sessions appear on the switch port in COD |
| Shared secret identical in COD and on the device | Otherwise the RADIUS server rejects the request | Test login on a port |
| Send accounting | Connection statistics | Accounting entries in NAC |
More: NAC module in the documentation
MikroTik
Routers running RouterOS are kept in the MikroTik module. It provides the routes for the layer 3 map, live views and the terminal.
| Requirement | Why | Check |
|---|---|---|
| Router’s REST interface reachable for COD | For the MikroTik sync, the router’s REST interface must be reachable for COD. You receive the details as part of the project. | A query from COD returns routes and interfaces |
| Access to the REST interface restricted to the COD source address | Only COD should reach it | Access from another address is rejected |
| A dedicated user with small rights | Traceability and a small attack surface. You receive the minimum rights as part of the project. | Logins in the router log |
| SSH enabled | Terminal and backup | Log in from the COD server |
| Field note | What you can do |
|---|---|
| RouterOS allows only a limited number of simultaneous SSH sessions, 20 in practice | Stagger backup start times |
| Backup by export usually needs full rights on the router in practice | Create a dedicated user just for backup |
| Routers in the MikroTik module do not appear in the Network inventory by themselves, and so not as nodes of the layer 2 map | Clarify in the project how to keep MikroTik routers for the layer 2 map |
| RouterOS has no TACACS+ client of its own | Do not connect MikroTik routers through TACACS+ |
Firewalls
COD manages firewalls from AIMdefense, OPNsense, pfSense and DynFi. The self-registration plugin and Captive Portal are available for OPNsense only.
| Requirement | Why | Check |
|---|---|---|
| Asset with the built-in asset type "Firewall". Do not rename the type | COD recognises firewalls by this type | Type on the asset |
| Asset enabled, vendor set | Selects the right connection | Details on the asset |
| API user with API key and API secret. Administrator by default. Without administrator rights, the layer 3 map needs at least the rights "Interfaces: Virtual IPs: Status" and "System: High Availability" for clusters | Firmware, state, VPN, aliases, zones. You receive the minimum rights as part of the project. | A query from COD returns the state |
| SSH user on the firewall | Reading rules and terminal | Log in from the COD server |
| Your own CA stored in COD if the firewall uses a certificate from your CA | Verification of the peer | Query without certificate errors |
| Reachability through ICMP and a connection attempt to the API | COD checks reachability regularly | Status in COD |
| With the plugin only: the firewall reaches COD's address | The firewall registers itself with COD once | The firewall appears in COD for approval |
More: Firewall module in the documentation
Access points
| Requirement | Why | Check |
|---|---|---|
| Access point name in the controller equal to the asset name | Then COD draws the edge between access point and switch | Edge in the layer 2 map |
| LLDP on the access point and on the switch port | The switch learns the access point as a neighbour | The switch's neighbour view |
Vendor notes
The general requirements on this page apply to all nine vendors. You receive the minimum rights as part of the project.
| Vendor | Field note |
|---|---|
| Allied Telesis | The optional LLDP TLVs are selected per port (lldp tlv-select). Configuration through automation is possible |
| Aruba | Aruba CX can optionally be discovered through its REST interface over HTTPS |
| Cisco | Enter an enable password only if the enable secret differs from the login password. Configuration through automation is possible |
| MikroTik | See the section MikroTik |
| Ruijie | Configuration through automation is possible |
| Arista, Extreme, Juniper, Sophos | No verified notes beyond the general requirements |
On the asset in COD
| Requirement | Why |
|---|---|
| Network flag set on the asset | Only then does the device belong to the Network module |
| Vendor and model family maintained correctly | They decide which collector runs. An unknown vendor leads to an error |
| "Routing" enabled on the network object if the device routes | Needed for layer 3 and for addresses and VLANs |