oxidized 0.35.0 → 0.37.0

data/docs/Release.md

@@ -61,7 +61,7 @@ They test different ruby versions an run security checks on the code (codeql).
 6. Install an test the gem locally
 ```shell
 gem install --user-install pkg/oxidized-0.xx.yy.gem
-~/.local/share/gem/ruby/3.1.0/bin/oxidized
+~/.local/share/gem/ruby/3.3.0/bin/oxidized
 ```
 
 ## Release in github
@@ -71,9 +71,14 @@ git push origin 0.xx.yy
 ```
 
 Make a release from the tag in github.
-- Take the release notes frm CHANGELOG.md
+- Name the release `0.xx.yy`
+- Generate release notes
+- Remove `## What's changed`
+- Take the release notes from CHANGELOG.md
 - List new contributors (generated automatically)
 - Keep the Full Changelog (generated automatically)
+- Preview
+- Publish
 
 Close the corresponding milestone in github.
 

data/docs/Ruby-API.md

@@ -10,11 +10,15 @@ The following objects exist in Oxidized.
 - [Model](#model)
   - [At the top level](#at-the-top-level)
     - [cfg](#cfg)
+    - [inputs](#inputs)
     - [cmd](#cmd)
     - [comment](#comment)
     - [prompt](#prompt)
     - [expect](#expect)
     - [pre / post](#pre--post)
+    - [macro :enable](#macro-enable)
+    - [clean :escape_codes](#clean-escape_codes)
+    - [clean :cut](#clean-cut)
   - [At the second level](#at-the-second-level)
     - [comment](#comment-1)
     - [password](#password)
@@ -26,9 +30,11 @@ The following objects exist in Oxidized.
     - [clear: true](#clear-true)
     - [prepend: true](#prepend-true)
   - [Refinements - String Convenience Methods](#refinements)
-    - [cut_tail](#cut_tail)
-    - [cut_head](#cut_head)
-    - [cut_both](#cut_both)
+  - [cut_tail](#cut_tail)
+  - [cut_head](#cut_head)
+  - [cut_both](#cut_both)
+  - [keep_lines](#keep_lines)
+  - [reject_lines](#reject_lines)
 
 ## Input
 
@@ -87,6 +93,40 @@ The block may contain commands to change some behaviour for the given methods
 
 Supports [monkey patching](#monkey-patching).
 
+#### 'inputs'
+`inputs` can be used to specify multiple inputs to be run on the model. It
+takes a list of either input symbols or lists of input symbols:
+```ruby
+  inputs [:ssh, %i[scp ftp]]
+  inputs [:ssh, :scp]
+```
+
+Oxidized will run the model against each item of `inputs`. If an item is a
+list of symbols (`%i[scp ftp]`), it will try each input in the order
+configured in the `input/default` section of the oxidized configuration file.
+
+If `inputs` is not specified, Oxidized will try each input that has a `cfg`
+section in the model, in the order configured in the `input/default` section
+of the oxidized configuration file.
+
+To specify which command is to run against which input, use the `input`
+parameter of the `cmd` configuration:
+```ruby
+  cmd 'upsabout', input: :ssh do |cfg|
+    comment cfg
+  end
+
+  cmd 'config.ini', input: %i[scp ftp] do |cfg|
+    "; ========== config.ini ==========\n" + cfg
+  end
+```
+
+`cmd` without `input` parameter will run against every input.
+
+
+See the [ApcAos model](/lib/oxidized/model/apcaos.rb) for a full example.
+
+
 #### `cmd`
 
 Is used to specify commands that should be executed on a model in order to
@@ -96,6 +136,7 @@ gather its configuration. It can be called with:
 * A string and a block
 * `:all` and a block
 * `:secret` and a block
+* `:significant_changes` and a block
 
 The block takes a single parameter `cfg` containing the output of the command
 being processed.
@@ -116,14 +157,27 @@ given block before emitting it to hide secrets if secret hiding is enabled. The
 block should replace any secrets with `'<hidden>'` and return the resulting
 string.
 
+Calling `cmd` with `:significant_changes` and a block will pass the final
+configuration to the given block. The resulting string should contain
+significant changes only and will be used to
+[decide if the configuration should be stored](Configuration.md#store-configuration-only-on-significant-changes).
+
 Execution order is `:all`, `:secret`, and lastly the command specific block, if
 given.
 
-The `cmd "string"` method for accepts a lambda function via the `:if` argument
+The `cmd "string"` method accepts a lambda function via the `:if` argument
 to execute the command only when the lambda evaluates to true.
 The lambda function is evaluated at runtime in the instance context.
 See [Conditional `cmd`](Creating-Models.md#conditional-cmd) for details.
 
+The `cmd "string"` method accepts a list of supported inputs via the `:input`
+argument to limit this command to specific inputs.
+```ruby
+  cmd 'config.ini', input: %i[scp ftp] do |cfg|
+    "; ========== config.ini ==========\n" + cfg
+  end
+```
+
 Supports [monkey patching](#monkey-patching).
 
 #### pre / post
@@ -167,6 +221,28 @@ it's further processed.
 
 Supports [monkey patching](#monkey-patching).
 
+#### `macro :enable`
+Implements an [handling of enable](Creating-Models.md#handling-enable-mode) for the model.
+
+#### `clean :escape_codes`
+[Remove ANSI escape codes](Creating-Models.md#remove-ansi-escape-codes) from the output.
+
+#### `clean :cut`
+Removes (default) the first and last line of the outputs (most of the time
+command echo and prompt).
+Arguments: head (default: 1), tail (default: 1)
+```ruby
+  clean :cut, head: 2, tail: 0
+```
+
+Equivalent to:
+```ruby
+  cmd :all do |cfg|
+    cfg.cut_both(2, 0)
+  end
+```
+
+
 ### At the second level
 
 The following methods are available:
@@ -223,7 +299,6 @@ This functionality is supported by `cfg`, `cmd`, `pre_*`, `post_*`, and `expect`
 blocks.
 
 #### `clear: true`
-
 Resets the existing block, allowing the user to completely override its contents.
 
 #### `prepend: true`
@@ -253,3 +328,9 @@ single line was present.
 
 Returns a multi-line string without the first and last lines, or an empty string
 if fewer than three lines were present.
+
+#### `keep_lines`
+Returns a multi-line string with only the lines matching any pattern (String or Regexp) given in an array.
+
+#### `reject_lines`
+Returns a multi-line string without the lines matching any pattern (String or Regexp) given in an array.

data/docs/Supported-OS-Types.md

@@ -2,6 +2,7 @@
 
 |Vendor              |OS model                      |oxidized model                                   |model maintainers|comment / model notes|
 |--------------------|------------------------------|-------------------------------------------------|-----------------|---------------------|
+|-generic-           |Cisco-like                    |[defacto](/lib/oxidized/model/defacto.rb)        |@ytti, @robertcheramy|[The defacto model may work on cisco like CLIs](/docs/Creating-Models.md#use-the-defacto-model)|
 |6WIND               |VSR                           |[sixwind](/lib/oxidized/model/sixwind.rb)        |@hcaldicott      |
 |A10 Networks        |ACOS                          |[acos](/lib/oxidized/model/acos.rb)              |                 |
 |Accedian Performance Elements (NIDs)|AEN           |[aen](/lib/oxidized/model/aen.rb)
@@ -17,7 +18,7 @@
 |Allied Telesis      |Alliedware Plus               |[awplus](/lib/oxidized/model/awplus.rb)
 |                    |AT-8000S, AT-8000GS series    |[powerconnect](/lib/oxidized/model/powerconnect.rb)
 |Alvarion            |BreezeACCESS                  |[alvarion](/lib/oxidized/model/alvarion.rb)
-|APC                 |AOS                           |[apc_aos](/lib/oxidized/model/apc_aos.rb)        |@robertcheramy   |[APC AOS](Model-Notes/APC_AOS.md)
+|APC                 |AOS                           |[apcaos](/lib/oxidized/model/apcaos.rb)          |@robertcheramy   |[APC](Model-Notes/APC.md)
 |Arbor Networks      |ArbOS                         |[arbos](/lib/oxidized/model/arbos.rb)            |                 |[ArbOS](Model-Notes/ArbOS.md)
 |Arista              |EOS                           |[eos](/lib/oxidized/model/eos.rb)                |                 |[EOS](Model-Notes/EOS.md)
 |Arris               |C4CMTS                        |[c4cmts](/lib/oxidized/model/c4cmts.rb)
@@ -52,6 +53,7 @@
 |                    |AsyncOS                       |[asyncos](/lib/oxidized/model/asyncos.rb)
 |                    |CatOS                         |[catos](/lib/oxidized/model/catos.rb)
 |                    |Cisco Catalyst Express        |[ciscoce](/lib/oxidized/model/ciscoce.rb)
+|                    |ExaLink Fusion (Nexus 3550-F) |[exalink](/lib/oxidized/model/exalink.rb)        |@obol89          |[ExaLink](Model-Notes/ExaLink.md)
 |                    |FireLinuxOS                   |[firelinuxos](/lib/oxidized/model/firelinuxos.rb)
 |                    |IOS                           |[ios](/lib/oxidized/model/ios.rb)                |@robertcheramy   |[IOS](Model-Notes/IOS.md)
 |                    |IOSXR                         |[iosxr](/lib/oxidized/model/iosxr.rb)
@@ -74,7 +76,7 @@
 |DELL                |PowerConnect                  |[powerconnect](/lib/oxidized/model/powerconnect.rb)
 |                    |AOSW                          |[aosw](/lib/oxidized/model/aosw.rb)              |                 |Same model as Aruba Wireless
 |                    |DellX                         |[dellx](/lib/oxidized/model/dellx.rb)
-|                    |Dell EMC Networking OS6       |[os6](/lib/oxidized/model/os6.rb)              |                 |[Dell EMC Networking OS6](Model-Notes/OS6.md)
+|                    |Dell EMC Networking OS6       |[os6](/lib/oxidized/model/os6.rb)                |                 |[Dell EMC Networking OS6](Model-Notes/OS6.md)
 |                    |Dell EMC Networking OS10      |[os10](/lib/oxidized/model/os10.rb)              |                 |[Dell EMC Networking OS10](Model-Notes/OS10.md)
 |D-Link              |D-Link                        |[dlink](/lib/oxidized/model/dlink.rb)
 |                    |D-Link cisco like CLI         |[dlinknextgen](/lib/oxidized/model/dlinknextgen.rb)
@@ -98,12 +100,15 @@
 |Firebrick           |FBxxxx                        |[firebrick](/lib/oxidized/model/firebrick.rb)
 |Force10             |DNOS                          |[dnos](/lib/oxidized/model/dnos.rb)
 |                    |FTOS                          |[ftos](/lib/oxidized/model/ftos.rb)
-|FortiGate           |FortiOS                       |[fortios](/lib/oxidized/model/fortios.rb)        |                 |[FortiOS](Model-Notes/FortiOS.md)
-|FortiWLC            |FortiWLC                      |[fortiwlc](/lib/oxidized/model/fortiwlc.rb)
+|Fortinet            |FortiGate                     |[fortigate](/lib/oxidized/model/fortigate.rb)    |@robertcheramy   |[Fortinet](Model-Notes/Fortinet.md)
+|                    |FortiOS                       |[fortios](/lib/oxidized/model/fortios.rb)        |@robertcheramy   |[Fortinet](Model-Notes/Fortinet.md)
+|                    |FortiWLC                      |[fortiwlc](/lib/oxidized/model/fortiwlc.rb)
 |Fujitsu             |PRIMERGY Blade switch 1/10Gbe |[fujitsupy](/lib/oxidized/model/fujitsupy.rb)
 |                    |1FINITY Switches              |[onefinity](/lib/oxidized/model/onefinity.rb)
+|[Garderos](https://garderos.com/) |GRS (Garderos Router Software) |[garderos](/lib/oxidized/model/garderos.rb) | @robertcheramy  |Routers for harsh environments
 |GCOM Technologies   |Broadband Network Platform Software|[gcombnps](/lib/oxidized/model/gcombnps.rb)
 |Grandstream Networks|GSX                           |[grandstream](/lib/oxidized/model/grandstream.rb)
+|                    |HT8xx                         |[grandstream](/lib/oxidized/model/grandstreamht8xx.rb) | @mklopocki | [Grandstream](Model-Notes/GrandstreamHT8xx.md)
 |Hatteras            |Hatteras                      |[hatteras](/lib/oxidized/model/hatteras.rb)
 |Hillstone Networks  |StoneOS                       |[stoneos](/lib/oxidized/model/stoneos.rb)
 |Hirschmann          |Classic                       |[hirschmann](/lib/oxidized/model/hirschmann.rb)
@@ -119,6 +124,7 @@
 |Icotera             |6400 series                   |[icotera](/lib/oxidized/model/icotera.rb)
 |Ingate              |SIParator/Firewalls           |[ingate](/lib/oxidized/model/ingate.rb)          |@thanegill
 |IP Infusion         |OcNOS                         |[ocnos](/lib/oxidized/model/ocnos.rb)
+|Ivanti              |Ivanti Connect Secure (ICS)   |[ivanti](/lib/oxidized/model/ivanti.rb)          |@candleflip      |[ICS](Model-Notes/IvantiConnectSecure.md)
 |Juniper             |JunOS                         |[junos](/lib/oxidized/model/junos.rb)            |                 |[MX/QFX/EX/SRX/J Series](Model-Notes/JunOS.md)
 |                    |ScreenOS (Netscreen)          |[screenos](/lib/oxidized/model/screenos.rb)
 |LANCOM Systems GmbH |LCOS                          |[lancom](/lib/oxidized/model/lancom.rb)
@@ -127,7 +133,7 @@
 |Linuxgeneric        |CentOS                        |[linuxgeneric](/lib/oxidized/model/linuxgeneric.rb)|               |[LinuxGeneric](Model-Notes/LinuxGeneric.md)
 |Mellanox            |MLNX-OS                       |[mlnxos](/lib/oxidized/model/mlnxos.rb)
 |                    |Voltaire                      |[voltaire](/lib/oxidized/model/voltaire.rb)
-|Mikrotik            |RouterOS                      |[routeros](/lib/oxidized/model/routeros.rb)      |  |[RouterOS](Model-Notes/RouterOS.md)
+|Mikrotik            |RouterOS                      |[routeros](/lib/oxidized/model/routeros.rb)      |                 |[RouterOS](Model-Notes/RouterOS.md)
 |                    |SwOS and SwOS Lite            |[swos](/lib/oxidized/model/swos.rb)
 |Mimosa              |Mimosa (B11)                  |[mimosab11](/lib/oxidized/model/mimosab11.rb)
 |Motorola            |RFS                           |[mtrlrfs](/lib/oxidized/model/mtrlrfs.rb)
@@ -138,6 +144,7 @@
 |Netgear             |Netgear switches              |[netgear](/lib/oxidized/model/netgear.rb)        |                 |[Netgear](Model-Notes/Netgear.md)
 |Netonix             |WISP Switch (As Netonix)      |[netonix](/lib/oxidized/model/netonix.rb)
 |Nokia (formerly TiMetra, Alcatel, Alcatel-Lucent)|SR OS (TiMOS)|[sros](/lib/oxidized/model/sros.rb)  |                 |[Nokia ISAM](Model-Notes/Nokia.md)
+|                    |SR OS Model-Driven CLI (7705 SAR, 7210 SAS, 7450 ESS, 7750 SR, 7950 XRS, NSP) |[srosmd](/lib/oxidized/model/srosmd.rb) | |
 |OneAccess           |OneOS                         |[oneos](/lib/oxidized/model/oneos.rb)
 |                    |TDRE                          |[tdre](/lib/oxidized/model/tdre.rb)
 |OpenBSD             |                              |[openbsd](/lib/oxidized/model/openbsd.rb)
@@ -152,13 +159,16 @@
 |Pure Storage        |PurityOS                      |[purityos](/lib/oxidized/model/purityos.rb)
 |Radware             |AlteonOS                      |[alteonos](/lib/oxidized/model/alteonos.rb)
 |Raisecom            |Raisecom                      |[raisecom](/lib/oxidized/model/raisecom.rb)
+|Riverbed            |SteelHead                     |[riverbed](/lib/oxidized/model/riverbed.rb)
 |Ruijie Networks     |RGOS                          |[rgos](/lib/oxidized/model/rgos.rb)
 |QTECH               |QSW-2800, QSW-3400, QSW-3450, QSW-3500|[qtech](/lib/oxidized/model/qtech.rb)
 |Quanta              |Quanta / VxWorks 6.6 (1.1.0.8)|[quantaos](/lib/oxidized/model/quantaos.rb)
 |Siklu               |EtherHaul                     |[siklu](/lib/oxidized/model/siklu.rb)            |@bdg-robert
 |                    |Multihaul TG                  |[siklumhtg](/lib/oxidized/model/siklumhtg.rb)    |@bdg-robert      |[Siklu Multihaul TG](Model-Notes/SikluMHTG.md)
 |Seiko Solutions     |SmartCS, SmartCS mini         |[smartcs](/lib/oxidized/model/smartcs.rb)
+|SmartByte           |LT-S8228G series              |[smartbyte](/lib/oxidized/model/smartbyte.rb)    |@freddy36
 |SonicWALL           |SonicOS                       |[sonicos](/lib/oxidized/model/sonicos.rb)
+|[SONiC](https://sonicfoundation.dev/) |Enterprise SONiC |[enterprise_sonic](/lib/oxidized/model/enterprise_sonic.rb) | |
 |SNR                 |SNR-S300G, S2xxx, S3xxx, S4xxx|[dcnos](/lib/oxidized/model/dcnos.rb)
 |Speedtouch          |Thomson Speedtouch            |[speedtouch](/lib/oxidized/model/speedtouch.rb)
 |Supermicro          |SSE-G2252, G2252P             |[edgecos](/lib/oxidized/model/edgecos.rb)
@@ -176,14 +186,14 @@
 |                    |Edgeos                        |[edgeos](/lib/oxidized/model/edgeos.rb)
 |                    |EdgeSwitch                    |[edgeswitch](/lib/oxidized/model/edgeswitch.rb)
 |                    |AirFiber                      |[airfiber](/lib/oxidized/model/airfiber.rb)
-|                    |UnifiAP                       |[unifiap](/lib/oxidized/model/unifiap.rb)              |@clifcox      |Also suports AirOS, and some Unifi switches
-|Uplink              |EP4440-DP                     |[EP4440](/lib/oxidized/model/uplinkolt.rb)             | |Might support all EP4440 series
+|                    |UnifiAP                       |[unifiap](/lib/oxidized/model/unifiap.rb)        |@clifcox         |Also suports AirOS, and some Unifi switches
+|Uplink              |EP4440-DP                     |[EP4440](/lib/oxidized/model/uplinkolt.rb)       |                 |Might support all EP4440 series
 |VMWare              |NSX Edge (configuration)      |[nsxconfig](/lib/oxidized/model/nsxconfig.rb)
 |                    |NSX Edge (firewall rules)     |[nsxfirewall](/lib/oxidized/model/nsxfirewall.rb)
 |                    |NSX Distributed Firewall      |[nsxdfw](/lib/oxidized/model/nsxdfw.rb)
-|VYOS Networks       |VYOS                          |[vyos](/lib/oxidized/model/vyos.rb)
-|                 |Fork of Vyatta, tracking the supported versions (>= 1.4.x)
+|VYOS Networks       |VYOS                          |[vyos](/lib/oxidized/model/vyos.rb)              |                 |Fork of Vyatta, tracking the supported versions (>= 1.4.x)
 |Watchguard          |Fireware OS                   |[firewareos](/lib/oxidized/model/firewareos.rb)
+|Waystream (PacketFront)|iBOS (Intelligent Broadband OS)|[ibos](/lib/oxidized/model/ibos.rb)
 |Westell             |Westell 8178G, Westell 8266G  |[weos](/lib/oxidized/model/weos.rb)
 |Yadro               |KornfeldOS                    |[kornfeldos](/lib/oxidized/model/kornfeldos.rb) 
 |YAMAHA              |YAMAHA NVR/RTX Series         |[yamaha](/lib/oxidized/model/yamaha.rb)
@@ -193,5 +203,7 @@
 |Zyxel               |ZyNOS                         |[zynos](/lib/oxidized/model/zynos.rb)            |                 |[XGS4600 Series](Model-Notes/XGS4600-Zyxel.md)
 |                    |ZyNOS GS-series variant       |[zynosgs](/lib/oxidized/model/zynosgs.rb)
 |                    |ZyNOS ADSL                    |[zynosadsl](/lib/oxidized/model/zynosadsl.rb)
+|                    |ZyNOS CLI (DSLAMs, e.g. SAM1316)|[zynoscli](/lib/oxidized/model/zynoscli.rb)
+|                    |ZyNOS MGS series              |[zynosmgs](/lib/oxidized/model/zynosmgs.rb)
 |                    |NDMS                          |[ndms](/lib/oxidized/model/ndms.rb)
 |                    |1308                          |[zy1308](/lib/oxidized/model/zy1308.rb)

data/docs/Troubleshooting.md

@@ -86,7 +86,7 @@ ssh-keyscan gitserver.git.com >> ~/.ssh/known_hosts
 
 If you are running oxidized in a container, you need to map /home/oxidized/.ssh in the
 container to a local repository and save the known_hosts in the local repository. You can
-find an example how to do this under [examples/podman-compose](/examples/podman-compose/)
+find an example how to do this under [Docker.md](Docker.md#store-the-ssh-keys-a-remote-git-repository)
 
 ## Oxidized ignores the changes I made to its git repository
 First of all: you shouldn't manipulate the git repository of oxidized. Don't

data/extra/device2yaml.rb

@@ -91,9 +91,8 @@ def yaml_output(prepend = '')
 
   prepend = @sequence_prepend_output + prepend
 
-  # as we want to prepend 'prepend' to each line, we need each_line and chomp
-  # chomp removes the trainling \n
-  @ssh_output.each_line(chomp: true) do |line|
+  # each_line(chomp: true) would remove \r\n, so we prefer split
+  @ssh_output.split("\n", -1).each do |line|
     # encode line and remove the first and the trailing double quote
     line = line.dump[1..-2]
     if firstline

data/extra/hooks/modelrules.rb

@@ -0,0 +1,55 @@
+### script in ~/config/oxidized/hook/modelrules.rb ## or OXDIZED_HOME equivalent
+###
+### router.db:
+### router1:1.1.1.1:routeros::mikrotik
+### router2:2.2.2.2:ios:switch:cisco
+### router3:3.3.3.3:routeros:switch:mikrotik
+###
+### config:
+### source:
+###   default: csv
+###   csv:
+###     file: "/Users/ytti/.config/oxidized/router.db"
+###     delimiter: !ruby/regexp /:/
+###     map:
+###       name: 0
+###       ip: 1
+###       model: 2
+###       group: 3
+### hooks:
+###   somename:
+###     type: modelrules
+###     events: ["source_node_transform"]
+###     rules:
+###        - vendor: mikrotik
+###          group: switch
+###          model: eltex
+###
+### Nodes BEFORE script:
+### {name: "router1", ip: "1.1.1.1", model: "routeros", group: ""}
+### {name: "router2", ip: "2.2.2.2", model: "ios", group: "switch"}
+### {name: "router3", ip: "3.3.3.3", model: "routeros", group: "switch"}
+###
+### Nodes AFTER script:
+### {name: "router1", ip: "1.1.1.1", model: "routeros", group: ""}
+### {name: "router2", ip: "2.2.2.2", model: "ios", group: "switch"}
+### {name: "router3", ip: "3.3.3.3", model: "eltex", group: "switch"}
+class ModelRules < Oxidized::Hook
+  def validate_cfg!
+    raise KeyError, 'hook.rules is required' unless cfg.has_key?('rules')
+  end
+
+  def run_hook(ctx)
+    # node is the node[key] that we'd return without manipulation
+    node = ctx.node ## e.g. node[:ip], node[:model] - what ever config maps
+
+    ## node_raw is source specific, in CSV it is just the field number, in HTTP it is JSON
+    vendor = ctx.node_raw[4]
+
+    cfg.rules.each do |rule|
+      node[:model] = rule['model'] if node[:group] == rule['group'] && vendor == rule['vendor']
+    end
+
+    node
+  end
+end

data/extra/hooks/modelrulesadvanced.rb

@@ -0,0 +1,167 @@
+# Advanced dynamic model selection hook for Oxidized
+# --------------------------------------------------
+# This hook allows you to assign Oxidized models based on any device attributes
+# (name, vendor, group, type, IP, etc.) using flexible rules defined in the config.
+# It uses the `source_node_transform` event and works with any source (CSV, HTTP, SQL).
+#
+# The hook is designed to be generic: you can specify any field that exists in the
+# node data after source mapping (see `map` section in the source configuration).
+# Rules are evaluated in order; the first matching rule assigns its `model`.
+#
+# ⚠️ IMPORTANT: For the hook to load correctly:
+#   - The filename must match the hook type (e.g., `modelrulesadvanced.rb`).
+#   - The class name must be the CamelCase version of the filename without underscores
+#     (e.g., filename `modelrulesadvanced.rb` → class `Modelrulesadvanced`).
+#   - In the Oxidized config, specify `type: modelrulesadvanced` (the filename without .rb).
+#
+# ⚠️ DOCKER NOTE: This hook was developed and tested in a Docker container.
+#   Ensure that your hooks directory inside the container is
+#   `/home/oxidized/.config/oxidized/hook` (singular "hook"), not "hooks".
+#   In docker-compose, mount your local hooks folder to this path, e.g.:
+#   volumes:
+#     - ./extra/hooks:/home/oxidized/.config/oxidized/hook
+#
+# Example scenario with NetBox:
+#   Suppose your NetBox instance returns devices with the following data (simplified):
+#     gw-001  | Mikrotik | RB750 | ro_ud  | 192.168.0.167/24
+#     gw-002  | Mikrotik | RB750 | ro_ud  | 192.168.0.177/24
+#     gw-003  | Mikrotik | RB750 | ro_bd  | 192.168.0.178/24
+#     gw-004  | Mikrotik | RB750 | switch | 192.168.0.181/24
+#     gw-005  | Cisco    | 2960  | switch | 192.168.0.179/24
+#     gw-006  | Mikrotik | RB750 | switch | 192.168.0.180/24
+#     gw-007  | Arista   | 3456  | ro_ud  | 192.168.0.190/24
+#
+#   Desired model assignment:
+#     - gw-001 (exception by name) → asa
+#     - MikroTik in group `switch` with IP 192.168.0.180/24 → eltex
+#     - All other MikroTik → routeros
+#     - Cisco switches → ios
+#     - Arista devices → eos
+#
+# Example configuration (top-level in Oxidized config):
+#   ---
+#   username: oxidized_ssh_user
+#   password: oxidized_ssh_password
+#
+#   hooks:
+#     modelrulesadvanced:
+#       type: modelrulesadvanced
+#       events: [source_node_transform]
+#       rules:
+#         - description: "Exception: gw-001 uses ASA model"
+#           name: gw-001
+#           model: asa
+#         - description: "Mikrotik switch with IP 192.168.0.180/24 uses eltex"
+#           vendor: Mikrotik
+#           group: switch
+#           ip: 192.168.0.180/24
+#           model: eltex
+#         - description: "All other Mikrotik devices"
+#           vendor: Mikrotik
+#           model: routeros
+#         - description: "Cisco switches"
+#           vendor: Cisco
+#           group: switch
+#           model: ios
+#         - description: "Arista devices"
+#           vendor: Arista
+#           model: eos
+#
+#   resolve_dns: false
+#   interval: 3600
+#   rest: 0.0.0.0:8888
+#   debug: true   # optional – enables detailed logging from the hook
+#
+#   source:
+#     default: http
+#     http:
+#       url: http://netbox.test/api/dcim/devices/?status=active&has_primary_ip=true
+#       headers:
+#         Authorization: Token YOUR_API_TOKEN
+#       map:
+#         name: name
+#         vendor: device_type.manufacturer.name
+#         type: device_type.model
+#         group: role.slug
+#         ip: primary_ip.address
+#       secure: false
+#       hosts_location: results
+#       pagination: true
+#       pagination_key_name: next
+#
+#   output:
+#     default: file
+#     file:
+#       directory: "/home/oxidized/.config/oxidized/configs"
+#
+#   groups:
+#     ro_ud: {}
+#     ro_bd: {}
+#     switch: {}
+#
+# How it works:
+#   1. Oxidized loads node data from the source (NetBox) and applies the `map`.
+#   2. For each node, the `source_node_transform` event is triggered.
+#   3. This hook receives a context object `ctx` containing:
+#        - `ctx.node` – the mapped node attributes (hash)
+#        - `ctx.node_raw` – the original source record (useful for unmapped fields)
+#   4. The hook iterates through the rules defined in `cfg.rules`.
+#   5. For each rule, it checks that every specified key (except `model` and `description`)
+#      matches the corresponding value in `ctx.node`. Comparison is case‑insensitive and
+#      strips surrounding spaces.
+#   6. The first matching rule assigns its `model` to `ctx.node[:model]`.
+#   7. If no rule matches, the node's `model` remains unchanged.
+#   8. The modified (or original) node is returned; returning `nil` would exclude the node.
+#
+# Notes:
+#   - Rule order is crucial: place more specific rules (e.g., with IP or name) before generic ones.
+#   - The `description` field is optional and only appears in debug logs.
+#   - Any field present in `ctx.node` after mapping can be used as a match key.
+#   - For HTTP sources (NetBox), you can access additional fields via `ctx.node_raw["field"]`.
+#   - Debug logging requires `debug: true` in the global config.
+
+class Modelrulesadvanced < Oxidized::Hook
+  # Validate that the hook configuration contains a 'rules' array.
+  def validate_cfg!
+    raise KeyError, "hook.rules is required" unless cfg.has_key?("rules")
+  end
+
+  # Main hook method – called for each node during source_node_transform event.
+  def run_hook(ctx)
+    node = ctx.node
+    rules = cfg.rules || []
+
+    matched_model = nil
+    rules.each_with_index do |rule, idx|
+      match = true
+      rule.each do |key, value|
+        next if %w[model description].include?(key)
+
+        # Retrieve the corresponding value from the node (symbol or string key)
+        node_value = node[key.to_sym] || node[key.to_s]
+        if node_value.to_s.strip.downcase != value.to_s.strip.downcase
+          match = false
+          break
+        end
+      end
+      next unless match
+
+      matched_model = rule["model"]
+      desc = rule["description"] ? " (#{rule['description']})" : ""
+      logger.debug "ModelRulesAdvanced: rule #{idx + 1}#{desc} matched -> #{matched_model}"
+      break
+    end
+
+    if matched_model
+      old_model = node[:model] || node["model"]
+      node[:model] = matched_model
+      logger.debug "ModelRulesAdvanced: changed model from #{old_model.inspect} to #{matched_model.inspect}"
+    else
+      # rubocop:disable Layout/LineLength
+      logger.debug "ModelRulesAdvanced: no rule matched, keeping existing model: #{node[:model] || node['model'].inspect}"
+      # rubocop:enable Layout/LineLength
+    end
+
+    node
+  end
+end

data/extra/hooks/srcipmap.rb

@@ -0,0 +1,54 @@
+### script in ~/config/oxidized/hook/srcipmap.rb ## or OXDIZED_HOME equivalent
+###
+### router.db:
+### router1:1.1.1.1:cisco:c7200:10.10.10.1:somerole
+### router2:2.2.2.2:juniper:mx80:10.10.10.2:wlc
+### router3:3.3.3.3:juniper:mx2020:10.10.10.3:anotherrole
+###
+### config:
+### source:
+###   default: csv
+###   csv:
+###    file: "/Users/ytti/.config/oxidized/router.db"
+###    delimiter: !ruby/regexp /:/
+###    map:
+###      name: 0
+###      ip: 1
+###      model: 2
+### model_map:
+###   juniper: junos
+###   cisco: ios
+### hooks:
+###   somename:
+###    type: srcipmap
+###    events: ["source_node_transform"]
+###
+###
+###
+### Nodes BEFORE script:
+### {name: "router1", ip: "1.1.1.1", model: "ios"}
+### {name: "router2", ip: "2.2.2.2", model: "junos"}
+### {name: "router3", ip: "3.3.3.3", model: "junos"
+###
+### Nodes AFTER script:
+### {name: "router1", ip: "1.1.1.1", model: "ios"}
+### {name: "router2", ip: "10.10.10.2", model: "junos"}
+### {name: "router3", ip: "3.3.3.3", model: "junos"}
+
+class SrcIpMap < Oxidized::Hook
+  def run_hook(ctx)
+    # node is the node[key] that we'd return without manipulation
+    node = ctx.node
+
+    ## node_raw is source specific, in CSV it is just the field number
+    _platform = ctx.node_raw[3]
+    oob_ip = ctx.node_raw[4]
+    role = ctx.node_raw[5]
+
+    ### the magic
+    node[:ip] = oob_ip if role == 'wlc'
+
+    ### remember to return the manipulated object, nil if you want to ignore loading node
+    node
+  end
+end