summaryrefslogtreecommitdiff
path: root/docs/services/snmp.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/services/snmp.rst')
-rw-r--r--docs/services/snmp.rst42
1 files changed, 33 insertions, 9 deletions
diff --git a/docs/services/snmp.rst b/docs/services/snmp.rst
index 54e23c6b..351d3324 100644
--- a/docs/services/snmp.rst
+++ b/docs/services/snmp.rst
@@ -33,10 +33,8 @@ agent which reports information via SNMP to the manager.
An SNMP-managed network consists of three key components:
* Managed devices
-
-* Agent – software which runs on managed devices
-
-* Network management station (NMS) – software which runs on the manager
+* Agent - software which runs on managed devices
+* Network management station (NMS) - software which runs on the manager
A managed device is a network node that implements an SNMP interface that
allows unidirectional (read-only) or bidirectional (read and write) access to
@@ -179,10 +177,12 @@ After commit the resulting configuration will look like:
SNMP 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.
+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
@@ -191,7 +191,8 @@ Once the script is uploaded, it needs to be configured via the command below.
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.
+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
@@ -201,6 +202,29 @@ The OID ``.1.3.6.1.4.1.8072.1.3.2.3.1.1.4.116.101.115.116``, once called, will c
NET-SNMP-EXTEND-MIB::nsExtendOutNumLines."my-extension" = INTEGER: 1
NET-SNMP-EXTEND-MIB::nsExtendResult."my-extension" = INTEGER: 0
+SolarWinds
+^^^^^^^^^^
+
+If you happen to use SolarWinds Orion as NMS you can also use the Device
+Templates Management. A template for VyOS can be easily imported.
+
+Create a file named ``VyOS-1.3.6.1.4.1.44641.ConfigMgmt-Commands`` using the
+following content:
+
+.. code-block:: sh
+ <Configuration-Management Device="VyOS" SystemOID="1.3.6.1.4.1.44641">
+ <Commands>
+ <Command Name="Reset" Value="set terminal width 0${CRLF}set terminal length 0"/>
+ <Command Name="Reboot" Value="reboot${CRLF}Yes"/>
+ <Command Name="EnterConfigMode" Value="configure"/>
+ <Command Name="ExitConfigMode" Value="commit${CRLF}exit"/>
+ <Command Name="DownloadConfig" Value="show configuration commands"/>
+ <Command Name="SaveConfig" Value="commit${CRLF}save"/>
+ <Command Name="Version" Value="show version"/>
+ <Command Name="MenuBased" Value="False"/>
+ <Command Name="VirtualPrompt" Value=":~"/>
+ </Commands>
+ </Configuration-Management>
.. include:: references.rst