diff options
Diffstat (limited to 'lib/snmp/doc')
| -rw-r--r-- | lib/snmp/doc/src/notes.xml | 77 | ||||
| -rw-r--r-- | lib/snmp/doc/src/notes_history.xml | 14 | ||||
| -rw-r--r-- | lib/snmp/doc/src/snmp_app.xml | 6 | ||||
| -rw-r--r-- | lib/snmp/doc/src/snmp_config.xml | 4 | ||||
| -rw-r--r-- | lib/snmp/doc/src/snmpa.xml | 20 | ||||
| -rw-r--r-- | lib/snmp/doc/src/snmpa_network_interface_filter.xml | 8 | ||||
| -rw-r--r-- | lib/snmp/doc/src/snmpc.xml | 152 | ||||
| -rw-r--r-- | lib/snmp/doc/src/snmpm.xml | 10 |
8 files changed, 206 insertions, 85 deletions
diff --git a/lib/snmp/doc/src/notes.xml b/lib/snmp/doc/src/notes.xml index 33e304abfa..45e1549de7 100644 --- a/lib/snmp/doc/src/notes.xml +++ b/lib/snmp/doc/src/notes.xml @@ -33,6 +33,83 @@ </header> <section> + <title>SNMP Development Toolkit 4.16.2</title> + <p>Version 4.16.2 supports code replacement in runtime from/to + version 4.16.1, 4.16, 4.15, 4.14 and 4.13.5.</p> + + <section> + <title>Improvements and new features</title> + <!-- + <p>-</p> + --> + <list type="bulleted"> + <item> + <p>[compiler] The SMI specifies that a table row OID should be + named: { <tableIdentifier> "1" }. </p> + <p>A new option has been introduced, + <seealso marker="snmpc#compiler_opts">relaxed_row_name_assign_check</seealso>, + that allows for a more liberal numbering scheme</p> + <p>Own Id: OTP-8574</p> + </item> + + <item> + <p>[agent|manager] Changes to make snmp (forward) compatible with + the new version of the crypto application (released in R14). + As of R14, crypto is implemented using NIFs. Also, + the API is more strict. </p> + <p>Own Id: OTP-8594</p> + </item> + + <item> + <p>Auto [agent] Changed default value for the MIB server cache. + GC is now on by default. </p> + <p>Own Id: OTP-8648</p> + </item> + + </list> + + </section> + + <section> + <title>Reported Fixed Bugs and Malfunctions</title> + <!-- + <p>-</p> + --> + + <list type="bulleted"> + <item> + <p>Encode/decode of Counter64 values larger than + 16#7fffffffffffffff (9223372036854775807) failed. </p> + <p>Own Id: OTP-8563</p> + </item> + + <item> + <p>[compiler] Fails to compile non-contiguous BITS. </p> + <p>Per Hedeland</p> + <p>Own Id: OTP-8595</p> + </item> + + <item> + <p>[manager] Raise condition causing the manager server process to + crash. Unregistering an agent while traffic (set/get-operations) + is ongoing could cause a crash in the manager server process + (raise condition). </p> + <p>Own Id: OTP-8646</p> + <p>Aux Id: Seq 11585</p> + </item> + + </list> + + </section> + + <section> + <title>Incompatibilities</title> + <p>-</p> + </section> + </section> <!-- 4.16.2 --> + + + <section> <title>SNMP Development Toolkit 4.16.1</title> <p>Version 4.16.1 supports code replacement in runtime from/to version 4.16, 4.15, 4.14 and 4.13.5.</p> diff --git a/lib/snmp/doc/src/notes_history.xml b/lib/snmp/doc/src/notes_history.xml index 8739400773..934df87866 100644 --- a/lib/snmp/doc/src/notes_history.xml +++ b/lib/snmp/doc/src/notes_history.xml @@ -4,7 +4,7 @@ <chapter> <header> <copyright> - <year>2004</year><year>2009</year> + <year>2004</year><year>2010</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> @@ -13,12 +13,12 @@ compliance with the License. You should have received a copy of the Erlang Public License along with this software. If not, it can be retrieved online at http://www.erlang.org/. - + Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License. - + </legalnotice> <title>SNMP Release Notes history</title> @@ -1732,7 +1732,7 @@ version 4.1. </p> <p>When performing a downgrade, make sure the verbosity of the manager server process is silence, or else the process will crash - (due to a bug in version 4.0.4) and be restarted by it's + (due to a bug in version 4.0.4) and be restarted by its supervisor.</p> <section> @@ -1773,7 +1773,7 @@ version 4.0.4. </p> <p>When performing a downgrade, make sure the verbosity of the manager server process is silence, or else the process will crash - (due to a bug in version 4.0.4) and be restarted by it's + (due to a bug in version 4.0.4) and be restarted by its supervisor.</p> <section> @@ -1827,8 +1827,8 @@ </item> <item> <p>[manager] The server process contained a bug that caused it - to crash, if it received an exit message from it's gct (GC timer) - process and it's verbosity was <em>log</em> or higher. </p> + to crash, if it received an exit message from its gct (GC timer) + process and its verbosity was <em>log</em> or higher. </p> <p>This also effects the application downgrade. </p> <p>Own Id: OTP-5306</p> </item> diff --git a/lib/snmp/doc/src/snmp_app.xml b/lib/snmp/doc/src/snmp_app.xml index e5a725d720..694e619da1 100644 --- a/lib/snmp/doc/src/snmp_app.xml +++ b/lib/snmp/doc/src/snmp_app.xml @@ -80,7 +80,7 @@ <!-- The info below is also found in the snmp_config.xml file --> - <p>Each snmp component has it's own set of configuration parameters, + <p>Each snmp component has its own set of configuration parameters, even though some of the types are common to both components. </p> <pre> @@ -346,7 +346,7 @@ <p>Defines if the mib server shall perform cache gc automatically or leave it to the user (see <seealso marker="snmpa#gc_mibs_cache">gc_mibs_cache/0,1,2,3</seealso>). </p> - <p>Default is <c>false</c>.</p> + <p>Default is <c>true</c>.</p> </item> <tag><c><![CDATA[mibs_cache_age() = integer() > 0 <optional>]]></c></tag> @@ -693,7 +693,7 @@ <p>Specifies if and how the audit trail log shall be repaired when opened. Unless this parameter has the value <c>snmp_repair</c> it is sent to <c>disk_log</c>. If, on the other hand, the value is - <c>snmp_repair</c>, snmp attempts to handle certain faults on it's + <c>snmp_repair</c>, snmp attempts to handle certain faults on its own. And even if it cannot repair the file, it does not truncate it directly, but instead <em>moves it aside</em> for later off-line analysis.</p> diff --git a/lib/snmp/doc/src/snmp_config.xml b/lib/snmp/doc/src/snmp_config.xml index 6fc9cc49f2..769b908adc 100644 --- a/lib/snmp/doc/src/snmp_config.xml +++ b/lib/snmp/doc/src/snmp_config.xml @@ -343,7 +343,7 @@ <p>Defines if the mib server shall perform cache gc automatically or leave it to the user (see <seealso marker="snmpa#gc_mibs_cache">gc_mibs_cache/0,1,2,3</seealso>). </p> - <p>Default is <c>false</c>.</p> + <p>Default is <c>true</c>.</p> </item> <tag><c><![CDATA[mibs_cache_age() = integer() > 0 <optional>]]></c></tag> @@ -704,7 +704,7 @@ <p>Specifies if and how the audit trail log shall be repaired when opened. Unless this parameter has the value <c>snmp_repair</c> it is sent to <c>disk_log</c>. If, on the other hand, the value is - <c>snmp_repair</c>, snmp attempts to handle certain faults on it's + <c>snmp_repair</c>, snmp attempts to handle certain faults on its own. And even if it cannot repair the file, it does not truncate it directly, but instead <em>moves it aside</em> for later off-line analysis.</p> diff --git a/lib/snmp/doc/src/snmpa.xml b/lib/snmp/doc/src/snmpa.xml index b3661ae9b0..69fe6d62f4 100644 --- a/lib/snmp/doc/src/snmpa.xml +++ b/lib/snmp/doc/src/snmpa.xml @@ -4,7 +4,7 @@ <erlref> <header> <copyright> - <year>2004</year><year>2009</year> + <year>2004</year><year>2010</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> @@ -13,12 +13,12 @@ compliance with the License. You should have received a copy of the Erlang Public License along with this software. If not, it can be retrieved online at http://www.erlang.org/. - + Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License. - + </legalnotice> <title>snmpa</title> @@ -648,6 +648,20 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} <desc> <p>Disable the mib server cache. </p> + <marker id="which_mibs_cache_size"></marker> + </desc> + </func> + + <func> + <name>which_mibs_cache_size() -> void()</name> + <name>which_mibs_cache_size(Agent) -> void()</name> + <fsummary>The size of the mib server cache</fsummary> + <type> + <v>Agent = pid() | atom()</v> + </type> + <desc> + <p>Retreive the size of the mib server cache. </p> + <marker id="gc_mibs_cache"></marker> </desc> </func> diff --git a/lib/snmp/doc/src/snmpa_network_interface_filter.xml b/lib/snmp/doc/src/snmpa_network_interface_filter.xml index d625fd3e4a..10419517dd 100644 --- a/lib/snmp/doc/src/snmpa_network_interface_filter.xml +++ b/lib/snmp/doc/src/snmpa_network_interface_filter.xml @@ -4,7 +4,7 @@ <erlref> <header> <copyright> - <year>2007</year><year>2009</year> + <year>2007</year><year>2010</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> @@ -13,12 +13,12 @@ compliance with the License. You should have received a copy of the Erlang Public License along with this software. If not, it can be retrieved online at http://www.erlang.org/. - + Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License. - + </legalnotice> <title>snmpa_network_interface_filter</title> @@ -153,7 +153,7 @@ pdu_type() = 'get-request' | 'get-next-request' | 'get-response' | 'set-request' <p>For the message to be discarded all together, the function <em>must</em> return <em>false</em>. </p> <p>Note that it is possible for this function to filter out targets - (but <em>not</em> add it's own) by returning an updated + (but <em>not</em> add its own) by returning an updated <c>Targets</c> list (<c>NewTargets</c>). </p> </desc> </func> diff --git a/lib/snmp/doc/src/snmpc.xml b/lib/snmp/doc/src/snmpc.xml index 48d63d6c91..fbd0950c69 100644 --- a/lib/snmp/doc/src/snmpc.xml +++ b/lib/snmp/doc/src/snmpc.xml @@ -4,7 +4,7 @@ <erlref> <header> <copyright> - <year>2004</year><year>2009</year> + <year>2004</year><year>2010</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> @@ -13,12 +13,12 @@ compliance with the License. You should have received a copy of the Erlang Public License along with this software. If not, it can be retrieved online at http://www.erlang.org/. - + Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License. - + </legalnotice> <title>snmpc</title> @@ -47,9 +47,10 @@ <type> <v>File = string()</v> <v>Options = [opt()]</v> - <v>opt() = db() | deprecated() | description() | reference() | group_check() | i() | il() | imports() | module() | module_identity() | outdir() | no_defs() | verbosity() | warnings()</v> + <v>opt() = db() | relaxed_row_name_assign_check() | deprecated() | description() | reference() | group_check() | i() | il() | imports() | module() | module_identity() | outdir() | no_defs() | verbosity() | warnings()</v> <v>db() = {db, volatile|persistent|mnesia}</v> <v>deprecated() = {deprecated, bool()}</v> + <v>relaxed_row_name_assign_check() = relaxed_row_name_assign_check</v> <v>description() = description</v> <v>reference() = reference</v> <v>group_check() = {group_check, bool()}</v> @@ -71,75 +72,104 @@ compiled file <c>BinFileName</c> is called <c><![CDATA[<File>.bin]]></c>. </p> <list type="bulleted"> - <item>The option <c>db</c> specifies which database should - be used for the default instrumentation. Default is - <c>volatile</c>. + <item> + <p>The option <c>db</c> specifies which database should + be used for the default instrumentation. </p> + <p>Default is <c>volatile</c>. </p> + </item> + <item> + <p>The option <c>deprecated</c> specifies if a deprecated + definition should be kept or not. If the option is + false the MIB compiler will ignore all deprecated + definitions. </p> + <p>Default is <c>true</c>. </p> </item> - <item>The option <c>deprecated</c> specifies if a deprecated - definition should be kept or not. If the option is - false the MIB compiler will ignore all deprecated - definitions. Default is <c>true</c>. + <item> + <p>The option <c>relaxed_row_name_assign_check</c>, if present, + specifies that the row name assign check shall not be done + strictly according to the SMI (which allows only the value 1). + With this option, all values greater than zero is allowed + (>= 1). This means that the error will be converted to a + warning. </p> + <p>By default it is not included, but if this option is present + it will be. </p> </item> - <item>The option <c>description</c> specifies if the text - of the DESCRIPTION field will be included or not. By default - it is not included, but if this option is present it will - be. + <item> + <p>The option <c>description</c> specifies if the text + of the DESCRIPTION field will be included or not. </p> + <p>By default it is not included, but if this option is + present it will be. </p> </item> - <item>The option <c>reference</c> specifies if the text - of the REFERENCE field, when found in a table definition, - will be included or not. By default - it is not included, but if this option is present it will - be. The reference text will be placed in the allocList field - of the mib-entry record (#me{}) for the table. + <item> + <p>The option <c>reference</c> specifies if the text + of the REFERENCE field, when found in a table definition, + will be included or not. </p> + <p>By default it is not included, but if this option is present + it will be. The reference text will be placed in the allocList + field of the mib-entry record (#me{}) for the table. </p> </item> - <item>The option <c>group_check</c> specifies whether the - mib compiler should check the OBJECT-GROUP macro and - the NOTIFICATION-GROUP macro for correctness or not. - Default is <c>true</c>. + <item> + <p>The option <c>group_check</c> specifies whether the + mib compiler should check the OBJECT-GROUP macro and + the NOTIFICATION-GROUP macro for correctness or not. </p> + <p>Default is <c>true</c>. </p> </item> - <item>The option <c>i</c> specifies the path to search for - imported (compiled) MIB files. The directories should be - strings with a trailing directory delimiter. Default is - <c>["./"]</c>. + <item> + <p>The option <c>i</c> specifies the path to search for + imported (compiled) MIB files. The directories should be + strings with a trailing directory delimiter. </p> + <p>Default is <c>["./"]</c>. </p> </item> - <item>The option <c>il</c> (include_lib) also specifies a - list of directories to search for imported MIBs. It - assumes that the first element in the directory name - corresponds to an OTP application. The compiler will find - the current installed version. For example, the value - ["snmp/mibs/"] will be replaced by ["snmp-3.1.1/mibs/"] - (or what the current version may be in the system). The - current directory and the <c><![CDATA[<snmp-home>/priv/mibs/]]></c> - are always listed last in the include path. + <item> + <p>The option <c>il</c> (include_lib) also specifies a + list of directories to search for imported MIBs. It + assumes that the first element in the directory name + corresponds to an OTP application. The compiler will find + the current installed version. For example, the value + ["snmp/mibs/"] will be replaced by ["snmp-3.1.1/mibs/"] + (or what the current version may be in the system). The + current directory and the + <c><![CDATA[<snmp-home>/priv/mibs/]]></c> + are always listed last in the include path. </p> </item> - <item>The option <c>imports</c>, if present, specifies that the - IMPORT statement of the MIB shall be included in the compiled mib. + <item> + <p>The option <c>imports</c>, if present, specifies that + the IMPORT statement of the MIB shall be included in the + compiled mib. </p> </item> - <item>The option <c>module</c>, if present, specifies the - name of a module which implements all instrumentation - functions for the MIB. The name of all instrumentation - functions must be the same as the corresponding managed - object it implements. + <item> + <p>The option <c>module</c>, if present, specifies the + name of a module which implements all instrumentation + functions for the MIB. </p> + <p>The name of all instrumentation + functions must be the same as the corresponding managed + object it implements. </p> </item> - <item>The option <c>module_identity</c>, if present, specifies - that the info part of the MODULE-IDENTITY statement of the MIB - shall be included in the compiled mib. + <item> + <p>The option <c>module_identity</c>, if present, specifies + that the info part of the MODULE-IDENTITY statement of the MIB + shall be included in the compiled mib. </p> </item> - <item>The option <c>no_defs</c>, if present, specifies - that if a managed object does not have an instrumentation - function, the default instrumentation function should NOT - be used, instead this is reported as an error, and the - compilation aborts. + <item> + <p>The option <c>no_defs</c>, if present, specifies + that if a managed object does not have an instrumentation + function, the default instrumentation function should NOT + be used, instead this is reported as an error, and the + compilation aborts. </p> </item> - <item>The option <c>verbosity</c> specifies the verbosity of - the SNMP mib compiler. I.e. if warning, info, log, debug - and trace messages shall be shown. Default is <c>silence</c>. - Note that if the option <c>warnings</c> is <c>true</c> and the - option <c>verbosity</c> is <c>silence</c>, warning messages will - still be shown. + <item> + <p>The option <c>verbosity</c> specifies the verbosity of + the SNMP mib compiler. I.e. if warning, info, log, debug + and trace messages shall be shown. </p> + <p>Default is <c>silence</c>. </p> + <p>Note that if the option <c>warnings</c> is <c>true</c> and the + option <c>verbosity</c> is <c>silence</c>, warning messages will + still be shown. </p> </item> - <item>The option <c>warnings</c> specifies whether warning - messages should be shown. Default is <c>true</c>. + <item> + <p>The option <c>warnings</c> specifies whether warning + messages should be shown. </p> + <p>Default is <c>true</c>. </p> </item> </list> <p>The MIB compiler understands both SMIv1 and SMIv2 MIBs. It diff --git a/lib/snmp/doc/src/snmpm.xml b/lib/snmp/doc/src/snmpm.xml index 9e7ac75daf..1ee391d9ba 100644 --- a/lib/snmp/doc/src/snmpm.xml +++ b/lib/snmp/doc/src/snmpm.xml @@ -4,7 +4,7 @@ <erlref> <header> <copyright> - <year>2004</year><year>2009</year> + <year>2004</year><year>2010</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> @@ -13,12 +13,12 @@ compliance with the License. You should have received a copy of the Erlang Public License along with this software. If not, it can be retrieved online at http://www.erlang.org/. - + Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License. - + </legalnotice> <title>snmpm</title> @@ -920,7 +920,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 <v>Oids = [oid()]</v> </type> <desc> - <p>Transform a alias-name to it's oid.</p> + <p>Transform a alias-name to its oid.</p> <p>Note that an alias-name is only unique within the mib, so when loading several mib's into a manager, there might be several instances of the same aliasname.</p> @@ -938,7 +938,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 <v>Reason = term()</v> </type> <desc> - <p>Transform a oid to it's aliasname.</p> + <p>Transform a oid to its aliasname.</p> <marker id="oid_to_type"></marker> </desc> |