vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-11-02 11:52:03 +01:00
Code Issues Packages Projects Releases Wiki Activity

[SNMP] T1299 - documentation for snmp script extension

Browse Source
This commit is contained in:
hagbard 2019-07-15 13:07:11 -07:00
parent 3bbf15aba8
commit be3bd2bac3
2 changed files with 27 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/services/references.rst
View File

@ -10,4 +10,4 @@
.. _Squid3: http://www.squid-cache.org/
.. _Squidguard: http://www.squidguard.org/
.. _TFTP: https://en.wikipedia.org/wiki/Trivial_File_Transfer_Protocol
.. _`arbitrary extension commands`: http://net-snmp.sourceforge.net/docs/man/snmpd.conf.html#lbAZ

26
docs/services/snmp.rst
View File

@ -176,5 +176,31 @@ After commit the resulting configuration will look like:
}
}
SNMPv3 Extensions
^^^^^^^^^^^^^^^^^
To extend SNMP agent functionality, custom scripts can be executed every time the agent is being called.
This can be achieved by using `arbitrary extension commands`_.
The first step is to create a functional script of course, then upload it to your VyOS instance via the command ``scp your_script.sh vyos@your_router:/config/user-data``.
Once the script is uploaded, it needs to be configured via the command below.
.. code-block:: sh
set service snmp script-extensions extension-name my-extension script your_script.sh
commit
The OID ``.1.3.6.1.4.1.8072.1.3.2.3.1.1.4.116.101.115.116``, once called, will contain the output of the extension.
.. code-block:: sh
root@vyos:/home/vyos# snmpwalk -v2c -c public 127.0.0.1 nsExtendOutput1
NET-SNMP-EXTEND-MIB::nsExtendOutput1Line."my-extension" = STRING: hello
NET-SNMP-EXTEND-MIB::nsExtendOutputFull."my-extension" = STRING: hello
NET-SNMP-EXTEND-MIB::nsExtendOutNumLines."my-extension" = INTEGER: 1
NET-SNMP-EXTEND-MIB::nsExtendResult."my-extension" = INTEGER: 0
.. include:: references.rst