userapps/opensource/net-snmp/local/snmpconf.dir/snmpd-data/extending

   1 title   Extending the Agent
   2 description     You can extend the snmp agent to have it return information
   3 description     that you yourself define.
   4
   5 token   exec
   6 info    run a simple command using exec()
   7 info    arguments:  [oid] name /path/to/executable arguments
   8 question 1 The OID where the results table should be display [default=extTable]
   9 question 2 The "name" to associate with this command when displaying the results.
  10 question 3 The path to the program to be run.
  11 question 4 The arguments to pass to $3
  12
  13 token    pass
  14 info     Run a command that intepretes the request for an entire tree.
  15 info     The pass program defined here will get called for all
  16 info     requests below a certain point in the mib tree.  It is then
  17 info     responsible for returning the right data beyond that point.
  18 info     #
  19 info     arguments: miboid program
  20 info     #
  21 info     example: pass .1.3.6.1.4.1.2021.255 /path/to/local/passtest
  22 info     #
  23 info     See the snmpd.conf manual page for further information.
  24 info     #
  25 info     Consider using "pass_persist" for a performance increase.
  26 question 1 The OID where the script should take control of
  27 question 2 The path to the program that should be called
  28
  29 token pass_persist
  30 info     Run a persistant process that intepretes the request for an entire tree.
  31 info     The pass program defined here will get called for all
  32 info     requests below a certain point in the mib tree.  It is then
  33 info     responsible for returning the right data beyond that point.
  34 info     The pass_persist scripts must be able to stay running and accept input
  35 info     from stdin.
  36 info     #
  37 info     arguments: miboid program
  38 info     #
  39 info     example: pass_persist .1.3.6.1.4.1.2021.255 /path/to/local/pass_persisttest
  40 info     #
  41 info     See the snmpd.conf manual page for further information.
  42 steal pass
  43
  44 token proxy
  45 info  Proxy requests to an external agent running somewhere else
  46 info  This passes all requests for a certain point of the mib tree to
  47 info  an external agent using snmp requests and then returning the
  48 info  results to the caller that spoke to our agent.
  49 info  arguments: [snmpcmd args] host oid [remoteoid]
  50 question 1 Enter the "snmpcmd" arguments that specify how to talk to the remote host
  51 question 2 The host you want to pass the requests to
  52 qusetion 3 The oid that we should pass beyond
  53 question 4 The oid of the remote site that we should talk to if different from $3
  54
  55 token   sh
  56 info    run a simple command using system()
  57 info    arguments:  [oid] name command arguments
  58 info    similar to exec, but implemented using system() instead of exec()
  59 info    #
  60 info    For security reasons, exec should be preferred.
  61 steal exec
  62
  63 token dlmod
  64 info dynamically extend the agent using a shared-object
  65 info    arguments:  module-name module-path
  66 question 1 Enter the name of the module
  67 question 2 Enter the path to the $1 module
  68