summaryrefslogtreecommitdiff
path: root/docs/source/docs/smi
diff options
context:
space:
mode:
authorelie <elie>2015-09-14 05:39:35 +0000
committerelie <elie>2015-09-14 05:39:35 +0000
commit8a2ab3c327b5d9128577b56e58bb93db396d59ed (patch)
tree982658337a44b1898b97cfd6b302917676f26cba /docs/source/docs/smi
parent2f24177c361ba4d9deba2d7378f84aa96111db80 (diff)
downloadpysnmp-8a2ab3c327b5d9128577b56e58bb93db396d59ed.tar.gz
documentation reworked and converted to Sphinx (in NumPy style)
Diffstat (limited to 'docs/source/docs/smi')
-rw-r--r--docs/source/docs/smi/contents.rst20
-rw-r--r--docs/source/docs/smi/mib-notification-types.rst14
-rw-r--r--docs/source/docs/smi/mib-variables.rst19
3 files changed, 53 insertions, 0 deletions
diff --git a/docs/source/docs/smi/contents.rst b/docs/source/docs/smi/contents.rst
new file mode 100644
index 0000000..0e2ee9f
--- /dev/null
+++ b/docs/source/docs/smi/contents.rst
@@ -0,0 +1,20 @@
+
+Oneliner MIB lookup service
+===========================
+
+PySNMP MIB architecture
+=======================
+
+MIB types and objects
+---------------------
+
+MIB Builder
+-----------
+
+MIB View Controller
+-------------------
+
+MIB Instrumentation Controller
+------------------------------
+
+
diff --git a/docs/source/docs/smi/mib-notification-types.rst b/docs/source/docs/smi/mib-notification-types.rst
new file mode 100644
index 0000000..118c615
--- /dev/null
+++ b/docs/source/docs/smi/mib-notification-types.rst
@@ -0,0 +1,14 @@
+
+MIB notification types
+======================
+
+ASN.1 macro definition -- NOTIFICATION-TYPE conveys MIB variables to
+be gathered and reported in SNMP Notification. The
+:py:mod:`~pysnmp.smi.rfc1902` module implements :RFC:`1902#section-2`
+macro definiitons.
+
+.. toctree::
+ :maxdepth: 2
+
+.. autoclass:: pysnmp.smi.rfc1902.NotificationType
+ :members:
diff --git a/docs/source/docs/smi/mib-variables.rst b/docs/source/docs/smi/mib-variables.rst
new file mode 100644
index 0000000..3d6cb4a
--- /dev/null
+++ b/docs/source/docs/smi/mib-variables.rst
@@ -0,0 +1,19 @@
+
+MIB Variables
+=============
+
+SNMP MIB variable is identified by an OBJECT IDENTIFIER (OID) and is
+accompanied by a value belonging to one of SNMP types (:RFC:`1902#section-2`).
+This pair is collectively called a variable-binding in SNMP parlance.
+
+The :py:mod:`~pysnmp.smi.rfc1902` module implements :RFC:`1902#section-2`
+MACRO definiitons.
+
+.. toctree::
+ :maxdepth: 2
+
+.. autoclass:: pysnmp.smi.rfc1902.ObjectIdentity
+ :members:
+
+.. autoclass:: pysnmp.smi.rfc1902.ObjectType
+ :members: