home *** CD-ROM | disk | FTP | other *** search
/ The Hacker's Encyclopedia 1998 / hackers_encyclopedia.iso / rfc / 3 / rfc2257.txt < prev    next >
Encoding:
Text File  |  2003-06-11  |  173.3 KB  |  4,485 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7. Network Working Group                                         M. Daniele
  8. Request for Comments: 2257                 Digital Equipment Corporation
  9. Category: Standards Track                                      B. Wijnen
  10.                                   T.J. Watson Research Center, IBM Corp.
  11.                                                        D. Francisco, Ed.
  12.                                                      Cisco Systems, Inc.
  13.                                                             January 1998
  14.  
  15.                  Agent Extensibility (AgentX) Protocol
  16.                                Version 1
  17.  
  18.  
  19. Status of this Memo
  20.  
  21.    This document specifies an Internet standards track protocol for the
  22.    Internet community, and requests discussion and suggestions for
  23.    improvements.  Please refer to the current edition of the "Internet
  24.    Official Protocol Standards" (STD 1) for the standardization state
  25.    and status of this protocol.  Distribution of this memo is unlimited.
  26.  
  27. Copyright Notice
  28.  
  29.    Copyright (C) The Internet Society (1998).  All Rights Reserved.
  30.  
  31. Table of Contents
  32.  
  33.    1 Introduction......................................................4
  34.  
  35.    2 The SNMP Framework................................................4
  36.      2.1 A Note on Terminology.........................................4
  37.  
  38.    3 Extending the MIB.................................................5
  39.      3.1 Motivation for AgentX.........................................5
  40.  
  41.    4 AgentX Framework..................................................6
  42.      4.1 AgentX Roles..................................................7
  43.      4.2 Applicability.................................................8
  44.      4.3 Design Features of AgentX.....................................9
  45.      4.4 Non-Goals....................................................10
  46.  
  47.    5 AgentX Encodings.................................................10
  48.      5.1 Object Identifier............................................11
  49.      5.2 SearchRange..................................................13
  50.      5.3 Octet String.................................................14
  51.      5.4 Value Representation.........................................14
  52.  
  53.    6 Protocol Definitions.............................................16
  54.      6.1 AgentX PDU Header............................................16
  55.  
  56.  
  57.  
  58. Daniele, et. al.            Standards Track                     [Page 1]
  59.  
  60. RFC 2257                        AgentX                      January 1998
  61.  
  62.  
  63.        6.1.1 Context..................................................19
  64.      6.2 AgentX PDUs..................................................20
  65.        6.2.1 The agentx-Open-PDU......................................20
  66.        6.2.2 The agentx-Close-PDU.....................................21
  67.        6.2.3 The agentx-Register-PDU..................................22
  68.        6.2.4 The agentx-Unregister-PDU................................25
  69.        6.2.5 The agentx-Get-PDU.......................................27
  70.        6.2.6 The agentx-GetNext-PDU...................................29
  71.        6.2.7 The agentx-GetBulk-PDU...................................30
  72.        6.2.8 The agentx-TestSet-PDU...................................31
  73.        6.2.9 The agentx-CommitSet, -UndoSet, -CleanupSet
  74.              PDUs.....................................................33
  75.        6.2.10 The agentx-Notify-PDU...................................33
  76.        6.2.11 The agentx-Ping-PDU.....................................34
  77.        6.2.12 The agentx-IndexAllocate-PDU............................35
  78.        6.2.13 The agentx-IndexDeallocate-PDU..........................36
  79.        6.2.14 The agentx-AddAgentCaps-PDU.............................37
  80.        6.2.15 The agentx-RemoveAgentCaps-PDU..........................38
  81.        6.2.16 The agentx-Response-PDU.................................39
  82.  
  83.    7 Elements of Procedure............................................41
  84.      7.1 Processing AgentX Administrative Messages....................42
  85.        7.1.1 Processing the agentx-Open-PDU...........................42
  86.        7.1.2 Processing the agentx-IndexAllocate-PDU..................43
  87.        7.1.3 Using the agentx-IndexAllocate-PDU.......................45
  88.        7.1.4 Processing the agentx-IndexDeallocate-PDU................47
  89.        7.1.5 Processing the agentx-Register-PDU.......................48
  90.          7.1.5.1 Handling Duplicate OID Ranges........................50
  91.        7.1.6 Processing the agentx-Unregister-PDU.....................51
  92.        7.1.7 Processing the agentx-AddAgentCaps-PDU...................51
  93.        7.1.8 Processing the agentx-RemoveAgentCaps-PDU................52
  94.        7.1.9 Processing the agentx-Close-PDU..........................52
  95.        7.1.10 Detecting Connection Loss...............................53
  96.        7.1.11 Processing the agentx-Notify-PDU........................53
  97.        7.1.12 Processing the agentx-Ping-PDU..........................54
  98.      7.2 Processing Received SNMP Protocol Messages...................54
  99.        7.2.1 Dispatching AgentX PDUs..................................55
  100.          7.2.1.1 agentx-Get-PDU.......................................57
  101.          7.2.1.2 agentx-GetNext-PDU...................................58
  102.          7.2.1.3 agentx-GetBulk-PDU...................................59
  103.          7.2.1.4 agentx-TestSet-PDU...................................60
  104.          7.2.1.5 Dispatch.............................................60
  105.        7.2.2 Subagent Processing of agentx-Get, GetNext,
  106.              GetBulk-PDUs.............................................61
  107.          7.2.2.1 Subagent Processing of the agentx-Get-PDU............61
  108.          7.2.2.2 Subagent Processing of the
  109.                  agentx-GetNext-PDU...................................62
  110.  
  111.  
  112.  
  113.  
  114. Daniele, et. al.            Standards Track                     [Page 2]
  115.  
  116. RFC 2257                        AgentX                      January 1998
  117.  
  118.  
  119.          7.2.2.3 Subagent Processing of the
  120.                  agentx-GetBulk-PDU...................................62
  121.        7.2.3 Subagent Processing of agentx-TestSet,
  122.              -CommitSet, -UndoSet, -CleanupSet-PDUs...................63
  123.          7.2.3.1 Subagent Processing of the
  124.                  agentx-TestSet-PDU...................................64
  125.          7.2.3.2 Subagent Processing of the
  126.                  agentx-CommitSet-PDU.................................65
  127.          7.2.3.3 Subagent Processing of the
  128.                  agentx-UndoSet-PDU...................................65
  129.          7.2.3.4 Subagent Processing of the
  130.                  agentx-CleanupSet-PDU................................65
  131.        7.2.4 Master Agent Processing of AgentX Responses..............66
  132.          7.2.4.1 Common Processing of All AgentX Response
  133.                  PDUs.................................................66
  134.          7.2.4.2 Processing of Responses to agentx-Get-PDUs...........66
  135.          7.2.4.3 Processing of Responses to
  136.                  agentx-GetNext-PDU and agentx-GetBulk-PDU............67
  137.          7.2.4.4 Processing of Responses to
  138.                  agentx-TestSet-PDUs..................................68
  139.          7.2.4.5 Processing of Responses to
  140.                  agentx-CommitSet-PDUs................................68
  141.          7.2.4.6 Processing of Responses to
  142.                  agentx-UndoSet-PDUs..................................69
  143.        7.2.5 Sending the SNMP Response-PDU............................69
  144.        7.2.6 MIB Views................................................69
  145.      7.3 State Transitions............................................70
  146.        7.3.1 Set Transaction States...................................70
  147.        7.3.2 Transport Connection States..............................71
  148.        7.3.3 Session States...........................................73
  149.  
  150.    8 Transport Mappings...............................................74
  151.      8.1 AgentX over TCP..............................................74
  152.        8.1.1 Well-known Values........................................74
  153.        8.1.2 Operation................................................74
  154.      8.2 AgentX over UNIX-domain Sockets..............................75
  155.        8.2.1 Well-known Values........................................75
  156.        8.2.2 Operation................................................75
  157.  
  158.    9 Security Considerations..........................................76
  159.  
  160.    10 Acknowledgements................................................77
  161.  
  162.    11 Authors' and Editor's Addresses.................................77
  163.  
  164.    12 References......................................................78
  165.  
  166.    13 Full Copyright Statement........................................80
  167.  
  168.  
  169.  
  170. Daniele, et. al.            Standards Track                     [Page 3]
  171.  
  172. RFC 2257                        AgentX                      January 1998
  173.  
  174.  
  175. 1.  Introduction
  176.  
  177.    This memo defines a standardized framework for extensible SNMP
  178.    agents.  It defines processing entities called master agents and
  179.    subagents, a protocol (AgentX) used to communicate between them, and
  180.    the elements of procedure by which the extensible agent processes
  181.    SNMP protocol messages.
  182.  
  183. 2.  The SNMP Framework
  184.  
  185.    A management system contains:  several (potentially many) nodes, each
  186.    with a processing entity, termed an agent, which has access to
  187.    management instrumentation; at least one management station; and, a
  188.    management protocol, used to convey management information between
  189.    the agents and management stations.  Operations of the protocol are
  190.    carried out under an administrative framework which defines
  191.    authentication, authorization, access control, and privacy policies.
  192.  
  193.    Management stations execute management applications which monitor and
  194.    control managed elements.  Managed elements are devices such as
  195.    hosts, routers, terminal servers, etc., which are monitored and
  196.    controlled via access to their management information.
  197.  
  198.    Management information is viewed as a collection of managed objects,
  199.    residing in a virtual information store, termed the Management
  200.    Information Base (MIB).  Collections of related objects are defined
  201.    in MIB modules.  These modules are written using a subset of OSI's
  202.    Abstract Syntax Notation One (ASN.1) [1], termed the Structure of
  203.    Management Information (SMI) (see RFC 1902 [2]).
  204.  
  205. 2.1.  A Note on Terminology
  206.  
  207.    The term "variable" refers to an instance of a non-aggregate object
  208.    type defined according to the conventions set forth in the SMI (RFC
  209.    1902, [2]) or the textual conventions based on the SMI (RFC 1903
  210.    [3]).  The term "variable binding" normally refers to the pairing of
  211.    the name of a variable and its associated value.  However, if certain
  212.    kinds of exceptional conditions occur during processing of a
  213.    retrieval request, a variable binding will pair a name and an
  214.    indication of that exception.
  215.  
  216.    A variable-binding list is a simple list of variable bindings.
  217.  
  218.    The name of a variable is an OBJECT IDENTIFIER, which is the
  219.    concatenation of the OBJECT IDENTIFIER of the corresponding object
  220.    type together with an OBJECT IDENTIFIER fragment identifying the
  221.  
  222.  
  223.  
  224.  
  225.  
  226. Daniele, et. al.            Standards Track                     [Page 4]
  227.  
  228. RFC 2257                        AgentX                      January 1998
  229.  
  230.  
  231.    instance.  The OBJECT IDENTIFIER of the corresponding object-type is
  232.    called the OBJECT IDENTIFIER prefix of the variable.  For the purpose
  233.    of exposition, the original Internet-standard
  234.  
  235.    Network Management Framework, as described in RFCs 1155 (STD 16),
  236.    1157 (STD 15), and 1212 (STD 16), is termed the SNMP version 1
  237.    framework (SNMPv1).  The current framework, as described in RFCs
  238.    1902-1908, is termed the SNMP version 2 framework (SNMPv2).
  239.  
  240. 3.  Extending the MIB
  241.  
  242.    New MIB modules that extend the Internet-standard MIB are
  243.    continuously being defined by various IETF working groups.  It is
  244.    also common for enterprises or individuals to create or extend
  245.    enterprise-specific or experimental MIBs.
  246.  
  247.    As a result, managed devices are frequently complex collections of
  248.    manageable components that have been independently installed on a
  249.    managed node.  Each component provides instrumentation for the
  250.    managed objects defined in the MIB module(s) it implements.
  251.  
  252.    Neither the SNMP version 1 nor version 2 framework describes how the
  253.    set of managed objects supported by a particular agent may be changed
  254.    dynamically.
  255.  
  256. 3.1.  Motivation for AgentX
  257.  
  258.    This very real need to dynamically extend the management objects
  259.    within a node has given rise to a variety of "extensible agents",
  260.    which typically comprise
  261.  
  262.       - a "master" agent that is available on the standard transport
  263.         address and that accepts SNMP protocol messages
  264.  
  265.       - a set of "subagents" that each contain management
  266.         instrumentation
  267.  
  268.       - a protocol that operates between the master agent and subagents,
  269.         permitting subagents to "connect" to the master agent, and the
  270.         master agent to multiplex received SNMP protocol messages
  271.         amongst the subagents.
  272.  
  273.       - a set of tools to aid subagent development, and a runtime (API)
  274.         environment that hides much of the protocol operation between a
  275.         subagent and the master agent.
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282. Daniele, et. al.            Standards Track                     [Page 5]
  283.  
  284. RFC 2257                        AgentX                      January 1998
  285.  
  286.  
  287.    The wide deployment of extensible SNMP agents, coupled with the lack
  288.    of Internet standards in this area, makes it difficult to field
  289.    SNMP-manageable applications.  A vendor may have to support several
  290.    different subagent environments (APIs) in order to support different
  291.    target platforms.
  292.  
  293.    It can also become quite cumbersome to configure subagents and
  294.    (possibly multiple) master agents on a particular managed node.
  295.  
  296.    Specifying a standard protocol for agent extensibility (AgentX)
  297.    provides the technical foundation required to solve both of these
  298.    problems.  Independently developed AgentX-capable master agents and
  299.    subagents will be able to interoperate at the protocol level.
  300.    Vendors can continue to differentiate their products in all other
  301.    respects.
  302.  
  303. 4.  AgentX Framework
  304.  
  305.    Within the SNMP framework, a managed node contains a processing
  306.    entity, called an agent, which has access to management information.
  307.  
  308.    Within the AgentX framework, an agent is further defined to consist
  309.    of
  310.  
  311.       - a single processing entity called the master agent, which sends
  312.         and receives SNMP protocol messages in an agent role (as
  313.         specified by the SNMP version 1 and version 2 framework
  314.         documents) but typically has little or no direct access to
  315.         management information.
  316.  
  317.       - 0 or more processing entities called subagents, which are
  318.         "shielded" from the SNMP protocol messages processed by the
  319.         master agent, but which have access to management information.
  320.  
  321.    The master and subagent entities communicate via AgentX protocol
  322.    messages, as specified in this memo.  Other interfaces (if any) on
  323.    these entities, and their associated protocols, are outside the scope
  324.    of this document.  While some of the AgentX protocol messages appear
  325.    similar in syntax and semantics to the SNMP, bear in mind that AgentX
  326.    is not SNMP.
  327.  
  328.    The internal operations of AgentX are invisible to an SNMP entity
  329.    operating in a manager role.  From a manager's point of view, an
  330.    extensible agent behaves exactly as would a non-extensible
  331.    (monolithic) agent that has access to the same management
  332.    instrumentation.
  333.  
  334.  
  335.  
  336.  
  337.  
  338. Daniele, et. al.            Standards Track                     [Page 6]
  339.  
  340. RFC 2257                        AgentX                      January 1998
  341.  
  342.  
  343.    This transparency to managers is a fundamental requirement of AgentX,
  344.    and is what differentiates AgentX subagents from SNMP proxy agents.
  345.  
  346. 4.1.  AgentX Roles
  347.  
  348.    An entity acting in a master agent role performs the following
  349.    functions:
  350.  
  351.       - Accepts AgentX session establishment requests from subagents.
  352.  
  353.       - Accepts registration of MIB regions by subagents.
  354.  
  355.       - Sends and accepts SNMP protocol messages on the agent's
  356.         specified transport addresses.
  357.  
  358.       - Implements the agent role Elements of Procedure specified
  359.         for the administrative framework applicable to the SNMP protocol
  360.         message, except where they specify performing management
  361.         operations.  (The application of MIB views, and the access
  362.         control policy for the managed node, are implemented by the
  363.         master agent.)
  364.  
  365.       - Provides instrumentation for the MIB objects defined in RFC
  366.         1907 [5], and for any MIB objects relevant to any administrative
  367.         framework it supports.
  368.  
  369.       - Sends and receives AgentX protocol messages to access
  370.         management information, based on the current registry of MIB
  371.         regions.
  372.  
  373.       - Forwards notifications on behalf of subagents.
  374.  
  375.    An entity acting in a subagent role performs the following functions:
  376.  
  377.       - Initiates an AgentX session with the master agent.
  378.  
  379.       - Registers MIB regions with the master agent.
  380.  
  381.       - Instantiates managed objects.
  382.  
  383.       - Binds OIDs within its registered MIB regions to actual
  384.         variables.
  385.  
  386.       - Performs management operations on variables.
  387.  
  388.       - Initiates notifications.
  389.  
  390.  
  391.  
  392.  
  393.  
  394. Daniele, et. al.            Standards Track                     [Page 7]
  395.  
  396. RFC 2257                        AgentX                      January 1998
  397.  
  398.  
  399. 4.2  Applicability
  400.  
  401.    It is intended that this memo specify the smallest amount of required
  402.    behavior necessary to achieve the largest benefit, that is, to cover
  403.    a very large number of possible MIB implementations and
  404.    configurations with minimum complexity and low "cost of entry".
  405.  
  406.    This section discusses several typical usage scenarios.
  407.  
  408.    1) Subagents implement separate MIB modules--for example,
  409.       subagent A implements "mib-2", subagent b implements "host-
  410.       resources".
  411.  
  412.       It is anticipated that this will be the most common subagent
  413.       configuration.
  414.  
  415.    2) Subagents implement rows in a "simple table".  A simple table
  416.       is one in which row creation is not specified, and for which the
  417.       MIB does not define an object that counts entries in the table.
  418.       Examples of simple tables are rdbmsDbTable, udpTable, and
  419.       hrSWRunTable.
  420.  
  421.       This is the most commonly defined type of MIB table, and probably
  422.       represents the next most typical configuration that AgentX would
  423.       support.
  424.  
  425.    3) Subagents share MIBs along non-row partitions.  Subagents
  426.       register "chunks" of the MIB that represent multiple rows, due to
  427.       the nature of the MIB's index structure.  Examples include
  428.       registering ipNetToMediaEntry.n, where n represents the ifIndex
  429.       value for an interface implemented by the subagent, and
  430.       tcpConnEntry.a.b.c.d, where a.b.c.d represents an IP address on an
  431.       interface implemented by the subagent.
  432.  
  433.    AgentX supports these three common configurations, and all
  434.    permutations of them, completely.  The consensus is that they
  435.    comprise a very large majority of current and likely future uses of
  436.    multi-vendor extensible agent configurations.
  437.  
  438.    4) Subagents implement rows in "complex tables".  Complex tables
  439.       here are defined as tables permitting row creation, or whose MIB
  440.       also defines an object that counts entries in the table.  Examples
  441.       include the MIB-2 ifTable (due to ifNumber), and the RMON
  442.       historyControlTable.
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450. Daniele, et. al.            Standards Track                     [Page 8]
  451.  
  452. RFC 2257                        AgentX                      January 1998
  453.  
  454.  
  455.    The subagent that implements such a counter object (like ifNumber)
  456.    must go beyond AgentX to correctly implement it.  This is an
  457.    implementation issue (and most new MIB designs no longer include such
  458.    objects).
  459.  
  460.    To implement row creation in such tables, at least one AgentX
  461.    subagent must register at a point "higher" in the OID tree than an
  462.    individual row (per AgentX's dispatching procedure).  Again, this is
  463.    an implementation issue.
  464.  
  465.    Scenarios in this category were thought to occur somewhat rarely in
  466.    configurations where subagents are independently implemented by
  467.    different vendors.  The focus of a standard protocol, however, must
  468.    be in just those areas where multi- vendor interoperability must be
  469.    assured.
  470.  
  471.    Note that it would be inefficient (due to AgentX registration
  472.    overhead) to share a table among AgentX subagents if the table
  473.    contains very dynamic instances, and each subagent registers fully
  474.    qualified instances.  ipRouteTable could be an example of such a
  475.    table in some environments.
  476.  
  477. 4.3.  Design Features of AgentX
  478.  
  479.    The primary features of the design described in this memo are:
  480.  
  481.    1) A general architectural division of labor between master agent
  482.       and subagent: The master agent is MIB ignorant and SNMP
  483.       omniscient, while the subagent is SNMP ignorant and MIB omniscient
  484.       (for the MIB variables it instantiates).  That is, master agents,
  485.       exclusively, are concerned with SNMP protocol operations and the
  486.       translations to and from AgentX protocol operations needed to
  487.       carry them out; subagents are exclusively concerned with
  488.       management instrumentation; and neither should intrude on the
  489.       other's territory.
  490.  
  491.    2) A standard protocol and "rules of engagement" to enable
  492.       interoperability between management instrumentation and extensible
  493.       agents.
  494.  
  495.    3) Mechanisms for independently developed subagents to
  496.       integrate into the extensible agent on a particular managed node
  497.       in such a way that they need not be aware of any other existing
  498.       subagents.
  499.  
  500.  
  501.  
  502.  
  503.  
  504.  
  505.  
  506. Daniele, et. al.            Standards Track                     [Page 9]
  507.  
  508. RFC 2257                        AgentX                      January 1998
  509.  
  510.  
  511.    4) A simple, deterministic registry and dispatching algorithm.
  512.       For a given extensible agent configuration, there is a single
  513.       subagent who is "authoritative" for any particular region of the
  514.       MIB (where "region" may extend from an entire MIB down to a single
  515.       object-instance).
  516.  
  517.    5) Performance considerations.  It is likely that the master
  518.       agent and all subagents will reside on the same host, and in such
  519.       cases AgentX is more a form of inter-process communication than a
  520.       traditional communications protocol.
  521.  
  522.       Some of the design decisions made with this in mind include:
  523.  
  524.          - 32-bit alignment of data within PDUs
  525.  
  526.          - Native byte-order encoding by subagents
  527.  
  528.          - Large AgentX PDU payload sizes.
  529.  
  530. 4.4  Non-Goals
  531.  
  532.    1) Subagent-to-subagent communication.  This is out of scope,
  533.       due to the security ramifications and complexity involved.
  534.  
  535.    2) Subagent access (via the master agent) to MIB variables.
  536.       This is not addressed, since various other mechanisms are
  537.       available and it was not a fundamental requirement.
  538.  
  539.    3) The ability to accommodate every conceivable extensible
  540.       agent configuration option. This was the most contentious aspect
  541.       in the development of this protocol.  In essence, certain features
  542.       currently available in some commercial extensible agent products
  543.       are not included in AgentX.  Although useful or even vital in some
  544.       implementation strategies, the rough consensus was that these
  545.       features were not appropriate for an Internet Standard, or not
  546.       typically required for independently developed subagents to
  547.       coexist.  The set of supported extensible agent configurations is
  548.       described above, in Section 4.2.
  549.  
  550.    Some possible future version of the AgentX protocol may provide
  551.    coverage for one or more of these "non-goals" or for new goals that
  552.    might be identified after greater deployment experience.
  553.  
  554. 5.  AgentX Encodings
  555.  
  556.    AgentX PDUs consist of a common header, followed by PDU-specific data
  557.    of variable length.  Unlike SNMP PDUs, AgentX PDUs are not encoded
  558.    using the BER (as specified in ISO 8824 [1]), but are transmitted as
  559.  
  560.  
  561.  
  562. Daniele, et. al.            Standards Track                    [Page 10]
  563.  
  564. RFC 2257                        AgentX                      January 1998
  565.  
  566.  
  567.    a contiguous byte stream.  The data within this stream is organized
  568.    to provide natural alignment with respect to the start of the PDU,
  569.    permitting direct (integer) access by the processing entities.
  570.  
  571.    The first four fields in the header are single-byte values.  A bit
  572.    (NETWORK_BYTE_ORDER) in the third field (h.flags) is used to indicate
  573.    the byte ordering of all multi-byte integer values in the PDU,
  574.    including those which follow in the header itself.  This is described
  575.    in more detail in Section 6.1, "AgentX PDU Header", below.
  576.  
  577.    PDUs are depicted in this memo using the following convention (where
  578.    byte 1 is the first transmitted byte):
  579.  
  580.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  581.    |  byte 1       |  byte 2       |  byte 3       |  byte 4       |
  582.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  583.    |  byte 5       |  byte 6       |  byte 7       |  byte 8       |
  584.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  585.  
  586.    Fields marked "<reserved>" are reserved for future use and must be
  587.    zero-filled.
  588.  
  589. 5.1.  Object Identifier
  590.  
  591.    An object identifier is encoded as a 4-byte header, followed by a
  592.    variable number of contiguous 4-byte fields representing sub-
  593.    identifiers.  This representation (termed Object Identifier) is as
  594.    follows:
  595.  
  596.    Object Identifier
  597.  
  598.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  599.    |  n_subid      |  prefix       |  include      |  <reserved>   |
  600.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  601.    |                       sub-identifier #1                       |
  602.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  603.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  604.    |                       sub-identifier #n_subid                 |
  605.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  606.  
  607.    Object Identifier header fields:
  608.  
  609.       n_subid
  610.  
  611.          The number (0-128) of sub-identifiers in the object identifier.
  612.          An ordered list of "n_subid" 4-byte sub-identifiers follows the
  613.          4-byte header.
  614.  
  615.  
  616.  
  617.  
  618. Daniele, et. al.            Standards Track                    [Page 11]
  619.  
  620. RFC 2257                        AgentX                      January 1998
  621.  
  622.  
  623.       prefix
  624.  
  625.          An unsigned value used to reduce the length of object
  626.          identifier encodings.  A non-zero value "x" is interpreted as
  627.          the first sub-identifier after "internet" (1.3.6.1), and
  628.          indicates an implicit prefix "internet.x" to the actual sub-
  629.          identifiers encoded in the Object Identifier.  For example, a
  630.          prefix field value 2 indicates an implicit prefix "1.3.6.1.2".
  631.          A value of 0 in the prefix field indicates there is no prefix
  632.          to the sub-identifiers.
  633.  
  634.       include
  635.  
  636.          Used only when the Object Identifier is the start of a
  637.          SearchRange, as described in section 5.2.
  638.  
  639.    A null Object Identifier consists of the 4-byte header with all bytes
  640.    set to 0.
  641.  
  642.    Examples:
  643.  
  644.    sysDescr.0 (1.3.6.1.2.1.1.1.0)
  645.  
  646.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  647.    | 4             | 2             | 0             | 0             |
  648.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  649.    | 1                                                             |
  650.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  651.    | 1                                                             |
  652.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  653.    | 1                                                             |
  654.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  655.    | 0                                                             |
  656.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  657.  
  658.    1.2.3.4
  659.  
  660.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  661.    | 4             | 0             | 0             | 0             |
  662.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  663.    | 1                                                             |
  664.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  665.    | 2                                                             |
  666.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  667.    | 3                                                             |
  668.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  669.    | 4                                                             |
  670.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  671.  
  672.  
  673.  
  674. Daniele, et. al.            Standards Track                    [Page 12]
  675.  
  676. RFC 2257                        AgentX                      January 1998
  677.  
  678.  
  679. 5.2.  SearchRange
  680.  
  681.    A SearchRange consists of two Object Identifiers.  In its
  682.    communication with a subagent, the master agent uses a SearchRange to
  683.    identify a requested variable binding, and, in GetNext and GetBulk
  684.    operations, to set an upper bound on the names of managed object
  685.    instances the subagent may send in reply.
  686.  
  687.    The first Object Identifier in a SearchRange (called the starting
  688.    OID) indicates the beginning of the range.  It is frequently (but not
  689.    necessarily) the name of a requested variable binding.
  690.  
  691.    The "include" field in this OID's header is a boolean value (0 or 1)
  692.    indicating whether or not the starting OID is included in the range.
  693.  
  694.    The second object identifier indicates the non-inclusive end of the
  695.    range, and its "include" field is always 0.
  696.  
  697.    Example:  To indicate a search range from 1.3.6.1.2.1.25.2
  698.    (inclusive) to 1.3.6.1.2.1.25.2.1 (exclusive), the SearchRange would
  699.    be
  700.  
  701.    (start)
  702.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  703.    | 3             | 2             | 1             |       0       |
  704.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  705.    | 1                                                             |
  706.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  707.    | 25                                                            |
  708.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  709.    | 2                                                             |
  710.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  711.  
  712.    (end)
  713.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  714.    | 4             | 2             | 0             |       0       |
  715.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  716.    | 1                                                             |
  717.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  718.    | 25                                                            |
  719.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  720.    | 2                                                             |
  721.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  722.    | 1                                                             |
  723.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  724.  
  725.    A SearchRangeList is a contiguous list of SearchRanges.
  726.  
  727.  
  728.  
  729.  
  730. Daniele, et. al.            Standards Track                    [Page 13]
  731.  
  732. RFC 2257                        AgentX                      January 1998
  733.  
  734.  
  735. 5.3.  Octet String
  736.  
  737.    An octet string is represented by a contiguous series of bytes,
  738.    beginning with a 4-byte integer whose value is the number of octets
  739.    in the octet string, followed by the octets themselves.  This
  740.    representation is termed an Octet String.  If the last octet does not
  741.    end on a 4-byte offset from the start of the Octet String, padding
  742.    bytes are appended to achieve alignment of following data.  This
  743.    padding must be added even if the Octet String is the last item in
  744.    the PDU.  Padding bytes must be zero filled.
  745.  
  746.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  747.    |                     Octet String Length (L)                   |
  748.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  749.    |  Octet 1      |  Octet 2      |   Octet 3     |   Octet 4     |
  750.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  751.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  752.    |  Octet L - 1  |  Octet L      |       Padding (as required)   |
  753.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  754.  
  755.    A null Octet String consists of a 4-byte length field set to 0.
  756.  
  757. 5.4.  Value Representation
  758.  
  759.    Variable bindings may be encoded within the variable-length portion
  760.    of some PDUs.  The representation of a variable binding (termed a
  761.    VarBind) consists of a 2-byte type field, a name (Object Identifier),
  762.    and the actual value data.
  763.  
  764.    VarBind
  765.  
  766.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  767.    |          v.type               |          <reserved>           |
  768.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  769.  
  770.    (v.name)
  771.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  772.    |  n_subid      |  prefix       |      0        |       0       |
  773.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  774.    |                       sub-identifier #1                       |
  775.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  776.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  777.    |                       sub-identifier #n_subid                 |
  778.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  779.  
  780.  
  781.  
  782.  
  783.  
  784.  
  785.  
  786. Daniele, et. al.            Standards Track                    [Page 14]
  787.  
  788. RFC 2257                        AgentX                      January 1998
  789.  
  790.  
  791.    (v.data)
  792.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  793.    |                       data                                    |
  794.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  795.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  796.    |                       data                                    |
  797.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  798.  
  799.    VarBind fields:
  800.  
  801.    v.type
  802.  
  803.          Indicates the variable binding's syntax, and must be one of
  804.          the following values:
  805.  
  806.                      Integer                  (2),
  807.                      Octet String             (4),
  808.                      Null                     (5),
  809.                      Object Identifier        (6),
  810.                      IpAddress               (64),
  811.                      Counter32               (65),
  812.                      Gauge32                 (66),
  813.                      TimeTicks               (67),
  814.                      Opaque                  (68),
  815.                      Counter64               (70),
  816.                      noSuchObject           (128),
  817.                      noSuchInstance         (129),
  818.                      endOfMibView           (130)
  819.  
  820.    v.name
  821.  
  822.          The Object Identifier which names the variable.
  823.  
  824.    v.data
  825.  
  826.          The actual value, encoded as follows:
  827.  
  828.           - Integer, Counter32, Gauge32, and TimeTicks are encoded as
  829.             4 contiguous bytes.  If the NETWORK_BYTE_ORDER bit is set
  830.             in h.flags, the bytes are ordered most significant to least
  831.             significant, otherwise they are ordered least significant
  832.             to most significant.
  833.  
  834.           - Counter64 is encoded as 8 contiguous bytes.  If the
  835.             NETWORK_BYTE_ORDER bit is set in h.flags, the bytes are
  836.             ordered most significant to least significant, otherwise
  837.             they are ordered least significant to most significant.
  838.  
  839.  
  840.  
  841.  
  842. Daniele, et. al.            Standards Track                    [Page 15]
  843.  
  844. RFC 2257                        AgentX                      January 1998
  845.  
  846.  
  847.           - Object Identifiers are encoded as described in section
  848.             5.1, Object Identifier.
  849.  
  850.           - IpAddress, Opaque, and Octet String are all octet strings
  851.             and are encoded as described in section 5.3, Octet String.
  852.  
  853.             Value data always follows v.name whenever v.type is one
  854.             of the above types.  These data bytes are present even if
  855.             they will not be used (as, for example, in certain types
  856.             of index allocation).
  857.  
  858.           - Null, noSuchObject, noSuchInstance, and endOfMibView do not
  859.             contain any encoded value.  Value data never follows
  860.             v.name in these cases.
  861.  
  862.          Note that the VarBind itself does not contain the value size.
  863.          That information is implied for the fixed-length types, and
  864.          explicitly contained in the encodings of variable-length types
  865.          (Object Identifier and Octet String).
  866.  
  867.    A VarBindList is a contiguous list of VarBinds.  Within a
  868.    VarBindList, a particular VarBind is identified by an index value.
  869.    The first VarBind in a VarBindList has index value 1, the second
  870.    has index value 2, and so on.
  871.  
  872. 6.  Protocol Definitions
  873.  
  874. 6.1.  AgentX PDU Header
  875.  
  876.    The AgentX PDU header is a fixed-format, 20-octet structure:
  877.  
  878.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  879.    |   h.version   |    h.type     |    h.flags    |  <reserved>   |
  880.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  881.    |                          h.sessionID                          |
  882.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  883.    |                        h.transactionID                        |
  884.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  885.    |                          h.packetID                           |
  886.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  887.    |                        h.payload_length                       |
  888.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  889.  
  890.    An AgentX PDU header contains the following fields:
  891.  
  892.       h.version
  893.  
  894.          The version of the AgentX protocol (1 for this memo).
  895.  
  896.  
  897.  
  898. Daniele, et. al.            Standards Track                    [Page 16]
  899.  
  900. RFC 2257                        AgentX                      January 1998
  901.  
  902.  
  903.       h.type
  904.  
  905.          The PDU type; one of the following values:
  906.  
  907.               agentx-Open-PDU             (1),
  908.               agentx-Close-PDU            (2),
  909.               agentx-Register-PDU         (3),
  910.               agentx-Unregister-PDU       (4),
  911.               agentx-Get-PDU              (5),
  912.               agentx-GetNext-PDU          (6),
  913.               agentx-GetBulk-PDU          (7),
  914.               agentx-TestSet-PDU          (8),
  915.               agentx-CommitSet-PDU        (9),
  916.               agentx-UndoSet-PDU         (10),
  917.               agentx-CleanupSet-PDU      (11),
  918.               agentx-Notify-PDU          (12),
  919.               agentx-Ping-PDU            (13),
  920.               agentx-IndexAllocate-PDU   (14),
  921.               agentx-IndexDeallocate-PDU (15),
  922.               agentx-AddAgentCaps-PDU    (16),
  923.               agentx-RemoveAgentCaps-PDU (17),
  924.               agentx-Response-PDU        (18)
  925.  
  926.       h.flags
  927.  
  928.          A bitmask, with bit 0 the least significant bit.  The bit
  929.          definitions are as follows:
  930.  
  931.                  Bit             Definition
  932.                  ---             ----------
  933.                  0               INSTANCE_REGISTRATION
  934.                  1               NEW_INDEX
  935.                  2               ANY_INDEX
  936.                  3               NON_DEFAULT_CONTEXT
  937.                  4               NETWORK_BYTE_ORDER
  938.                  5-7             (reserved)
  939.  
  940.          The NETWORK_BYTE_ORDER bit applies to all multi-byte integer
  941.          values in the entire AgentX packet, including the remaining
  942.          header fields.  If set, then network byte order (most
  943.          significant byte first; "big endian") is used.  If not set,
  944.          then least significant byte first ("little endian") is used.
  945.  
  946.          The NETWORK_BYTE_ORDER bit applies to all AgentX PDUs.
  947.  
  948.          The NON_DEFAULT_CONTEXT bit is used only in the AgentX PDUs
  949.          described in section 6.1.1.
  950.  
  951.  
  952.  
  953.  
  954. Daniele, et. al.            Standards Track                    [Page 17]
  955.  
  956. RFC 2257                        AgentX                      January 1998
  957.  
  958.  
  959.          The NEW_INDEX and ANY_INDEX bits are used only within the
  960.          agentx-IndexAllocate-, and -IndexDeallocate-PDUs.
  961.  
  962.          The INSTANCE_REGISTRATION bit is used only within the agentx-
  963.          Register-PDU.
  964.  
  965.       h.sessionID
  966.  
  967.          The session ID uniquely identifies a session over which AgentX
  968.          PDUs are exchanged between a subagent and the master agent.
  969.          The session ID has no significance and no defined value in the
  970.          agentx-Open-PDU sent by a subagent to open a session with the
  971.          master agent; in this case, the master agent will assign a
  972.          unique sessionID that it will pass back in the corresponding
  973.          agentx-Response-PDU.  From that point on, that same sessionID
  974.          will appear in every AgentX PDU exchanged over that session
  975.          between the master and the subagent.  A subagent may establish
  976.          multiple AgentX sessions by sending multiple agentx-Open-PDUs
  977.          to the master agent.
  978.  
  979.          In master agents that support multiple transport protocols, the
  980.          sessionID should be globally unique rather than unique just to
  981.          a particular transport.
  982.  
  983.       h.transactionID
  984.  
  985.          The transaction ID uniquely identifies, for a given session,
  986.          the single SNMP management request (and single SNMP PDU) with
  987.          which an AgentX PDU is associated.  If a single SNMP management
  988.          request results in multiple AgentX PDUs being sent by the
  989.          master agent with the same sessionID, each of these AgentX PDUs
  990.          must contain the same transaction ID; conversely, AgentX PDUs
  991.          sent during a particular session, that result from distinct
  992.          SNMP management requests, must have distinct transaction IDs
  993.          within the limits of the 32-bit field).
  994.  
  995.          Note that the transaction ID is not the same as the SNMP PDU's
  996.          request-id (as described in section 4.1 of RFC 1905 [4]), nor
  997.          can it be, since a master agent might receive SNMP requests
  998.          with the same request-ids from different managers.
  999.  
  1000.          The transaction ID has no significance and no defined value in
  1001.          AgentX administrative PDUs, i.e., AgentX PDUs that are not
  1002.          associated with an SNMP management request.
  1003.  
  1004.  
  1005.  
  1006.  
  1007.  
  1008.  
  1009.  
  1010. Daniele, et. al.            Standards Track                    [Page 18]
  1011.  
  1012. RFC 2257                        AgentX                      January 1998
  1013.  
  1014.  
  1015.       h.packetID
  1016.  
  1017.          A packet ID generated by the sender for all AgentX PDUs except
  1018.          the agentx-Response-PDU. In an agentx-Response-PDU, the packet
  1019.          ID must be the same as that in the received AgentX PDU to which
  1020.          it is a response.  A master agent might use this field to
  1021.          associate subagent response PDUs with their corresponding
  1022.          request PDUs.  A subagent might use this field to correlate
  1023.          responses to multiple (batched) registrations.
  1024.  
  1025.       h.payload_length
  1026.  
  1027.          The size in octets of the PDU contents, excluding the 20-byte
  1028.          header.  As a result of the encoding schemes and PDU layouts,
  1029.          this value will always be either 0, or a multiple of 4.
  1030.  
  1031. 6.1.1.  Context
  1032.  
  1033.    In the SNMPv1 or v2c frameworks, the community string may be used as
  1034.    an index into a local repository of configuration information that
  1035.    may include community profiles or more complex context information.
  1036.    Future versions of the SNMP will likely formalize this notion of
  1037.    "context".
  1038.  
  1039.    AgentX provides a mechanism for transmitting a context specification
  1040.    within relevant PDUs, but does not place any constraints on the
  1041.    content of that specification.
  1042.  
  1043.    An optional context field may be present in the agentx-Register-,
  1044.    UnRegister-, AddAgentCaps-, RemoveAgentCaps-, Get-, GetNext-,
  1045.    GetBulk-, IndexAllocate-, IndexDeallocate-, Notify-, TestSet-, and
  1046.    Ping- PDUs.
  1047.  
  1048.    If the NON_DEFAULT_CONTEXT bit in the AgentX header field h.flags is
  1049.    clear, then there is no context field in the PDU, and the operation
  1050.    refers to the default context.
  1051.  
  1052.    If the NON_DEFAULT_CONTEXT bit is set, then a context field
  1053.    immediately follows the AgentX header, and the operation refers to
  1054.    that specific context.  The context is represented as an Octet
  1055.    String.  There are no constraints on its length or contents.
  1056.  
  1057.    Thus, all of these AgentX PDUs (that is, those listed immediately
  1058.    above) refer to, or "indicate" a context, which is either the default
  1059.    context, or a non-default context explicitly named in the PDU.
  1060.  
  1061.  
  1062.  
  1063.  
  1064.  
  1065.  
  1066. Daniele, et. al.            Standards Track                    [Page 19]
  1067.  
  1068. RFC 2257                        AgentX                      January 1998
  1069.  
  1070.  
  1071. 6.2.  AgentX PDUs
  1072.  
  1073. 6.2.1.  The agentx-Open-PDU
  1074.  
  1075.    An agentx-Open-PDU is generated by a subagent to request
  1076.    establishment of an AgentX session with the master agent.
  1077.  
  1078.    (AgentX header)
  1079.  
  1080.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1081.    | h.version (1) |  h.type (1)   |    h.flags    |  <reserved>   |
  1082.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1083.    |                          h.sessionID                          |
  1084.    +-+-+-+-+-+-+-|
  1085.    +-+-+-+-+-+-+-+--+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1086.    |                        h.transactionID                        |
  1087.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1088.    |                           h.packetID                          |
  1089.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1090.    |                        h.payload_length                       |
  1091.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1092.  
  1093.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1094.    |  o.timeout    |                     <reserved>                |
  1095.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1096.  
  1097.    (o.id)
  1098.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1099.    |  n_subid      |  prefix       |       0       |  <reserved>   |
  1100.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1101.    |             subidentifier #1                                  |
  1102.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1103.    ...                                                             |
  1104.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1105.    |             subidentifier #n_subid                            |
  1106.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1107.  
  1108.    (o.descr)
  1109.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1110.    |                     Octet String Length (L)                   |
  1111.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1112.    |  Octet 1      |  Octet 2      |   Octet 3     |   Octet 4     |
  1113.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1114.    ...
  1115.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1116.    |  Octet L - 1  |  Octet L      |       Padding (as required)   |
  1117.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1118.  
  1119.    An agentx-Open-PDU contains the following fields:
  1120.  
  1121.  
  1122.  
  1123. Daniele, et. al.            Standards Track                    [Page 20]
  1124.  
  1125. RFC 2257                        AgentX                      January 1998
  1126.  
  1127.  
  1128.       o.timeout
  1129.  
  1130.          The length of time, in seconds, that a master agent should
  1131.          allow to elapse after dispatching a message to a subagent
  1132.          before it regards the subagent as not responding.  This is a
  1133.          subagent-wide default value that may be overridden by values
  1134.          associated with specific registered MIB regions.  The default
  1135.          value of 0 indicates that no subagent-wide value is requested.
  1136.  
  1137.       o.id
  1138.  
  1139.          An Object Identifier that identifies the subagent.  Subagents
  1140.          that do not support such an notion may send a null Object
  1141.          Identifier.
  1142.  
  1143.       o.descr
  1144.  
  1145.          An Octet String containing a DisplayString describing the
  1146.          subagent.
  1147.  
  1148. 6.2.2.  The agentx-Close-PDU
  1149.  
  1150.    An agentx-Close-PDU issued by either a subagent or the master agent
  1151.    terminates an AgentX session.
  1152.  
  1153.    (AgentX header)
  1154.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1155.    | h.version (1) |  h.type (2)   |    h.flags    |  <reserved>   |
  1156.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1157.    |                          h.sessionID                          |
  1158.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1159.    |                        h.transactionID                        |
  1160.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1161.    |                           h.packetID                          |
  1162.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1163.    |                        h.payload_length                       |
  1164.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1165.  
  1166.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1167.    |  c.reason     |                     <reserved>                |
  1168.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1169.  
  1170.    An agentx-Close-PDU contains the following field:
  1171.  
  1172.  
  1173.  
  1174.  
  1175.  
  1176.  
  1177.  
  1178.  
  1179. Daniele, et. al.            Standards Track                    [Page 21]
  1180.  
  1181. RFC 2257                        AgentX                      January 1998
  1182.  
  1183.  
  1184.       c.reason
  1185.  
  1186.          An enumerated value that gives the reason that the master agent
  1187.          or subagent closed the AgentX session.  This field may take one
  1188.          of the following values:
  1189.  
  1190.             reasonOther(1)
  1191.                None of the following reasons
  1192.  
  1193.             reasonParseError(2)
  1194.                Too many AgentX parse errors from peer
  1195.  
  1196.             reasonProtocolError(3)
  1197.                Too many AgentX protocol errors from peer
  1198.  
  1199.             reasonTimeouts(4)
  1200.                Too many timeouts waiting for peer
  1201.  
  1202.             reasonShutdown(5)
  1203.                Sending entity is shutting down
  1204.  
  1205.             reasonByManager(6)
  1206.                Due to Set operation; this reason code can be used only
  1207.                by the master agent, in response to an SNMP management
  1208.                request.
  1209.  
  1210. 6.2.3.  The agentx-Register-PDU
  1211.  
  1212.    An agentx-Register-PDU is generated by a subagent for each region of
  1213.    the MIB variable naming tree (within one or more contexts) that it
  1214.    wishes to support.
  1215.  
  1216.     (AgentX header)
  1217.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1218.    | h.version (1) |  h.type (3)   |    h.flags    |  <reserved>   |
  1219.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1220.    |                          h.sessionID                          |
  1221.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1222.    |                        h.transactionID                        |
  1223.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1224.    |                           h.packetID                          |
  1225.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1226.    |                        h.payload_length                       |
  1227.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1228.  
  1229.  
  1230.  
  1231.  
  1232.  
  1233.  
  1234.  
  1235. Daniele, et. al.            Standards Track                    [Page 22]
  1236.  
  1237. RFC 2257                        AgentX                      January 1998
  1238.  
  1239.  
  1240.     (r.context) (OPTIONAL)
  1241.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1242.     |                     Octet String Length (L)                   |
  1243.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1244.     |  Octet 1      |  Octet 2      |   Octet 3     |   Octet 4     |
  1245.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1246.     ...
  1247.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1248.     |  Octet L - 1  |  Octet L      |       Padding (as required)   |
  1249.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1250.  
  1251.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1252.     |  r.timeout    |  r.priority   | r.range_subid |  <reserved>   |
  1253.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1254.  
  1255.     (r.region)
  1256.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1257.     |  n_subid      |  prefix       |      0        |  <reserved>   |
  1258.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1259.     |             sub-identifier #1                                 |
  1260.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1261.     ...
  1262.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1263.     |             sub-identifier #n_subid                           |
  1264.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1265.  
  1266.     (r.upper_bound)
  1267.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1268.     |             optional upper-bound sub-identifier               |
  1269.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1270.  
  1271.    An agentx-Register-PDU contains the following fields:
  1272.  
  1273.       r.context
  1274.  
  1275.          An optional non-default context.
  1276.  
  1277.       r.timeout
  1278.  
  1279.          The length of time, in seconds, that a master agent should
  1280.          allow to elapse after dispatching a message to a subagent
  1281.          before it regards the subagent as not responding.  r.timeout
  1282.          applies only to messages that concern MIB objects within
  1283.          r.region.  It overrides both the subagent-wide value (if any)
  1284.          indicated when the AgentX session with the master agent was
  1285.          established, and the master agent's default timeout.  The
  1286.          default value for r.timeout is 0 (no override).
  1287.  
  1288.  
  1289.  
  1290.  
  1291. Daniele, et. al.            Standards Track                    [Page 23]
  1292.  
  1293. RFC 2257                        AgentX                      January 1998
  1294.  
  1295.  
  1296.       r.priority
  1297.  
  1298.          A value between 1 and 255, used to achieve a desired
  1299.          configuration when different subagents register identical or
  1300.          overlapping regions.  Subagents with no particular knowledge of
  1301.          priority should register with the default value of 255 (lowest
  1302.          priority).
  1303.  
  1304.          In the master agent's dispatching algorithm, smaller values of
  1305.          r.priority take precedence over larger values, as described in
  1306.          section 7.1.5.1.
  1307.  
  1308.       r.region
  1309.  
  1310.          An Object Identifier that, in conjunction with r.range_subid,
  1311.          indicates a region of the MIB that a subagent wishes to
  1312.          support.  It may be a fully-qualified instance name, a partial
  1313.          instance name, a MIB table, an entire MIB, or ranges of any of
  1314.          these.
  1315.  
  1316.          The choice of what to register is implementation-specific; this
  1317.          memo does not specify permissible values.  Standard practice
  1318.          however is for a subagent to register at the highest level of
  1319.          the naming tree that makes sense.  Registration of fully-
  1320.          qualified instances is typically done only when a subagent can
  1321.          perform management operations only on particular rows of a
  1322.          conceptual table.
  1323.  
  1324.          If r.region is in fact a fully qualified instance name, the
  1325.          INSTANCE_REGISTRATION bit in h.flags must be set, otherwise it
  1326.          must be cleared.  The master agent may save this information to
  1327.          optimize subsequent operational dispatching.
  1328.  
  1329.       r.range_subid
  1330.  
  1331.          Permits specifying a range in place of one of r.region's sub-
  1332.          identifiers.  If this value is 0, no range is specified.
  1333.          Otherwise the "r.range_subid"-th sub-identifier in r.region is
  1334.          a range lower bound, and the range upper bound sub-identifier
  1335.          (r.upper_bound) immediately follows r.region.
  1336.  
  1337.          This permits registering a conceptual row with a single PDU.
  1338.          For example, the following PDU would register row 7 of the RFC
  1339.          1573 ifTable (1.3.6.1.2.1.2.2.1.1-22.7):
  1340.  
  1341.  
  1342.  
  1343.  
  1344.  
  1345.  
  1346.  
  1347. Daniele, et. al.            Standards Track                    [Page 24]
  1348.  
  1349. RFC 2257                        AgentX                      January 1998
  1350.  
  1351.  
  1352.    (AgentX header)
  1353.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1354.    | h.version (1) |  h.type (3)   |    h.flags    |  <reserved>   |
  1355.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1356.    |                          h.sessionID                          |
  1357.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1358.    |                        h.transactionID                        |
  1359.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1360.    |                           h.packetID                          |
  1361.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1362.    |                        h.payload_length                       |
  1363.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1364.  
  1365.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1366.    |   r.timeout   |  r.priority   | 5             |  <reserved>   |
  1367.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1368.  
  1369.    (r.region)
  1370.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1371.    | 6             |  2            |  0            |  <reserved>   |
  1372.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1373.    | 1                                                             |
  1374.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1375.    | 2                                                             |
  1376.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1377.    | 2                                                             |
  1378.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1379.    | 1                                                             |
  1380.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1381.    | 1                                                             |
  1382.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1383.    | 7                                                             |
  1384.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1385.  
  1386.    (r.upper_bound)
  1387.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1388.    | 22                                                            |
  1389.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1390.  
  1391. 6.2.4.  The agentx-Unregister-PDU
  1392.  
  1393.    The agentx-Unregister-PDU is sent by a subagent to remove a
  1394.    previously registered MIB region from the master agent's OID space.
  1395.  
  1396.  
  1397.  
  1398.  
  1399.  
  1400.  
  1401.  
  1402.  
  1403. Daniele, et. al.            Standards Track                    [Page 25]
  1404.  
  1405. RFC 2257                        AgentX                      January 1998
  1406.  
  1407.  
  1408.    (AgentX header)
  1409.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1410.    | h.version (1) |  h.type (4)   |    h.flags    |  <reserved>   |
  1411.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1412.    |                          h.sessionID                          |
  1413.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1414.    |                        h.transactionID                        |
  1415.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1416.    |                           h.packetID                          |
  1417.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1418.    |                        h.payload_length                       |
  1419.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1420.  
  1421.    (u.context) OPTIONAL
  1422.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1423.    |                     Octet String Length (L)                   |
  1424.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1425.    |  Octet 1      |  Octet 2      |   Octet 3     |   Octet 4     |
  1426.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1427.    ...
  1428.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1429.    |  Octet L - 1  |  Octet L      |       Padding (as required)   |
  1430.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1431.  
  1432.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1433.    |    <reserved> |  u.priority   | u.range_subid |  <reserved>   |
  1434.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1435.  
  1436.    (u.region)
  1437.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1438.    |  n_subid      |  prefix       |      0        |  <reserved>   |
  1439.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1440.    |             sub-identifier #1                                 |
  1441.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1442.    ...
  1443.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1444.    |             sub-identifier #n_subid                           |
  1445.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1446.  
  1447.    (u.upper_bound)
  1448.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1449.    |             optional upper-bound sub-identifier               |
  1450.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1451.  
  1452.    An agentx-Unregister-PDU contains the following fields:
  1453.  
  1454.  
  1455.  
  1456.  
  1457.  
  1458.  
  1459. Daniele, et. al.            Standards Track                    [Page 26]
  1460.  
  1461. RFC 2257                        AgentX                      January 1998
  1462.  
  1463.  
  1464.       u.context
  1465.  
  1466.          An optional non-default context.
  1467.  
  1468.       u.priority
  1469.  
  1470.          The priority at which this region was originally registered.
  1471.  
  1472.       u.region
  1473.  
  1474.          Indicates a previously-registered region of the MIB that a
  1475.          subagent no longer wishes to support.
  1476.  
  1477. 6.2.5.  The agentx-Get-PDU
  1478.  
  1479.     (AgentX header)
  1480.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1481.     | h.version (1) |  h.type (5)   |    h.flags    |  <reserved>   |
  1482.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1483.     |                          h.sessionID                          |
  1484.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1485.     |                        h.transactionID                        |
  1486.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1487.     |                           h.packetID                          |
  1488.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1489.     |                        h.payload_length                       |
  1490.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1491.  
  1492.     (g.context) OPTIONAL
  1493.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1494.     |                     Octet String Length (L)                   |
  1495.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1496.     |  Octet 1      |  Octet 2      |   Octet 3     |   Octet 4     |
  1497.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1498.     ...
  1499.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1500.     |  Octet L - 1  |  Octet L      |       Padding (as required)   |
  1501.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1502.  
  1503.     (g.sr)
  1504.  
  1505.     (start 1)
  1506.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1507.     |  n_subid      |  prefix       |  include      |  <reserved>   |
  1508.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1509.     |             sub-identifier #1                                 |
  1510.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1511.  
  1512.  
  1513.  
  1514.  
  1515. Daniele, et. al.            Standards Track                    [Page 27]
  1516.  
  1517. RFC 2257                        AgentX                      January 1998
  1518.  
  1519.  
  1520.     ...
  1521.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1522.     |             sub-identifier #n_subid                           |
  1523.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1524.  
  1525.     (end 1)
  1526.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1527.     | 0             | 0             | 0             |       0       |
  1528.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1529.     ...
  1530.     (start n)
  1531.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1532.     |  n_subid      |  prefix       |  include      |  <reserved>   |
  1533.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1534.     |             sub-identifier #1                                 |
  1535.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1536.     ...
  1537.  
  1538.  
  1539.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1540.     |             sub-identifier #n_subid                           |
  1541.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1542.  
  1543.     (end n)
  1544.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1545.     | 0             | 0             | 0             |       0       |
  1546.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1547.  
  1548.  
  1549.    An agentx-Get-PDU contains the following fields:
  1550.  
  1551.       g.context
  1552.  
  1553.          An optional non-default context.
  1554.  
  1555.       g.sr
  1556.  
  1557.          A SearchRangeList containing the requested variables for this
  1558.          subagent.
  1559.  
  1560.  
  1561.  
  1562.  
  1563.  
  1564.  
  1565.  
  1566.  
  1567.  
  1568.  
  1569.  
  1570.  
  1571. Daniele, et. al.            Standards Track                    [Page 28]
  1572.  
  1573. RFC 2257                        AgentX                      January 1998
  1574.  
  1575.  
  1576. 6.2.6.  The agentx-GetNext-PDU
  1577.  
  1578.     (AgentX header)
  1579.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1580.     | h.version (1) |  h.type (6)   |    h.flags    |  <reserved>   |
  1581.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1582.     |                          h.sessionID                          |
  1583.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1584.     |                        h.transactionID                        |
  1585.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1586.     |                           h.packetID                          |
  1587.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1588.     |                        h.payload_length                       |
  1589.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1590.  
  1591.     (g.context) OPTIONAL
  1592.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1593.     |                     Octet String Length (L)                   |
  1594.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1595.     |  Octet 1      |  Octet 2      |   Octet 3     |   Octet 4     |
  1596.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1597.     ...
  1598.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1599.     |  Octet L - 1  |  Octet L      |       Padding (as required)   |
  1600.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1601.  
  1602.     (g.sr)
  1603.  
  1604.  
  1605.     (start 1)
  1606.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1607.     |  n_subid      |  prefix       |  include      |  <reserved>   |
  1608.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1609.     |             sub-identifier #1                                 |
  1610.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1611.     ...
  1612.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1613.     |             sub-identifier #n_subid                           |
  1614.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1615.  
  1616.     (end 1)
  1617.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1618.     |  n_subid      |  prefix       |      0        |  <reserved>   |
  1619.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1620.     |             sub-identifier #1                                 |
  1621.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1622.  
  1623.  
  1624.  
  1625.  
  1626.  
  1627. Daniele, et. al.            Standards Track                    [Page 29]
  1628.  
  1629. RFC 2257                        AgentX                      January 1998
  1630.  
  1631.  
  1632.     ...
  1633.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1634.     |             sub-identifier #n_subid                           |
  1635.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1636.     ...
  1637.  
  1638.     (start n)
  1639.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1640.     |  n_subid      |  prefix       |  include      |  <reserved>   |
  1641.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1642.     |             sub-identifier #1                                 |
  1643.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1644.     ...
  1645.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1646.     |             sub-identifier #n_subid                           |
  1647.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1648.  
  1649.     (end n)
  1650.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1651.     |  n_subid      |  prefix       |      0        |  <reserved>   |
  1652.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1653.     |             sub-identifier #1                                 |
  1654.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1655.     ...
  1656.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1657.     |             sub-identifier #n_subid                           |
  1658.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1659.     ...
  1660.  
  1661. 6.2.7.  The agentx-GetBulk-PDU
  1662.  
  1663.     (AgentX header)
  1664.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1665.     | h.version (1) |  h.type (7)   |    h.flags    |  <reserved>   |
  1666.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1667.     |                          h.sessionID                          |
  1668.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1669.     |                        h.transactionID                        |
  1670.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1671.     |                           h.packetID                          |
  1672.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1673.     |                        h.payload_length                       |
  1674.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1675.  
  1676.  
  1677.  
  1678.  
  1679.  
  1680.  
  1681.  
  1682.  
  1683. Daniele, et. al.            Standards Track                    [Page 30]
  1684.  
  1685. RFC 2257                        AgentX                      January 1998
  1686.  
  1687.  
  1688.     (g.context) OPTIONAL
  1689.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1690.     |                     Octet String Length (L)                   |
  1691.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1692.     |  Octet 1      |  Octet 2      |   Octet 3     |   Octet 4     |
  1693.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1694.     ...
  1695.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1696.     |  Octet L - 1  |  Octet L      |       Padding (as required)   |
  1697.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1698.  
  1699.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1700.     |             g.non_repeaters   |     g.max_repetitions         |
  1701.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1702.  
  1703.     (g.sr) as in agentx-GetNext-PDU above
  1704.     ...
  1705.  
  1706. 6.2.8.  The agentx-TestSet-PDU
  1707.  
  1708.     (AgentX header)
  1709.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1710.     | h.version (1) |  h.type (8)   |    h.flags    |  <reserved>   |
  1711.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1712.     |                          h.sessionID                          |
  1713.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1714.     |                        h.transactionID                        |
  1715.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1716.     |                           h.packetID                          |
  1717.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1718.     |                        h.payload_length                       |
  1719.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1720.  
  1721.     (t.context) OPTIONAL
  1722.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1723.     |                     Octet String Length (L)                   |
  1724.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1725.     |  Octet 1      |  Octet 2      |   Octet 3     |   Octet 4     |
  1726.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1727.     ...
  1728.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1729.     |  Octet L - 1  |  Octet L      |       Padding (as required)   |
  1730.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1731.  
  1732.     (t.vb)
  1733.  
  1734.  
  1735.  
  1736.  
  1737.  
  1738.  
  1739. Daniele, et. al.            Standards Track                    [Page 31]
  1740.  
  1741. RFC 2257                        AgentX                      January 1998
  1742.  
  1743.  
  1744.     (VarBind 1)
  1745.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1746.     |          v.type               |        <reserved>             |
  1747.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1748.     |  n_subid      |  prefix       |      0        |  <reserved>   |
  1749.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1750.     |                       sub-identifier #1                       |
  1751.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1752.     ...
  1753.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1754.     |                       sub-identifier #n_subid                 |
  1755.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1756.     |                       data                                    |
  1757.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1758.     ...
  1759.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1760.     |                       data                                    |
  1761.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1762.     ...
  1763.  
  1764.  
  1765.     (VarBind n)
  1766.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1767.     |          v.type               |        <reserved>             |
  1768.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1769.     |  n_subid      |  prefix       |      0        |  <reserved>   |
  1770.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1771.     |                       sub-identifier #1                       |
  1772.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1773.     ...
  1774.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1775.     |                       sub-identifier #n_subid                 |
  1776.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1777.     |                       data                                    |
  1778.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1779.     ...
  1780.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1781.     |                       data                                    |
  1782.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1783.  
  1784.    An agentx-TestSet-PDU contains the following fields:
  1785.  
  1786.       t.context
  1787.  
  1788.          An optional non-default context.
  1789.  
  1790.  
  1791.  
  1792.  
  1793.  
  1794.  
  1795. Daniele, et. al.            Standards Track                    [Page 32]
  1796.  
  1797. RFC 2257                        AgentX                      January 1998
  1798.  
  1799.  
  1800.       t.vb
  1801.  
  1802.          A VarBindList containing the requested VarBinds for this
  1803.          subagent.
  1804.  
  1805. 6.2.9.  The agentx-CommitSet, -UndoSet, -CleanupSet PDUs
  1806.  
  1807.    These PDUs consist of the AgentX header only.
  1808.  
  1809.    The agentx-CommitSet-, -UndoSet-, and -Cleanup-PDUs are used in
  1810.    processing an SNMP SetRequest operation.
  1811.  
  1812. 6.2.10.  The agentx-Notify-PDU
  1813.  
  1814.    An agentx-Notify-PDU is sent by a subagent to cause the master agent
  1815.    to forward a notification.
  1816.  
  1817.     (AgentX header)
  1818.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1819.     | h.version (1) |  h.type (12)  |    h.flags    |  <reserved>   |
  1820.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1821.     |                          h.sessionID                          |
  1822.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1823.     |                        h.transactionID                        |
  1824.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1825.     |                           h.packetID                          |
  1826.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1827.     |                        h.payload_length                       |
  1828.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1829.  
  1830.     (n.context) OPTIONAL
  1831.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1832.     |                     Octet String Length (L)                   |
  1833.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1834.     |  Octet 1      |  Octet 2      |   Octet 3     |   Octet 4     |
  1835.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1836.     ...
  1837.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1838.     |  Octet L - 1  |  Octet L      |       Padding (as required)   |
  1839.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1840.  
  1841.     (n.vb)
  1842.     ...
  1843.  
  1844.  
  1845.    An agentx-Notify-PDU contains the following fields:
  1846.  
  1847.  
  1848.  
  1849.  
  1850.  
  1851. Daniele, et. al.            Standards Track                    [Page 33]
  1852.  
  1853. RFC 2257                        AgentX                      January 1998
  1854.  
  1855.  
  1856.       n.context
  1857.  
  1858.          An optional non-default context.
  1859.  
  1860.       n.vb
  1861.  
  1862.          A VarBindList whose contents define the actual PDU to be sent.
  1863.          This memo places the following restrictions on its contents:
  1864.  
  1865.              - If the subagent supplies sysUpTime.0, it must be
  1866.                present as the first varbind.
  1867.  
  1868.              - snmpTrapOID.0 must be present, as the second
  1869.                varbind if sysUpTime.0 was supplied, as the first if it
  1870.                was not.
  1871.  
  1872. 6.2.11  The agentx-Ping-PDU
  1873.  
  1874.    The agentx-Ping-PDU is sent by a subagent to the master agent to
  1875.    monitor the master agent's ability to receive and send AgentX PDUs
  1876.    over their AgentX session.
  1877.  
  1878.     (AgentX header)
  1879.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1880.     | h.version (1) |  h.type (13)  |    h.flags    |  <reserved>   |
  1881.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1882.     |                          h.sessionID                          |
  1883.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1884.     |                        h.transactionID                        |
  1885.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1886.     |                           h.packetID                          |
  1887.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1888.     |                        h.payload_length                       |
  1889.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1890.  
  1891.    (p.context) OPTIONAL
  1892.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1893.     |                     Octet String Length (L)                   |
  1894.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1895.     |  Octet 1      |  Octet 2      |   Octet 3     |   Octet 4     |
  1896.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1897.     ...
  1898.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1899.     |  Octet L - 1  |  Octet L      |       Padding (as required)   |
  1900.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1901.  
  1902.    An agentx-Ping-PDU may contain the following field:
  1903.  
  1904.  
  1905.  
  1906.  
  1907. Daniele, et. al.            Standards Track                    [Page 34]
  1908.  
  1909. RFC 2257                        AgentX                      January 1998
  1910.  
  1911.  
  1912.       p.context
  1913.  
  1914.          An optional non-default context.
  1915.  
  1916.    Using p.context a subagent can retrieve the sysUpTime value for a
  1917.    specific context, if required.
  1918.  
  1919. 6.2.12.  The agentx-IndexAllocate-PDU
  1920.  
  1921.    An agentx-IndexAllocate-PDU is sent by a subagent to request
  1922.    allocation of a value for specific index objects.  Refer to section
  1923.    7.1.3 (Using the agentx-IndexAllocate-PDU) for suggested usage.
  1924.  
  1925.     (AgentX header)
  1926.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1927.     | h.version (1) |  h.type (14)  |    h.flags    |  <reserved>   |
  1928.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1929.     |                          h.sessionID                          |
  1930.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1931.     |                        h.transactionID                        |
  1932.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1933.     |                           h.packetID                          |
  1934.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1935.     |                        h.payload_length                       |
  1936.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1937.  
  1938.     (i.context) OPTIONAL
  1939.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1940.     |                     Octet String Length (L)                   |
  1941.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1942.     |  Octet 1      |  Octet 2      |   Octet 3     |   Octet 4     |
  1943.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1944.     ...
  1945.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1946.     |  Octet L - 1  |  Octet L      |       Padding (as required)   |
  1947.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1948.  
  1949.     (i.vb)
  1950.     ...
  1951.  
  1952.    An agentx-IndexAllocate-PDU contains the following fields:
  1953.  
  1954.       i.context
  1955.  
  1956.          An optional non-default context.
  1957.  
  1958.  
  1959.  
  1960.  
  1961.  
  1962.  
  1963. Daniele, et. al.            Standards Track                    [Page 35]
  1964.  
  1965. RFC 2257                        AgentX                      January 1998
  1966.  
  1967.  
  1968.       i.vb
  1969.  
  1970.          A VarBindList containing the index names and values requested
  1971.          for allocation.
  1972.  
  1973. 6.2.13.  The agentx-IndexDeallocate-PDU
  1974.  
  1975.    An agentx-IndexDeallocate-PDU is sent by a subagent to release
  1976.    previously allocated index values.
  1977.  
  1978.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1979.     | h.version (1) |  h.type (15)  |    h.flags    |  <reserved>   |
  1980.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1981.     |                          h.sessionID                          |
  1982.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1983.     |                        h.transactionID                        |
  1984.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1985.     |                           h.packetID                          |
  1986.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1987.     |                        h.payload_length                       |
  1988.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1989.  
  1990.     (i.context) OPTIONAL
  1991.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1992.     |                     Octet String Length (L)                   |
  1993.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1994.     |  Octet 1      |  Octet 2      |   Octet 3     |   Octet 4     |
  1995.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1996.     ...
  1997.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  1998.     |  Octet L - 1  |  Octet L      |       Padding (as required)   |
  1999.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2000.  
  2001.     (i.vb)
  2002.     ...
  2003.  
  2004.    An agentx-IndexDeallocate-PDU contains the following fields:
  2005.  
  2006.       i.context
  2007.  
  2008.          An optional non-default context.
  2009.  
  2010.       i.vb
  2011.  
  2012.          A VarBindList containing the index names and values to be
  2013.          released.
  2014.  
  2015.  
  2016.  
  2017.  
  2018.  
  2019. Daniele, et. al.            Standards Track                    [Page 36]
  2020.  
  2021. RFC 2257                        AgentX                      January 1998
  2022.  
  2023.  
  2024. 6.2.14.  The agentx-AddAgentCaps-PDU
  2025.  
  2026.    An agentx-AddAgentCaps-PDU is generated by a subagent to inform the
  2027.    master agent of its agent capabilities.
  2028.  
  2029.     (AgentX header)
  2030.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2031.     | h.version (1) |  h.type (16)  |    h.flags    |  <reserved>   |
  2032.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2033.     |                          h.sessionID                          |
  2034.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2035.     |                        h.transactionID                        |
  2036.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2037.     |                           h.packetID                          |
  2038.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2039.     |                        h.payload_length                       |
  2040.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2041.  
  2042.     (a.context) (OPTIONAL)
  2043.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2044.     |                     Octet String Length (L)                   |
  2045.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2046.     |  Octet 1      |  Octet 2      |   Octet 3     |   Octet 4     |
  2047.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2048.     ...
  2049.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2050.     |  Octet L - 1  |  Octet L      |       Optional Padding        |
  2051.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2052.  
  2053.     (a.id)
  2054.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2055.     |  n_subid      |  prefix       |      0        |  <reserved>   |
  2056.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2057.     |             sub-identifier #1                                 |
  2058.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2059.     ...
  2060.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2061.     |             sub-identifier #n_subid                           |
  2062.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2063.  
  2064.     (a.descr)
  2065.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2066.     |                     Octet String Length (L)                   |
  2067.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2068.     |  Octet 1      |  Octet 2      |   Octet 3     |   Octet 4     |
  2069.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2070.  
  2071.  
  2072.  
  2073.  
  2074.  
  2075. Daniele, et. al.            Standards Track                    [Page 37]
  2076.  
  2077. RFC 2257                        AgentX                      January 1998
  2078.  
  2079.  
  2080.     ...
  2081.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2082.     |  Octet L - 1  |  Octet L      |       Optional Padding        |
  2083.     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2084.  
  2085.    An agentx-AddAgentCaps-PDU contains the following fields:
  2086.  
  2087.       a.context
  2088.  
  2089.          An optional non-default context.
  2090.  
  2091.       a.id
  2092.  
  2093.          An Object Identifier containing the value of an invocation of
  2094.          the AGENT-CAPABILITIES macro, which the master agent exports as
  2095.          a value of sysORID for the indicated context.  (Recall that the
  2096.          value of an invocation of an AGENT-CAPABILITIES macro is an
  2097.          object identifier that describes a precise level of support
  2098.          with respect to implemented MIB modules.  A more complete
  2099.          discussion of the AGENT-CAPABILITIES macro and related sysORID
  2100.          values can be found in section 6 of RFC 1904 [10].)
  2101.  
  2102.       a.descr
  2103.  
  2104.          An Octet String containing a DisplayString to be used as the
  2105.          value of sysORDescr corresponding to the sysORID value above.
  2106.  
  2107. 6.2.15.  The agentx-RemoveAgentCaps-PDU
  2108.  
  2109.    An agentx-RemoveAgentCaps-PDU is generated by a subagent to request
  2110.    that the master agent stop exporting a particular value of sysORID.
  2111.    This value must have previously been advertised by the subagent in an
  2112.    agentx-AddAgentCaps-PDU.
  2113.  
  2114.    (AgentX header)
  2115.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2116.    | h.version (1) |  h.type (17)  |    h.flags    |  <reserved>   |
  2117.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2118.    |                          h.sessionID                          |
  2119.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2120.    |                        h.transactionID                        |
  2121.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2122.    |                           h.packetID                          |
  2123.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2124.    |                        h.payload_length                       |
  2125.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2126.  
  2127.  
  2128.  
  2129.  
  2130.  
  2131. Daniele, et. al.            Standards Track                    [Page 38]
  2132.  
  2133. RFC 2257                        AgentX                      January 1998
  2134.  
  2135.  
  2136.    (a.context) (OPTIONAL)
  2137.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2138.    |                     Octet String Length (L)                   |
  2139.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2140.    |  Octet 1      |  Octet 2      |   Octet 3     |   Octet 4     |
  2141.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2142.    ...
  2143.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2144.    |  Octet L - 1  |  Octet L      |       Optional Padding        |
  2145.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2146.  
  2147.    (a.id)
  2148.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2149.    |  n_subid      |  prefix       |       0       |   <reserved>  |
  2150.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2151.    |             sub-identifier #1                                 |
  2152.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2153.    ...
  2154.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2155.    |             sub-identifier #n_subid                           |
  2156.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2157.  
  2158.    An agentx-RemoveAgentCaps-PDU contains the following fields:
  2159.  
  2160.       a.context
  2161.  
  2162.          An optional non-default context.
  2163.  
  2164.       a.id
  2165.  
  2166.          An ObjectIdentifier containing the value of sysORID that should
  2167.          no longer be exported.
  2168.  
  2169. 6.2.16.  The agentx-Response-PDU
  2170.  
  2171.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2172.    | h.version (1) |  h.type (18)  |    h.flags    |  <reserved>   |
  2173.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2174.    |                          h.sessionID                          |
  2175.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2176.    |                        h.transactionID                        |
  2177.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2178.    |                           h.packetID                          |
  2179.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2180.    |                        h.payload_length                       |
  2181.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2182.  
  2183.  
  2184.  
  2185.  
  2186.  
  2187. Daniele, et. al.            Standards Track                    [Page 39]
  2188.  
  2189. RFC 2257                        AgentX                      January 1998
  2190.  
  2191.  
  2192.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2193.    |                        res.sysUpTime                          |
  2194.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2195.    |             res.error         |     res.index                 |
  2196.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2197.    ...
  2198.  
  2199.    An agentx-Response-PDU contains the following fields:
  2200.  
  2201.       h.sessionID
  2202.  
  2203.          If this is a response to a agentx-Open-PDU, then it contains
  2204.          the new and unique sessionID (as assigned by the master agent)
  2205.          for this session.
  2206.  
  2207.          Otherwise it must be identical to the h.sessionID value in the
  2208.          PDU to which this PDU is a response.
  2209.  
  2210.       h.transactionID
  2211.  
  2212.          Must be identical to the h.transactionID value in the PDU to
  2213.          which this PDU is a response.
  2214.  
  2215.          In an agentx response PDU from the master agent to the
  2216.          subagent, the value of h.transactionID has no significance and
  2217.          can be ignored by the subagent.
  2218.  
  2219.       h.packetID
  2220.  
  2221.          Must be identical to the h.packetID value in the PDU to which
  2222.          this PDU is a response.
  2223.  
  2224.       res.sysUpTime
  2225.  
  2226.          This field contains the current value of sysUpTime for the
  2227.          indicated context.  It is relevant only in agentx response PDUs
  2228.          sent from the master agent to a subagent in response to the
  2229.          following agentx PDUs:
  2230.  
  2231.                agentx-Open-PDU               (1),
  2232.                agentx-Close-PDU              (2),
  2233.                agentx-Register-PDU           (3),
  2234.                agentx-Unregister-PDU         (4),
  2235.                agentx-Ping-PDU              (13),
  2236.                agentx-IndexAllocate-PDU     (14),
  2237.                agentx-IndexDeallocate-PDU   (15),
  2238.                agentx-AddAgentCaps-PDU      (16),
  2239.                agentx-RemoveAgentCaps-PDU   (17)
  2240.  
  2241.  
  2242.  
  2243. Daniele, et. al.            Standards Track                    [Page 40]
  2244.  
  2245. RFC 2257                        AgentX                      January 1998
  2246.  
  2247.  
  2248.          In an agentx response PDU from the subagent to the master
  2249.          agent, the value of res.sysUpTime has no significance and is
  2250.          ignored by the master agent.
  2251.  
  2252.       res.error
  2253.  
  2254.          Indicates error status (including `noError').  Values are
  2255.          limited to those defined for errors in the SNMPv2 SMI (RFC 1905
  2256.          [4]), and the following AgentX-specific values:
  2257.  
  2258.                 openFailed                 (256),
  2259.                 notOpen                    (257),
  2260.                 indexWrongType             (258),
  2261.                 indexAlreadyAllocated      (259),
  2262.                 indexNoneAvailable         (260),
  2263.                 indexNotAllocated          (261),
  2264.                 unsupportedContext         (262),
  2265.                 duplicateRegistration      (263),
  2266.                 unknownRegistration        (264),
  2267.                 unknownAgentCaps           (265)
  2268.  
  2269.       res.index
  2270.  
  2271.          In error cases, this is the index of the failed variable
  2272.          binding within a received request PDU.  (Note: As explained in
  2273.          section 5.4, Value Representation, the index values of variable
  2274.          bindings within a variable binding list are 1-based.)
  2275.  
  2276.    A VarBindList may follow these latter two fields, depending on which
  2277.    AgentX PDU is being responded to.  These data are specified in the
  2278.    subsequent elements of procedure.
  2279.  
  2280. 7.  Elements of Procedure
  2281.  
  2282.    This section describes the actions of protocol entities (master
  2283.    agents and subagents) implementing the AgentX protocol.  Note,
  2284.    however, that it is not intended to constrain the internal
  2285.    architecture of any conformant implementation.
  2286.  
  2287.    Specific error conditions and associated actions are described in
  2288.    various places.  Other error conditions not specifically mentioned
  2289.    fall into one of two categories, "parse" errors and "protocol"
  2290.    errors.
  2291.  
  2292.    A parse error occurs when a receiving entity cannot decode the PDU.
  2293.    For instance, a VarBind contains an unknown type, or a PDU contains a
  2294.    malformed Object Identifier.
  2295.  
  2296.  
  2297.  
  2298.  
  2299. Daniele, et. al.            Standards Track                    [Page 41]
  2300.  
  2301. RFC 2257                        AgentX                      January 1998
  2302.  
  2303.  
  2304.    A protocol error occurs when a receiving entity can parse a PDU, but
  2305.    the resulting data is unspecified.  For instance, an agentx-
  2306.    Response-PDU is successfully parsed, but contains an unknown
  2307.    res.error value.
  2308.  
  2309.    An implementation may choose either to ignore such messages, or to
  2310.    close the session on which they are received, using the appropriate
  2311.    reason code as defined in the agentx-Close-PDU.
  2312.  
  2313.    The actions of AgentX protocol entities can be broadly categorized
  2314.    under two headings, each of which is described separately:
  2315.  
  2316.       (1) processing AgentX administrative messages (e.g., connection
  2317.           requests from a subagent to a master agent); and
  2318.  
  2319.       (2) processing SNMP messages (the coordinated actions of a
  2320.           master agent and one or more subagents in processing, for
  2321.           example, a received SNMP GetRequest-PDU).
  2322.  
  2323. 7.1.  Processing AgentX Administrative Messages
  2324.  
  2325.    This subsection describes the actions of AgentX protocol entities in
  2326.    processing AgentX administrative messages.  Such messages include
  2327.    those involved in establishing and terminating an AgentX session
  2328.    between a subagent and a master agent, those by which a subagent
  2329.    requests allocation of instance index values, and those by which a
  2330.    subagent communicates to a master agent which MIB regions it
  2331.    supports.
  2332.  
  2333. 7.1.1.  Processing the agentx-Open-PDU
  2334.  
  2335.    When the master agent receives an agentx-Open-PDU, it processes it as
  2336.    follows:
  2337.  
  2338.    1) An agentx-Response-PDU is created and res.sysUpTime is set to
  2339.       the value of sysUpTime.0 for the indicated context.
  2340.  
  2341.    2) If the master agent is unable to open an AgentX session for
  2342.       any reason, it may refuse the session establishment request,
  2343.       sending in reply the agentx-Response-PDU, with res.error field set
  2344.       to `openFailed'.
  2345.  
  2346.    3) Otherwise:  The master agent assigns a sessionID to the new
  2347.       session and puts the value in the h.sessionID field of the
  2348.       agentx-Response-PDU.  This value must be unique among all existing
  2349.       open sessions.
  2350.  
  2351.  
  2352.  
  2353.  
  2354.  
  2355. Daniele, et. al.            Standards Track                    [Page 42]
  2356.  
  2357. RFC 2257                        AgentX                      January 1998
  2358.  
  2359.  
  2360.    4) The master agent retains session-specific information
  2361.       from the PDU for this subagent:
  2362.  
  2363.        - The NETWORK_BYTE_ORDER value in h.flags is retained.
  2364.          All subsequent AgentX protocol operations initiated by the
  2365.          master agent for this session must use this byte ordering and
  2366.          set this bit accordingly.
  2367.  
  2368.          The subagent typically sets this bit to correspond to its
  2369.          native byte ordering, and typically does not vary byte ordering
  2370.          for an initiated session.  The master agent must be able to
  2371.          decode each PDU according to the h.flag NETWORK_BYTE_ORDER bit
  2372.          in the PDU, but does not need to toggle its retained value for
  2373.          the session if the subagent varies its byte ordering.
  2374.  
  2375.        - The o.timeout value is used in calculating response
  2376.          timeout conditions for this subagent.
  2377.  
  2378.        - The o.id and o.descr fields are used for informational
  2379.          purposes.  (Such purposes are implementation-specific for now,
  2380.          and may be used in a possible future standard AgentX MIB.)
  2381.  
  2382.    5) The agentx-Response-PDU is sent with the res.error field
  2383.       set to `noError'.
  2384.  
  2385.    At this point, an AgentX session is considered established between
  2386.    the master agent and the subagent.  An AgentX session is a distinct
  2387.    channel for the exchange of AgentX protocol messages between a master
  2388.    agent and one subagent, qualified by the session-specific attributes
  2389.    listed in 4) above.  AgentX session establishment is initiated by the
  2390.    subagent.  An AgentX session can be terminated by either the master
  2391.    agent or the subagent.
  2392.  
  2393. 7.1.2.  Processing the agentx-IndexAllocate-PDU
  2394.  
  2395.    When the master agent receives an agentx-IndexAllocate-PDU, it
  2396.    processes it as follows:
  2397.  
  2398.    1) An agentx-Response-PDU is created and res.sysUpTime is set to
  2399.       the value of sysUpTime.0 for the default context.
  2400.  
  2401.    2) If h.sessionID does not correspond to a currently established
  2402.       session with this subagent, the agentx-Response-PDU is sent in
  2403.       reply with res.error set to `notOpen'.
  2404.  
  2405.  
  2406.  
  2407.  
  2408.  
  2409.  
  2410.  
  2411. Daniele, et. al.            Standards Track                    [Page 43]
  2412.  
  2413. RFC 2257                        AgentX                      January 1998
  2414.  
  2415.  
  2416.    3) If the NON_DEFAULT_CONTEXT bit is set, and the master agent
  2417.       supports only a default context, the agentx-Response-PDU is
  2418.       returned with res.error set to `unsupportedContext', and the
  2419.       requested allocation fails.  Otherwise: The value of res.sysUpTime
  2420.       is set to the value of sysUpTime.0 for the indicated context.
  2421.  
  2422.    4) Each VarBind in the VarBindList is processed until either all
  2423.       are successful, or one fails.  If any VarBind fails, the agentx-
  2424.       Response-PDU is sent in reply containing the original VarBindList,
  2425.       with res.index set to indicate the failed VarBind, and with
  2426.       res.error set as described subsequently.  All other VarBinds are
  2427.       ignored; no index values are allocated.
  2428.  
  2429.       VarBinds are processed as follows:
  2430.  
  2431.       - v.name is the name of the index for which a value is to be
  2432.         allocated.
  2433.  
  2434.       - v.type is the syntax of the index object.
  2435.  
  2436.       - v.data indicates the specific index value requested.
  2437.         If the NEW_INDEX or the ANY_INDEX bit is set, the actual value
  2438.         in v.data is ignored and an appropriate index value is
  2439.         generated.
  2440.  
  2441.       a) If there are no currently allocated index values for v.name
  2442.          in the indicated context, and v.type does not correspond to a
  2443.          valid index type value, the VarBind fails and res.error is set
  2444.          to `indexWrongType'.
  2445.  
  2446.       b) If there are currently allocated index values for v.name
  2447.          in the indicated context, but the syntax of those values does
  2448.          not match v.type, the VarBind fails and res.error is set to
  2449.          `indexWrongType'.
  2450.  
  2451.       c) Otherwise, if both the NEW_INDEX and ANY_INDEX bits are
  2452.          clear, allocation of a specific index value is being requested.
  2453.          If the requested index is already allocated for v.name in the
  2454.          indicated context, the VarBind fails and res.error is set to
  2455.          `indexAlreadyAllocated'.
  2456.  
  2457.       d) Otherwise, if the NEW_INDEX bit is set, the master agent
  2458.          should generate the next available index value for v.name in
  2459.          the indicated context, with the constraint that this value must
  2460.          not have been allocated (even if subsequently released) to any
  2461.          subagent since the last re-initialization of the master agent.
  2462.          If no such value can be generated, the VarBind fails and
  2463.          res.error is set to `indexNoneAvailable'.
  2464.  
  2465.  
  2466.  
  2467. Daniele, et. al.            Standards Track                    [Page 44]
  2468.  
  2469. RFC 2257                        AgentX                      January 1998
  2470.  
  2471.  
  2472.       e) Otherwise, if the ANY_INDEX bit is set, the master agent
  2473.          should generate an index value for v.name in the indicated
  2474.          context, with the constraint that this value is not currently
  2475.          allocated to any subagent.  If no such value can be generated,
  2476.          then the VarBind fails and res.error is set to
  2477.          `indexNoneAvailable'.
  2478.  
  2479.    5) If all VarBinds are processed successfully, the
  2480.       agentx-Response-PDU is sent in reply with res.error set to
  2481.       `noError'.  A VarBindList is included that is identical to the one
  2482.       sent in the agentx-IndexAllocate-PDU, except that VarBinds
  2483.       requesting a NEW_INDEX or ANY_INDEX value are generated with an
  2484.       appropriate value.
  2485.  
  2486. 7.1.3.  Using the agentx-IndexAllocate-PDU
  2487.  
  2488.    Index allocation is a service provided by an AgentX master agent.  It
  2489.    provides generic support for sharing MIB conceptual tables among
  2490.    subagents who are assumed to have no knowledge of each other.
  2491.  
  2492.    Each subagent sharing a table should first request allocation of
  2493.    index values, then use those index values to qualify MIB regions in
  2494.    its subsequent registrations.
  2495.  
  2496.    The master agent maintains a database of index objects (OIDs), and,
  2497.    for each index, the values that have been allocated for it.  It is
  2498.    unaware of what MIB variables (if any) the index objects represent.
  2499.  
  2500.    By convention, subagents use the MIB variable listed in the INDEX
  2501.    clause as the index object for which values must be allocated.  For
  2502.    tables indexed by multiple variables, values may be allocated for
  2503.    each index (although this is frequently unnecessary; see example 2
  2504.    below).  The subagent may request allocation of
  2505.  
  2506.         - a specific index value - an index value that is not currently
  2507.         allocated - an index value that has never been allocated
  2508.  
  2509.    The last two alternatives reflect the uniqueness and constancy
  2510.    requirements present in many MIB specifications for arbitrary integer
  2511.    indexes (e.g., ifIndex in the IF MIB (RFC 1573 [11]),
  2512.    snmpFddiSMTIndex in the FDDI MIB (RFC 1285 [12]), or
  2513.    sysApplInstallPkgIndex in the System Application MIB [13]).  The need
  2514.    for subagents to share tables using such indexes is the main
  2515.    motivation for index allocation in AgentX.
  2516.  
  2517.  
  2518.  
  2519.  
  2520.  
  2521.  
  2522.  
  2523. Daniele, et. al.            Standards Track                    [Page 45]
  2524.  
  2525. RFC 2257                        AgentX                      January 1998
  2526.  
  2527.  
  2528.    Example 1:
  2529.  
  2530.       A subagent implements an interface, and wishes to register a
  2531.       single row of the RFC 1573 ifTable.  It requests an allocation for
  2532.       the index object "ifIndex", for a value that has never been
  2533.       allocated (since ifIndex values must be unique).  The master agent
  2534.       returns the value "7".
  2535.  
  2536.       The subagent now attempts to register row 7 of ifTable, by
  2537.       specifying a MIB region in the agentx-Register-PDU of
  2538.       1.3.6.1.2.1.2.2.1.[1-22].7.  If the registration succeeds, no
  2539.       further processing is required.  The master agent will dispatch to
  2540.       this subagent correctly.
  2541.  
  2542.       But the registration may fail.  Index allocation and MIB region
  2543.       registration are not coupled in the master agent.  Some other
  2544.       subagent may have already registered ifTable row 7 without first
  2545.       having requested allocation of the index.  The current state of
  2546.       index allocations is not considered when processing registration
  2547.       requests, and the current registry is not considered when
  2548.       processing index allocation requests.  If subagents follow the
  2549.       model of "first request allocation of an index, then register the
  2550.       corresponding region", then a successful index allocation request
  2551.       gives a subagent a good hint (but no guarantee) of what it should
  2552.       be able to register.
  2553.  
  2554.       If the registration failed, the subagent should request allocation
  2555.       of a new index i, and attempt to register ifTable.[1-22].i, until
  2556.       successful.
  2557.  
  2558.    Example 2:
  2559.  
  2560.       This same subagent wishes to register ipNetToMediaTable rows
  2561.       corresponding to its interface (ifIndex i).  Due to structure of
  2562.       this table, no further index allocation need be done.  The
  2563.       subagent can register the MIB region ipNetToMediaTable.[1-4].i, It
  2564.       is claiming responsibility for all rows of the table whose value
  2565.       of ipNetToMediaIfIndex is i.
  2566.  
  2567.    Example 3:
  2568.  
  2569.       A network device consists of a set of processors, each of which
  2570.       accepts network connections for a unique set of IP addresses.
  2571.  
  2572.       Further, each processor contains a subagent that implements
  2573.       tcpConnTable.  In order to represent tcpConnTable for the entire
  2574.       managed device, the subagents need to share tcpConnTable.
  2575.  
  2576.  
  2577.  
  2578.  
  2579. Daniele, et. al.            Standards Track                    [Page 46]
  2580.  
  2581. RFC 2257                        AgentX                      January 1998
  2582.  
  2583.  
  2584.       In this case, no index allocation need be done at all.  Each
  2585.       subagent can register a MIB region of tcpConnTable.[1-5].a.b.c.d,
  2586.       where a.b.c.d represents an unique IP address of the individual
  2587.       processor.
  2588.  
  2589.       Each subagent is claiming responsibility for the region of
  2590.       tcpConnTable where the value of tcpConnLocalAddress is a.b.c.d.
  2591.  
  2592. 7.1.4   Processing the agentx-IndexDeallocate-PDU
  2593.  
  2594.    When the master agent receives an agentx-IndexDeallocate-PDU, it
  2595.    processes it as follows:
  2596.  
  2597.    1) An agentx-Response-PDU is created and res.sysUpTime is set to
  2598.       the value of sysUpTime.0 for the default context.
  2599.  
  2600.    2) If h.sessionID does not correspond to a currently
  2601.       established session with this subagent, the agentx-Response-PDU is
  2602.       sent in reply with res.error set to `notOpen'.
  2603.  
  2604.    3) If the NON_DEFAULT_CONTEXT bit is set, and the master agent
  2605.       supports only a default context, the agentx-Response-PDU is
  2606.       returned with res.error set to `unsupportedContext', and the
  2607.       requested deallocation fails.  Otherwise: The value of
  2608.       res.sysUpTime is set to the value of sysUpTime.0 for the indicated
  2609.       context.
  2610.  
  2611.    4) Each VarBind in the VarBindList is processed until either all
  2612.       are successful, or one fails.  If any VarBind fails, the agentx-
  2613.       Response-PDU is sent in reply, containing the original
  2614.       VarBindList, with res.index set to indicate the failed VarBind,
  2615.       and with res.error set as described subsequently.  All other
  2616.       VarBinds are ignored; no index values are released.
  2617.  
  2618.       VarBinds are processed as follows:
  2619.  
  2620.       - v.name is the name of the index for which a value is to be
  2621.         released
  2622.  
  2623.       - v.type is the syntax of the index object
  2624.  
  2625.       - v.data indicates the specific index value to be released.
  2626.         The NEW_INDEX and ANY_INDEX bits are ignored.
  2627.  
  2628.       a) If the index value for the named index is not currently
  2629.          allocated to this subagent, the VarBind fails and res.error is
  2630.          set to `indexNotAllocated'.
  2631.  
  2632.  
  2633.  
  2634.  
  2635. Daniele, et. al.            Standards Track                    [Page 47]
  2636.  
  2637. RFC 2257                        AgentX                      January 1998
  2638.  
  2639.  
  2640.    5) If all VarBinds are processed successfully, res.error is
  2641.       set to `noError' and the agentx-Response-PDU is sent.  A
  2642.       VarBindList is included which is identical to the one sent in the
  2643.       agentx-IndexDeallocate-PDU.
  2644.  
  2645.       All released index values are now available, and may be used in
  2646.       response to subsequent allocation requests for ANY_INDEX values
  2647.       for the particular index.
  2648.  
  2649. 7.1.5.  Processing the agentx-Register-PDU
  2650.  
  2651.    When the master agent receives an agentx-Register-PDU, it processes
  2652.    it as follows:
  2653.  
  2654.    1) An agentx-Response-PDU is created and res.sysUpTime is set to
  2655.       the value of sysUpTime.0 for the default context.
  2656.  
  2657.    2) If h.sessionID does not correspond to a currently
  2658.       established session with this subagent, the agentx-Response-PDU is
  2659.       sent in reply with res.error set to `notOpen'.
  2660.  
  2661.    3) If the NON_DEFAULT_CONTEXT bit is set, and the master agent
  2662.       supports only a default context, the agentx-Response-PDU is
  2663.       returned with res.error set to `unsupportedContext', and the
  2664.       requested registration fails.  Otherwise:  The value of
  2665.       res.sysUpTime is set to the value of sysUpTime.0 for the indicated
  2666.       context.
  2667.  
  2668.       Note: Non-default contexts might be added on the fly by
  2669.             the master agent, or the master agent might require such
  2670.             non-default contexts to be pre-configured.  The choice is
  2671.             implementation-specific.
  2672.  
  2673.    4) Characterize the request.
  2674.  
  2675.       If r.region (or any of its set of Object Identifiers, if r.range
  2676.       is non-zero) is exactly the same as any currently registered value
  2677.       of r.region (or any of its set of Object Identifiers), this
  2678.       registration is termed a duplicate region.
  2679.  
  2680.       If r.region (or any of its set of Object Identifiers, if r.range
  2681.       is non-zero) is a subtree of, or contains, any currently
  2682.       registered value of r.region (or any of its set of Object
  2683.       Identifiers), this registration is termed an overlapping region.
  2684.  
  2685.       If the NON_DEFAULT_CONTEXT bit is set, this region is to be
  2686.       logically registered within the context indicated by r.context.
  2687.  
  2688.  
  2689.  
  2690.  
  2691. Daniele, et. al.            Standards Track                    [Page 48]
  2692.  
  2693. RFC 2257                        AgentX                      January 1998
  2694.  
  2695.  
  2696.       Otherwise this region is to be logically registered within the
  2697.       default context.
  2698.  
  2699.       A registration that would result in a duplicate region with the
  2700.       same priority and within the same context as that of a current
  2701.       registration is termed a duplicate registration.
  2702.  
  2703.    5) Otherwise, if this is a duplicate registration, the
  2704.       agentx-Response-PDU is returned with res.error set to
  2705.       `duplicateRegistration', and the requested registration fails.
  2706.  
  2707.    6) Otherwise, the agentx-Response-PDU is returned with res.error
  2708.       set to `noError'.
  2709.  
  2710.       The master agent adds this region to its registered OID space for
  2711.       the indicated context, to be considered during the dispatching
  2712.       phase for subsequently received SNMP protocol messages.
  2713.  
  2714.       Note: The following algorithm describes maintaining a set of OID
  2715.       ranges derived from "splitting" registered regions.  The algorithm
  2716.       for operational dispatching is also stated in terms of these OID
  2717.       ranges.
  2718.  
  2719.       These OID ranges are a useful explanatory device, but are not
  2720.       required for a correct implementation.
  2721.  
  2722.        - If r.region (R1) is a subtree of a currently registered
  2723.          region (R2), split R2 into 3 new regions (R2a, R2b, and R2c)
  2724.          such that R2b is an exact duplicate of R1.  Now remove R2 and
  2725.          add R1, R2a, R2b, and R2c to the master agent's
  2726.          lexicographically ordered set of ranges (the registered OID
  2727.          space).  Note: Though newly-added ranges R1 and R2b are
  2728.          identical in terms of the MIB objects they contain, they are
  2729.          registered by different subagents, possibly at different
  2730.          priorities.
  2731.  
  2732.          For instance, if subagent S2 registered "ip" (R2 is
  2733.          1.3.6.1.2.1.4) and subagent S1 subsequently registered
  2734.          "ipNetToMediaTable" (R1 is 1.3.6.1.2.1.4.22), the resulting set
  2735.          of registered regions would be:
  2736.  
  2737.    1.3.6.1.2.1.4    up to but not including 1.3.6.1.2.1.4.22     (by S2)
  2738.    1.3.6.1.2.1.4.22 up to but not including 1.3.6.1.2.1.4.23     (by S2)
  2739.    1.3.6.1.2.1.4.22 up to but not including 1.3.6.1.2.1.4.23     (by S1)
  2740.    1.3.6.1.2.1.4.23 up to but not including 1.3.6.1.2.1.5        (by S2)
  2741.  
  2742.  
  2743.  
  2744.  
  2745.  
  2746.  
  2747. Daniele, et. al.            Standards Track                    [Page 49]
  2748.  
  2749. RFC 2257                        AgentX                      January 1998
  2750.  
  2751.  
  2752.        - If r.region (R1) overlaps one or more currently registered
  2753.          regions, then for each overlapped region (R2) split R1 into 3
  2754.          new ranges (R1a, R1b, R1c) such that R1b is an exact
  2755.          duplicate of R2.  Add R1b and R2 into the lexicographically
  2756.          ordered set of regions.  Apply (5) above iteratively to R1a and
  2757.          R1c (since they may overlap, or be subtrees of, other regions).
  2758.  
  2759.          For instance, given the currently registered regions in the
  2760.          example above, if subagent S3 now registers mib-2 (R1 is
  2761.          1.3.6.1.2.1) the resulting set of regions would be:
  2762.  
  2763.    1.3.6.1.2.1      up to but not including 1.3.6.1.2.1.4        (by S3)
  2764.    1.3.6.1.2.1.4    up to but not including 1.3.6.1.2.1.4.22     (by S2)
  2765.    1.3.6.1.2.1.4    up to but not including 1.3.6.1.2.1.4.22     (by S3)
  2766.    1.3.6.1.2.1.4.22 up to but not including 1.3.6.1.2.1.4.23     (by S2)
  2767.    1.3.6.1.2.1.4.22 up to but not including 1.3.6.1.2.1.4.23     (by S1)
  2768.    1.3.6.1.2.1.4.22 up to but not including 1.3.6.1.2.1.4.23     (by S3)
  2769.    1.3.6.1.2.1.4.23 up to but not including 1.3.6.1.2.1.5        (by S2)
  2770.    1.3.6.1.2.1.4.23 up to but not including 1.3.6.1.2.1.5        (by S3)
  2771.    1.3.6.1.2.1.5    up to but not including 1.3.6.1.2.2          (by S3)
  2772.  
  2773.    Note that at registration time a region may be split into multiple
  2774.    OID ranges due to pre-existing registrations, or as a result of any
  2775.    subsequent registration.  This region splitting is transparent to
  2776.    subagents.  Hence the master agent must always be able to associate
  2777.    any OID range with the information contained in its original agentx-
  2778.    Register-PDU.
  2779.  
  2780. 7.1.5.1.  Handling Duplicate OID Ranges
  2781.  
  2782.    As a result of this registration algorithm there are likely to be
  2783.    duplicate OID ranges (regions of identical MIB objects registered to
  2784.    different subagents) in the master agent's registered OID space.
  2785.    Whenever the master agent's dispatching algorithm (see 7.2.1,
  2786.    Dispatching AgentX PDUs) results in  a duplicate OID range, the
  2787.    master agent selects one to use, termed the 'authoritative region',
  2788.    as follows:
  2789.  
  2790.       1) Choose the one whose original agentx-Register-PDU
  2791.          r.region contained the most subids, i.e., the most specific
  2792.          r.region.  Note: The presence or absence of a range subid has
  2793.          no bearing on how "specific" one object identifier is compared
  2794.          to another.
  2795.  
  2796.       2) If still ambiguous, there were duplicate regions.  Choose the
  2797.          one whose original agentx-Register-PDU specified the smaller
  2798.          value of r.priority.
  2799.  
  2800.  
  2801.  
  2802.  
  2803. Daniele, et. al.            Standards Track                    [Page 50]
  2804.  
  2805. RFC 2257                        AgentX                      January 1998
  2806.  
  2807.  
  2808. 7.1.6.  Processing the agentx-Unregister-PDU
  2809.  
  2810.    1) An agentx-Response-PDU is created and res.sysUpTime is set to
  2811.       the value of sysUpTime.0 for the default context.
  2812.  
  2813.    2) If h.sessionID does not correspond to a currently
  2814.       established session with this subagent, the agentx-Response-PDU is
  2815.       sent in reply with res.error set to `notOpen'.
  2816.  
  2817.    3) If the NON_DEFAULT_CONTEXT bit is set, and the master agent
  2818.       supports only a default context, the agentx-Response-PDU is
  2819.       returned with res.error set to `unsupportedContext', and the
  2820.       requested unregistration fails.  Otherwise:  The value of
  2821.       res.sysUpTime is set to the value of sysUpTime.0 for the indicated
  2822.       context.
  2823.  
  2824.    4) If u.region, u.priority, and the indicated context do not match
  2825.       an existing registration made during this session, the agentx-
  2826.       Response-PDU is returned with res.error set to
  2827.       `unknownRegistration'.
  2828.  
  2829.    5) Otherwise, the agentx-Response-PDU is sent in reply with res.error
  2830.       set to `noError', and the previous registration is removed:
  2831.  
  2832.       - The master agent removes u.region from its registered OID space
  2833.         within the indicated context.  If the original region had been
  2834.         split, all such related regions are removed.
  2835.  
  2836.         For instance, given the example registry above, if subagent S2
  2837.         unregisters "ip", the resulting registry would be:
  2838.  
  2839.    1.3.6.1.2.1      up to but not including 1.3.6.1.2.1.4        (by S3)
  2840.    1.3.6.1.2.1.4    up to but not including 1.3.6.1.2.1.4.22     (by S3)
  2841.    1.3.6.1.2.1.4.22 up to but not including 1.3.6.1.2.1.4.23     (by S1)
  2842.    1.3.6.1.2.1.4.22 up to but not including 1.3.6.1.2.1.4.23     (by S3)
  2843.    1.3.6.1.2.1.4.23 up to but not including 1.3.6.1.2.1.5        (by S3)
  2844.    1.3.6.1.2.1.5    up to but not including 1.3.6.1.2.2          (by S3)
  2845.  
  2846. 7.1.7.  Processing the agentx-AddAgentCaps-PDU
  2847.  
  2848.    When the master agent receives an agentx-AddAgentCaps-PDU, it
  2849.    processes it as follows:
  2850.  
  2851.    1) An agentx-Response-PDU is created and res.sysUpTime is set to
  2852.       the value of sysUpTime.0 for the default context.
  2853.  
  2854.  
  2855.  
  2856.  
  2857.  
  2858.  
  2859. Daniele, et. al.            Standards Track                    [Page 51]
  2860.  
  2861. RFC 2257                        AgentX                      January 1998
  2862.  
  2863.  
  2864.    2) If h.sessionID does not correspond to a currently
  2865.       established session with this subagent, the agentx-Response-PDU is
  2866.       sent in reply with res.error set to `notOpen'.
  2867.  
  2868.    3) If the NON_DEFAULT_CONTEXT bit is set, and the master agent
  2869.       supports only a default context, the agentx-Response-PDU is
  2870.       returned with res.error set to `unsupportedContext', and the
  2871.       requested operation fails.  Otherwise:  The value of res.sysUpTime
  2872.       is set to the value of sysUpTime.0 for the indicated context.
  2873.  
  2874.    4) Otherwise, the master agent adds the subagent's capabilities
  2875.       information to the sysORTable for the indicated context.  An
  2876.       agentx-Response-PDU is sent in reply with res.error set to
  2877.       `noError'.
  2878.  
  2879. 7.1.8.  Processing the agentx-RemoveAgentCaps-PDU
  2880.  
  2881.    1) An agentx-Response-PDU is created and res.sysUpTime is set to
  2882.       the value of sysUpTime.0 for the default context.
  2883.  
  2884.    2) If h.sessionID does not correspond to a currently
  2885.       established session with this subagent, the agentx-Response-PDU is
  2886.       sent in reply with res.error set to `notOpen'.
  2887.  
  2888.    3) If the NON_DEFAULT_CONTEXT bit is set, and the master agent
  2889.       supports only a default context, the agentx-Response-PDU is
  2890.       returned with res.error set to `unsupportedContext', and the
  2891.       requested operation fails.  Otherwise:  The value of res.sysUpTime
  2892.       is set to the value of sysUpTime.0 for the indicated context.
  2893.  
  2894.    4) If the combination of a.id and the optional a.context does not
  2895.       represent a sysORTable entry that was added by this subagent,
  2896.       during this session, the agentx-Response-PDU is returned with
  2897.       res.error set to `unknownAgentCaps'.
  2898.  
  2899.    5) Otherwise the master agent deletes the corresponding sysORTable
  2900.       entry and sends in reply the agentx-Response-PDU, with res.error
  2901.       set to `noError'.
  2902.  
  2903. 7.1.9.  Processing the agentx-Close-PDU
  2904.  
  2905.    When the master agent receives an agentx-Close-PDU, it processes it
  2906.    as follows:
  2907.  
  2908.    1) An agentx-Response-PDU is created and res.sysUpTime is set to
  2909.       the value of sysUpTime.0 for the default context.
  2910.  
  2911.  
  2912.  
  2913.  
  2914.  
  2915. Daniele, et. al.            Standards Track                    [Page 52]
  2916.  
  2917. RFC 2257                        AgentX                      January 1998
  2918.  
  2919.  
  2920.    2) If h.sessionID does not correspond to a currently
  2921.       established session with this subagent, the agentx-Response-PDU is
  2922.       sent in reply with res.error set to `notOpen'.
  2923.  
  2924.    3) Otherwise, the master agent closes the AgentX session
  2925.       as described below.  No agentx-Response-PDU is sent.
  2926.  
  2927.       - All MIB regions that have been registered during this session
  2928.         are unregistered, as described in 7.1.6.
  2929.  
  2930.       - All index values allocated during this session are freed, as
  2931.         described in section 7.1.4.
  2932.  
  2933.       - All sysORID values that were registered during this session
  2934.         are removed, as described in section 7.1.8.
  2935.  
  2936.    The master agent does not maintain state for closed sessions.  If a
  2937.    subagent wishes to re-establish a session after receiving an agentx-
  2938.    Close-PDU, it needs to re-register MIB regions, agent capabilities,
  2939.    etc.
  2940.  
  2941. 7.1.10.  Detecting Connection Loss
  2942.  
  2943.    If a master agent is able to detect (from the underlying transport)
  2944.    that a subagent cannot receive AgentX PDUs, it should close all
  2945.    affected AgentX sessions as described in 7.1.9, step 3).
  2946.  
  2947. 7.1.11.  Processing the agentx-Notify-PDU
  2948.  
  2949.    A subagent sending SNMPv1 trap information must map this into
  2950.    (minimally) a value of snmpTrapOID.0, as described in 3.1.2 of RFC
  2951.    1908 [8].
  2952.  
  2953.    The master agent processes the agentx-Notify-PDU as follows:
  2954.  
  2955.    1) If h.sessionID does not correspond to a currently
  2956.          established session with this subagent, an agentx-Response-PDU
  2957.          is sent in reply with res.error set to `notOpen', and
  2958.          res.sysUpTime set to the value of sysUpTime.0 for the indicated
  2959.          context.
  2960.  
  2961.    2) The VarBindList is parsed.  If it does not contain a value for
  2962.          sysUpTime.0, the master agent supplies the current value of
  2963.          sysUpTime.0 for the indicated context.  If the next VarBind
  2964.          (either the first or second VarBind; see section 6.2.10.1) is
  2965.          not snmpTrapOID.0, the master agent ceases further processing
  2966.          of the notification.
  2967.  
  2968.  
  2969.  
  2970.  
  2971. Daniele, et. al.            Standards Track                    [Page 53]
  2972.  
  2973. RFC 2257                        AgentX                      January 1998
  2974.  
  2975.  
  2976.    3) Notifications are sent according to the implementation-specific
  2977.          configuration of the master agent.
  2978.  
  2979.          If SNMPv1 Trap PDUs are generated, the recommended mapping is
  2980.          as described in RFC 2089 [9].
  2981.  
  2982.          Except in the case of a `notOpen' error as described in (1)
  2983.          above, no agentx-Response-PDU is sent to the subagent when the
  2984.          master agent finishes processing the notification.
  2985.  
  2986. 7.1.12.  Processing the agentx-Ping-PDU
  2987.  
  2988.    When the master agent receives an agentx-Ping-PDU, it processes it as
  2989.    follows:
  2990.  
  2991.    1) An agentx-Response-PDU is created and res.sysUpTime is set to
  2992.       the value of sysUpTime.0 for the default context.
  2993.  
  2994.    2) If h.sessionID does not correspond to a currently
  2995.       established session with this subagent, the agentx-Response-PDU is
  2996.       sent in reply with res.error set to `notOpen'.
  2997.  
  2998.    3) If the NON_DEFAULT_CONTEXT bit is set, and the master agent
  2999.       supports only a default context, the agentx-Response-PDU is
  3000.       returned with res.error set to `unsupportedContext'.  Otherwise:
  3001.       The value of res.sysUpTime is set to the value of sysUpTime.0 for
  3002.       the indicated context.
  3003.  
  3004.    4) The agentx-Response-PDU is sent, with res.error set to
  3005.       `noError'.
  3006.  
  3007.    If a subagent does not receive a response to its pings, or if it is
  3008.    able to detect (from the underlying transport) that the master agent
  3009.    is not able to receive AgentX messages, then it eventually must
  3010.    initiate a new AgentX session, re-register its regions, etc.
  3011.  
  3012. 7.2.  Processing Received SNMP Protocol Messages
  3013.  
  3014.    When an SNMP GetRequest, GetNextRequest, GetBulkRequest, or
  3015.    SetRequest protocol message is received by the master agent, the
  3016.    master agent applies its access control policy.
  3017.  
  3018.    In particular, for SNMPv1 or SNMPv2c PDUs, the master agent applies
  3019.    the Elements of Procedure defined in section 4.1 of RFC 1157 [6] that
  3020.    apply to receiving entities.  (For other versions of SNMP, the master
  3021.    agent applies the access control policy defined in the Elements of
  3022.    Procedure for those versions.)
  3023.  
  3024.  
  3025.  
  3026.  
  3027. Daniele, et. al.            Standards Track                    [Page 54]
  3028.  
  3029. RFC 2257                        AgentX                      January 1998
  3030.  
  3031.  
  3032.    In the SNMPv1 or v2c frameworks, the master agent uses the community
  3033.    string as an index into a local repository of configuration
  3034.    information that may include community profiles or more complex
  3035.    context information.
  3036.  
  3037.    If application of the access control policy results in a valid SNMP
  3038.    request PDU, then an SNMP Response-PDU is constructed from
  3039.    information gathered in the exchange of AgentX PDUs between the
  3040.    master agent and one or more subagents.  Upon receipt and initial
  3041.    validation of an SNMP request PDU, a master agent uses the procedures
  3042.    described below to dispatch AgentX PDUs to the proper subagents,
  3043.    marshal the subagent responses, and construct an SNMP response PDU.
  3044.  
  3045. 7.2.1.  Dispatching AgentX PDUs
  3046.  
  3047.    Upon receipt and initial validation of an SNMP request PDU, a master
  3048.    agent uses the procedures described below to dispatch AgentX PDUs to
  3049.    the proper subagents.
  3050.  
  3051.    Note: In the following procedures, an object identifier is said to be
  3052.    "contained" within an OID range when both of the following are true:
  3053.  
  3054.        - The object identifier does not lexicographically precede
  3055.          the range.
  3056.  
  3057.        - The object identifier lexicographically precedes the end
  3058.          of the range.
  3059.  
  3060.    General Rules of Procedure
  3061.  
  3062.    While processing a particular SNMP request, the master agent may send
  3063.    one or more AgentX PDUs to one or more subagents.  The following
  3064.    rules of procedure apply in general to the AgentX master agent. PDU-
  3065.    specific rules are listed in the applicable sections.
  3066.  
  3067.    1) Honoring the registry
  3068.  
  3069.       Because AgentX supports overlapping registrations, it is possible
  3070.       for the master agent to obtain a value for a requested varbind
  3071.       from within multiple registered MIB regions.
  3072.  
  3073.       The master agent must ensure that the value (or exception)
  3074.       actually returned in the SNMP response PDU is taken from the
  3075.       authoritative region (as defined in section 7.1.5.1).
  3076.  
  3077.  
  3078.  
  3079.  
  3080.  
  3081.  
  3082.  
  3083. Daniele, et. al.            Standards Track                    [Page 55]
  3084.  
  3085. RFC 2257                        AgentX                      January 1998
  3086.  
  3087.  
  3088.    2) GetNext and GetBulk Processing
  3089.  
  3090.       The master agent may choose to send agentx-Get-PDUs while
  3091.       servicing an SNMP GetNextRequest-PDU.  The master agent may choose
  3092.       to send agentx-Get-PDUs or agentx-GetNext-PDUs while servicing an
  3093.       SNMP GetBulkRequest-PDU.  One possible reason for this would be if
  3094.       the current iteration has targeted instance-level registrations.
  3095.  
  3096.       The master agent may choose to "scope" the possible instances
  3097.       returned by a subagent by specifying an ending OID in the
  3098.       SearchRange.  If such scoping is used, typically the ending OID
  3099.       would be the first lexicographical successor to the target OID
  3100.       range that was registered by a subagent other than the target
  3101.       subagent.  Regardless of this choice, rule (1) must be obeyed.
  3102.  
  3103.       The master agent may require multiple request-response iterations
  3104.       on the same subagent session, to determine the final value of all
  3105.       requested variables.
  3106.  
  3107.       All AgentX PDUs sent on the session while processing a given SNMP
  3108.       request must contain identical values of transactionID.  Each
  3109.       different SNMP request processed by the master agent must present
  3110.       a unique value of transactionID (within the limits of the 32-bit
  3111.       field) to the session.
  3112.  
  3113.    3) Number and order of variables sent per AgentX PDU
  3114.  
  3115.       For Get/GetNext/GetBulk operations, at any stage of the possibly
  3116.       iterative process, the master agent may need to dispatch several
  3117.       SearchRanges to a particular subagent session.  The master agent
  3118.       may send one, some, or all of the SearchRanges in a single AgentX
  3119.       PDU.
  3120.  
  3121.       The master agent must ensure that the correct contents and
  3122.       ordering of the VarBindList in the SNMP Response-PDU are
  3123.       maintained.
  3124.  
  3125.       The following rules govern the number of VarBinds in a given
  3126.       AgentX PDU:
  3127.  
  3128.          a) The subagent must support processing of AgentX PDUs
  3129.             with multiple VarBinds.
  3130.  
  3131.          b) When processing an SNMP Set request, the master agent
  3132.             must send all of the VarBinds applicable to a particular
  3133.             subagent session in a single Test/Set transaction.
  3134.  
  3135.  
  3136.  
  3137.  
  3138.  
  3139. Daniele, et. al.            Standards Track                    [Page 56]
  3140.  
  3141. RFC 2257                        AgentX                      January 1998
  3142.  
  3143.  
  3144.          c) When processing an SNMP Get, GetNext, or GetBulk request,
  3145.             the master agent may send a single AgentX PDU to the
  3146.             subagent with all applicable VarBinds, or multiple PDUs with
  3147.             single VarBinds, or something in between those extremes. The
  3148.             determination of which method to use in a particular case is
  3149.             implementation-specific.
  3150.  
  3151.    4) Timeout Values
  3152.  
  3153.       The master agent chooses a timeout value for each MIB region being
  3154.       queried, which is
  3155.  
  3156.          a) the value specified during registration of the MIB region,
  3157.             if it was non-zero
  3158.  
  3159.          b) otherwise, the value specified during establishment of
  3160.             the session in which this region was subsequently
  3161.             registered, if that value was non-zero.
  3162.  
  3163.          c) otherwise, the master agent's default value
  3164.  
  3165.       When an AgentX PDU that references multiple MIB regions is
  3166.       dispatched, the timeout value used for the PDU is the maximum
  3167.       value of the timeouts so determined for each of the referenced MIB
  3168.       regions.
  3169.  
  3170.    5) Context
  3171.  
  3172.       If the master agent has determined that a specific non-default
  3173.       context is associated with the SNMP request PDU, that context is
  3174.       encoded into the AgentX PDU's context field and the
  3175.       NON_DEFAULT_CONTEXT bit is set in h.flags.
  3176.  
  3177.       Otherwise, no context Octet String is added to the PDU, and the
  3178.       NON_DEFAULT_CONTEXT bit is cleared.
  3179.  
  3180. 7.2.1.1.  agentx-Get-PDU
  3181.  
  3182.    Each variable binding in the SNMP request PDU is processed as
  3183.    follows:
  3184.  
  3185.    (1) Identify the target OID range.
  3186.  
  3187.        Within a lexicographically ordered set of OID ranges, valid for
  3188.        the indicated context, locate the authoritative region that
  3189.        contains the binding's name.
  3190.  
  3191.  
  3192.  
  3193.  
  3194.  
  3195. Daniele, et. al.            Standards Track                    [Page 57]
  3196.  
  3197. RFC 2257                        AgentX                      January 1998
  3198.  
  3199.  
  3200.    (2) If no such OID range exists, the variable binding is not
  3201.        processed further, and its value is set to `noSuchObject'.
  3202.  
  3203.    (3) Identify the subagent session in which this region was
  3204.        registered, termed the target session.
  3205.  
  3206.    (4) If this is the first variable binding to be dispatched over
  3207.        the target session in a request-response exchange entailed in the
  3208.        processing of this management request:
  3209.  
  3210.        - Create an agentx-Get-PDU for this session, with the header
  3211.          fields initialized as described above (see 6.1 AgentX PDU
  3212.          Header).
  3213.  
  3214.    (5) Add a SearchRange to the end of the target session's PDU
  3215.        for this variable binding.
  3216.  
  3217.        - The variable binding's name is encoded into the starting OID.
  3218.  
  3219.        - The ending OID is encoded as null.
  3220.  
  3221. 7.2.1.2.  agentx-GetNext-PDU
  3222.  
  3223.    Each variable binding in the SNMP request PDU is processed as
  3224.    follows:
  3225.  
  3226.    (1) Identify the target OID range.
  3227.  
  3228.        Within a lexicographically ordered set of OID ranges, valid for
  3229.        the indicated context, locate
  3230.  
  3231.         a) the authoritative OID range that contains the variable
  3232.            binding's name and is not a fully qualified instance, or
  3233.  
  3234.         b) the authoritative OID range that is the first
  3235.            lexicographical successor to the variable binding's name.
  3236.  
  3237.    (2) If no such OID range exists, the variable binding is not
  3238.        processed further, and its value is set to `endOfMibView'.
  3239.  
  3240.    (3) Identify the subagent session in which this region was
  3241.        registered, termed the target session.
  3242.  
  3243.    (4) If this is the first variable binding to be dispatched over the
  3244.        target session in a request-response exchange entailed in the
  3245.        processing of this management request:
  3246.  
  3247.  
  3248.  
  3249.  
  3250.  
  3251. Daniele, et. al.            Standards Track                    [Page 58]
  3252.  
  3253. RFC 2257                        AgentX                      January 1998
  3254.  
  3255.  
  3256.        - Create an agentx-GetNext-PDU for the session, with
  3257.          the header fields initialized as described above (see 6.1
  3258.          AgentX PDU Header).
  3259.  
  3260.    (5) Add a SearchRange to the end of the target session's
  3261.        agentx-GetNext-PDU for this variable binding.
  3262.  
  3263.         - if (1a) applies, the variable binding's name is encoded
  3264.           into the starting OID, and the OID's "include" field is set to
  3265.           0.
  3266.  
  3267.         - if (1b) applies, the target OID is encoded into the starting
  3268.           OID, and its "include" field is set to 1.
  3269.  
  3270. 7.2.1.3.  agentx-GetBulk-PDU
  3271.  
  3272.    (Note: The outline of the following procedure is based closely on
  3273.    section 4.2.3, "The GetBulkRequest-PDU" of RFC 1905 [4].  Please
  3274.    refer to it for details on the format of the SNMP GetBulkRequest-PDU
  3275.    itself.)
  3276.  
  3277.    Each variable binding in the request PDU is processed as follows:
  3278.  
  3279.    (1) Identify the authoritative target OID range and target session,
  3280.        exactly as described for the agentx-GetNext-PDU (see 7.2.1.2).
  3281.  
  3282.    (2) If this is the first variable binding to be dispatched over the
  3283.        target session in a request-response exchange entailed in the
  3284.        processing of this management request:
  3285.  
  3286.        - Create an agentx-GetBulk-PDU for the session, with
  3287.          the header fields initialized as described above (see 6.1
  3288.          AgentX PDU Header).
  3289.  
  3290.    (3) Add a SearchRange to the end of the target session's
  3291.        agentx-GetBulk-PDU for this variable binding, as described for
  3292.        the agentx-GetNext-PDU.  If the variable binding was a non-
  3293.        repeater in the original request PDU, it must be a non-repeater
  3294.        in the agentx-GetBulk-PDU.
  3295.  
  3296.    The value of g.max_repetitions in the agentx-GetBulk-PDU may be less
  3297.    than (but not greater than) the value in the original request PDU.
  3298.  
  3299.    The master agent may make such alterations due to simple sanity
  3300.    checking, optimizations for the current iteration based on the
  3301.    registry, the maximum possible size of a potential Response-PDU,
  3302.    known constraints of the AgentX transport, or any other
  3303.    implementation-specific constraint.
  3304.  
  3305.  
  3306.  
  3307. Daniele, et. al.            Standards Track                    [Page 59]
  3308.  
  3309. RFC 2257                        AgentX                      January 1998
  3310.  
  3311.  
  3312. 7.2.1.4.  agentx-TestSet-PDU
  3313.  
  3314.    AgentX employs test-commit-undo-cleanup phases to achieve "as if
  3315.    simultaneous" semantics of the SNMP SetRequest-PDU within the
  3316.    extensible agent.  The initial phase involves the agentx-TestSet-PDU.
  3317.  
  3318.    Each variable binding in the SNMP request PDU is processed in order,
  3319.    as follows:
  3320.  
  3321.    (1) Identify the target OID range.
  3322.  
  3323.        Within a lexicographically ordered set of OID ranges, valid for
  3324.        the indicated context, locate the authoritative range that
  3325.        contains the variable binding's name.
  3326.  
  3327.    (2) If no such OID range exists, this variable binding fails with an
  3328.        error of `notWritable'.  Processing is complete for this request.
  3329.  
  3330.    (3) Identify the single subagent responsible for this OID range,
  3331.        termed the target subagent, and the applicable session, termed
  3332.        the target session.
  3333.  
  3334.    (4) If this is the first variable binding to be dispatched over
  3335.        the target session in a request-response exchange entailed in the
  3336.        processing of this management request:
  3337.  
  3338.        - create an agentx-TestSet-PDU for the session, with the
  3339.          header fields initialized as described above (see 6.1 AgentX
  3340.          PDU Header).
  3341.  
  3342.    (5) Add a VarBind to the end of the target session's PDU
  3343.        for this variable binding, as described in section 5.4.
  3344.  
  3345.     Note that all VarBinds applicable to a given session must be sent in
  3346.     a single agentx-TestSet-PDU.
  3347.  
  3348. 7.2.1.5.  Dispatch
  3349.  
  3350.    A timeout value is calculated for each PDU to be sent, which is the
  3351.    maximum value of the timeouts determined for each of the PDU's
  3352.    SearchRanges (as described above in 7.2.1 Dispatching AgentX PDUs,
  3353.    item 4). Each pending PDU is mapped (via its h.sessionID value) to a
  3354.    particular transport domain/endpoint, as described in section 8
  3355.    (Transport Mappings).
  3356.  
  3357.  
  3358.  
  3359.  
  3360.  
  3361.  
  3362.  
  3363. Daniele, et. al.            Standards Track                    [Page 60]
  3364.  
  3365. RFC 2257                        AgentX                      January 1998
  3366.  
  3367.  
  3368. 7.2.2.  Subagent Processing of agentx-Get, GetNext, GetBulk-PDUs
  3369.  
  3370.    A conformant AgentX subagent must support the agentx-Get, -GetNext,
  3371.    and -GetBulk PDUs, and must support multiple variables being supplied
  3372.    in each PDU.
  3373.  
  3374.    When a subagent receives an agentx-Get-, GetNext-, or GetBulk-PDU, it
  3375.    performs the indicated management operations and returns an agentx-
  3376.    Response-PDU.
  3377.  
  3378.    The agentx-Response-PDU header fields are identical to the received
  3379.    request PDU except that, at the start of processing, the subagent
  3380.    initializes h.type to Response, res.error to `noError', res.index to
  3381.    0, and the VarBindList to null.
  3382.  
  3383.    Each SearchRange in the request PDU's SearchRangeList is processed as
  3384.    described below, and a VarBind is added in the corresponding location
  3385.    of the agentx-Response-PDU's  VarbindList.  If processing should fail
  3386.    for any reason not described below, res.error is set to `genErr',
  3387.    res.index to the index of the failed SearchRange, the VarBindList is
  3388.    reset to null, and this agentx-Response-PDU is returned to the master
  3389.    agent.
  3390.  
  3391. 7.2.2.1.  Subagent Processing of the agentx-Get-PDU
  3392.  
  3393.    Upon the subagent's receipt of an agentx-Get-PDU, each SearchRange in
  3394.    the request is processed as follows:
  3395.  
  3396.    (1) The starting OID is copied to v.name.
  3397.  
  3398.    (2) If the starting OID exactly matches the name of a
  3399.        variable instantiated by this subagent within the indicated
  3400.        context and session, v.type and v.data are encoded to represent
  3401.        the variable's syntax and value, as described in section 5.4,
  3402.        Value Representation.
  3403.  
  3404.    (3) Otherwise, if the starting OID does not match the object
  3405.        identifier prefix of any variable instantiated within the
  3406.        indicated context and session, the VarBind is set to
  3407.        `noSuchObject', in the manner described in section 5.4, Value
  3408.        Representation.
  3409.  
  3410.    (4) Otherwise, the VarBind is set to `noSuchInstance'
  3411.        in the manner described in section 5.4, Value Representation.
  3412.  
  3413.  
  3414.  
  3415.  
  3416.  
  3417.  
  3418.  
  3419. Daniele, et. al.            Standards Track                    [Page 61]
  3420.  
  3421. RFC 2257                        AgentX                      January 1998
  3422.  
  3423.  
  3424. 7.2.2.2.  Subagent Processing of the agentx-GetNext-PDU
  3425.  
  3426.    Upon the subagent's receipt of an agentx-GetNext-PDU, each
  3427.    SearchRange in the request is processed as follows:
  3428.  
  3429.    (1) The subagent searches for a variable within the
  3430.        lexicographically ordered list of variable names for all
  3431.        variables it instantiates (without regard to registration of
  3432.        regions) within the indicated context and session, for which the
  3433.        following are all true:
  3434.  
  3435.        - if the "include" field of the starting OID is 0, the
  3436.          variable's name is the closest lexicographical successor to the
  3437.          starting OID.
  3438.  
  3439.        - if the "include" field of the starting OID is 1, the
  3440.          variable's name is either equal to, or the closest
  3441.          lexicographical successor to, the starting OID.
  3442.  
  3443.        - If the ending OID is not null, the variable's name
  3444.          lexicographically precedes the ending OID.
  3445.  
  3446.        If all of these conditions are met, v.name is set to the located
  3447.        variable's name.  v.type and v.data are encoded to represent the
  3448.        variable's syntax and value, as described in section 5.4, Value
  3449.        Representation.
  3450.  
  3451.    (2) If no such variable exists, v.name is set to the starting OID,
  3452.        and the VarBind is set to `endOfMibView', in the manner described
  3453.        in section 5.4, Value Representation.
  3454.  
  3455. 7.2.2.3.  Subagent Processing of the agentx-GetBulk-PDU
  3456.  
  3457.    A maximum of N + (M * R) VarBinds are returned, where
  3458.  
  3459.       N equals g.non_repeaters,
  3460.       M equals g.max_repetitions, and
  3461.       R is (number of SearchRanges in the GetBulk request) - N.
  3462.  
  3463.    The first N SearchRanges are processed exactly as for the agentx-
  3464.    GetNext-PDU.
  3465.  
  3466.    If M and R are both non-zero, the remaining R SearchRanges are
  3467.    processed iteratively to produce potentially many VarBinds.  For each
  3468.    iteration i, such that i is greater than zero and less than or equal
  3469.    to M, and for each repeated SearchRange s, such that s is greater
  3470.    than zero and less than or equal to R, the (N+((i-1)*R)+s)-th VarBind
  3471.    is added to the agentx-Response-PDU as follows:
  3472.  
  3473.  
  3474.  
  3475. Daniele, et. al.            Standards Track                    [Page 62]
  3476.  
  3477. RFC 2257                        AgentX                      January 1998
  3478.  
  3479.  
  3480.       1) The subagent searches for a variable within the
  3481.          lexicographically ordered list of variable names for all
  3482.          variables it instantiates (without regard to registration of
  3483.          regions) within the indicated context and session, for which
  3484.          the following are all true:
  3485.  
  3486.           - The variable's name is the (i)-th lexicographical successor
  3487.             to the (N+s)-th requested OID.
  3488.  
  3489.             (Note that if i is 0 and the "include" field is 1, the
  3490.             variable's name may be equivalent to, or the first
  3491.             lexicographical successor to, the (N+s)-th requested OID.)
  3492.  
  3493.           - If the ending OID is not null, the variable's name
  3494.             lexicographically precedes the ending OID.
  3495.  
  3496.          If all of these conditions are met, v.name is set to the
  3497.          located variable's name.  v.type and v.data are encoded to
  3498.          represent the variable's syntax and value, as described in
  3499.          section 5.4, Value Representation.
  3500.  
  3501.       2) If no such variable exists, the VarBind is set to
  3502.          `endOfMibView' as described in section 5.4, Value
  3503.          Representation.  v.name is set to v.name of the (N+((i-
  3504.          2)*R)+s)-th VarBind unless i is currently 1, in which case it
  3505.          is set to the value of the starting OID in the (N+s)-th
  3506.          SearchRange.
  3507.  
  3508.    Note that further iterative processing should stop if
  3509.  
  3510.         - For any iteration i, all s values of v.type are
  3511.           `endOfMibView'.
  3512.  
  3513.         - An AgentX transport constraint or other
  3514.           implementation-specific constraint is reached.
  3515.  
  3516. 7.2.3.  Subagent Processing of agentx-TestSet, -CommitSet, -UndoSet,
  3517.                   -CleanupSet-PDUs
  3518.  
  3519.    A conformant AgentX subagent must support the agentx-TestSet,
  3520.    -CommitSet, -UndoSet, and -CleanupSet PDUs, and must support multiple
  3521.    variables being supplied in each PDU.
  3522.  
  3523.    These four PDUs are used to collectively perform the indicated
  3524.    management operation.  An agentx-Response-PDU is sent in reply to
  3525.    each of the PDUs, to inform the master agent of the state of the
  3526.    operation.
  3527.  
  3528.  
  3529.  
  3530.  
  3531. Daniele, et. al.            Standards Track                    [Page 63]
  3532.  
  3533. RFC 2257                        AgentX                      January 1998
  3534.  
  3535.  
  3536.    The agentx-Response-PDU header fields are identical to the received
  3537.    request PDU except that, at the start of processing, the subagent
  3538.    initializes h.type to Response, res.error to `noError', and res.index
  3539.    to 0.
  3540.  
  3541.    These Response-PDUs do not contain a VarBindList.
  3542.  
  3543. 7.2.3.1.  Subagent Processing of the agentx-TestSet-PDU
  3544.  
  3545.    Upon the subagent's receipt of an agentx-TestSet-PDU, each VarBind in
  3546.    the PDU is validated until they are all successful, or until one
  3547.    fails, as described in section 4.2.5 of RFC 1905 [4]. The subagent
  3548.    validates variables with respect to the context and session indicated
  3549.    in the testSet-PDU.
  3550.  
  3551.    If each VarBind is successful, the subagent has a further
  3552.    responsibility to ensure the availability of all resources (memory,
  3553.    write access, etc.) required for successfully carrying out a
  3554.    subsequent agentx-CommitSet operation.  If this cannot be guaranteed,
  3555.    the subagent should set res.error to `resourceUnavailable'.
  3556.  
  3557.    As a result of this validation step, an agentx-Response-PDU is sent
  3558.    in reply whose res.error field is set to one of the following (SNMPv2
  3559.    SMI) values:
  3560.  
  3561.             noError                    (0),
  3562.             genErr                     (5),
  3563.             noAccess                   (6),
  3564.             wrongType                  (7),
  3565.             wrongLength                (8),
  3566.             wrongEncoding              (9),
  3567.             wrongValue                (10),
  3568.             noCreation                (11),
  3569.             inconsistentValue         (12),
  3570.             resourceUnavailable       (13),
  3571.             notWritable               (17),
  3572.             inconsistentName          (18)
  3573.  
  3574.    If this value is not `noError', the res.index field must be set to
  3575.    the index of the VarBind for which validation failed.
  3576.  
  3577.    Implementation of rigorous validation code may be one of the most
  3578.    demanding aspects of subagent development.  Implementors are strongly
  3579.    encouraged to do this right, so as to avoid if at all possible the
  3580.    extensible agent's having to return `commitFailed' or `undoFailed'
  3581.    during subsequent processing.
  3582.  
  3583.  
  3584.  
  3585.  
  3586.  
  3587. Daniele, et. al.            Standards Track                    [Page 64]
  3588.  
  3589. RFC 2257                        AgentX                      January 1998
  3590.  
  3591.  
  3592. 7.2.3.2.  Subagent Processing of the agentx-CommitSet-PDU
  3593.  
  3594.    The agentx-CommitSet-PDU indicates that the subagent should actually
  3595.    perform (as described in the post-validation sections of 4.2.5 of RFC
  3596.    1905 [4]) the management operation indicated by the previous
  3597.    TestSet-PDU.  After carrying out the management operation, the
  3598.    subagent sends in reply an agentx-Response-PDU whose res.error field
  3599.    is set to one of the following (SNMPv2 SMI) values:
  3600.  
  3601.             noError                    (0),
  3602.             commitFailed              (14)
  3603.  
  3604.    If this value is `commitFailed', the res.index field must be set to
  3605.    the index of the VarBind for which the operation failed.  Otherwise
  3606.    res.index is set to 0.
  3607.  
  3608. 7.2.3.3.  Subagent Processing of the agentx-UndoSet-PDU
  3609.  
  3610.    The agentx-UndoSet-PDU indicates that the subagent should undo the
  3611.    management operation requested in a preceding CommitSet-PDU.  The
  3612.    undo process is as described in section 4.2.5 of RFC 1905 [4].
  3613.  
  3614.    After carrying out the undo process, the subagent sends in reply an
  3615.    agentx-Response-PDU whose res.index field is set to 0, and whose
  3616.    res.error field is set to one of the following (SNMPv2 SMI) values:
  3617.  
  3618.             noError                    (0),
  3619.             undoFailed                (15)
  3620.  
  3621.    If this value is `undoFailed', the res.index field must be set to the
  3622.    index of the VarBind for which the operation failed.  Otherwise
  3623.    res.index is set to 0.
  3624.  
  3625.    This PDU also signals the end of processing of the management
  3626.    operation initiated by the previous TestSet-PDU.  The subagent should
  3627.    release resources, etc. as described in section 7.2.3.4.
  3628.  
  3629. 7.2.3.4.  Subagent Processing of the agentx-CleanupSet-PDU
  3630.  
  3631.    The agentx-CleanupSet-PDU signals the end of processing of the
  3632.    management operation requested in the previous TestSet-PDU.  This is
  3633.    an indication to the subagent that it may now release any resources
  3634.    it may have reserved in order to carry out the management request.
  3635.  
  3636.    No response is sent by the subagent.
  3637.  
  3638.  
  3639.  
  3640.  
  3641.  
  3642.  
  3643. Daniele, et. al.            Standards Track                    [Page 65]
  3644.  
  3645. RFC 2257                        AgentX                      January 1998
  3646.  
  3647.  
  3648. 7.2.4.  Master Agent Processing of AgentX Responses
  3649.  
  3650.    The master agent now marshals all subagent AgentX response PDUs and
  3651.    builds an SNMP response PDU.  In the next several subsections, the
  3652.    initial processing of all subagent AgentX response PDUs is described,
  3653.    followed by descriptions of subsequent processing for each specific
  3654.    subagent Response.
  3655.  
  3656. 7.2.4.1.  Common Processing of All AgentX Response PDUs
  3657.  
  3658.    1) If a subagent does not respond within the timeout interval for
  3659.       this dispatch, it is treated as if the subagent had returned
  3660.       `genErr' and processed as described below.
  3661.  
  3662.       A timeout may be due to a variety of reasons, and does not
  3663.       necessarily denote a failed or malfunctioning subagent.  As such,
  3664.       the master agent's response to a subagent timeout is
  3665.       implementation-specific, but with the following constraint:
  3666.  
  3667.          A subagent that times out on three consecutive requests is
  3668.          considered unable to respond, and the master agent must close
  3669.          the AgentX session as described in 7.1.9, step (2).
  3670.  
  3671.    2) Otherwise, the h.packetID, h.sessionID, and h.transactionID
  3672.       fields of the AgentX response PDU are used to correlate subagent
  3673.       responses.  If the response does not pertain to this SNMP
  3674.       operation, it is ignored.
  3675.  
  3676.    3) Otherwise, the responses are processed jointly to form the SNMP
  3677.       response PDU.
  3678.  
  3679. 7.2.4.2.  Processing of Responses to agentx-Get-PDUs
  3680.  
  3681.    After common processing of the subagent's response to an agentx-Get-
  3682.    PDU (see 7.2.4.1 above), processing continues with the following
  3683.    steps:
  3684.  
  3685.    1)  For any received AgentX response PDU, if res.error is not
  3686.        `noError', the SNMP response PDU's error code is set to this
  3687.        value, and its error index to the index of the variable binding
  3688.        corresponding to the failed VarBind in the subagent's AgentX
  3689.        response PDU.
  3690.  
  3691.        All other AgentX response PDUs received due to processing this
  3692.        SNMP request are ignored.  Processing is complete; the SNMP
  3693.        Response PDU is ready to be sent (see section 7.2.5, Sending the
  3694.        SNMP Response-PDU).
  3695.  
  3696.  
  3697.  
  3698.  
  3699. Daniele, et. al.            Standards Track                    [Page 66]
  3700.  
  3701. RFC 2257                        AgentX                      January 1998
  3702.  
  3703.  
  3704.    2)  Otherwise, the content of each VarBind in the AgentX response PDU
  3705.        is used to update the corresponding variable binding in the SNMP
  3706.        Response-PDU.
  3707.  
  3708. 7.2.4.3.  Processing of Responses to agentx-GetNext-PDU and
  3709.                  agentx-GetBulk-PDU
  3710.  
  3711.    After common processing of the subagent's response to an agentx-
  3712.    GetNext-PDU or agentx-GetBulk-PDU (see 7.2.4.1 above), processing
  3713.    continues with the following steps:
  3714.  
  3715.    1)  For any received AgentX response PDU, if res.error is not
  3716.        `noError', the SNMP response PDU's error code is set to this
  3717.        value, and its error index to the index of the VarBind
  3718.        corresponding to the failed VarBind in the subagent's AgentX
  3719.        response PDU.
  3720.  
  3721.        All other AgentX response PDUs received due to processing this
  3722.        SNMP request are ignored.  Processing is complete; the SNMP
  3723.        response PDU is ready to be sent (see section 7.2.5, Sending the
  3724.        SNMP Response PDU).
  3725.  
  3726.    2)  Otherwise, the content of each VarBind in the AgentX response
  3727.        PDU is used to update the corresponding VarBind in the SNMP
  3728.        response PDU.
  3729.  
  3730.    After all expected AgentX response PDUs have been processed, if any
  3731.    VarBinds still contain the value `endOfMibView' in their v.type
  3732.    fields, processing must continue:
  3733.  
  3734.    3)  A new iteration of AgentX request dispatching is initiated
  3735.        (as described in section 7.2.1.1), in which only those VarBinds
  3736.        whose v.type is `endOfMibView' are processed.
  3737.  
  3738.    4)  For each such VarBind, a target OID range is identified
  3739.        which is the lexicographical successor to the target OID range
  3740.        for this VarBind on the last iteration.  The target subagent is
  3741.        the one that registered the target OID range.  The target session
  3742.        is the one in which the target OID range was registered.
  3743.  
  3744.        If an agentx-GetNext- or GetBulk-PDU is being dispatched, the
  3745.        starting OID in the SearchRanges is set to the target OID range,
  3746.        and its "include" field is set to 1.
  3747.  
  3748.    5)  The value of transactionID must be identical to the value
  3749.        used during the previous iteration.
  3750.  
  3751.  
  3752.  
  3753.  
  3754.  
  3755. Daniele, et. al.            Standards Track                    [Page 67]
  3756.  
  3757. RFC 2257                        AgentX                      January 1998
  3758.  
  3759.  
  3760.    6)  The AgentX PDUs are sent to the subagent(s), and the responses
  3761.        are received and processed according to the steps described in
  3762.        section 7.2.4.
  3763.  
  3764.    7)  This process continues iteratively until a complete SNMP
  3765.        Response-PDU has been built, or until there remain no target OID
  3766.        range lexicographical successors.
  3767.  
  3768. 7.2.4.4.  Processing of Responses to agentx-TestSet-PDUs
  3769.  
  3770.    After common processing of the subagent's response to an agentx-
  3771.    TestSet-PDU (see 7.2.4.1 above), processing continues with the
  3772.    further exchange of AgentX PDUs.  The value of h.transactionID in the
  3773.    agentx-CommitSet, -UndoSet, and -CleanupSet-PDUs must be identical to
  3774.    the value sent in the testSet-PDU.
  3775.  
  3776.    The state transitions and PDU sequences are depicted in section 7.3.
  3777.  
  3778.    1)  If any target subagent's response is not `noError', all other
  3779.        agentx-Response-PDUs received due to processing this SNMP request
  3780.        are ignored.
  3781.  
  3782.        An agentx-CleanupSet-PDU is sent to each target subagent that has
  3783.        been sent a agentx-TestSet-PDU.
  3784.  
  3785.        Processing is complete; the SNMP response PDU is constructed as
  3786.        described below in 7.2.4.6.
  3787.  
  3788.    2)  Otherwise an agentx-CommitSet-PDU is sent to each target
  3789.        subagent.
  3790.  
  3791. 7.2.4.5.  Processing of Responses to agentx-CommitSet-PDUs
  3792.  
  3793.    After common processing of the subagent's response to an agentx-
  3794.    CommitSet-PDU (see 7.2.4.1 above), processing continues with the
  3795.    following steps:
  3796.  
  3797.    1)  If any response is not `noError', all other
  3798.        agentx-Response-PDUs received due to processing this SNMP request
  3799.        are ignored.
  3800.  
  3801.        An agentx-UndoSet-PDU is sent to each target subagent that has
  3802.        been sent a agentx-CommitSet-PDU.  All other subagents are sent a
  3803.        agentx-CleanupSet-PDU.
  3804.  
  3805.    2)  Otherwise an agentx-CleanupSet-PDU is sent to each target
  3806.        subagent.  Processing is complete; the SNMP response PDU is
  3807.        constructed as described below in 7.2.4.6.
  3808.  
  3809.  
  3810.  
  3811. Daniele, et. al.            Standards Track                    [Page 68]
  3812.  
  3813. RFC 2257                        AgentX                      January 1998
  3814.  
  3815.  
  3816. 7.2.4.6.  Processing of Responses to agentx-UndoSet-PDUs
  3817.  
  3818.    After common processing of the subagent's response to an agentx-
  3819.    UndoSet-PDU (see 7.2.4.1 above), processing continues with the
  3820.    following steps:
  3821.  
  3822.    1)  If any response is not `noError' the SNMP response
  3823.        PDU's error code is set to this value, and its error index to the
  3824.        index of the VarBind corresponding to the failed VarBind in the
  3825.        agentx-TestSet-PDU.
  3826.  
  3827.        Otherwise the SNMP response PDU's error code is set to `noError'
  3828.        and its error index to 0.
  3829.  
  3830. 7.2.5.  Sending the SNMP Response-PDU
  3831.  
  3832.    Once the processing described in sections 7.2.1 - 7.2.4 is complete,
  3833.    there is an SNMP response PDU available.  The master agent now
  3834.    implements the Elements of Procedure for the applicable version of
  3835.    the SNMP protocol in order to encapsulate the PDU into a message, and
  3836.    transmit it to the originator of the SNMP management request.  Note
  3837.    that this may involve altering the PDU contents (for instance, to
  3838.    replace the original VarBinds if an error condition is to be
  3839.    returned).
  3840.  
  3841.    The response PDU may also be altered in order to support the SNMP
  3842.    version 1 framework.  In such cases the required mapping is that
  3843.    defined in RFC 2089 [9].  (Note in particular that the rules for
  3844.    handling Counter64 syntax may require re-sending AgentX GetBulk or
  3845.    GetNext PDUs until a VarBind of suitable syntax is returned.)
  3846.  
  3847. 7.2.6.  MIB Views
  3848.  
  3849.    AgentX subagents are not aware of MIB views, since view information
  3850.    is not contained in AgentX PDUs.
  3851.  
  3852.    As stated above, the descriptions of procedures in section 7 of this
  3853.    memo are not intended to constrain the internal architecture of any
  3854.    conformant implementation.  In particular, the master agent
  3855.    procedures described in sections 7.2.1 and 7.2.4 may be altered so as
  3856.    to optimize AgentX exchanges when implementing MIB views.
  3857.  
  3858.    Such optimizations are beyond the scope of this memo.  But note that
  3859.    section 7.2.3 defines subagent behavior in such a way that alteration
  3860.    of SearchRanges may be used in such optimizations.
  3861.  
  3862.  
  3863.  
  3864.  
  3865.  
  3866.  
  3867. Daniele, et. al.            Standards Track                    [Page 69]
  3868.  
  3869. RFC 2257                        AgentX                      January 1998
  3870.  
  3871.  
  3872. 7.3.  State Transitions
  3873.  
  3874.    State diagrams are presented from the master agent's perspective for
  3875.    transport connection and session establishment, and from the
  3876.    subagent's perspective for Set transaction processing.
  3877.  
  3878. 7.3.1.  Set Transaction States
  3879.  
  3880.    The following table presents, from the subagent's perspective, the
  3881.    state transitions involved in Set transaction processing:
  3882.  
  3883.                                        STATE
  3884.             +----------------+--------------+---------+--------+--------
  3885.             |       A        |      B       |   C     |   D    |   E
  3886.             |   (Initial     |    TestOK    | Commit  | Test   | Commit
  3887.             |     State)     |              |  OK     | Fail   |  Fail
  3888.             |                |              |         |        |
  3889.     EVENT   |                |              |         |        |
  3890.    ---------+----------------+--------------+---------+--------+--------
  3891.             | 7.2.3.1        |              |         |        |
  3892.    Receive  | All varbinds   |              |         |        |
  3893.    TestSet  | OK?            |      X       |    X    |   X    |    X
  3894.    PDU      |   Yes ->B      |              |         |        |
  3895.             |   No  ->D      |              |         |        |
  3896.    ---------+----------------+--------------+---------+--------+--------
  3897.             |                |  7.2.3.2     |         |        |
  3898.    Receive  |                |  NoError?    |         |        |
  3899.    Commit-  |       X        |   Yes ->C    |    X    |   X    |    X
  3900.    Set PDU  |                |   No  ->E    |         |        |
  3901.    ---------+----------------+--------------+---------+--------+--------
  3902.    Receive  |                |              | 7.2.3.3 |        |7.2.4.5
  3903.    UndoSet  |       X        |       X      | ->done  |   X    | ->done
  3904.    PDU      |                |              |         |        |
  3905.    ---------+----------------+--------------+---------+--------+--------
  3906.    Receive  |                |  7.2.4.4     | 7.2.3.4 |7.2.4.4 |
  3907.    Cleanup- |       X        |   ->done     | ->done  | ->done |   X
  3908.    Set PDU  |                |              |         |        |
  3909.    ---------+----------------+--------------+---------+--------+--------
  3910.    Session  |                | rollback     | undo    |        |
  3911.    Loss     |  ->done        |  ->done      |  ->done | ->done | ->done
  3912.    ---------+----------------+--------------+---------+--------+--------
  3913.  
  3914.    There are three possible sequences that a subagent may follow for a
  3915.    particular set transaction:
  3916.  
  3917.       1) TestSet CommitSet CleanupSet
  3918.       2) TestSet CommitSet UndoSet
  3919.       3) TestSet           CleanupSet
  3920.  
  3921.  
  3922.  
  3923. Daniele, et. al.            Standards Track                    [Page 70]
  3924.  
  3925. RFC 2257                        AgentX                      January 1998
  3926.  
  3927.  
  3928.    Note that a single PDU sequence may result in multiple paths through
  3929.    the finite state machine (FSM).  For example, the sequence
  3930.  
  3931.       TestSet CommitSet UndoSet
  3932.  
  3933.    may walk through either of these two state sequences:
  3934.  
  3935.       (initial) TestOK CommitOK   (done)
  3936.       (initial) TestOK CommitFail (done)
  3937.  
  3938. 7.3.2  Transport Connection States
  3939.  
  3940.    The following table presents, from the master agent's perspective,
  3941.    the state transitions involved in transport connection setup and
  3942.    teardown:
  3943.  
  3944.  
  3945.  
  3946.  
  3947.  
  3948.  
  3949.  
  3950.  
  3951.  
  3952.  
  3953.  
  3954.  
  3955.  
  3956.  
  3957.  
  3958.  
  3959.  
  3960.  
  3961.  
  3962.  
  3963.  
  3964.  
  3965.  
  3966.  
  3967.  
  3968.  
  3969.  
  3970.  
  3971.  
  3972.  
  3973.  
  3974.  
  3975.  
  3976.  
  3977.  
  3978.  
  3979. Daniele, et. al.            Standards Track                    [Page 71]
  3980.  
  3981. RFC 2257                        AgentX                      January 1998
  3982.  
  3983.  
  3984.                                 STATE
  3985.                    +--------------+--------------
  3986.                    |      A       |      B
  3987.                    | No transport |  Transport
  3988.                    |              |  connected
  3989.                    |              |
  3990.    EVENT           |              |
  3991.    ----------------+--------------+--------------
  3992.    Transport       |              |
  3993.    connect         |     ->B      |      X
  3994.    indication      |              |
  3995.    ----------------+--------------+--------------
  3996.    Receive         |              | if duplicate
  3997.    Open-PDU        |              | session id,
  3998.                    |              | reject, else
  3999.                    |      X       | establish
  4000.                    |              | session
  4001.                    |              |
  4002.                    |              |     ->B
  4003.    ----------------+--------------+--------------
  4004.    Receive         |              | if matching
  4005.    Response-PDU    |              | session id,
  4006.                    |              | feed to that
  4007.                    |      X       | session's FSM
  4008.                    |              | else ignore
  4009.                    |              |
  4010.                    |              |     ->B
  4011.    ----------------+--------------+--------------
  4012.    Receive other   |              | if matching
  4013.    PDUs            |              | session id,
  4014.                    |              | feed to that
  4015.                    |      X       | session's FSM
  4016.                    |              | else reject
  4017.                    |              |
  4018.                    |              |     ->B
  4019.    ----------------+--------------+--------------
  4020.    Transport       |              |notify all
  4021.    disconnect      |              |sessions on
  4022.    indication      |      X       |this transport
  4023.                    |              |
  4024.                    |              |     ->A
  4025.    ----------------+--------------+--------------
  4026.  
  4027.  
  4028.  
  4029.  
  4030.  
  4031.  
  4032.  
  4033.  
  4034.  
  4035. Daniele, et. al.            Standards Track                    [Page 72]
  4036.  
  4037. RFC 2257                        AgentX                      January 1998
  4038.  
  4039.  
  4040. 7.3.3  Session States
  4041.  
  4042.    The following table presents, from the master agent's perspective,
  4043.    the state transitions involved in session setup and teardown:
  4044.  
  4045.                               STATE
  4046.                   +-------------+----------------
  4047.                   |     A       |      B
  4048.                   |  No session |  Session
  4049.                   |             |  established
  4050.    EVENT          |             |
  4051.    ---------------+-------------+----------------
  4052.                   |  7.1.1      |
  4053.    Receive        |             |      X
  4054.    Open PDU       |    ->B      |
  4055.    ---------------+-------------+----------------
  4056.                   |             |  7.1.9
  4057.    Receive        |      X      |
  4058.    Close PDU      |             |    ->A
  4059.    ---------------+-------------+----------------
  4060.    Receive        |             |  7.1.5
  4061.    Register PDU   |      X      |
  4062.                   |             |    ->B
  4063.    ---------------+-------------+----------------
  4064.    Receive        |             |  7.1.6
  4065.    Unregister     |      X      |
  4066.    PDU            |             |    ->B
  4067.    ---------------+-------------+----------------
  4068.    Receive        |             |
  4069.    Get PDU        |             |
  4070.    GetNext PDU    |             |
  4071.    GetBulk PDU    |      X      |       X
  4072.    TestSet PDU    |             |
  4073.    CommitSet PDU  |             |
  4074.    UndoSet PDU    |             |
  4075.    CleanupSet PDU |             |
  4076.    ---------------+-------------+----------------
  4077.    Receive        |             |  7.1.11
  4078.    Notify PDU     |      X      |
  4079.                   |             |    ->B
  4080.    ---------------+-------------+----------------
  4081.    Receive Ping   |             |  7.1.12
  4082.    PDU            |      X      |
  4083.                   |             |    ->B
  4084.    ---------------+-------------+----------------
  4085.    (continued next page)
  4086.  
  4087.  
  4088.  
  4089.  
  4090.  
  4091. Daniele, et. al.            Standards Track                    [Page 73]
  4092.  
  4093. RFC 2257                        AgentX                      January 1998
  4094.  
  4095.  
  4096.    ---------------+-------------+----------------
  4097.    Receive        |             |  7.1.2
  4098.    IndexAllocate  |      X      |
  4099.    PDU            |             |    ->B
  4100.    ---------------+-------------+----------------
  4101.    Receive        |             |  7.1.4
  4102.    IndexDeallocate|      X      |
  4103.    PDU            |             |    ->B
  4104.    ---------------+-------------+----------------
  4105.    Receive        |             |  7.1.7
  4106.    AddAgentxCaps  |      X      |
  4107.    PDU            |             |    ->B
  4108.    ---------------+-------------+----------------
  4109.    Receive        |             |  7.1.8
  4110.    RemoveAgentxCap|      X      |
  4111.    PDU            |             |    ->B
  4112.    ---------------+-------------+----------------
  4113.    Receive        |             |  7.2.4
  4114.    Response PDU   |      X      |
  4115.                   |             |    ->B
  4116.    ---------------+-------------+----------------
  4117.    Receive        |             |
  4118.    Other PDU      |      X      |       X
  4119.    ---------------+-------------+----------------
  4120.  
  4121. 8.  Transport Mappings
  4122.  
  4123.    The same AgentX PDU formats, encodings, and elements of procedure are
  4124.    used regardless of the underlying transport.
  4125.  
  4126. 8.1.  AgentX over TCP
  4127.  
  4128. 8.1.1.  Well-known Values
  4129.  
  4130.    The master agent accepts TCP connection requests for the well-known
  4131.    port 705.  Subagents connect to the master agent using this port
  4132.    number.
  4133.  
  4134. 8.1.2.  Operation
  4135.  
  4136.    Once a TCP connection has been established, the AgentX peers use this
  4137.    connection to carry all AgentX PDUs. Multiple AgentX sessions may be
  4138.    established using the same TCP connection.  AgentX PDUs are sent
  4139.    within an AgentX session.  AgentX peers are responsible for mapping
  4140.    the h.sessionID to a particular TCP connection.
  4141.  
  4142.    All AgentX PDUs are presented individually to the TCP, to be sent as
  4143.    the data portion of a TCP PDU.
  4144.  
  4145.  
  4146.  
  4147. Daniele, et. al.            Standards Track                    [Page 74]
  4148.  
  4149. RFC 2257                        AgentX                      January 1998
  4150.  
  4151.  
  4152. 8.2.  AgentX over UNIX-domain Sockets
  4153.  
  4154.    Many (BSD-derived) implementations of the UNIX operating system
  4155.    support the UNIX pathname address family (AF_UNIX) for socket
  4156.    communications.  This provides a convenient method of sending and
  4157.    receiving data between processes on the same host.
  4158.  
  4159.    Mapping AgentX to this transport is useful for environments that
  4160.  
  4161.        - wish to guarantee subagents are running on the same
  4162.          managed node as the master agent, and where
  4163.  
  4164.        - sockets provide better performance than TCP or UDP,
  4165.          especially in the presence of heavy network I/O
  4166.  
  4167. 8.2.1.  Well-known Values
  4168.  
  4169.    The master agent creates a well-known UNIX-domain socket endpoint
  4170.    called "/var/agentx/master".  (It may create other, implementation-
  4171.    specific endpoints.)
  4172.  
  4173.    This endpoint name uses the character set encoding native to the
  4174.    managed node, and represents a UNIX-domain stream (SOCK_STREAM)
  4175.    socket.
  4176.  
  4177. 8.2.2.  Operation
  4178.  
  4179.    Once a connection has been established, the AgentX peers use this
  4180.    connection to carry all AgentX PDUs.
  4181.  
  4182.    Multiple AgentX sessions may be established using the same
  4183.    connection.  AgentX PDUs are sent within an AgentX session.  AgentX
  4184.    peers are responsible for mapping the h.sessionID to a particular
  4185.    connection.
  4186.  
  4187.    All AgentX PDUs are presented individually to the socket layer, to be
  4188.    sent in the data stream.
  4189.  
  4190.  
  4191. 9.  Security Considerations
  4192.  
  4193.    This memo defines a protocol between two processing entities, one of
  4194.    which (the master agent) is assumed to perform authentication of
  4195.    received SNMP requests and to control access to management
  4196.    information.  The master agent performs these security operations
  4197.    independently of the other processing entity (the subagent).
  4198.  
  4199.  
  4200.  
  4201.  
  4202.  
  4203. Daniele, et. al.            Standards Track                    [Page 75]
  4204.  
  4205. RFC 2257                        AgentX                      January 1998
  4206.  
  4207.  
  4208.    Security considerations require three questions to be answered:
  4209.  
  4210.       1. Is a particular subagent allowed to initiate a session with a
  4211.          particular master agent?
  4212.  
  4213.       2. During an AgentX session, is any SNMP security-related
  4214.          information (for example, community names) passed from the
  4215.          master agent to the subagent?
  4216.  
  4217.       3. During an AgentX session, what part of the MIB tree is this
  4218.          subagent allowed to register?
  4219.  
  4220.    The answer to the third question is: A subagent can register any
  4221.    subtree (subject to AgentX elements of procedure, section 7.1.5).
  4222.    Currently there is no access control mechanism defined in AgentX. A
  4223.    concern here is that a malicious subagent that registers an
  4224.    unauthorized "sensitive" subtree, could see modification requests to
  4225.    those objects, or by giving its own clever answer to NMS queries,
  4226.    could cause the NMS to do something that leads to information
  4227.    disclosure or other damage.
  4228.  
  4229.    The answer to the second question is: No.
  4230.  
  4231.    Now we can answer the first question.  AgentX does not contain a
  4232.    mechanism for authorizing/refusing session initiations.  Thus,
  4233.    controlling subagent access to the master agent may only be done at a
  4234.    lower layer (e.g., transport).
  4235.  
  4236.    An AgentX subagent can connect to a master agent using either a
  4237.    network transport mechanism (e.g., TCP), or a "local" mechanism
  4238.    (e.g., shared memory, named pipes).
  4239.  
  4240.    In the case where a local transport mechanism is used and both
  4241.    subagent and master agent are running on the same host, connection
  4242.    authorization can be delegated to the operating system features.  The
  4243.    answer to the first security question then becomes: "If and only if
  4244.    the subagent has sufficient privileges, then the operating system
  4245.    will allow the connection".
  4246.  
  4247.    If a network transport is used, currently there is no inherent
  4248.    security.  Transport Layer Security or SSL could be used to control
  4249.    subagent connections, but that is beyond the scope of this document.
  4250.  
  4251.    Thus it is recommended that subagents always run on the same host as
  4252.    the master agent and that operating system features be used to ensure
  4253.    that only properly authorized subagents can establish connections to
  4254.    the master agent.
  4255.  
  4256.  
  4257.  
  4258.  
  4259. Daniele, et. al.            Standards Track                    [Page 76]
  4260.  
  4261. RFC 2257                        AgentX                      January 1998
  4262.  
  4263.  
  4264. 10.  Acknowledgements
  4265.  
  4266.    The initial development of this memo was heavily influenced by the
  4267.    DPI 2.0 specification RFC 1592 [7].
  4268.  
  4269.    This document was produced by the IETF Agent Extensibility (AgentX)
  4270.    Working Group, and benefited especially from the contributions of the
  4271.    following working group members:
  4272.  
  4273.       David Battle, Uri Blumenthal, Jeff Case, Maria Greene, Dave
  4274.       Keeney, Harmen van der Linde, Bob Natale, Randy Presuhn, Aleksey
  4275.       Romanov, Don Ryan, and Juergen Schoenwaelder.
  4276.  
  4277.    The AgentX Working Group is chaired by:
  4278.  
  4279.    Bob Natale
  4280.    ACE*COMM Corporation
  4281.    704 Quince Orchard Road
  4282.    Gaithersburg MD  20878
  4283.  
  4284.    Phone: +1-301-721-3000
  4285.    Fax:   +1-301-721-3001
  4286.    EMail: bnatale@acecomm.com
  4287.  
  4288. 11.  Authors' and Editor's Addresses
  4289.  
  4290.    Mike Daniele
  4291.    Digital Equipment Corporation
  4292.    110 Spit Brook Rd
  4293.    Nashua, NH 03062
  4294.  
  4295.    Phone: +1-603-881-1423
  4296.    EMail: daniele@zk3.dec.com
  4297.  
  4298.  
  4299.    Bert Wijnen
  4300.    IBM Professional Services
  4301.    Watsonweg 2
  4302.    1423 ND Uithoorn
  4303.    The Netherlands
  4304.  
  4305.    Phone: +31-79-322-8316
  4306.    EMail: wijnen@vnet.ibm.com
  4307.  
  4308.  
  4309.  
  4310.  
  4311.  
  4312.  
  4313.  
  4314.  
  4315. Daniele, et. al.            Standards Track                    [Page 77]
  4316.  
  4317. RFC 2257                        AgentX                      January 1998
  4318.  
  4319.  
  4320.    Dale Francisco (editor)
  4321.    Cisco Systems
  4322.    150 Castilian Dr
  4323.    Goleta CA 93117
  4324.  
  4325.    Phone: +1-805-961-3642
  4326.    Fax:   +1-805-961-3600
  4327.    EMail: dfrancis@cisco.com
  4328.  
  4329. 12.  References
  4330.  
  4331. [1]  Information processing systems - Open Systems Interconnection -
  4332.      Specification of Abstract Syntax Notation One (ASN.1),
  4333.      International Organization for Standardization.  International
  4334.      Standard 8824, (December, 1987).
  4335.  
  4336. [2]  Case, J., McCloghrie, K., Rose, M. and S. Waldbusser,
  4337.      "Structure of Management Information for Version 2 of the Simple
  4338.      Network Management Protocol (SNMPv2)", RFC 1902, January 1996.
  4339.  
  4340. [3]  Case, J., McCloghrie, K., Rose, M. and S. Waldbusser,
  4341.      "Textual Conventions for Version 2 of the Simple Network Management
  4342.      Protocol (SNMPv2)", RFC 1903, January 1996.
  4343.  
  4344. [4]  Case, J., McCloghrie, K., Rose, M., and S. Waldbusser,
  4345.      "Protocol Operations for Version 2 of the Simple Network Management
  4346.      Protocol (SNMPv2)", RFC 1905, January 1996.
  4347.  
  4348. [5]  Case, J., McCloghrie, K., Rose, M. and S. Waldbusser,
  4349.      "Management Information Base for Version 2 of the Simple Network
  4350.      Management Protocol (SNMPv2)", RFC 1907, January 1996.
  4351.  
  4352. [6]  Case, J., Fedor, M., Schoffstall, M., and J. Davin, "Simple Network
  4353.      Management Protocol", STD 15, RFC 1157, SNMP Research, Performance
  4354.      Systems International, MIT Laboratory for Computer Science, May
  4355.      1990.
  4356.  
  4357. [7]  Wijnen, B., Carpenter, G., Curran, K., Sehgal, A. and G. Waters,
  4358.      "Simple Network Management Protocol: Distributed Protocol
  4359.      Interface, Version 2.0", RFC 1592, March 1994.
  4360.  
  4361. [8]  Case, J., McCloghrie, K., Rose, M. and S. Waldbusser,
  4362.      "Coexistence between Version 1 and Version 2 of the Internet-
  4363.      standard Network Management Framework", RFC 1908, January 1996.
  4364.  
  4365. [9]  Wijnen, B. and D. Levi, "V2ToV1: Mapping SNMPv2 onto SNMPv1
  4366.      Within a Bilingual SNMP Agent", RFC 2089, January 1997.
  4367.  
  4368.  
  4369.  
  4370.  
  4371. Daniele, et. al.            Standards Track                    [Page 78]
  4372.  
  4373. RFC 2257                        AgentX                      January 1998
  4374.  
  4375.  
  4376. [10] Case, J., McCloghrie, K., Rose, M. and S. Waldbusser,
  4377.      "Conformance Statements for Version 2 of the Simple Network
  4378.      Management Protocol (SNMPv2)", RFC 1904, January 1996.
  4379.  
  4380. [11] McCloghrie, K. and F. Kastenholz, "Evolution of the
  4381.      Interfaces Group of MIB-II", RFC 1573, January 1994.
  4382.  
  4383. [12] Case, J., "FDDI Management Information Base", RFC 1285,
  4384.      January 1992.
  4385.  
  4386. [13] Application MIB Working Group, Krupczak, C., and J. Saperia,
  4387.      "Definitions of System-Level Managed Objects for Applications",
  4388.      draft-ietf-applmib-sysapplmib-08.txt, 15 Apr 1997.
  4389.  
  4390.  
  4391.  
  4392.  
  4393.  
  4394.  
  4395.  
  4396.  
  4397.  
  4398.  
  4399.  
  4400.  
  4401.  
  4402.  
  4403.  
  4404.  
  4405.  
  4406.  
  4407.  
  4408.  
  4409.  
  4410.  
  4411.  
  4412.  
  4413.  
  4414.  
  4415.  
  4416.  
  4417.  
  4418.  
  4419.  
  4420.  
  4421.  
  4422.  
  4423.  
  4424.  
  4425.  
  4426.  
  4427. Daniele, et. al.            Standards Track                    [Page 79]
  4428.  
  4429. RFC 2257                        AgentX                      January 1998
  4430.  
  4431.  
  4432. 13.  Full Copyright Statement
  4433.  
  4434.    Copyright (C) The Internet Society (1998).  All Rights Reserved.
  4435.  
  4436.    This document and translations of it may be copied and furnished to
  4437.    others, and derivative works that comment on or otherwise explain it
  4438.    or assist in its implementation may be prepared, copied, published
  4439.    and distributed, in whole or in part, without restriction of any
  4440.    kind, provided that the above copyright notice and this paragraph are
  4441.    included on all such copies and derivative works.  However, this
  4442.    document itself may not be modified in any way, such as by removing
  4443.    the copyright notice or references to the Internet Society or other
  4444.    Internet organizations, except as needed for the purpose of
  4445.    developing Internet standards in which case the procedures for
  4446.    copyrights defined in the Internet Standards process must be
  4447.    followed, or as required to translate it into languages other than
  4448.    English.
  4449.  
  4450.    The limited permissions granted above are perpetual and will not be
  4451.    revoked by the Internet Society or its successors or assigns.
  4452.  
  4453.    This document and the information contained herein is provided on an
  4454.    "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
  4455.    TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
  4456.    BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
  4457.    HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
  4458.    MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  4459.  
  4460.  
  4461.  
  4462.  
  4463.  
  4464.  
  4465.  
  4466.  
  4467.  
  4468.  
  4469.  
  4470.  
  4471.  
  4472.  
  4473.  
  4474.  
  4475.  
  4476.  
  4477.  
  4478.  
  4479.  
  4480.  
  4481.  
  4482.  
  4483. Daniele, et. al.            Standards Track                    [Page 80]
  4484.  
  4485.