SNMP Data Source (SNMP) v25.4+ PREVIEW

type: "object"
id: "schema:kubling:dbvirt:model:vdb:sources:SnmpSourceConfig"
properties:
  version:
    type: "string"
    enum:
    - "V2"
    - "V3"
  transport:
    type: "string"
    enum:
    - "UDP"
    - "TCP"
  address:
    type: "string"
  port:
    type: "integer"
  localBindingAddress:
    type: "string"
  localBindingPorts:
    type: "string"
    description: "A comma-separated list of local UDP ports to bind SNMP requests\
      \ to. Supports individual ports (e.g., \"1162\") and port ranges (e.g., \"1162-1164\"\
      ). You can mix both formats: \"1162,1164-1166,1170\". All port numbers must\
      \ be in the range 1–65535, and ranges must be ordered (start <= end). Kubling\
      \ will attempt to bind to these ports in order until one is available."
  community:
    type: "string"
  connectionTimeout:
    type: "integer"
  connectionRetries:
    type: "integer"
  enableSoftTransactions:
    type: "boolean"
  cache:
    type: "object"
    id: "schema:kubling:dbvirt:translation:model:CacheDataSourceConfig"
    properties:
      enabled:
        type: "boolean"
        description: "Specifies whether the cache is enabled for this Data Source.\
          \ Default is false."
      ttlSeconds:
        type: "integer"
        description: "The time-to-live (TTL) for cache entries, in seconds. Default\
          \ is 43,200 seconds (12 hours)."
  contributesToHealth:
    type: "boolean"
    description: "Indicates whether this data source contributes to the engine's overall\
      \ health status. When set to true, if this data source is not healthy, the engine\
      \ will be marked as unhealthy. Otherwise, the health status of this data source\
      \ is ignored in the overall assessment."
  oidForHealthCheck:
    type: "string"
    description: "The SNMP OID to be used for health checks. Kubling periodically\
      \ polls this OID to verify that the target device is reachable and responding.\
      \ By default, it uses '1.3.6.1.2.1.1.1.0' (sysDescr.0), which returns the device\
      \ description. You can override this with any scalar OID that is known to exist\
      \ and respond reliably on the target device."
  connectionPool:
    type: "object"
    id: "schema:kubling:dbvirt:model:vdb:sources:ConnectionPool"
    properties:
      partitions:
        type: "integer"
        description: "Internal connections pool partitions. Default: 2"
      minConnections:
        type: "integer"
        description: "Minimum available connections in the pool per partition. The\
          \ overall total Minimum connections must be calculated per partition, that\
          \ is: partitions * minConnections. Default: 3"
      maxConnections:
        type: "integer"
        description: "Maximum connections to be added to the pool per partition. Once\
          \ reached, subsequent connection requests will be enqueued. The overall\
          \ total Maximum connections must be calculated per partition, that is: partitions\
          \ * maxConnections. Default: 10"
      maxWaitMilliseconds:
        type: "integer"
        description: "Maximum wait time in milliseconds the thread will wait in the\
          \ queue for a connection from the pool. Once reached, an error is thrown\
          \ if no available connection.Default: 10000ms (10s)"
  oidPrefix:
    type: "string"
  mibJsonFilePath:
    type: "string"
    description: "Absolute path to the JSON file generated by gosmi-json-exporter.\
      \ For details, see: https://github.com/kubling-community/gosmi-json-exporter"
  v3Config:
    type: "object"
    id: "schema:kubling:dbvirt:model:vdb:sources:SnmpV3Config"
    properties:
      username:
        type: "string"
        description: "The SNMPv3 username used to authenticate with the target device.\
          \ Must match a valid user configured on the SNMP agent."
      localEngineId:
        type: "string"
        description: "The local SNMP engine ID, in hexadecimal string format. If not\
          \ set, the engine ID is derived automatically. Only needed in advanced SNMPv3\
          \ setups involving Engine ID synchronization."
      enterpriseId:
        type: "integer"
        description: "Enterprise ID used for constructing a local engine ID when it\
          \ is autogenerated. This is optional and typically only needed when setting\
          \ up a custom SNMP engine identity."
      engineBoots:
        type: "integer"
        description: "Boot counter value for SNMPv3 engine restarts. Used to prevent\
          \ replay attacks. Usually left at 0 unless explicitly managing engine state\
          \ across restarts."
      authProtocol:
        type: "string"
        description: "Authentication protocol used for SNMPv3 message integrity and\
          \ sender verification. Supported values include MD5, SHA, and extended HMAC-based\
          \ algorithms."
        enum:
        - "MD5"
        - "SHA"
        - "HMAC128SHA224"
        - "HMAC192SHA256"
        - "HMAC256SHA384"
        - "HMAC384SHA512"
      privacyProtocol:
        type: "string"
        description: "Privacy (encryption) protocol used to secure SNMPv3 message\
          \ contents."
        enum:
        - "DES"
        - "v3DES"
        - "AES128"
        - "AES192"
        - "AES256"
      authenticationPassphrase:
        type: "string"
        description: "The passphrase used for SNMPv3 authentication. Required when\
          \ using an authProtocol."
      privacyPassphrase:
        type: "string"
        description: "The passphrase used for SNMPv3 encryption. Required when using\
          \ a privacyProtocol."
  singleEventErrorToleration:
    type: "boolean"
    description: "Controls how Kubling handles individual SNMP response errors. When\
      \ set to false (default), any response event with an error causes the entire\
      \ operation to fail. When set to true, Kubling tolerates single event errors\
      \ by skipping the failed OID and continuing to process the remaining ones. Useful\
      \ for dealing with partially implemented or unstable SNMP agents."

CREATE FOREIGN TABLE ifTable
(
	ifIndex string OPTIONS (snmp_oid '1.3.6.1.2.1.2.2.1.1', ANNOTATION 'A unique value, greater than zero, for each interface.  It is recommended that values are assigned contiguously starting from 1.  The value for each interface sub-layer must remain constant at least from one re-initialization of the entity''s network management system to the next re- initialization.'),
	ifDescr string OPTIONS (snmp_oid '1.3.6.1.2.1.2.2.1.2', ANNOTATION 'A textual string containing information about the interface.  This string should include the name of the manufacturer, the product name and the version of the interface hardware/software.'),
	ifType string OPTIONS (snmp_oid '1.3.6.1.2.1.2.2.1.3', ANNOTATION 'The type of interface.  Additional values for ifType are assigned by the Internet Assigned Numbers Authority (IANA), through updating the syntax of the IANAifType textual convention.'),
	ifMtu integer OPTIONS (snmp_oid '1.3.6.1.2.1.2.2.1.4', ANNOTATION 'The size of the largest packet which can be sent/received on the interface, specified in octets.  For interfaces that are used for transmitting network datagrams, this is the size of the largest network datagram that can be sent on the interface.'),
	ifSpeed integer OPTIONS (snmp_oid '1.3.6.1.2.1.2.2.1.5', ANNOTATION 'An estimate of the interface''s current bandwidth in bits per second.  For interfaces which do not vary in bandwidth or for those where no accurate estimation can be made, this object should contain the nominal bandwidth.  If the bandwidth of the interface is greater than the maximum value reportable by this object then this object should report its maximum value (4,294,967,295) and ifHighSpeed must be used to report the interace''s speed.  For a sub-layer which has no concept of bandwidth, this object should be zero.'),
	ifPhysAddress string OPTIONS (snmp_oid '1.3.6.1.2.1.2.2.1.6', ANNOTATION 'The interface''s address at its protocol sub-layer.  For example, for an 802.x interface, this object normally contains a MAC address.  The interface''s media-specific MIB must define the bit and byte ordering and the format of the value of this object.  For interfaces which do not have such an address (e.g., a serial line), this object should contain an octet string of zero length.'),
	ifAdminStatus string OPTIONS (snmp_oid '1.3.6.1.2.1.2.2.1.7', ANNOTATION 'The desired state of the interface.  The testing(3) state indicates that no operational packets can be passed.  When a managed system initializes, all interfaces start with ifAdminStatus in the down(2) state.  As a result of either explicit management action or per configuration information retained by the managed system, ifAdminStatus is then changed to either the up(1) or testing(3) states (or remains in the down(2) state).'),
	ifOperStatus string OPTIONS (snmp_oid '1.3.6.1.2.1.2.2.1.8', ANNOTATION 'The current operational state of the interface.  The testing(3) state indicates that no operational packets can be passed.  If ifAdminStatus is down(2) then ifOperStatus should be down(2).  If ifAdminStatus is changed to up(1) then ifOperStatus should change to up(1) if the interface is ready to transmit and receive network traffic; it should change to dormant(5) if the interface is waiting for external actions (such as a serial line waiting for an incoming connection); it should remain in the down(2) state if and only if there is a fault that prevents it from going to the up(1) state; it should remain in the notPresent(6) state if the interface has missing (typically, hardware) components.'),
	ifLastChange string OPTIONS (snmp_oid '1.3.6.1.2.1.2.2.1.9', ANNOTATION 'The value of sysUpTime at the time the interface entered its current operational state.  If the current state was entered prior to the last re-initialization of the local network management subsystem, then this object contains a zero value.'),
	ifInOctets long OPTIONS (snmp_oid '1.3.6.1.2.1.2.2.1.10', ANNOTATION 'The total number of octets received on the interface, including framing characters. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime.'),
	ifInUcastPkts long OPTIONS (snmp_oid '1.3.6.1.2.1.2.2.1.11', ANNOTATION 'The number of packets, delivered by this sub-layer to a higher (sub-)layer, which were not addressed to a multicast or broadcast address at this sub-layer. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime.'),
	ifInNUcastPkts long OPTIONS (snmp_oid '1.3.6.1.2.1.2.2.1.12', ANNOTATION 'The number of packets, delivered by this sub-layer to a higher (sub-)layer, which were addressed to a multicast or broadcast address at this sub-layer. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. This object is deprecated in favour of ifInMulticastPkts and ifInBroadcastPkts.'),
	ifInDiscards long OPTIONS (snmp_oid '1.3.6.1.2.1.2.2.1.13', ANNOTATION 'The number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being deliverable to a higher-layer protocol.  One possible reason for discarding such a packet could be to free up buffer space. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime.'),
	ifInErrors long OPTIONS (snmp_oid '1.3.6.1.2.1.2.2.1.14', ANNOTATION 'For packet-oriented interfaces, the number of inbound packets that contained errors preventing them from being deliverable to a higher-layer protocol.  For character- oriented or fixed-length interfaces, the number of inbound transmission units that contained errors preventing them from being deliverable to a higher-layer protocol. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime.'),
	ifInUnknownProtos long OPTIONS (snmp_oid '1.3.6.1.2.1.2.2.1.15', ANNOTATION 'For packet-oriented interfaces, the number of packets received via the interface which were discarded because of an unknown or unsupported protocol.  For character-oriented or fixed-length interfaces that support protocol multiplexing the number of transmission units received via the interface which were discarded because of an unknown or unsupported protocol.  For any interface that does not support protocol multiplexing, this counter will always be 0. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime.'),
	ifOutOctets long OPTIONS (snmp_oid '1.3.6.1.2.1.2.2.1.16', ANNOTATION 'The total number of octets transmitted out of the interface, including framing characters. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime.'),
	ifOutUcastPkts long OPTIONS (snmp_oid '1.3.6.1.2.1.2.2.1.17', ANNOTATION 'The total number of packets that higher-level protocols requested be transmitted, and which were not addressed to a multicast or broadcast address at this sub-layer, including those that were discarded or not sent. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime.'),
	ifOutNUcastPkts long OPTIONS (snmp_oid '1.3.6.1.2.1.2.2.1.18', ANNOTATION 'The total number of packets that higher-level protocols requested be transmitted, and which were addressed to a multicast or broadcast address at this sub-layer, including those that were discarded or not sent. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. This object is deprecated in favour of ifOutMulticastPkts and ifOutBroadcastPkts.'),
	ifOutDiscards long OPTIONS (snmp_oid '1.3.6.1.2.1.2.2.1.19', ANNOTATION 'The number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted.  One possible reason for discarding such a packet could be to free up buffer space. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime.'),
	ifOutErrors long OPTIONS (snmp_oid '1.3.6.1.2.1.2.2.1.20', ANNOTATION 'For packet-oriented interfaces, the number of outbound packets that could not be transmitted because of errors. For character-oriented or fixed-length interfaces, the number of outbound transmission units that could not be transmitted because of errors. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime.'),
	ifOutQLen long OPTIONS (snmp_oid '1.3.6.1.2.1.2.2.1.21', ANNOTATION 'The length of the output packet queue (in packets).'),
	ifSpecific string OPTIONS (snmp_oid '1.3.6.1.2.1.2.2.1.22', ANNOTATION 'A reference to MIB definitions specific to the particular media being used to realize the interface.  It is recommended that this value point to an instance of a MIB object in the media-specific MIB, i.e., that this object have the semantics associated with the InstancePointer textual convention defined in RFC 2579.  In fact, it is recommended that the media-specific MIB specify what value ifSpecific should/can take for values of ifType.  If no MIB definitions specific to the particular media are available, the value should be set to the OBJECT IDENTIFIER { 0 0 }.')
)
OPTIONS (updatable 'false', snmp_type 'full_table', ANNOTATION 'A list of interface entries.  The number of entries is given by the value of ifNumber.');
 
CREATE FOREIGN TABLE ifXTable
(
    ifIndex integer OPTIONS (snmp_derived_index '1.3.6.1.2.1.31.1.1.1.1:0'),
	ifName string OPTIONS (snmp_oid '1.3.6.1.2.1.31.1.1.1.1', ANNOTATION 'The textual name of the interface.  The value of this object should be the name of the interface as assigned by the local device and should be suitable for use in commands entered at the device''s `console''.  This might be a text name, such as `le0'' or a simple port number, such as `1'', depending on the interface naming syntax of the device.  If several entries in the ifTable together represent a single interface as named by the device, then each will have the same value of ifName.  Note that for an agent which responds to SNMP queries concerning an interface on some other (proxied) device, then the value of ifName for such an interface is the proxied device''s local name for it. If there is no local name, or this object is otherwise not applicable, then this object contains a zero-length string.'),
	ifInMulticastPkts integer OPTIONS (snmp_oid '1.3.6.1.2.1.31.1.1.1.2', ANNOTATION 'The number of packets, delivered by this sub-layer to a higher (sub-)layer, which were addressed to a multicast address at this sub-layer.  For a MAC layer protocol, this includes both Group and Functional addresses. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime.'),
	ifInBroadcastPkts integer OPTIONS (snmp_oid '1.3.6.1.2.1.31.1.1.1.3', ANNOTATION 'The number of packets, delivered by this sub-layer to a higher (sub-)layer, which were addressed to a broadcast address at this sub-layer. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime.'),
	ifOutMulticastPkts integer OPTIONS (snmp_oid '1.3.6.1.2.1.31.1.1.1.4', ANNOTATION 'The total number of packets that higher-level protocols requested be transmitted, and which were addressed to a multicast address at this sub-layer, including those that were discarded or not sent.  For a MAC layer protocol, this includes both Group and Functional addresses. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime.'),
	ifOutBroadcastPkts integer OPTIONS (snmp_oid '1.3.6.1.2.1.31.1.1.1.5', ANNOTATION 'The total number of packets that higher-level protocols requested be transmitted, and which were addressed to a broadcast address at this sub-layer, including those that were discarded or not sent. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime.'),
	ifHCInOctets biginteger OPTIONS (snmp_oid '1.3.6.1.2.1.31.1.1.1.6', ANNOTATION 'The total number of octets received on the interface, including framing characters.  This object is a 64-bit version of ifInOctets. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime.'),
	ifHCInUcastPkts biginteger OPTIONS (snmp_oid '1.3.6.1.2.1.31.1.1.1.7', ANNOTATION 'The number of packets, delivered by this sub-layer to a higher (sub-)layer, which were not addressed to a multicast or broadcast address at this sub-layer.  This object is a 64-bit version of ifInUcastPkts. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime.'),
	ifHCInMulticastPkts biginteger OPTIONS (snmp_oid '1.3.6.1.2.1.31.1.1.1.8', ANNOTATION 'The number of packets, delivered by this sub-layer to a higher (sub-)layer, which were addressed to a multicast address at this sub-layer.  For a MAC layer protocol, this includes both Group and Functional addresses.  This object is a 64-bit version of ifInMulticastPkts. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime.'),
	ifHCInBroadcastPkts biginteger OPTIONS (snmp_oid '1.3.6.1.2.1.31.1.1.1.9', ANNOTATION 'The number of packets, delivered by this sub-layer to a higher (sub-)layer, which were addressed to a broadcast address at this sub-layer.  This object is a 64-bit version of ifInBroadcastPkts. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime.'),
	ifHCOutOctets biginteger OPTIONS (snmp_oid '1.3.6.1.2.1.31.1.1.1.10', ANNOTATION 'The total number of octets transmitted out of the interface, including framing characters.  This object is a 64-bit version of ifOutOctets. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime.'),
	ifHCOutUcastPkts biginteger OPTIONS (snmp_oid '1.3.6.1.2.1.31.1.1.1.11', ANNOTATION 'The total number of packets that higher-level protocols requested be transmitted, and which were not addressed to a multicast or broadcast address at this sub-layer, including those that were discarded or not sent.  This object is a 64-bit version of ifOutUcastPkts. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime.'),
	ifHCOutMulticastPkts biginteger OPTIONS (snmp_oid '1.3.6.1.2.1.31.1.1.1.12', ANNOTATION 'The total number of packets that higher-level protocols requested be transmitted, and which were addressed to a multicast address at this sub-layer, including those that were discarded or not sent.  For a MAC layer protocol, this includes both Group and Functional addresses.  This object is a 64-bit version of ifOutMulticastPkts. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime.'),
	ifHCOutBroadcastPkts biginteger OPTIONS (snmp_oid '1.3.6.1.2.1.31.1.1.1.13', ANNOTATION 'The total number of packets that higher-level protocols requested be transmitted, and which were addressed to a broadcast address at this sub-layer, including those that were discarded or not sent.  This object is a 64-bit version of ifOutBroadcastPkts. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime.'),
	ifLinkUpDownTrapEnable string OPTIONS (snmp_oid '1.3.6.1.2.1.31.1.1.1.14', ANNOTATION 'Indicates whether linkUp/linkDown traps should be generated for this interface. By default, this object should have the value enabled(1) for interfaces which do not operate on ''top'' of any other interface (as defined in the ifStackTable), and disabled(2) otherwise.'),
	ifHighSpeed integer OPTIONS (snmp_oid '1.3.6.1.2.1.31.1.1.1.15', ANNOTATION 'An estimate of the interface''s current bandwidth in units of 1,000,000 bits per second.  If this object reports a value of `n'' then the speed of the interface is somewhere in the range of `n-500,000'' to `n+499,999''.  For interfaces which do not vary in bandwidth or for those where no accurate estimation can be made, this object should contain the nominal bandwidth.  For a sub-layer which has no concept of bandwidth, this object should be zero.'),
	ifPromiscuousMode boolean OPTIONS (snmp_oid '1.3.6.1.2.1.31.1.1.1.16', ANNOTATION 'This object has a value of false(2) if this interface only accepts packets/frames that are addressed to this station. This object has a value of true(1) when the station accepts all packets/frames transmitted on the media.  The value true(1) is only legal on certain types of media.  If legal, setting this object to a value of true(1) may require the interface to be reset before becoming effective. The value of ifPromiscuousMode does not affect the reception of broadcast and multicast packets/frames by the interface.'),
	ifConnectorPresent boolean OPTIONS (snmp_oid '1.3.6.1.2.1.31.1.1.1.17', ANNOTATION 'This object has the value ''true(1)'' if the interface sublayer has a physical connector and the value ''false(2)'' otherwise.'),
	ifAlias string OPTIONS (snmp_oid '1.3.6.1.2.1.31.1.1.1.18', ANNOTATION 'This object is an ''alias'' name for the interface as specified by a network manager, and provides a non-volatile ''handle'' for the interface. On the first instantiation of an interface, the value of ifAlias associated with that interface is the zero-length string.  As and when a value is written into an instance of ifAlias through a network management set operation, then the agent must retain the supplied value in the ifAlias instance associated with the same interface for as long as that interface remains instantiated, including across all re- initializations/reboots of the network management system, including those which result in a change of the interface''s ifIndex value. An example of the value which a network manager might store in this object for a WAN interface is the (Telco''s) circuit number/identifier of the interface. Some agents may support write-access only for interfaces having particular values of ifType.  An agent which supports write access to this object is required to keep the value in non-volatile storage, but it may limit the length of new values depending on how much storage is already occupied by the current values for other interfaces.'),
	ifCounterDiscontinuityTime string OPTIONS (snmp_oid '1.3.6.1.2.1.31.1.1.1.19', ANNOTATION 'The value of sysUpTime on the most recent occasion at which any one or more of this interface''s counters suffered a discontinuity.  The relevant counters are the specific instances associated with this interface of any Counter32 or Counter64 object contained in the ifTable or ifXTable.  If no such discontinuities have occurred since the last re- initialization of the local management subsystem, then this object contains a zero value.')
)
OPTIONS (updatable 'false', snmp_type 'full_table', ANNOTATION 'A list of interface entries.  The number of entries is given by the value of ifNumber.  This table contains additional objects for the interface table.');
 
CREATE FOREIGN TABLE ifStackTable
(
	ifStackStatus string OPTIONS (snmp_oid '1.3.6.1.2.1.31.1.2.1.3'),
	ifStackHigherLayer integer OPTIONS (snmp_derived_index '1.3.6.1.2.1.31.1.2.1.3:0'),
	ifStackLowerLayer integer OPTIONS (snmp_derived_index '1.3.6.1.2.1.31.1.2.1.3:1')
)
OPTIONS (updatable 'false', snmp_type 'full_table', ANNOTATION 'The table containing information on the relationships between the multiple sub-layers of network interfaces.  In particular, it contains information on which sub-layers run ''on top of'' which other sub-layers, where each sub-layer corresponds to a conceptual row in the ifTable.  For example, when the sub-layer with ifIndex value x runs over the sub-layer with ifIndex value y, then this table contains: ifStackStatus.x.y=active For each ifIndex value, I, which identifies an active interface, there are always at least two instantiated rows in this table associated with I.  For one of these rows, I is the value of ifStackHigherLayer; for the other, I is the value of ifStackLowerLayer.  (If I is not involved in multiplexing, then these are the only two rows associated with I.) For example, two rows exist even for an interface which has no others stacked on top or below it: ifStackStatus.0.x=active ifStackStatus.x.0=active');
 
CREATE FOREIGN TABLE entityPhysical (
    index integer OPTIONS (snmp_derived_index '1.3.6.1.2.1.47.1.1.1.1:0'),
    name string OPTIONS (snmp_oid '1.3.6.1.2.1.47.1.1.1.1'),
    class string OPTIONS (snmp_oid '1.3.6.1.2.1.47.1.1.1.5'),
    parentIndex integer OPTIONS (snmp_oid '1.3.6.1.2.1.47.1.1.1.2')
)
OPTIONS (snmp_type 'full_table');
 
CREATE FOREIGN TABLE "system" (
    sysDescr string OPTIONS (snmp_oid '1.3.6.1.2.1.1.1', ANNOTATION 'Device description (vendor, OS, version)'),
    sysObjectID string OPTIONS (snmp_oid '1.3.6.1.2.1.1.2', ANNOTATION 'OID identifying the device type'),
    sysUpTime string OPTIONS (snmp_oid '1.3.6.1.2.1.1.3', ANNOTATION 'Time since last reboot'),
    sysContact string OPTIONS (snmp_oid '1.3.6.1.2.1.1.4', ANNOTATION 'Admin contact info'),
    sysName string OPTIONS (snmp_oid '1.3.6.1.2.1.1.5', ANNOTATION 'Hostname'),
    sysLocation string OPTIONS (snmp_oid '1.3.6.1.2.1.1.6', ANNOTATION 'Physical location'),
    sysServices integer OPTIONS (snmp_oid '1.3.6.1.2.1.1.7', ANNOTATION 'Service bitmask')
)
OPTIONS (snmp_type 'full_table');
 
CREATE FOREIGN TABLE ipStats (
    ipInReceives bigint OPTIONS (snmp_oid '1.3.6.1.2.1.4.3'),
    ipInDelivers bigint OPTIONS (snmp_oid '1.3.6.1.2.1.4.9'),
    ipOutRequests bigint OPTIONS (snmp_oid '1.3.6.1.2.1.4.10'),
    ipForwDatagrams bigint OPTIONS (snmp_oid '1.3.6.1.2.1.4.6'),
    ipInDiscards bigint OPTIONS (snmp_oid '1.3.6.1.2.1.4.4'),
    ipOutDiscards bigint OPTIONS (snmp_oid '1.3.6.1.2.1.4.11'),
    ipInAddrErrors bigint OPTIONS (snmp_oid '1.3.6.1.2.1.4.5')
)
OPTIONS (snmp_type 'full_table');
 
CREATE FOREIGN TABLE icmpStats (
    icmpInMsgs bigint OPTIONS (snmp_oid '1.3.6.1.2.1.5.1'),
    icmpOutMsgs bigint OPTIONS (snmp_oid '1.3.6.1.2.1.5.14'),
    icmpInErrors bigint OPTIONS (snmp_oid '1.3.6.1.2.1.5.2'),
    icmpOutErrors bigint OPTIONS (snmp_oid '1.3.6.1.2.1.5.15'),
    icmpInEchoReps bigint OPTIONS (snmp_oid '1.3.6.1.2.1.5.8'),
    icmpOutEchos bigint OPTIONS (snmp_oid '1.3.6.1.2.1.5.21')
)
OPTIONS (snmp_type 'full_table');
 
CREATE FOREIGN TABLE tcpStats (
    tcpActiveOpens bigint OPTIONS (snmp_oid '1.3.6.1.2.1.6.5'),
    tcpPassiveOpens bigint OPTIONS (snmp_oid '1.3.6.1.2.1.6.6'),
    tcpAttemptFails bigint OPTIONS (snmp_oid '1.3.6.1.2.1.6.7'),
    tcpEstabResets bigint OPTIONS (snmp_oid '1.3.6.1.2.1.6.8'),
    tcpCurrEstab bigint OPTIONS (snmp_oid '1.3.6.1.2.1.6.9')
)
OPTIONS (snmp_type 'full_table');
 
CREATE FOREIGN TABLE udpStats (
    udpInDatagrams bigint OPTIONS (snmp_oid '1.3.6.1.2.1.7.1'),
    udpNoPorts bigint OPTIONS (snmp_oid '1.3.6.1.2.1.7.2'),
    udpInErrors bigint OPTIONS (snmp_oid '1.3.6.1.2.1.7.3'),
    udpOutDatagrams bigint OPTIONS (snmp_oid '1.3.6.1.2.1.7.4')
)
OPTIONS (snmp_type 'full_table');
 
CREATE FOREIGN TABLE etherStats (
    index integer OPTIONS (snmp_derived_index '1.3.6.1.2.1.16.1.1.1.1:0'),
    dropEvents bigint OPTIONS (snmp_oid '1.3.6.1.2.1.16.1.1.1.2'),
    octets bigint OPTIONS (snmp_oid '1.3.6.1.2.1.16.1.1.1.3'),
    packets bigint OPTIONS (snmp_oid '1.3.6.1.2.1.16.1.1.1.4')
)
OPTIONS (snmp_type 'full_table');
 
CREATE FOREIGN TABLE bridge (
    dot1dBaseBridgeAddress string OPTIONS (snmp_oid '1.3.6.1.2.1.17.1.1'),
    dot1dBaseNumPorts integer OPTIONS (snmp_oid '1.3.6.1.2.1.17.1.2'),
    dot1dStpTimeSinceTopologyChange integer OPTIONS (snmp_oid '1.3.6.1.2.1.17.2.4'),
    dot1dStpTopChanges integer OPTIONS (snmp_oid '1.3.6.1.2.1.17.2.5')
)
OPTIONS (snmp_type 'full_table');
 
CREATE FOREIGN TABLE rmonEtherStats (
    index integer OPTIONS (snmp_derived_index '1.3.6.1.2.1.16.1.1.1.1:0'),
    octets bigint OPTIONS (snmp_oid '1.3.6.1.2.1.16.1.1.1.3'),
    packets bigint OPTIONS (snmp_oid '1.3.6.1.2.1.16.1.1.1.4'),
    crcAlignErrors bigint OPTIONS (snmp_oid '1.3.6.1.2.1.16.1.1.1.5'),
    undersizePkts bigint OPTIONS (snmp_oid '1.3.6.1.2.1.16.1.1.1.6'),
    oversizePkts bigint OPTIONS (snmp_oid '1.3.6.1.2.1.16.1.1.1.7')
)
OPTIONS (snmp_type 'full_table');
 
CREATE FOREIGN TABLE ifTestTable
(
	ifTestId string OPTIONS (snmp_oid '1.3.6.1.2.1.31.1.3.1.1', ANNOTATION 'This object identifies the current invocation of the interface''s test.'),
	ifTestStatus string OPTIONS (snmp_oid '1.3.6.1.2.1.31.1.3.1.2', ANNOTATION 'This object indicates whether or not some manager currently has the necessary ''ownership'' required to invoke a test on this interface.  A write to this object is only successful when it changes its value from ''notInUse(1)'' to ''inUse(2)''. After completion of a test, the agent resets the value back to ''notInUse(1)''.'),
	ifTestType string OPTIONS (snmp_oid '1.3.6.1.2.1.31.1.3.1.3', ANNOTATION 'A control variable used to start and stop operator- initiated interface tests.  Most OBJECT IDENTIFIER values assigned to tests are defined elsewhere, in association with specific types of interface.  However, this document assigns a value for a full-duplex loopback test, and defines the special meanings of the subject identifier: noTest  OBJECT IDENTIFIER ::= { 0 0 } When the value noTest is written to this object, no action is taken unless a test is in progress, in which case the test is aborted.  Writing any other value to this object is only valid when no test is currently in progress, in which case the indicated test is initiated. When read, this object always returns the most recent value that ifTestType was set to.  If it has not been set since the last initialization of the network management subsystem on the agent, a value of noTest is returned.'),
	ifTestResult string OPTIONS (snmp_oid '1.3.6.1.2.1.31.1.3.1.4', ANNOTATION 'This object contains the result of the most recently requested test, or the value none(1) if no tests have been requested since the last reset.  Note that this facility provides no provision for saving the results of one test when starting another, as could be required if used by multiple managers concurrently.'),
	ifTestCode string OPTIONS (snmp_oid '1.3.6.1.2.1.31.1.3.1.5', ANNOTATION 'This object contains a code which contains more specific information on the test result, for example an error-code after a failed test.  Error codes and other values this object may take are specific to the type of interface and/or test.  The value may have the semantics of either the AutonomousType or InstancePointer textual conventions as defined in RFC 2579.  The identifier: testCodeUnknown  OBJECT IDENTIFIER ::= { 0 0 } is defined for use if no additional result code is available.'),
	ifTestOwner string OPTIONS (snmp_oid '1.3.6.1.2.1.31.1.3.1.6', ANNOTATION 'The entity which currently has the ''ownership'' required to invoke a test on this interface.')
)
OPTIONS (updatable 'false', snmp_type 'full_table', ANNOTATION 'This table contains one entry per interface.  It defines objects which allow a network manager to instruct an agent to test an interface for various faults.  Tests for an interface are defined in the media-specific MIB for that interface.  After invoking a test, the object ifTestResult can be read to determine the outcome.  If an agent can not perform the test, ifTestResult is set to so indicate.  The object ifTestCode can be used to provide further test- specific or interface-specific (or even enterprise-specific) information concerning the outcome of the test.  Only one test can be in progress on each interface at any one time. If one test is in progress when another test is invoked, the second test is rejected.  Some agents may reject a test when a prior test is active on another interface. Before starting a test, a manager-station must first obtain ''ownership'' of the entry in the ifTestTable for the interface to be tested.  This is accomplished with the ifTestId and ifTestStatus objects as follows: try_again: get (ifTestId, ifTestStatus) while (ifTestStatus != notInUse) /* * Loop while a test is running or some other * manager is configuring a test. */ short delay get (ifTestId, ifTestStatus) } /* * Is not being used right now -- let''s compete * to see who gets it. */ lock_value = ifTestId if ( set(ifTestId = lock_value, ifTestStatus = inUse, ifTestOwner = ''my-IP-address'') == FAILURE) /* * Another manager got the ifTestEntry -- go * try again */ goto try_again; /* * I have the lock */ set up any test parameters. /* * This starts the test */ set(ifTestType = test_to_run); wait for test completion by polling ifTestResult when test completes, agent sets ifTestResult agent also sets ifTestStatus = ''notInUse'' retrieve any additional test results, and ifTestId if (ifTestId == lock_value+1) results are valid A manager station first retrieves the value of the appropriate ifTestId and ifTestStatus objects, periodically repeating the retrieval if necessary, until the value of ifTestStatus is ''notInUse''.  The manager station then tries to set the same ifTestId object to the value it just retrieved, the same ifTestStatus object to ''inUse'', and the corresponding ifTestOwner object to a value indicating itself.  If the set operation succeeds then the manager has obtained ownership of the ifTestEntry, and the value of the ifTestId object is incremented by the agent (per the semantics of TestAndIncr).  Failure of the set operation indicates that some other manager has obtained ownership of the ifTestEntry. Once ownership is obtained, any test parameters can be setup, and then the test is initiated by setting ifTestType. On completion of the test, the agent sets ifTestStatus to ''notInUse''.  Once this occurs, the manager can retrieve the results.  In the (rare) event that the invocation of tests by two network managers were to overlap, then there would be a possibility that the first test''s results might be overwritten by the second test''s results prior to the first results being read.  This unlikely circumstance can be detected by a network manager retrieving ifTestId at the same time as retrieving the test results, and ensuring that the results are for the desired request. If ifTestType is not set within an abnormally long period of time after ownership is obtained, the agent should time-out the manager, and reset the value of the ifTestStatus object back to ''notInUse''.  It is suggested that this time-out period be 5 minutes. In general, a management station must not retransmit a request to invoke a test for which it does not receive a response; instead, it properly inspects an agent''s MIB to determine if the invocation was successful.  Only if the invocation was unsuccessful, is the invocation request retransmitted. Some tests may require the interface to be taken off-line in order to execute them, or may even require the agent to reboot after completion of the test.  In these circumstances, communication with the management station invoking the test may be lost until after completion of the test.  An agent is not required to support such tests. However, if such tests are supported, then the agent should make every effort to transmit a response to the request which invoked the test prior to losing communication.  When the agent is restored to normal service, the results of the test are properly made available in the appropriate objects. Note that this requires that the ifIndex value assigned to an interface must be unchanged even if the test causes a reboot.  An agent must reject any test for which it cannot, perhaps due to resource constraints, make available at least the minimum amount of information after that test completes.');
 
CREATE FOREIGN TABLE ifRcvAddressTable
(
	ifRcvAddressAddress string OPTIONS (snmp_oid '1.3.6.1.2.1.31.1.4.1.1', ANNOTATION 'An address for which the system will accept packets/frames on this entry''s interface.'),
	ifRcvAddressStatus string OPTIONS (snmp_oid '1.3.6.1.2.1.31.1.4.1.2', ANNOTATION 'This object is used to create and delete rows in the ifRcvAddressTable.'),
	ifRcvAddressType string OPTIONS (snmp_oid '1.3.6.1.2.1.31.1.4.1.3', ANNOTATION 'This object has the value nonVolatile(3) for those entries in the table which are valid and will not be deleted by the next restart of the managed system.  Entries having the value volatile(2) are valid and exist, but have not been saved, so that will not exist after the next restart of the managed system.  Entries having the value other(1) are valid and exist but are not classified as to whether they will continue to exist after the next restart.')
)
OPTIONS (updatable 'false', snmp_type 'full_table', ANNOTATION 'This table contains an entry for each address (broadcast, multicast, or uni-cast) for which the system will receive packets/frames on a particular interface, except as follows: - for an interface operating in promiscuous mode, entries are only required for those addresses for which the system would receive frames were it not operating in promiscuous mode. - for 802.5 functional addresses, only one entry is required, for the address which has the functional address bit ANDed with the bit mask of all functional addresses for which the interface will accept frames. A system is normally able to use any unicast address which corresponds to an entry in this table as a source address.');