← Back to branch summary

~ubuntu-branches/ubuntu/trusty/erlang/trusty

« back to all changes in this revision

Viewing changes to lib/snmp/doc/src/snmpa.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sergei Golovan
  • Date: 2009-06-11 12:18:07 UTC
  • mfrom: (1.2.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20090611121807-ks7eb4xrt7dsysgx
Tags: 1:13.b.1-dfsg-1
http://bugs.debian.org/529512
* New upstream release.
* Removed unnecessary dependency of erlang-os-mon on erlang-observer and
  erlang-tools and added missing dependency of erlang-nox on erlang-os-mon
  (closes: #529512).
* Removed a patch to eunit application because the bug was fixed upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/snmp/doc/src/snmpa.xml
984
984
    </func>
985
985
 
986
986
    <func>
987
 
      <name>discovery(TargetName, Notification, Varbinds) -> ok | {error, Reason}</name>
988
 
      <name>discovery(TargetName, Notification, ContextName, Varbinds) -> ok | {error, Reason}</name>
 
987
      <name>discovery(TargetName, Notification) -> ok | {ok, ManagerEngineID} | {error, Reason}</name>
 
988
      <name>discovery(TargetName, Notification, Varbinds) -> ok | {ok, ManagerEngineID} | {error, Reason}</name>
 
989
      <name>discovery(TargetName, Notification, DiscoHandler) -> ok | {ok, ManagerEngineID} | {error, Reason}</name>
 
990
      <name>discovery(TargetName, Notification, ContextName, Varbinds) -> ok | {ok, ManagerEngineID} | {error, Reason}</name>
 
991
      <name>discovery(TargetName, Notification, Varbinds, DiscoHandler) -> ok | {ok, ManagerEngineID} | {error, Reason}</name>
 
992
      <name>discovery(TargetName, Notification, ContextName, Varbinds, DiscoHandler) -> ok | {ok, ManagerEngineID} | {error, Reason}</name>
989
993
      <fsummary>Initiate the discovery process with a manager</fsummary>
990
994
      <type>
991
995
        <v>TargetName = string()</v>
993
997
        <v>ContextName = string() (defaults to "")</v>
994
998
        <v>Varbinds = varbinds()</v>
995
999
        <v>varbinds() = [varbind()]</v>
 
1000
        <v>DiscoHandler = snmpa_discovery_handler()</v>
 
1001
        <v>snmpa_discovery_handler() = Module implementing the snmpa_discovery_handler behaviour</v>
 
1002
        <v>ManagerEngineID = string()</v>
996
1003
        <v>varbind() = {Variable, Value} | {Column, RowIndex, Value} | {OID, Value}</v>
997
1004
        <v>Variable = atom()</v>
998
1005
        <v>Column = atom()</v>
1008
1015
        <p>This function is synchronous, which means that it will return when
1009
1016
          the discovery process has been completed or failed. </p>
1010
1017
 
 
1018
        <p>The <c>DiscoHandler</c> module is used during the discovery 
 
1019
          process. See 
 
1020
          <seealso marker="snmpa_discovery_handler">discovery handler</seealso>
 
1021
          for more info. </p>
 
1022
 
 
1023
        <p>In case the 
 
1024
          <seealso marker="snmpa_discovery_handler#stage1_finish">stage1_finish</seealso> 
 
1025
          function returns <c>ignore</c> then the <c>discovery</c> will
 
1026
          return <c>{ok, ManagerEngineID}</c> for a successfull discovery.
 
1027
          eitherwise <c>ok</c> is returned. </p>
 
1028
 
 
1029
        <note><p>If we are not at security-level <c>noAuthNoPriv</c>,
 
1030
          this could be complicated, since the agent will then continue 
 
1031
          with stage 2, before which the usm-related updates must be 
 
1032
          done. </p></note>
 
1033
 
 
1034
        <note><p>The default discovery handler will require 
 
1035
          additional actions by the caller and the discovery will not work
 
1036
          if the security-level is higher then <c>noAuthNoPriv</c>. </p></note>
 
1037
 
1011
1038
          <marker id="convert_config"></marker>
1012
1039
      </desc>
1013
1040
    </func>