Automation
This page describes how COD configures switches through the Ansible runner, 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 | Port, auth and VLAN profiles, VLAN Zones, rollout across port ranges and zones, cable test, port restart |
| Vendors | Allied Telesis, Cisco, Ruijie |
| Execution | Ansible runner as a separate service next to COD. It runs only COD actions, no playbooks of your own |
| Connection and direction | COD instructs the runner. The runner connects to the switch over SSH and reports the result back to COD |
| Credentials | SSH access from the network object. The runner keeps it encrypted in its vault |
| Location of the runner | on the COD server by default. By default it accepts only local connections |
| Database | none of its own |
| Firewall rules | Customers and partners receive the list of connections and firewall rules as part of the project. |
Requirements
On the switch
- SSH server enabled and reachable from the runner’s host.
- A dedicated user for COD with configuration rights. You receive the minimum rights as part of the project.
- For auth profiles: a RADIUS server, for example the NAC module.
In COD
- The switch exists as a network object. Collection in the Network module has run successfully at least once.
- The asset carries the vendor Allied Telesis, Cisco or Ruijie. Without a vendor, COD rejects the job before it contacts any device.
- The Ansible module is rolled out for the location.
- The location’s “Ansible Config” setting is filled in: API URL, schema, API key and vault password.
Setup
- Enable the module with the Manager account under “Admin Area > Tenant > Modules”. Then log out and log in again.
- Roll out the runner under “Admin Area > Module Rollout”: Ansible module, location, then Install, Connect, Configure and Apply.
- Check the location’s “Ansible Config” setting.
- Create the profiles under “Network > Config”: PORT, AUTH and VLAN.
- If needed, group switches into VLAN Zones and define which VLANs a zone must carry.
- Roll out a profile to a port range or a zone.
- Check the result under “Network > Config > Logs”.
Note: Almost every save under “Network > Config” writes to real devices. Test new profiles on a test port first. At remote sites: no change that could cost you access, and always a second access path.
Technical details
| Item | Value |
|---|---|
| Profiles | PORT (interface), AUTH (802.1X and AAA), VLAN (create and delete), PORT_ACTION (cable test, port restart) |
| Vendors | Allied Telesis (AlliedWare Plus), Cisco IOS, Ruijie (through the CLI) |
| Transport | SSH. Older algorithms for host key, key exchange and cipher are supported |
| Credentials | encrypted in the runner’s vault after the first rollout, reused afterwards |
| Execution | asynchronous. For each job, “Network > Config > Logs” shows user, time, data sent and the runner’s reply |
| Overview | “Network > Config” names, per port, the profile COD rolled out |
Port restart
A port restart only resets the single interface (shutdown and no shutdown). The switch stays in operation.
Credentials
After the first rollout the credentials are stored encrypted in the runner’s vault. You do not enter them again for every change.
Concurrent changes
There is no lock against concurrent changes. The runner processes jobs one after another. Avoid CLI changes on the same switch while a run is in progress.
Configuration backup
Scheduled backups of the switch configuration are handled by the Backup module. Back up switches there before you roll out profiles.
Known limits
| Limit | What you can do |
|---|---|
| Configuration only for Allied Telesis, Cisco and Ruijie | COD collects switches from other vendors read-only in the Network module |
| No lock against concurrent changes | Coordinate changes within the team. No CLI changes during a run |
| The overview shows what COD recorded, not the actual state on the switch | Check the actual state on the device or in the Network module’s collection |
| Changes to VLAN Zones and templates write no log entry of their own | Document such changes yourself |
| Almost every save takes effect on devices at once | Test new profiles on a test port first |
| By default the runner accepts only local connections | Run it on the COD server. If it should run on a separate server, agree on this with your partner first. |
| If the address under which COD is reachable changes, Ansible runs fail | Repeat the runner rollout afterwards |
| No playbooks of your own | The runner only runs COD actions |
| Minimum rights on the switch not defined | You receive the minimum rights as part of the project. |
Further reading
- Automation module page
- Network and MikroTik
- NAC
- What your network needs for Automation
- Deployment shapes
- Troubleshooting
- Questions about the modules
- Support: your partner is your first point of contact. Technical questions to extocode go through the helpdesk form.