{ "openapi": "3.0.0", "info": { "title": "IF-MIB MIB API", "version": "1.0.0", "description": "The MIB module to describe generic objects for network\n interface sub-layers. This MIB is an updated version of\n MIB-II's ifTable, and incorporates the extensions defined in\n RFC 1229.\n\nāš ļø **IMPORTANT - MIB DATA ACCESS**:\nThis YANG model exists for SMIv2-to-YANG translation purposes, but MIB data on IOS-XE devices is primarily accessed via **SNMP protocol**, not RESTCONF.\n\n**RESTCONF Limitation**: Many MIB paths may return 404 errors via RESTCONF `/data` endpoints because the device exposes MIB data through SNMP, not the YANG datastore.\n\n**Recommended Access Methods**:\n- Use SNMP (v2c/v3) to query MIB data directly\n- Use NETCONF `` operations for devices supporting YANG-modeled MIB access\n- Check device capabilities: some newer IOS-XE versions may support limited RESTCONF access to specific MIBs\n\n**YANG Model Purpose**: These YANG models define the structure of SNMP MIBs in YANG format for tooling compatibility, but do not guarantee RESTCONF data availability.\n\n\n**šŸ“Š YANG Tree:** [View IF-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/IF-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "IF-MIB", "x-model-type": "mib" }, "servers": [ { "url": "https://{device}/restconf", "description": "RESTCONF server", "variables": { "device": { "default": "10.1.1.1", "description": "Device hostname or IP address" } } } ], "paths": { "/data/IF-MIB:interfaces": { "get": { "summary": "Get interfaces data", "description": "Retrieve interfaces operational data from MIB", "tags": [ "IF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The number of network interfaces (regardless of their\n current state) present on this system.", "properties": { "ifNumber": { "type": "integer", "description": "The number of network interfaces (regardless of their\n current state) present on this system.", "minimum": -2147483648, "maximum": 2147483647 } } }, "example": { "IF-MIB:interfaces": { "ifNumber": 48 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-interfaces", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/interfaces", "x-restconf-kind": "container" }, "/data/IF-MIB:ifMIBObjects": { "get": { "summary": "Get ifMIBObjects data", "description": "Retrieve ifMIBObjects operational data from MIB", "tags": [ "IF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The value of sysUpTime at the time of the last creation or\n deletion of an entry in the ifTable. If the number of\n entries has been unchanged since the last re-initialization\n of the local network management subsystem, then this object\n contains a zero value.", "properties": { "ifTableLastChange": { "type": "string", "description": "The value of sysUpTime at the time of the last creation or\n deletion of an entry in the ifTable. If the number of\n entries has been unchanged since the last re-initialization\n of the local network management subsystem, then this object\n contains a zero value.", "x-yang-type": "yang:timeticks" }, "ifStackLastChange": { "type": "string", "description": "The value of sysUpTime at the time of the last change of\n the (whole) interface stack. A change of the interface\n stack is defined to be any creation, deletion, or change in\n value of any instance of ifStackStatus. If the interface\n stack has been unchanged since the last re-initialization of\n the local network management subsystem, then this object\n contains a zero value.", "x-yang-type": "yang:timeticks" } } }, "example": { "IF-MIB:ifMIBObjects": { "ifTableLastChange": "example-string", "ifStackLastChange": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ifMIBObjects", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/ifMIBObjects", "x-restconf-kind": "container" }, "/data/IF-MIB:ifTable": { "get": { "summary": "Get ifTable data", "description": "Retrieve ifTable operational data from MIB", "tags": [ "IF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A list of interface entries. The number of entries is\n given by the value of ifNumber.", "properties": { "ifEntry": { "type": "array", "description": "An entry containing management information applicable to a\n particular interface.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "A unique value, greater than zero, for each interface. It\n is recommended that values are assigned contiguously\n starting from 1. The value for each interface sub-layer\n must remain constant at least from one re-initialization of\n the entity's network management system to the next re-\n initialization.", "x-yang-type": "IF-MIB:InterfaceIndex" }, "ifDescr": { "type": "string", "description": "A textual string containing information about the\n interface. This string should include the name of the\n manufacturer, the product name and the version of the\n interface hardware/software.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ifType": { "type": "string", "description": "The type of interface. Additional values for ifType are\n assigned by the Internet Assigned Numbers Authority (IANA),\n through updating the syntax of the IANAifType textual\n convention.", "x-yang-type": "ianaiftype-mib:IANAifType" }, "ifMtu": { "type": "integer", "description": "The size of the largest packet which can be sent/received\n on the interface, specified in octets. For interfaces that\n are used for transmitting network datagrams, this is the\n size of the largest network datagram that can be sent on the\n interface.", "minimum": -2147483648, "maximum": 2147483647 }, "ifSpeed": { "type": "integer", "description": "An estimate of the interface's current bandwidth in bits\n per second. For interfaces which do not vary in bandwidth\n or for those where no accurate estimation can be made, this\n object should contain the nominal bandwidth. If the\n bandwidth of the interface is greater than the maximum value\n reportable by this object then this object should report its\n maximum value (4,294,967,295) and ifHighSpeed must be used\n to report the interace's speed. For a sub-layer which has\n no concept of bandwidth, this object should be zero.", "minimum": 0, "maximum": 4294967295 }, "ifPhysAddress": { "type": "string", "description": "The interface's address at its protocol sub-layer. For\n example, for an 802.x interface, this object normally\n contains a MAC address. The interface's media-specific MIB\n must define the bit and byte ordering and the format of the\n value of this object. For interfaces which do not have such\n an address (e.g., a serial line), this object should contain\n an octet string of zero length.", "x-yang-type": "yang:phys-address" }, "ifAdminStatus": { "type": "string", "description": "The desired state of the interface. The testing(3) state\n indicates that no operational packets can be passed. When a\n managed system initializes, all interfaces start with\n ifAdminStatus in the down(2) state. As a result of either\n explicit management action or per configuration information\n retained by the managed system, ifAdminStatus is then\n changed to either the up(1) or testing(3) states (or remains\n in the down(2) state)." }, "ifOperStatus": { "type": "string", "description": "The current operational state of the interface. The\n testing(3) state indicates that no operational packets can\n be passed. If ifAdminStatus is down(2) then ifOperStatus\n should be down(2). If ifAdminStatus is changed to up(1)\n then ifOperStatus should change to up(1) if the interface is\n ready to transmit and receive network traffic; it should\n change to dormant(5) if the interface is waiting for\n external actions (such as a serial line waiting for an\n incoming connection); it should remain in the down(2) state\n if and only if there is a fault that prevents it from going\n to the up(1) state; it should remain in the notPresent(6)\n state if the interface has missing (typically, hardware)\n components." }, "ifLastChange": { "type": "string", "description": "The value of sysUpTime at the time the interface entered\n its current operational state. If the current state was\n entered prior to the last re-initialization of the local\n network management subsystem, then this object contains a\n zero value.", "x-yang-type": "yang:timeticks" }, "ifInOctets": { "type": "integer", "description": "The total number of octets received on the interface,\n including framing characters.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifInUcastPkts": { "type": "integer", "description": "The number of packets, delivered by this sub-layer to a\n higher (sub-)layer, which were not addressed to a multicast\n or broadcast address at this sub-layer.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifInNUcastPkts": { "type": "integer", "description": "The number of packets, delivered by this sub-layer to a\n higher (sub-)layer, which were addressed to a multicast or\n broadcast address at this sub-layer.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.\n \n This object is deprecated in favour of ifInMulticastPkts and\n ifInBroadcastPkts.", "minimum": 0, "maximum": 4294967295 }, "ifInDiscards": { "type": "integer", "description": "The number of inbound packets which were chosen to be\n discarded even though no errors had been detected to prevent\n their being deliverable to a higher-layer protocol. One\n possible reason for discarding such a packet could be to\n free up buffer space.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifInErrors": { "type": "integer", "description": "For packet-oriented interfaces, the number of inbound\n packets that contained errors preventing them from being\n deliverable to a higher-layer protocol. For character-\n oriented or fixed-length interfaces, the number of inbound\n transmission units that contained errors preventing them\n from being deliverable to a higher-layer protocol.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifInUnknownProtos": { "type": "integer", "description": "For packet-oriented interfaces, the number of packets\n received via the interface which were discarded because of\n an unknown or unsupported protocol. For character-oriented\n or fixed-length interfaces that support protocol\n multiplexing the number of transmission units received via\n the interface which were discarded because of an unknown or\n unsupported protocol. For any interface that does not\n support protocol multiplexing, this counter will always be\n 0.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifOutOctets": { "type": "integer", "description": "The total number of octets transmitted out of the\n interface, including framing characters.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifOutUcastPkts": { "type": "integer", "description": "The total number of packets that higher-level protocols\n requested be transmitted, and which were not addressed to a\n multicast or broadcast address at this sub-layer, including\n those that were discarded or not sent.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifOutNUcastPkts": { "type": "integer", "description": "The total number of packets that higher-level protocols\n requested be transmitted, and which were addressed to a\n multicast or broadcast address at this sub-layer, including\n those that were discarded or not sent.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.\n \n This object is deprecated in favour of ifOutMulticastPkts\n and ifOutBroadcastPkts.", "minimum": 0, "maximum": 4294967295 }, "ifOutDiscards": { "type": "integer", "description": "The number of outbound packets which were chosen to be\n discarded even though no errors had been detected to prevent\n their being transmitted. One possible reason for discarding\n such a packet could be to free up buffer space.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifOutErrors": { "type": "integer", "description": "For packet-oriented interfaces, the number of outbound\n packets that could not be transmitted because of errors.\n For character-oriented or fixed-length interfaces, the\n number of outbound transmission units that could not be\n transmitted because of errors.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifOutQLen": { "type": "integer", "description": "The length of the output packet queue (in packets).", "minimum": 0, "maximum": 4294967295 }, "ifSpecific": { "type": "string", "description": "A reference to MIB definitions specific to the particular\n media being used to realize the interface. It is\n recommended that this value point to an instance of a MIB\n object in the media-specific MIB, i.e., that this object\n have the semantics associated with the InstancePointer\n textual convention defined in RFC 2579. In fact, it is\n recommended that the media-specific MIB specify what value\n ifSpecific should/can take for values of ifType. If no MIB\n definitions specific to the particular media are available,\n the value should be set to the OBJECT IDENTIFIER { 0 0 }.", "x-yang-type": "yang:object-identifier-128" } } } } } }, "example": { "IF-MIB:ifTable": { "ifEntry": [ { "ifIndex": "1", "ifDescr": "GigabitEthernet1/0/1", "ifType": "ethernetCsmacd(6)", "ifMtu": 1500, "ifSpeed": 1000000000, "ifPhysAddress": "00:11:22:33:44:01", "ifAdminStatus": "up(1)", "ifOperStatus": "up(1)", "ifLastChange": "example-string", "ifInOctets": 1234567890, "ifInUcastPkts": 0, "ifInNUcastPkts": 0, "ifInDiscards": 0, "ifInErrors": 0, "ifInUnknownProtos": 0, "ifOutOctets": 1234567890, "ifOutUcastPkts": 0, "ifOutNUcastPkts": 0, "ifOutDiscards": 0, "ifOutErrors": 0, "ifOutQLen": 0, "ifSpecific": "example-string" }, { "ifIndex": "2", "ifDescr": "GigabitEthernet1/0/2", "ifType": "ethernetCsmacd(6)", "ifMtu": 1500, "ifSpeed": 1000000000, "ifPhysAddress": "00:11:22:33:44:02", "ifAdminStatus": "up(1)", "ifOperStatus": "up(1)", "ifLastChange": "example-string", "ifInOctets": 1235567890, "ifInUcastPkts": 0, "ifInNUcastPkts": 0, "ifInDiscards": 0, "ifInErrors": 0, "ifInUnknownProtos": 0, "ifOutOctets": 1235567890, "ifOutUcastPkts": 0, "ifOutNUcastPkts": 0, "ifOutDiscards": 0, "ifOutErrors": 0, "ifOutQLen": 0, "ifSpecific": "example-string" }, { "ifIndex": "3", "ifDescr": "GigabitEthernet1/0/3", "ifType": "ethernetCsmacd(6)", "ifMtu": 1500, "ifSpeed": 1000000000, "ifPhysAddress": "00:11:22:33:44:03", "ifAdminStatus": "up(1)", "ifOperStatus": "up(1)", "ifLastChange": "example-string", "ifInOctets": 1236567890, "ifInUcastPkts": 0, "ifInNUcastPkts": 0, "ifInDiscards": 0, "ifInErrors": 0, "ifInUnknownProtos": 0, "ifOutOctets": 1236567890, "ifOutUcastPkts": 0, "ifOutNUcastPkts": 0, "ifOutDiscards": 0, "ifOutErrors": 0, "ifOutQLen": 0, "ifSpecific": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ifTable", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/ifTable", "x-restconf-kind": "container" }, "/data/IF-MIB:ifTable/ifEntry": { "get": { "summary": "Get ifEntry list", "description": "Retrieve list of ifEntry entries from MIB", "tags": [ "IF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry containing management information applicable to a\n particular interface.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "A unique value, greater than zero, for each interface. It\n is recommended that values are assigned contiguously\n starting from 1. The value for each interface sub-layer\n must remain constant at least from one re-initialization of\n the entity's network management system to the next re-\n initialization.", "x-yang-type": "IF-MIB:InterfaceIndex" }, "ifDescr": { "type": "string", "description": "A textual string containing information about the\n interface. This string should include the name of the\n manufacturer, the product name and the version of the\n interface hardware/software.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ifType": { "type": "string", "description": "The type of interface. Additional values for ifType are\n assigned by the Internet Assigned Numbers Authority (IANA),\n through updating the syntax of the IANAifType textual\n convention.", "x-yang-type": "ianaiftype-mib:IANAifType" }, "ifMtu": { "type": "integer", "description": "The size of the largest packet which can be sent/received\n on the interface, specified in octets. For interfaces that\n are used for transmitting network datagrams, this is the\n size of the largest network datagram that can be sent on the\n interface.", "minimum": -2147483648, "maximum": 2147483647 }, "ifSpeed": { "type": "integer", "description": "An estimate of the interface's current bandwidth in bits\n per second. For interfaces which do not vary in bandwidth\n or for those where no accurate estimation can be made, this\n object should contain the nominal bandwidth. If the\n bandwidth of the interface is greater than the maximum value\n reportable by this object then this object should report its\n maximum value (4,294,967,295) and ifHighSpeed must be used\n to report the interace's speed. For a sub-layer which has\n no concept of bandwidth, this object should be zero.", "minimum": 0, "maximum": 4294967295 }, "ifPhysAddress": { "type": "string", "description": "The interface's address at its protocol sub-layer. For\n example, for an 802.x interface, this object normally\n contains a MAC address. The interface's media-specific MIB\n must define the bit and byte ordering and the format of the\n value of this object. For interfaces which do not have such\n an address (e.g., a serial line), this object should contain\n an octet string of zero length.", "x-yang-type": "yang:phys-address" }, "ifAdminStatus": { "type": "string", "description": "The desired state of the interface. The testing(3) state\n indicates that no operational packets can be passed. When a\n managed system initializes, all interfaces start with\n ifAdminStatus in the down(2) state. As a result of either\n explicit management action or per configuration information\n retained by the managed system, ifAdminStatus is then\n changed to either the up(1) or testing(3) states (or remains\n in the down(2) state)." }, "ifOperStatus": { "type": "string", "description": "The current operational state of the interface. The\n testing(3) state indicates that no operational packets can\n be passed. If ifAdminStatus is down(2) then ifOperStatus\n should be down(2). If ifAdminStatus is changed to up(1)\n then ifOperStatus should change to up(1) if the interface is\n ready to transmit and receive network traffic; it should\n change to dormant(5) if the interface is waiting for\n external actions (such as a serial line waiting for an\n incoming connection); it should remain in the down(2) state\n if and only if there is a fault that prevents it from going\n to the up(1) state; it should remain in the notPresent(6)\n state if the interface has missing (typically, hardware)\n components." }, "ifLastChange": { "type": "string", "description": "The value of sysUpTime at the time the interface entered\n its current operational state. If the current state was\n entered prior to the last re-initialization of the local\n network management subsystem, then this object contains a\n zero value.", "x-yang-type": "yang:timeticks" }, "ifInOctets": { "type": "integer", "description": "The total number of octets received on the interface,\n including framing characters.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifInUcastPkts": { "type": "integer", "description": "The number of packets, delivered by this sub-layer to a\n higher (sub-)layer, which were not addressed to a multicast\n or broadcast address at this sub-layer.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifInNUcastPkts": { "type": "integer", "description": "The number of packets, delivered by this sub-layer to a\n higher (sub-)layer, which were addressed to a multicast or\n broadcast address at this sub-layer.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.\n \n This object is deprecated in favour of ifInMulticastPkts and\n ifInBroadcastPkts.", "minimum": 0, "maximum": 4294967295 }, "ifInDiscards": { "type": "integer", "description": "The number of inbound packets which were chosen to be\n discarded even though no errors had been detected to prevent\n their being deliverable to a higher-layer protocol. One\n possible reason for discarding such a packet could be to\n free up buffer space.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifInErrors": { "type": "integer", "description": "For packet-oriented interfaces, the number of inbound\n packets that contained errors preventing them from being\n deliverable to a higher-layer protocol. For character-\n oriented or fixed-length interfaces, the number of inbound\n transmission units that contained errors preventing them\n from being deliverable to a higher-layer protocol.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifInUnknownProtos": { "type": "integer", "description": "For packet-oriented interfaces, the number of packets\n received via the interface which were discarded because of\n an unknown or unsupported protocol. For character-oriented\n or fixed-length interfaces that support protocol\n multiplexing the number of transmission units received via\n the interface which were discarded because of an unknown or\n unsupported protocol. For any interface that does not\n support protocol multiplexing, this counter will always be\n 0.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifOutOctets": { "type": "integer", "description": "The total number of octets transmitted out of the\n interface, including framing characters.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifOutUcastPkts": { "type": "integer", "description": "The total number of packets that higher-level protocols\n requested be transmitted, and which were not addressed to a\n multicast or broadcast address at this sub-layer, including\n those that were discarded or not sent.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifOutNUcastPkts": { "type": "integer", "description": "The total number of packets that higher-level protocols\n requested be transmitted, and which were addressed to a\n multicast or broadcast address at this sub-layer, including\n those that were discarded or not sent.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.\n \n This object is deprecated in favour of ifOutMulticastPkts\n and ifOutBroadcastPkts.", "minimum": 0, "maximum": 4294967295 }, "ifOutDiscards": { "type": "integer", "description": "The number of outbound packets which were chosen to be\n discarded even though no errors had been detected to prevent\n their being transmitted. One possible reason for discarding\n such a packet could be to free up buffer space.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifOutErrors": { "type": "integer", "description": "For packet-oriented interfaces, the number of outbound\n packets that could not be transmitted because of errors.\n For character-oriented or fixed-length interfaces, the\n number of outbound transmission units that could not be\n transmitted because of errors.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifOutQLen": { "type": "integer", "description": "The length of the output packet queue (in packets).", "minimum": 0, "maximum": 4294967295 }, "ifSpecific": { "type": "string", "description": "A reference to MIB definitions specific to the particular\n media being used to realize the interface. It is\n recommended that this value point to an instance of a MIB\n object in the media-specific MIB, i.e., that this object\n have the semantics associated with the InstancePointer\n textual convention defined in RFC 2579. In fact, it is\n recommended that the media-specific MIB specify what value\n ifSpecific should/can take for values of ifType. If no MIB\n definitions specific to the particular media are available,\n the value should be set to the OBJECT IDENTIFIER { 0 0 }.", "x-yang-type": "yang:object-identifier-128" } } } }, "example": { "IF-MIB:ifEntry": [ { "ifIndex": "example-string", "ifDescr": "GigabitEthernet1/0/1", "ifType": "ethernetCsmacd(6)", "ifMtu": 1500, "ifSpeed": 1000000000, "ifPhysAddress": "00:11:22:33:44:55", "ifAdminStatus": "up(1)", "ifOperStatus": "up(1)", "ifLastChange": "example-string", "ifInOctets": 1234567890, "ifInUcastPkts": 0, "ifInNUcastPkts": 0, "ifInDiscards": 0, "ifInErrors": 0, "ifInUnknownProtos": 0, "ifOutOctets": 1234567890, "ifOutUcastPkts": 0, "ifOutNUcastPkts": 0, "ifOutDiscards": 0, "ifOutErrors": 0, "ifOutQLen": 0, "ifSpecific": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ifEntry", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/ifTable/ifEntry", "x-restconf-kind": "container" }, "/data/IF-MIB:ifTable/ifEntry={ifIndex}": { "get": { "summary": "Get ifEntry entry", "description": "Retrieve specific ifEntry entry by key from MIB", "tags": [ "IF-MIB" ], "parameters": [ { "name": "ifIndex", "in": "path", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "A unique value, greater than zero, for each interface. It\n is recommended that values are assigned contiguously\n starting from 1. The value for each interface sub-layer\n must remain constant at least from one re-initialization of\n the entity's network management system to the next re-\n initialization.", "x-yang-type": "IF-MIB:InterfaceIndex" }, "ifDescr": { "type": "string", "description": "A textual string containing information about the\n interface. This string should include the name of the\n manufacturer, the product name and the version of the\n interface hardware/software.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ifType": { "type": "string", "description": "The type of interface. Additional values for ifType are\n assigned by the Internet Assigned Numbers Authority (IANA),\n through updating the syntax of the IANAifType textual\n convention.", "x-yang-type": "ianaiftype-mib:IANAifType" }, "ifMtu": { "type": "integer", "description": "The size of the largest packet which can be sent/received\n on the interface, specified in octets. For interfaces that\n are used for transmitting network datagrams, this is the\n size of the largest network datagram that can be sent on the\n interface.", "minimum": -2147483648, "maximum": 2147483647 }, "ifSpeed": { "type": "integer", "description": "An estimate of the interface's current bandwidth in bits\n per second. For interfaces which do not vary in bandwidth\n or for those where no accurate estimation can be made, this\n object should contain the nominal bandwidth. If the\n bandwidth of the interface is greater than the maximum value\n reportable by this object then this object should report its\n maximum value (4,294,967,295) and ifHighSpeed must be used\n to report the interace's speed. For a sub-layer which has\n no concept of bandwidth, this object should be zero.", "minimum": 0, "maximum": 4294967295 }, "ifPhysAddress": { "type": "string", "description": "The interface's address at its protocol sub-layer. For\n example, for an 802.x interface, this object normally\n contains a MAC address. The interface's media-specific MIB\n must define the bit and byte ordering and the format of the\n value of this object. For interfaces which do not have such\n an address (e.g., a serial line), this object should contain\n an octet string of zero length.", "x-yang-type": "yang:phys-address" }, "ifAdminStatus": { "type": "string", "description": "The desired state of the interface. The testing(3) state\n indicates that no operational packets can be passed. When a\n managed system initializes, all interfaces start with\n ifAdminStatus in the down(2) state. As a result of either\n explicit management action or per configuration information\n retained by the managed system, ifAdminStatus is then\n changed to either the up(1) or testing(3) states (or remains\n in the down(2) state)." }, "ifOperStatus": { "type": "string", "description": "The current operational state of the interface. The\n testing(3) state indicates that no operational packets can\n be passed. If ifAdminStatus is down(2) then ifOperStatus\n should be down(2). If ifAdminStatus is changed to up(1)\n then ifOperStatus should change to up(1) if the interface is\n ready to transmit and receive network traffic; it should\n change to dormant(5) if the interface is waiting for\n external actions (such as a serial line waiting for an\n incoming connection); it should remain in the down(2) state\n if and only if there is a fault that prevents it from going\n to the up(1) state; it should remain in the notPresent(6)\n state if the interface has missing (typically, hardware)\n components." }, "ifLastChange": { "type": "string", "description": "The value of sysUpTime at the time the interface entered\n its current operational state. If the current state was\n entered prior to the last re-initialization of the local\n network management subsystem, then this object contains a\n zero value.", "x-yang-type": "yang:timeticks" }, "ifInOctets": { "type": "integer", "description": "The total number of octets received on the interface,\n including framing characters.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifInUcastPkts": { "type": "integer", "description": "The number of packets, delivered by this sub-layer to a\n higher (sub-)layer, which were not addressed to a multicast\n or broadcast address at this sub-layer.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifInNUcastPkts": { "type": "integer", "description": "The number of packets, delivered by this sub-layer to a\n higher (sub-)layer, which were addressed to a multicast or\n broadcast address at this sub-layer.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.\n \n This object is deprecated in favour of ifInMulticastPkts and\n ifInBroadcastPkts.", "minimum": 0, "maximum": 4294967295 }, "ifInDiscards": { "type": "integer", "description": "The number of inbound packets which were chosen to be\n discarded even though no errors had been detected to prevent\n their being deliverable to a higher-layer protocol. One\n possible reason for discarding such a packet could be to\n free up buffer space.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifInErrors": { "type": "integer", "description": "For packet-oriented interfaces, the number of inbound\n packets that contained errors preventing them from being\n deliverable to a higher-layer protocol. For character-\n oriented or fixed-length interfaces, the number of inbound\n transmission units that contained errors preventing them\n from being deliverable to a higher-layer protocol.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifInUnknownProtos": { "type": "integer", "description": "For packet-oriented interfaces, the number of packets\n received via the interface which were discarded because of\n an unknown or unsupported protocol. For character-oriented\n or fixed-length interfaces that support protocol\n multiplexing the number of transmission units received via\n the interface which were discarded because of an unknown or\n unsupported protocol. For any interface that does not\n support protocol multiplexing, this counter will always be\n 0.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifOutOctets": { "type": "integer", "description": "The total number of octets transmitted out of the\n interface, including framing characters.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifOutUcastPkts": { "type": "integer", "description": "The total number of packets that higher-level protocols\n requested be transmitted, and which were not addressed to a\n multicast or broadcast address at this sub-layer, including\n those that were discarded or not sent.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifOutNUcastPkts": { "type": "integer", "description": "The total number of packets that higher-level protocols\n requested be transmitted, and which were addressed to a\n multicast or broadcast address at this sub-layer, including\n those that were discarded or not sent.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.\n \n This object is deprecated in favour of ifOutMulticastPkts\n and ifOutBroadcastPkts.", "minimum": 0, "maximum": 4294967295 }, "ifOutDiscards": { "type": "integer", "description": "The number of outbound packets which were chosen to be\n discarded even though no errors had been detected to prevent\n their being transmitted. One possible reason for discarding\n such a packet could be to free up buffer space.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifOutErrors": { "type": "integer", "description": "For packet-oriented interfaces, the number of outbound\n packets that could not be transmitted because of errors.\n For character-oriented or fixed-length interfaces, the\n number of outbound transmission units that could not be\n transmitted because of errors.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifOutQLen": { "type": "integer", "description": "The length of the output packet queue (in packets).", "minimum": 0, "maximum": 4294967295 }, "ifSpecific": { "type": "string", "description": "A reference to MIB definitions specific to the particular\n media being used to realize the interface. It is\n recommended that this value point to an instance of a MIB\n object in the media-specific MIB, i.e., that this object\n have the semantics associated with the InstancePointer\n textual convention defined in RFC 2579. In fact, it is\n recommended that the media-specific MIB specify what value\n ifSpecific should/can take for values of ifType. If no MIB\n definitions specific to the particular media are available,\n the value should be set to the OBJECT IDENTIFIER { 0 0 }.", "x-yang-type": "yang:object-identifier-128" } } }, "example": { "IF-MIB:ifEntry": { "ifIndex": "example-string", "ifDescr": "GigabitEthernet1/0/1", "ifType": "ethernetCsmacd(6)", "ifMtu": 1500, "ifSpeed": 1000000000, "ifPhysAddress": "00:11:22:33:44:55", "ifAdminStatus": "up(1)", "ifOperStatus": "up(1)", "ifLastChange": "example-string", "ifInOctets": 1234567890, "ifInUcastPkts": 0, "ifInNUcastPkts": 0, "ifInDiscards": 0, "ifInErrors": 0, "ifInUnknownProtos": 0, "ifOutOctets": 1234567890, "ifOutUcastPkts": 0, "ifOutNUcastPkts": 0, "ifOutDiscards": 0, "ifOutErrors": 0, "ifOutQLen": 0, "ifSpecific": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ifEntry-2" }, "x-yang-path": "/ifTable/ifEntry={ifIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex" ] }, "/data/IF-MIB:ifStackTable": { "get": { "summary": "Get ifStackTable data", "description": "Retrieve ifStackTable operational data from MIB", "tags": [ "IF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "ifStackTable", "properties": { "ifStackEntry": { "type": "array", "description": "Information on a particular relationship between two sub-\n layers, specifying that one sub-layer runs on 'top' of the\n other sub-layer. Each sub-layer corresponds to a conceptual\n row in the ifTable.", "items": { "type": "object", "properties": { "ifStackHigherLayer": { "type": "string", "description": "The value of ifIndex corresponding to the higher sub-layer\n of the relationship, i.e., the sub-layer which runs on 'top'\n of the sub-layer identified by the corresponding instance of\n ifStackLowerLayer. If there is no higher sub-layer (below\n the internetwork layer), then this object has the value 0.", "x-yang-type": "IF-MIB:InterfaceIndexOrZero" }, "ifStackLowerLayer": { "type": "string", "description": "The value of ifIndex corresponding to the lower sub-layer\n of the relationship, i.e., the sub-layer which runs 'below'\n the sub-layer identified by the corresponding instance of\n ifStackHigherLayer. If there is no lower sub-layer, then\n this object has the value 0.", "x-yang-type": "IF-MIB:InterfaceIndexOrZero" }, "ifStackStatus": { "type": "string", "description": "The status of the relationship between two sub-layers.\n \n Changing the value of this object from 'active' to\n 'notInService' or 'destroy' will likely have consequences up\n and down the interface stack. Thus, write access to this\n object is likely to be inappropriate for some types of\n interfaces, and many implementations will choose not to\n support write-access for any type of interface.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "IF-MIB:ifStackTable": { "ifStackEntry": [ { "ifStackHigherLayer": "example-string", "ifStackLowerLayer": "example-string", "ifStackStatus": "up(1)" }, { "ifStackHigherLayer": "example-string", "ifStackLowerLayer": "example-string", "ifStackStatus": "up(1)" }, { "ifStackHigherLayer": "example-string", "ifStackLowerLayer": "example-string", "ifStackStatus": "up(1)" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ifStackTable", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/ifStackTable", "x-restconf-kind": "container" }, "/data/IF-MIB:ifStackTable/ifStackEntry": { "get": { "summary": "Get ifStackEntry list", "description": "Retrieve list of ifStackEntry entries from MIB", "tags": [ "IF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information on a particular relationship between two sub-\n layers, specifying that one sub-layer runs on 'top' of the\n other sub-layer. Each sub-layer corresponds to a conceptual\n row in the ifTable.", "items": { "type": "object", "properties": { "ifStackHigherLayer": { "type": "string", "description": "The value of ifIndex corresponding to the higher sub-layer\n of the relationship, i.e., the sub-layer which runs on 'top'\n of the sub-layer identified by the corresponding instance of\n ifStackLowerLayer. If there is no higher sub-layer (below\n the internetwork layer), then this object has the value 0.", "x-yang-type": "IF-MIB:InterfaceIndexOrZero" }, "ifStackLowerLayer": { "type": "string", "description": "The value of ifIndex corresponding to the lower sub-layer\n of the relationship, i.e., the sub-layer which runs 'below'\n the sub-layer identified by the corresponding instance of\n ifStackHigherLayer. If there is no lower sub-layer, then\n this object has the value 0.", "x-yang-type": "IF-MIB:InterfaceIndexOrZero" }, "ifStackStatus": { "type": "string", "description": "The status of the relationship between two sub-layers.\n \n Changing the value of this object from 'active' to\n 'notInService' or 'destroy' will likely have consequences up\n and down the interface stack. Thus, write access to this\n object is likely to be inappropriate for some types of\n interfaces, and many implementations will choose not to\n support write-access for any type of interface.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "IF-MIB:ifStackEntry": [ { "ifStackHigherLayer": "example-string", "ifStackLowerLayer": "example-string", "ifStackStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ifStackEntry", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/ifStackTable/ifStackEntry", "x-restconf-kind": "container" }, "/data/IF-MIB:ifRcvAddressTable": { "get": { "summary": "Get ifRcvAddressTable data", "description": "Retrieve ifRcvAddressTable operational data from MIB", "tags": [ "IF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "ifRcvAddressTable", "properties": { "ifRcvAddressEntry": { "type": "array", "description": "A list of objects identifying an address for which the\n system will accept packets/frames on the particular\n interface identified by the index value ifIndex.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "ifRcvAddressAddress": { "type": "string", "description": "An address for which the system will accept packets/frames\n on this entry's interface.", "x-yang-type": "yang:phys-address" }, "ifRcvAddressStatus": { "type": "string", "description": "This object is used to create and delete rows in the\n ifRcvAddressTable.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ifRcvAddressType": { "type": "string", "description": "This object has the value nonVolatile(3) for those entries\n in the table which are valid and will not be deleted by the\n next restart of the managed system. Entries having the\n value volatile(2) are valid and exist, but have not been\n saved, so that will not exist after the next restart of the\n managed system. Entries having the value other(1) are valid\n and exist but are not classified as to whether they will\n continue to exist after the next restart." } } } } } }, "example": { "IF-MIB:ifRcvAddressTable": { "ifRcvAddressEntry": [ { "ifIndex": "1", "ifRcvAddressAddress": "192.168.1.1", "ifRcvAddressStatus": "192.168.1.1", "ifRcvAddressType": "192.168.1.1" }, { "ifIndex": "2", "ifRcvAddressAddress": "192.168.1.1", "ifRcvAddressStatus": "192.168.1.1", "ifRcvAddressType": "192.168.1.1" }, { "ifIndex": "3", "ifRcvAddressAddress": "192.168.1.1", "ifRcvAddressStatus": "192.168.1.1", "ifRcvAddressType": "192.168.1.1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ifRcvAddressTable", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/ifRcvAddressTable", "x-restconf-kind": "container" }, "/data/IF-MIB:ifRcvAddressTable/ifRcvAddressEntry": { "get": { "summary": "Get ifRcvAddressEntry list", "description": "Retrieve list of ifRcvAddressEntry entries from MIB", "tags": [ "IF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A list of objects identifying an address for which the\n system will accept packets/frames on the particular\n interface identified by the index value ifIndex.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "ifRcvAddressAddress": { "type": "string", "description": "An address for which the system will accept packets/frames\n on this entry's interface.", "x-yang-type": "yang:phys-address" }, "ifRcvAddressStatus": { "type": "string", "description": "This object is used to create and delete rows in the\n ifRcvAddressTable.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ifRcvAddressType": { "type": "string", "description": "This object has the value nonVolatile(3) for those entries\n in the table which are valid and will not be deleted by the\n next restart of the managed system. Entries having the\n value volatile(2) are valid and exist, but have not been\n saved, so that will not exist after the next restart of the\n managed system. Entries having the value other(1) are valid\n and exist but are not classified as to whether they will\n continue to exist after the next restart." } } } }, "example": { "IF-MIB:ifRcvAddressEntry": [ { "ifIndex": "example-string", "ifRcvAddressAddress": "192.168.1.1", "ifRcvAddressStatus": "192.168.1.1", "ifRcvAddressType": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ifRcvAddressEntry", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/ifRcvAddressTable/ifRcvAddressEntry", "x-restconf-kind": "container" }, "/data/IF-MIB:ifEntry": { "get": { "summary": "Get ifEntry list", "description": "Retrieve list of ifEntry entries from MIB", "tags": [ "IF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry containing management information applicable to a\n particular interface.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "A unique value, greater than zero, for each interface. It\n is recommended that values are assigned contiguously\n starting from 1. The value for each interface sub-layer\n must remain constant at least from one re-initialization of\n the entity's network management system to the next re-\n initialization.", "x-yang-type": "IF-MIB:InterfaceIndex" }, "ifDescr": { "type": "string", "description": "A textual string containing information about the\n interface. This string should include the name of the\n manufacturer, the product name and the version of the\n interface hardware/software.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ifType": { "type": "string", "description": "The type of interface. Additional values for ifType are\n assigned by the Internet Assigned Numbers Authority (IANA),\n through updating the syntax of the IANAifType textual\n convention.", "x-yang-type": "ianaiftype-mib:IANAifType" }, "ifMtu": { "type": "integer", "description": "The size of the largest packet which can be sent/received\n on the interface, specified in octets. For interfaces that\n are used for transmitting network datagrams, this is the\n size of the largest network datagram that can be sent on the\n interface.", "minimum": -2147483648, "maximum": 2147483647 }, "ifSpeed": { "type": "integer", "description": "An estimate of the interface's current bandwidth in bits\n per second. For interfaces which do not vary in bandwidth\n or for those where no accurate estimation can be made, this\n object should contain the nominal bandwidth. If the\n bandwidth of the interface is greater than the maximum value\n reportable by this object then this object should report its\n maximum value (4,294,967,295) and ifHighSpeed must be used\n to report the interace's speed. For a sub-layer which has\n no concept of bandwidth, this object should be zero.", "minimum": 0, "maximum": 4294967295 }, "ifPhysAddress": { "type": "string", "description": "The interface's address at its protocol sub-layer. For\n example, for an 802.x interface, this object normally\n contains a MAC address. The interface's media-specific MIB\n must define the bit and byte ordering and the format of the\n value of this object. For interfaces which do not have such\n an address (e.g., a serial line), this object should contain\n an octet string of zero length.", "x-yang-type": "yang:phys-address" }, "ifAdminStatus": { "type": "string", "description": "The desired state of the interface. The testing(3) state\n indicates that no operational packets can be passed. When a\n managed system initializes, all interfaces start with\n ifAdminStatus in the down(2) state. As a result of either\n explicit management action or per configuration information\n retained by the managed system, ifAdminStatus is then\n changed to either the up(1) or testing(3) states (or remains\n in the down(2) state)." }, "ifOperStatus": { "type": "string", "description": "The current operational state of the interface. The\n testing(3) state indicates that no operational packets can\n be passed. If ifAdminStatus is down(2) then ifOperStatus\n should be down(2). If ifAdminStatus is changed to up(1)\n then ifOperStatus should change to up(1) if the interface is\n ready to transmit and receive network traffic; it should\n change to dormant(5) if the interface is waiting for\n external actions (such as a serial line waiting for an\n incoming connection); it should remain in the down(2) state\n if and only if there is a fault that prevents it from going\n to the up(1) state; it should remain in the notPresent(6)\n state if the interface has missing (typically, hardware)\n components." }, "ifLastChange": { "type": "string", "description": "The value of sysUpTime at the time the interface entered\n its current operational state. If the current state was\n entered prior to the last re-initialization of the local\n network management subsystem, then this object contains a\n zero value.", "x-yang-type": "yang:timeticks" }, "ifInOctets": { "type": "integer", "description": "The total number of octets received on the interface,\n including framing characters.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifInUcastPkts": { "type": "integer", "description": "The number of packets, delivered by this sub-layer to a\n higher (sub-)layer, which were not addressed to a multicast\n or broadcast address at this sub-layer.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifInNUcastPkts": { "type": "integer", "description": "The number of packets, delivered by this sub-layer to a\n higher (sub-)layer, which were addressed to a multicast or\n broadcast address at this sub-layer.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.\n \n This object is deprecated in favour of ifInMulticastPkts and\n ifInBroadcastPkts.", "minimum": 0, "maximum": 4294967295 }, "ifInDiscards": { "type": "integer", "description": "The number of inbound packets which were chosen to be\n discarded even though no errors had been detected to prevent\n their being deliverable to a higher-layer protocol. One\n possible reason for discarding such a packet could be to\n free up buffer space.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifInErrors": { "type": "integer", "description": "For packet-oriented interfaces, the number of inbound\n packets that contained errors preventing them from being\n deliverable to a higher-layer protocol. For character-\n oriented or fixed-length interfaces, the number of inbound\n transmission units that contained errors preventing them\n from being deliverable to a higher-layer protocol.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifInUnknownProtos": { "type": "integer", "description": "For packet-oriented interfaces, the number of packets\n received via the interface which were discarded because of\n an unknown or unsupported protocol. For character-oriented\n or fixed-length interfaces that support protocol\n multiplexing the number of transmission units received via\n the interface which were discarded because of an unknown or\n unsupported protocol. For any interface that does not\n support protocol multiplexing, this counter will always be\n 0.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifOutOctets": { "type": "integer", "description": "The total number of octets transmitted out of the\n interface, including framing characters.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifOutUcastPkts": { "type": "integer", "description": "The total number of packets that higher-level protocols\n requested be transmitted, and which were not addressed to a\n multicast or broadcast address at this sub-layer, including\n those that were discarded or not sent.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifOutNUcastPkts": { "type": "integer", "description": "The total number of packets that higher-level protocols\n requested be transmitted, and which were addressed to a\n multicast or broadcast address at this sub-layer, including\n those that were discarded or not sent.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.\n \n This object is deprecated in favour of ifOutMulticastPkts\n and ifOutBroadcastPkts.", "minimum": 0, "maximum": 4294967295 }, "ifOutDiscards": { "type": "integer", "description": "The number of outbound packets which were chosen to be\n discarded even though no errors had been detected to prevent\n their being transmitted. One possible reason for discarding\n such a packet could be to free up buffer space.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifOutErrors": { "type": "integer", "description": "For packet-oriented interfaces, the number of outbound\n packets that could not be transmitted because of errors.\n For character-oriented or fixed-length interfaces, the\n number of outbound transmission units that could not be\n transmitted because of errors.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifOutQLen": { "type": "integer", "description": "The length of the output packet queue (in packets).", "minimum": 0, "maximum": 4294967295 }, "ifSpecific": { "type": "string", "description": "A reference to MIB definitions specific to the particular\n media being used to realize the interface. It is\n recommended that this value point to an instance of a MIB\n object in the media-specific MIB, i.e., that this object\n have the semantics associated with the InstancePointer\n textual convention defined in RFC 2579. In fact, it is\n recommended that the media-specific MIB specify what value\n ifSpecific should/can take for values of ifType. If no MIB\n definitions specific to the particular media are available,\n the value should be set to the OBJECT IDENTIFIER { 0 0 }.", "x-yang-type": "yang:object-identifier-128" } } } }, "example": { "IF-MIB:ifEntry": [ { "ifIndex": "example-string", "ifDescr": "GigabitEthernet1/0/1", "ifType": "ethernetCsmacd(6)", "ifMtu": 1500, "ifSpeed": 1000000000, "ifPhysAddress": "00:11:22:33:44:55", "ifAdminStatus": "up(1)", "ifOperStatus": "up(1)", "ifLastChange": "example-string", "ifInOctets": 1234567890, "ifInUcastPkts": 0, "ifInNUcastPkts": 0, "ifInDiscards": 0, "ifInErrors": 0, "ifInUnknownProtos": 0, "ifOutOctets": 1234567890, "ifOutUcastPkts": 0, "ifOutNUcastPkts": 0, "ifOutDiscards": 0, "ifOutErrors": 0, "ifOutQLen": 0, "ifSpecific": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ifEntry-3", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/ifEntry", "x-restconf-kind": "container" }, "/data/IF-MIB:ifEntry={ifIndex}": { "get": { "summary": "Get ifEntry entry", "description": "Retrieve specific ifEntry entry by key from MIB", "tags": [ "IF-MIB" ], "parameters": [ { "name": "ifIndex", "in": "path", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "A unique value, greater than zero, for each interface. It\n is recommended that values are assigned contiguously\n starting from 1. The value for each interface sub-layer\n must remain constant at least from one re-initialization of\n the entity's network management system to the next re-\n initialization.", "x-yang-type": "IF-MIB:InterfaceIndex" }, "ifDescr": { "type": "string", "description": "A textual string containing information about the\n interface. This string should include the name of the\n manufacturer, the product name and the version of the\n interface hardware/software.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ifType": { "type": "string", "description": "The type of interface. Additional values for ifType are\n assigned by the Internet Assigned Numbers Authority (IANA),\n through updating the syntax of the IANAifType textual\n convention.", "x-yang-type": "ianaiftype-mib:IANAifType" }, "ifMtu": { "type": "integer", "description": "The size of the largest packet which can be sent/received\n on the interface, specified in octets. For interfaces that\n are used for transmitting network datagrams, this is the\n size of the largest network datagram that can be sent on the\n interface.", "minimum": -2147483648, "maximum": 2147483647 }, "ifSpeed": { "type": "integer", "description": "An estimate of the interface's current bandwidth in bits\n per second. For interfaces which do not vary in bandwidth\n or for those where no accurate estimation can be made, this\n object should contain the nominal bandwidth. If the\n bandwidth of the interface is greater than the maximum value\n reportable by this object then this object should report its\n maximum value (4,294,967,295) and ifHighSpeed must be used\n to report the interace's speed. For a sub-layer which has\n no concept of bandwidth, this object should be zero.", "minimum": 0, "maximum": 4294967295 }, "ifPhysAddress": { "type": "string", "description": "The interface's address at its protocol sub-layer. For\n example, for an 802.x interface, this object normally\n contains a MAC address. The interface's media-specific MIB\n must define the bit and byte ordering and the format of the\n value of this object. For interfaces which do not have such\n an address (e.g., a serial line), this object should contain\n an octet string of zero length.", "x-yang-type": "yang:phys-address" }, "ifAdminStatus": { "type": "string", "description": "The desired state of the interface. The testing(3) state\n indicates that no operational packets can be passed. When a\n managed system initializes, all interfaces start with\n ifAdminStatus in the down(2) state. As a result of either\n explicit management action or per configuration information\n retained by the managed system, ifAdminStatus is then\n changed to either the up(1) or testing(3) states (or remains\n in the down(2) state)." }, "ifOperStatus": { "type": "string", "description": "The current operational state of the interface. The\n testing(3) state indicates that no operational packets can\n be passed. If ifAdminStatus is down(2) then ifOperStatus\n should be down(2). If ifAdminStatus is changed to up(1)\n then ifOperStatus should change to up(1) if the interface is\n ready to transmit and receive network traffic; it should\n change to dormant(5) if the interface is waiting for\n external actions (such as a serial line waiting for an\n incoming connection); it should remain in the down(2) state\n if and only if there is a fault that prevents it from going\n to the up(1) state; it should remain in the notPresent(6)\n state if the interface has missing (typically, hardware)\n components." }, "ifLastChange": { "type": "string", "description": "The value of sysUpTime at the time the interface entered\n its current operational state. If the current state was\n entered prior to the last re-initialization of the local\n network management subsystem, then this object contains a\n zero value.", "x-yang-type": "yang:timeticks" }, "ifInOctets": { "type": "integer", "description": "The total number of octets received on the interface,\n including framing characters.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifInUcastPkts": { "type": "integer", "description": "The number of packets, delivered by this sub-layer to a\n higher (sub-)layer, which were not addressed to a multicast\n or broadcast address at this sub-layer.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifInNUcastPkts": { "type": "integer", "description": "The number of packets, delivered by this sub-layer to a\n higher (sub-)layer, which were addressed to a multicast or\n broadcast address at this sub-layer.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.\n \n This object is deprecated in favour of ifInMulticastPkts and\n ifInBroadcastPkts.", "minimum": 0, "maximum": 4294967295 }, "ifInDiscards": { "type": "integer", "description": "The number of inbound packets which were chosen to be\n discarded even though no errors had been detected to prevent\n their being deliverable to a higher-layer protocol. One\n possible reason for discarding such a packet could be to\n free up buffer space.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifInErrors": { "type": "integer", "description": "For packet-oriented interfaces, the number of inbound\n packets that contained errors preventing them from being\n deliverable to a higher-layer protocol. For character-\n oriented or fixed-length interfaces, the number of inbound\n transmission units that contained errors preventing them\n from being deliverable to a higher-layer protocol.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifInUnknownProtos": { "type": "integer", "description": "For packet-oriented interfaces, the number of packets\n received via the interface which were discarded because of\n an unknown or unsupported protocol. For character-oriented\n or fixed-length interfaces that support protocol\n multiplexing the number of transmission units received via\n the interface which were discarded because of an unknown or\n unsupported protocol. For any interface that does not\n support protocol multiplexing, this counter will always be\n 0.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifOutOctets": { "type": "integer", "description": "The total number of octets transmitted out of the\n interface, including framing characters.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifOutUcastPkts": { "type": "integer", "description": "The total number of packets that higher-level protocols\n requested be transmitted, and which were not addressed to a\n multicast or broadcast address at this sub-layer, including\n those that were discarded or not sent.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifOutNUcastPkts": { "type": "integer", "description": "The total number of packets that higher-level protocols\n requested be transmitted, and which were addressed to a\n multicast or broadcast address at this sub-layer, including\n those that were discarded or not sent.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.\n \n This object is deprecated in favour of ifOutMulticastPkts\n and ifOutBroadcastPkts.", "minimum": 0, "maximum": 4294967295 }, "ifOutDiscards": { "type": "integer", "description": "The number of outbound packets which were chosen to be\n discarded even though no errors had been detected to prevent\n their being transmitted. One possible reason for discarding\n such a packet could be to free up buffer space.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifOutErrors": { "type": "integer", "description": "For packet-oriented interfaces, the number of outbound\n packets that could not be transmitted because of errors.\n For character-oriented or fixed-length interfaces, the\n number of outbound transmission units that could not be\n transmitted because of errors.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ifOutQLen": { "type": "integer", "description": "The length of the output packet queue (in packets).", "minimum": 0, "maximum": 4294967295 }, "ifSpecific": { "type": "string", "description": "A reference to MIB definitions specific to the particular\n media being used to realize the interface. It is\n recommended that this value point to an instance of a MIB\n object in the media-specific MIB, i.e., that this object\n have the semantics associated with the InstancePointer\n textual convention defined in RFC 2579. In fact, it is\n recommended that the media-specific MIB specify what value\n ifSpecific should/can take for values of ifType. If no MIB\n definitions specific to the particular media are available,\n the value should be set to the OBJECT IDENTIFIER { 0 0 }.", "x-yang-type": "yang:object-identifier-128" } } }, "example": { "IF-MIB:ifEntry": { "ifIndex": "example-string", "ifDescr": "GigabitEthernet1/0/1", "ifType": "ethernetCsmacd(6)", "ifMtu": 1500, "ifSpeed": 1000000000, "ifPhysAddress": "00:11:22:33:44:55", "ifAdminStatus": "up(1)", "ifOperStatus": "up(1)", "ifLastChange": "example-string", "ifInOctets": 1234567890, "ifInUcastPkts": 0, "ifInNUcastPkts": 0, "ifInDiscards": 0, "ifInErrors": 0, "ifInUnknownProtos": 0, "ifOutOctets": 1234567890, "ifOutUcastPkts": 0, "ifOutNUcastPkts": 0, "ifOutDiscards": 0, "ifOutErrors": 0, "ifOutQLen": 0, "ifSpecific": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ifEntry-4" }, "x-yang-path": "/ifEntry={ifIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex" ] }, "/data/IF-MIB:ifStackEntry": { "get": { "summary": "Get ifStackEntry list", "description": "Retrieve list of ifStackEntry entries from MIB", "tags": [ "IF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information on a particular relationship between two sub-\n layers, specifying that one sub-layer runs on 'top' of the\n other sub-layer. Each sub-layer corresponds to a conceptual\n row in the ifTable.", "items": { "type": "object", "properties": { "ifStackHigherLayer": { "type": "string", "description": "The value of ifIndex corresponding to the higher sub-layer\n of the relationship, i.e., the sub-layer which runs on 'top'\n of the sub-layer identified by the corresponding instance of\n ifStackLowerLayer. If there is no higher sub-layer (below\n the internetwork layer), then this object has the value 0.", "x-yang-type": "IF-MIB:InterfaceIndexOrZero" }, "ifStackLowerLayer": { "type": "string", "description": "The value of ifIndex corresponding to the lower sub-layer\n of the relationship, i.e., the sub-layer which runs 'below'\n the sub-layer identified by the corresponding instance of\n ifStackHigherLayer. If there is no lower sub-layer, then\n this object has the value 0.", "x-yang-type": "IF-MIB:InterfaceIndexOrZero" }, "ifStackStatus": { "type": "string", "description": "The status of the relationship between two sub-layers.\n \n Changing the value of this object from 'active' to\n 'notInService' or 'destroy' will likely have consequences up\n and down the interface stack. Thus, write access to this\n object is likely to be inappropriate for some types of\n interfaces, and many implementations will choose not to\n support write-access for any type of interface.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "IF-MIB:ifStackEntry": [ { "ifStackHigherLayer": "example-string", "ifStackLowerLayer": "example-string", "ifStackStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ifStackEntry-3", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/ifStackEntry", "x-restconf-kind": "container" }, "/data/IF-MIB:ifRcvAddressEntry": { "get": { "summary": "Get ifRcvAddressEntry list", "description": "Retrieve list of ifRcvAddressEntry entries from MIB", "tags": [ "IF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A list of objects identifying an address for which the\n system will accept packets/frames on the particular\n interface identified by the index value ifIndex.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "ifRcvAddressAddress": { "type": "string", "description": "An address for which the system will accept packets/frames\n on this entry's interface.", "x-yang-type": "yang:phys-address" }, "ifRcvAddressStatus": { "type": "string", "description": "This object is used to create and delete rows in the\n ifRcvAddressTable.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ifRcvAddressType": { "type": "string", "description": "This object has the value nonVolatile(3) for those entries\n in the table which are valid and will not be deleted by the\n next restart of the managed system. Entries having the\n value volatile(2) are valid and exist, but have not been\n saved, so that will not exist after the next restart of the\n managed system. Entries having the value other(1) are valid\n and exist but are not classified as to whether they will\n continue to exist after the next restart." } } } }, "example": { "IF-MIB:ifRcvAddressEntry": [ { "ifIndex": "example-string", "ifRcvAddressAddress": "192.168.1.1", "ifRcvAddressStatus": "192.168.1.1", "ifRcvAddressType": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ifRcvAddressEntry-3", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/ifRcvAddressEntry", "x-restconf-kind": "container" }, "/data/IF-MIB:ifStackTable/ifStackEntry={ifStackHigherLayer},{ifStackLowerLayer}": { "get": { "summary": "Get ifStackEntry entry", "description": "Retrieve specific ifStackEntry entry by key from MIB", "tags": [ "IF-MIB" ], "parameters": [ { "name": "ifStackHigherLayer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ifStackLowerLayer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "ifStackHigherLayer": { "type": "string", "description": "The value of ifIndex corresponding to the higher sub-layer\n of the relationship, i.e., the sub-layer which runs on 'top'\n of the sub-layer identified by the corresponding instance of\n ifStackLowerLayer. If there is no higher sub-layer (below\n the internetwork layer), then this object has the value 0.", "x-yang-type": "IF-MIB:InterfaceIndexOrZero" }, "ifStackLowerLayer": { "type": "string", "description": "The value of ifIndex corresponding to the lower sub-layer\n of the relationship, i.e., the sub-layer which runs 'below'\n the sub-layer identified by the corresponding instance of\n ifStackHigherLayer. If there is no lower sub-layer, then\n this object has the value 0.", "x-yang-type": "IF-MIB:InterfaceIndexOrZero" }, "ifStackStatus": { "type": "string", "description": "The status of the relationship between two sub-layers.\n \n Changing the value of this object from 'active' to\n 'notInService' or 'destroy' will likely have consequences up\n and down the interface stack. Thus, write access to this\n object is likely to be inappropriate for some types of\n interfaces, and many implementations will choose not to\n support write-access for any type of interface.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "IF-MIB:ifStackEntry": { "ifStackHigherLayer": "example-string", "ifStackLowerLayer": "example-string", "ifStackStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ifStackEntry-2" }, "x-yang-path": "/ifStackTable/ifStackEntry={ifStackHigherLayer ifStackLowerLayer}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifStackHigherLayer ifStackLowerLayer" ] }, "/data/IF-MIB:ifRcvAddressTable/ifRcvAddressEntry={ifIndex},{ifRcvAddressAddress}": { "get": { "summary": "Get ifRcvAddressEntry entry", "description": "Retrieve specific ifRcvAddressEntry entry by key from MIB", "tags": [ "IF-MIB" ], "parameters": [ { "name": "ifIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ifRcvAddressAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "ifRcvAddressAddress": { "type": "string", "description": "An address for which the system will accept packets/frames\n on this entry's interface.", "x-yang-type": "yang:phys-address" }, "ifRcvAddressStatus": { "type": "string", "description": "This object is used to create and delete rows in the\n ifRcvAddressTable.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ifRcvAddressType": { "type": "string", "description": "This object has the value nonVolatile(3) for those entries\n in the table which are valid and will not be deleted by the\n next restart of the managed system. Entries having the\n value volatile(2) are valid and exist, but have not been\n saved, so that will not exist after the next restart of the\n managed system. Entries having the value other(1) are valid\n and exist but are not classified as to whether they will\n continue to exist after the next restart." } } }, "example": { "IF-MIB:ifRcvAddressEntry": { "ifIndex": "example-string", "ifRcvAddressAddress": "192.168.1.1", "ifRcvAddressStatus": "192.168.1.1", "ifRcvAddressType": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ifRcvAddressEntry-2" }, "x-yang-path": "/ifRcvAddressTable/ifRcvAddressEntry={ifIndex ifRcvAddressAddress}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex ifRcvAddressAddress" ] }, "/data/IF-MIB:ifStackEntry={ifStackHigherLayer},{ifStackLowerLayer}": { "get": { "summary": "Get ifStackEntry entry", "description": "Retrieve specific ifStackEntry entry by key from MIB", "tags": [ "IF-MIB" ], "parameters": [ { "name": "ifStackHigherLayer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ifStackLowerLayer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "ifStackHigherLayer": { "type": "string", "description": "The value of ifIndex corresponding to the higher sub-layer\n of the relationship, i.e., the sub-layer which runs on 'top'\n of the sub-layer identified by the corresponding instance of\n ifStackLowerLayer. If there is no higher sub-layer (below\n the internetwork layer), then this object has the value 0.", "x-yang-type": "IF-MIB:InterfaceIndexOrZero" }, "ifStackLowerLayer": { "type": "string", "description": "The value of ifIndex corresponding to the lower sub-layer\n of the relationship, i.e., the sub-layer which runs 'below'\n the sub-layer identified by the corresponding instance of\n ifStackHigherLayer. If there is no lower sub-layer, then\n this object has the value 0.", "x-yang-type": "IF-MIB:InterfaceIndexOrZero" }, "ifStackStatus": { "type": "string", "description": "The status of the relationship between two sub-layers.\n \n Changing the value of this object from 'active' to\n 'notInService' or 'destroy' will likely have consequences up\n and down the interface stack. Thus, write access to this\n object is likely to be inappropriate for some types of\n interfaces, and many implementations will choose not to\n support write-access for any type of interface.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "IF-MIB:ifStackEntry": { "ifStackHigherLayer": "example-string", "ifStackLowerLayer": "example-string", "ifStackStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ifStackEntry-4" }, "x-yang-path": "/ifStackEntry={ifStackHigherLayer ifStackLowerLayer}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifStackHigherLayer ifStackLowerLayer" ] }, "/data/IF-MIB:ifRcvAddressEntry={ifIndex},{ifRcvAddressAddress}": { "get": { "summary": "Get ifRcvAddressEntry entry", "description": "Retrieve specific ifRcvAddressEntry entry by key from MIB", "tags": [ "IF-MIB" ], "parameters": [ { "name": "ifIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ifRcvAddressAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "ifRcvAddressAddress": { "type": "string", "description": "An address for which the system will accept packets/frames\n on this entry's interface.", "x-yang-type": "yang:phys-address" }, "ifRcvAddressStatus": { "type": "string", "description": "This object is used to create and delete rows in the\n ifRcvAddressTable.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ifRcvAddressType": { "type": "string", "description": "This object has the value nonVolatile(3) for those entries\n in the table which are valid and will not be deleted by the\n next restart of the managed system. Entries having the\n value volatile(2) are valid and exist, but have not been\n saved, so that will not exist after the next restart of the\n managed system. Entries having the value other(1) are valid\n and exist but are not classified as to whether they will\n continue to exist after the next restart." } } }, "example": { "IF-MIB:ifRcvAddressEntry": { "ifIndex": "example-string", "ifRcvAddressAddress": "192.168.1.1", "ifRcvAddressStatus": "192.168.1.1", "ifRcvAddressType": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ifRcvAddressEntry-4" }, "x-yang-path": "/ifRcvAddressEntry={ifIndex ifRcvAddressAddress}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex ifRcvAddressAddress" ] } }, "components": { "schemas": { "IF-MIB_IF-MIB": { "type": "object", "description": "The number of network interfaces (regardless of their\n current state) present on this system.", "properties": { "ifEntry": { "type": "array", "description": "An entry containing management information applicable to a\n particular interface.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "A unique value, greater than zero, for each interface. It\n is recommended that values are assigned contiguously\n starting from 1. The value for each interface sub-layer\n must remain constant at least from one re-initialization of\n the entity's network management system to the next re-\n initialization.", "x-yang-type": "IF-MIB:InterfaceIndex", "readOnly": true }, "ifDescr": { "type": "string", "description": "A textual string containing information about the\n interface. This string should include the name of the\n manufacturer, the product name and the version of the\n interface hardware/software.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ifType": { "type": "string", "description": "The type of interface. Additional values for ifType are\n assigned by the Internet Assigned Numbers Authority (IANA),\n through updating the syntax of the IANAifType textual\n convention.", "x-yang-type": "ianaiftype-mib:IANAifType", "readOnly": true }, "ifMtu": { "type": "integer", "description": "The size of the largest packet which can be sent/received\n on the interface, specified in octets. For interfaces that\n are used for transmitting network datagrams, this is the\n size of the largest network datagram that can be sent on the\n interface.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ifSpeed": { "type": "integer", "description": "An estimate of the interface's current bandwidth in bits\n per second. For interfaces which do not vary in bandwidth\n or for those where no accurate estimation can be made, this\n object should contain the nominal bandwidth. If the\n bandwidth of the interface is greater than the maximum value\n reportable by this object then this object should report its\n maximum value (4,294,967,295) and ifHighSpeed must be used\n to report the interace's speed. For a sub-layer which has\n no concept of bandwidth, this object should be zero.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifPhysAddress": { "type": "string", "description": "The interface's address at its protocol sub-layer. For\n example, for an 802.x interface, this object normally\n contains a MAC address. The interface's media-specific MIB\n must define the bit and byte ordering and the format of the\n value of this object. For interfaces which do not have such\n an address (e.g., a serial line), this object should contain\n an octet string of zero length.", "x-yang-type": "yang:phys-address", "readOnly": true }, "ifAdminStatus": { "type": "string", "description": "The desired state of the interface. The testing(3) state\n indicates that no operational packets can be passed. When a\n managed system initializes, all interfaces start with\n ifAdminStatus in the down(2) state. As a result of either\n explicit management action or per configuration information\n retained by the managed system, ifAdminStatus is then\n changed to either the up(1) or testing(3) states (or remains\n in the down(2) state).", "readOnly": true }, "ifOperStatus": { "type": "string", "description": "The current operational state of the interface. The\n testing(3) state indicates that no operational packets can\n be passed. If ifAdminStatus is down(2) then ifOperStatus\n should be down(2). If ifAdminStatus is changed to up(1)\n then ifOperStatus should change to up(1) if the interface is\n ready to transmit and receive network traffic; it should\n change to dormant(5) if the interface is waiting for\n external actions (such as a serial line waiting for an\n incoming connection); it should remain in the down(2) state\n if and only if there is a fault that prevents it from going\n to the up(1) state; it should remain in the notPresent(6)\n state if the interface has missing (typically, hardware)\n components.", "readOnly": true }, "ifLastChange": { "type": "string", "description": "The value of sysUpTime at the time the interface entered\n its current operational state. If the current state was\n entered prior to the last re-initialization of the local\n network management subsystem, then this object contains a\n zero value.", "x-yang-type": "yang:timeticks", "readOnly": true }, "ifInOctets": { "type": "integer", "description": "The total number of octets received on the interface,\n including framing characters.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifInUcastPkts": { "type": "integer", "description": "The number of packets, delivered by this sub-layer to a\n higher (sub-)layer, which were not addressed to a multicast\n or broadcast address at this sub-layer.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifInNUcastPkts": { "type": "integer", "description": "The number of packets, delivered by this sub-layer to a\n higher (sub-)layer, which were addressed to a multicast or\n broadcast address at this sub-layer.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.\n \n This object is deprecated in favour of ifInMulticastPkts and\n ifInBroadcastPkts.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifInDiscards": { "type": "integer", "description": "The number of inbound packets which were chosen to be\n discarded even though no errors had been detected to prevent\n their being deliverable to a higher-layer protocol. One\n possible reason for discarding such a packet could be to\n free up buffer space.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifInErrors": { "type": "integer", "description": "For packet-oriented interfaces, the number of inbound\n packets that contained errors preventing them from being\n deliverable to a higher-layer protocol. For character-\n oriented or fixed-length interfaces, the number of inbound\n transmission units that contained errors preventing them\n from being deliverable to a higher-layer protocol.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifInUnknownProtos": { "type": "integer", "description": "For packet-oriented interfaces, the number of packets\n received via the interface which were discarded because of\n an unknown or unsupported protocol. For character-oriented\n or fixed-length interfaces that support protocol\n multiplexing the number of transmission units received via\n the interface which were discarded because of an unknown or\n unsupported protocol. For any interface that does not\n support protocol multiplexing, this counter will always be\n 0.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifOutOctets": { "type": "integer", "description": "The total number of octets transmitted out of the\n interface, including framing characters.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifOutUcastPkts": { "type": "integer", "description": "The total number of packets that higher-level protocols\n requested be transmitted, and which were not addressed to a\n multicast or broadcast address at this sub-layer, including\n those that were discarded or not sent.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifOutNUcastPkts": { "type": "integer", "description": "The total number of packets that higher-level protocols\n requested be transmitted, and which were addressed to a\n multicast or broadcast address at this sub-layer, including\n those that were discarded or not sent.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.\n \n This object is deprecated in favour of ifOutMulticastPkts\n and ifOutBroadcastPkts.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifOutDiscards": { "type": "integer", "description": "The number of outbound packets which were chosen to be\n discarded even though no errors had been detected to prevent\n their being transmitted. One possible reason for discarding\n such a packet could be to free up buffer space.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifOutErrors": { "type": "integer", "description": "For packet-oriented interfaces, the number of outbound\n packets that could not be transmitted because of errors.\n For character-oriented or fixed-length interfaces, the\n number of outbound transmission units that could not be\n transmitted because of errors.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifOutQLen": { "type": "integer", "description": "The length of the output packet queue (in packets).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifSpecific": { "type": "string", "description": "A reference to MIB definitions specific to the particular\n media being used to realize the interface. It is\n recommended that this value point to an instance of a MIB\n object in the media-specific MIB, i.e., that this object\n have the semantics associated with the InstancePointer\n textual convention defined in RFC 2579. In fact, it is\n recommended that the media-specific MIB specify what value\n ifSpecific should/can take for values of ifType. If no MIB\n definitions specific to the particular media are available,\n the value should be set to the OBJECT IDENTIFIER { 0 0 }.", "x-yang-type": "yang:object-identifier-128", "readOnly": true } } }, "readOnly": true }, "ifStackEntry": { "type": "array", "description": "Information on a particular relationship between two sub-\n layers, specifying that one sub-layer runs on 'top' of the\n other sub-layer. Each sub-layer corresponds to a conceptual\n row in the ifTable.", "items": { "type": "object", "properties": { "ifStackHigherLayer": { "type": "string", "description": "The value of ifIndex corresponding to the higher sub-layer\n of the relationship, i.e., the sub-layer which runs on 'top'\n of the sub-layer identified by the corresponding instance of\n ifStackLowerLayer. If there is no higher sub-layer (below\n the internetwork layer), then this object has the value 0.", "x-yang-type": "IF-MIB:InterfaceIndexOrZero", "readOnly": true }, "ifStackLowerLayer": { "type": "string", "description": "The value of ifIndex corresponding to the lower sub-layer\n of the relationship, i.e., the sub-layer which runs 'below'\n the sub-layer identified by the corresponding instance of\n ifStackHigherLayer. If there is no lower sub-layer, then\n this object has the value 0.", "x-yang-type": "IF-MIB:InterfaceIndexOrZero", "readOnly": true }, "ifStackStatus": { "type": "string", "description": "The status of the relationship between two sub-layers.\n \n Changing the value of this object from 'active' to\n 'notInService' or 'destroy' will likely have consequences up\n and down the interface stack. Thus, write access to this\n object is likely to be inappropriate for some types of\n interfaces, and many implementations will choose not to\n support write-access for any type of interface.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "ifRcvAddressEntry": { "type": "array", "description": "A list of objects identifying an address for which the\n system will accept packets/frames on the particular\n interface identified by the index value ifIndex.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "ifRcvAddressAddress": { "type": "string", "description": "An address for which the system will accept packets/frames\n on this entry's interface.", "x-yang-type": "yang:phys-address", "readOnly": true }, "ifRcvAddressStatus": { "type": "string", "description": "This object is used to create and delete rows in the\n ifRcvAddressTable.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ifRcvAddressType": { "type": "string", "description": "This object has the value nonVolatile(3) for those entries\n in the table which are valid and will not be deleted by the\n next restart of the managed system. Entries having the\n value volatile(2) are valid and exist, but have not been\n saved, so that will not exist after the next restart of the\n managed system. Entries having the value other(1) are valid\n and exist but are not classified as to whether they will\n continue to exist after the next restart.", "readOnly": true } } }, "readOnly": true }, "interfaces": { "type": "object", "description": "The number of network interfaces (regardless of their\n current state) present on this system.", "properties": { "ifNumber": { "type": "integer", "description": "The number of network interfaces (regardless of their\n current state) present on this system.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true } }, "readOnly": true }, "ifMIBObjects": { "type": "object", "description": "The value of sysUpTime at the time of the last creation or\n deletion of an entry in the ifTable. If the number of\n entries has been unchanged since the last re-initialization\n of the local network management subsystem, then this object\n contains a zero value.", "properties": { "ifTableLastChange": { "type": "string", "description": "The value of sysUpTime at the time of the last creation or\n deletion of an entry in the ifTable. If the number of\n entries has been unchanged since the last re-initialization\n of the local network management subsystem, then this object\n contains a zero value.", "x-yang-type": "yang:timeticks", "readOnly": true }, "ifStackLastChange": { "type": "string", "description": "The value of sysUpTime at the time of the last change of\n the (whole) interface stack. A change of the interface\n stack is defined to be any creation, deletion, or change in\n value of any instance of ifStackStatus. If the interface\n stack has been unchanged since the last re-initialization of\n the local network management subsystem, then this object\n contains a zero value.", "x-yang-type": "yang:timeticks", "readOnly": true } }, "readOnly": true }, "ifTable": { "type": "object", "description": "A list of interface entries. The number of entries is\n given by the value of ifNumber.", "properties": { "ifEntry": { "type": "array", "description": "An entry containing management information applicable to a\n particular interface.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "A unique value, greater than zero, for each interface. It\n is recommended that values are assigned contiguously\n starting from 1. The value for each interface sub-layer\n must remain constant at least from one re-initialization of\n the entity's network management system to the next re-\n initialization.", "x-yang-type": "IF-MIB:InterfaceIndex", "readOnly": true }, "ifDescr": { "type": "string", "description": "A textual string containing information about the\n interface. This string should include the name of the\n manufacturer, the product name and the version of the\n interface hardware/software.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ifType": { "type": "string", "description": "The type of interface. Additional values for ifType are\n assigned by the Internet Assigned Numbers Authority (IANA),\n through updating the syntax of the IANAifType textual\n convention.", "x-yang-type": "ianaiftype-mib:IANAifType", "readOnly": true }, "ifMtu": { "type": "integer", "description": "The size of the largest packet which can be sent/received\n on the interface, specified in octets. For interfaces that\n are used for transmitting network datagrams, this is the\n size of the largest network datagram that can be sent on the\n interface.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ifSpeed": { "type": "integer", "description": "An estimate of the interface's current bandwidth in bits\n per second. For interfaces which do not vary in bandwidth\n or for those where no accurate estimation can be made, this\n object should contain the nominal bandwidth. If the\n bandwidth of the interface is greater than the maximum value\n reportable by this object then this object should report its\n maximum value (4,294,967,295) and ifHighSpeed must be used\n to report the interace's speed. For a sub-layer which has\n no concept of bandwidth, this object should be zero.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifPhysAddress": { "type": "string", "description": "The interface's address at its protocol sub-layer. For\n example, for an 802.x interface, this object normally\n contains a MAC address. The interface's media-specific MIB\n must define the bit and byte ordering and the format of the\n value of this object. For interfaces which do not have such\n an address (e.g., a serial line), this object should contain\n an octet string of zero length.", "x-yang-type": "yang:phys-address", "readOnly": true }, "ifAdminStatus": { "type": "string", "description": "The desired state of the interface. The testing(3) state\n indicates that no operational packets can be passed. When a\n managed system initializes, all interfaces start with\n ifAdminStatus in the down(2) state. As a result of either\n explicit management action or per configuration information\n retained by the managed system, ifAdminStatus is then\n changed to either the up(1) or testing(3) states (or remains\n in the down(2) state).", "readOnly": true }, "ifOperStatus": { "type": "string", "description": "The current operational state of the interface. The\n testing(3) state indicates that no operational packets can\n be passed. If ifAdminStatus is down(2) then ifOperStatus\n should be down(2). If ifAdminStatus is changed to up(1)\n then ifOperStatus should change to up(1) if the interface is\n ready to transmit and receive network traffic; it should\n change to dormant(5) if the interface is waiting for\n external actions (such as a serial line waiting for an\n incoming connection); it should remain in the down(2) state\n if and only if there is a fault that prevents it from going\n to the up(1) state; it should remain in the notPresent(6)\n state if the interface has missing (typically, hardware)\n components.", "readOnly": true }, "ifLastChange": { "type": "string", "description": "The value of sysUpTime at the time the interface entered\n its current operational state. If the current state was\n entered prior to the last re-initialization of the local\n network management subsystem, then this object contains a\n zero value.", "x-yang-type": "yang:timeticks", "readOnly": true }, "ifInOctets": { "type": "integer", "description": "The total number of octets received on the interface,\n including framing characters.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifInUcastPkts": { "type": "integer", "description": "The number of packets, delivered by this sub-layer to a\n higher (sub-)layer, which were not addressed to a multicast\n or broadcast address at this sub-layer.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifInNUcastPkts": { "type": "integer", "description": "The number of packets, delivered by this sub-layer to a\n higher (sub-)layer, which were addressed to a multicast or\n broadcast address at this sub-layer.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.\n \n This object is deprecated in favour of ifInMulticastPkts and\n ifInBroadcastPkts.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifInDiscards": { "type": "integer", "description": "The number of inbound packets which were chosen to be\n discarded even though no errors had been detected to prevent\n their being deliverable to a higher-layer protocol. One\n possible reason for discarding such a packet could be to\n free up buffer space.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifInErrors": { "type": "integer", "description": "For packet-oriented interfaces, the number of inbound\n packets that contained errors preventing them from being\n deliverable to a higher-layer protocol. For character-\n oriented or fixed-length interfaces, the number of inbound\n transmission units that contained errors preventing them\n from being deliverable to a higher-layer protocol.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifInUnknownProtos": { "type": "integer", "description": "For packet-oriented interfaces, the number of packets\n received via the interface which were discarded because of\n an unknown or unsupported protocol. For character-oriented\n or fixed-length interfaces that support protocol\n multiplexing the number of transmission units received via\n the interface which were discarded because of an unknown or\n unsupported protocol. For any interface that does not\n support protocol multiplexing, this counter will always be\n 0.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifOutOctets": { "type": "integer", "description": "The total number of octets transmitted out of the\n interface, including framing characters.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifOutUcastPkts": { "type": "integer", "description": "The total number of packets that higher-level protocols\n requested be transmitted, and which were not addressed to a\n multicast or broadcast address at this sub-layer, including\n those that were discarded or not sent.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifOutNUcastPkts": { "type": "integer", "description": "The total number of packets that higher-level protocols\n requested be transmitted, and which were addressed to a\n multicast or broadcast address at this sub-layer, including\n those that were discarded or not sent.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.\n \n This object is deprecated in favour of ifOutMulticastPkts\n and ifOutBroadcastPkts.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifOutDiscards": { "type": "integer", "description": "The number of outbound packets which were chosen to be\n discarded even though no errors had been detected to prevent\n their being transmitted. One possible reason for discarding\n such a packet could be to free up buffer space.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifOutErrors": { "type": "integer", "description": "For packet-oriented interfaces, the number of outbound\n packets that could not be transmitted because of errors.\n For character-oriented or fixed-length interfaces, the\n number of outbound transmission units that could not be\n transmitted because of errors.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifOutQLen": { "type": "integer", "description": "The length of the output packet queue (in packets).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifSpecific": { "type": "string", "description": "A reference to MIB definitions specific to the particular\n media being used to realize the interface. It is\n recommended that this value point to an instance of a MIB\n object in the media-specific MIB, i.e., that this object\n have the semantics associated with the InstancePointer\n textual convention defined in RFC 2579. In fact, it is\n recommended that the media-specific MIB specify what value\n ifSpecific should/can take for values of ifType. If no MIB\n definitions specific to the particular media are available,\n the value should be set to the OBJECT IDENTIFIER { 0 0 }.", "x-yang-type": "yang:object-identifier-128", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ifStackTable": { "type": "object", "description": "ifStackTable", "properties": { "ifStackEntry": { "type": "array", "description": "Information on a particular relationship between two sub-\n layers, specifying that one sub-layer runs on 'top' of the\n other sub-layer. Each sub-layer corresponds to a conceptual\n row in the ifTable.", "items": { "type": "object", "properties": { "ifStackHigherLayer": { "type": "string", "description": "The value of ifIndex corresponding to the higher sub-layer\n of the relationship, i.e., the sub-layer which runs on 'top'\n of the sub-layer identified by the corresponding instance of\n ifStackLowerLayer. If there is no higher sub-layer (below\n the internetwork layer), then this object has the value 0.", "x-yang-type": "IF-MIB:InterfaceIndexOrZero", "readOnly": true }, "ifStackLowerLayer": { "type": "string", "description": "The value of ifIndex corresponding to the lower sub-layer\n of the relationship, i.e., the sub-layer which runs 'below'\n the sub-layer identified by the corresponding instance of\n ifStackHigherLayer. If there is no lower sub-layer, then\n this object has the value 0.", "x-yang-type": "IF-MIB:InterfaceIndexOrZero", "readOnly": true }, "ifStackStatus": { "type": "string", "description": "The status of the relationship between two sub-layers.\n \n Changing the value of this object from 'active' to\n 'notInService' or 'destroy' will likely have consequences up\n and down the interface stack. Thus, write access to this\n object is likely to be inappropriate for some types of\n interfaces, and many implementations will choose not to\n support write-access for any type of interface.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ifRcvAddressTable": { "type": "object", "description": "ifRcvAddressTable", "properties": { "ifRcvAddressEntry": { "type": "array", "description": "A list of objects identifying an address for which the\n system will accept packets/frames on the particular\n interface identified by the index value ifIndex.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "ifRcvAddressAddress": { "type": "string", "description": "An address for which the system will accept packets/frames\n on this entry's interface.", "x-yang-type": "yang:phys-address", "readOnly": true }, "ifRcvAddressStatus": { "type": "string", "description": "This object is used to create and delete rows in the\n ifRcvAddressTable.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ifRcvAddressType": { "type": "string", "description": "This object has the value nonVolatile(3) for those entries\n in the table which are valid and will not be deleted by the\n next restart of the managed system. Entries having the\n value volatile(2) are valid and exist, but have not been\n saved, so that will not exist after the next restart of the\n managed system. Entries having the value other(1) are valid\n and exist but are not classified as to whether they will\n continue to exist after the next restart.", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "IF-MIB_object-1": { "type": "object", "description": "object-1", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true } } }, "IF-MIB_object-2": { "type": "object", "description": "object-2", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "ifAdminStatus": { "type": "string", "description": "ifAdminStatus", "x-yang-type": "leafref", "readOnly": true } } }, "IF-MIB_object-3": { "type": "object", "description": "object-3", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "ifOperStatus": { "type": "string", "description": "ifOperStatus", "x-yang-type": "leafref", "readOnly": true } } }, "IF-MIB_ifEntry": { "type": "array", "description": "An entry containing management information applicable to a\n particular interface.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "A unique value, greater than zero, for each interface. It\n is recommended that values are assigned contiguously\n starting from 1. The value for each interface sub-layer\n must remain constant at least from one re-initialization of\n the entity's network management system to the next re-\n initialization.", "x-yang-type": "IF-MIB:InterfaceIndex", "readOnly": true }, "ifDescr": { "type": "string", "description": "A textual string containing information about the\n interface. This string should include the name of the\n manufacturer, the product name and the version of the\n interface hardware/software.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ifType": { "type": "string", "description": "The type of interface. Additional values for ifType are\n assigned by the Internet Assigned Numbers Authority (IANA),\n through updating the syntax of the IANAifType textual\n convention.", "x-yang-type": "ianaiftype-mib:IANAifType", "readOnly": true }, "ifMtu": { "type": "integer", "description": "The size of the largest packet which can be sent/received\n on the interface, specified in octets. For interfaces that\n are used for transmitting network datagrams, this is the\n size of the largest network datagram that can be sent on the\n interface.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ifSpeed": { "type": "integer", "description": "An estimate of the interface's current bandwidth in bits\n per second. For interfaces which do not vary in bandwidth\n or for those where no accurate estimation can be made, this\n object should contain the nominal bandwidth. If the\n bandwidth of the interface is greater than the maximum value\n reportable by this object then this object should report its\n maximum value (4,294,967,295) and ifHighSpeed must be used\n to report the interace's speed. For a sub-layer which has\n no concept of bandwidth, this object should be zero.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifPhysAddress": { "type": "string", "description": "The interface's address at its protocol sub-layer. For\n example, for an 802.x interface, this object normally\n contains a MAC address. The interface's media-specific MIB\n must define the bit and byte ordering and the format of the\n value of this object. For interfaces which do not have such\n an address (e.g., a serial line), this object should contain\n an octet string of zero length.", "x-yang-type": "yang:phys-address", "readOnly": true }, "ifAdminStatus": { "type": "string", "description": "The desired state of the interface. The testing(3) state\n indicates that no operational packets can be passed. When a\n managed system initializes, all interfaces start with\n ifAdminStatus in the down(2) state. As a result of either\n explicit management action or per configuration information\n retained by the managed system, ifAdminStatus is then\n changed to either the up(1) or testing(3) states (or remains\n in the down(2) state).", "readOnly": true }, "ifOperStatus": { "type": "string", "description": "The current operational state of the interface. The\n testing(3) state indicates that no operational packets can\n be passed. If ifAdminStatus is down(2) then ifOperStatus\n should be down(2). If ifAdminStatus is changed to up(1)\n then ifOperStatus should change to up(1) if the interface is\n ready to transmit and receive network traffic; it should\n change to dormant(5) if the interface is waiting for\n external actions (such as a serial line waiting for an\n incoming connection); it should remain in the down(2) state\n if and only if there is a fault that prevents it from going\n to the up(1) state; it should remain in the notPresent(6)\n state if the interface has missing (typically, hardware)\n components.", "readOnly": true }, "ifLastChange": { "type": "string", "description": "The value of sysUpTime at the time the interface entered\n its current operational state. If the current state was\n entered prior to the last re-initialization of the local\n network management subsystem, then this object contains a\n zero value.", "x-yang-type": "yang:timeticks", "readOnly": true }, "ifInOctets": { "type": "integer", "description": "The total number of octets received on the interface,\n including framing characters.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifInUcastPkts": { "type": "integer", "description": "The number of packets, delivered by this sub-layer to a\n higher (sub-)layer, which were not addressed to a multicast\n or broadcast address at this sub-layer.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifInNUcastPkts": { "type": "integer", "description": "The number of packets, delivered by this sub-layer to a\n higher (sub-)layer, which were addressed to a multicast or\n broadcast address at this sub-layer.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.\n \n This object is deprecated in favour of ifInMulticastPkts and\n ifInBroadcastPkts.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifInDiscards": { "type": "integer", "description": "The number of inbound packets which were chosen to be\n discarded even though no errors had been detected to prevent\n their being deliverable to a higher-layer protocol. One\n possible reason for discarding such a packet could be to\n free up buffer space.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifInErrors": { "type": "integer", "description": "For packet-oriented interfaces, the number of inbound\n packets that contained errors preventing them from being\n deliverable to a higher-layer protocol. For character-\n oriented or fixed-length interfaces, the number of inbound\n transmission units that contained errors preventing them\n from being deliverable to a higher-layer protocol.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifInUnknownProtos": { "type": "integer", "description": "For packet-oriented interfaces, the number of packets\n received via the interface which were discarded because of\n an unknown or unsupported protocol. For character-oriented\n or fixed-length interfaces that support protocol\n multiplexing the number of transmission units received via\n the interface which were discarded because of an unknown or\n unsupported protocol. For any interface that does not\n support protocol multiplexing, this counter will always be\n 0.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifOutOctets": { "type": "integer", "description": "The total number of octets transmitted out of the\n interface, including framing characters.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifOutUcastPkts": { "type": "integer", "description": "The total number of packets that higher-level protocols\n requested be transmitted, and which were not addressed to a\n multicast or broadcast address at this sub-layer, including\n those that were discarded or not sent.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifOutNUcastPkts": { "type": "integer", "description": "The total number of packets that higher-level protocols\n requested be transmitted, and which were addressed to a\n multicast or broadcast address at this sub-layer, including\n those that were discarded or not sent.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.\n \n This object is deprecated in favour of ifOutMulticastPkts\n and ifOutBroadcastPkts.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifOutDiscards": { "type": "integer", "description": "The number of outbound packets which were chosen to be\n discarded even though no errors had been detected to prevent\n their being transmitted. One possible reason for discarding\n such a packet could be to free up buffer space.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifOutErrors": { "type": "integer", "description": "For packet-oriented interfaces, the number of outbound\n packets that could not be transmitted because of errors.\n For character-oriented or fixed-length interfaces, the\n number of outbound transmission units that could not be\n transmitted because of errors.\n \n Discontinuities in the value of this counter can occur at\n re-initialization of the management system, and at other\n times as indicated by the value of\n ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifOutQLen": { "type": "integer", "description": "The length of the output packet queue (in packets).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ifSpecific": { "type": "string", "description": "A reference to MIB definitions specific to the particular\n media being used to realize the interface. It is\n recommended that this value point to an instance of a MIB\n object in the media-specific MIB, i.e., that this object\n have the semantics associated with the InstancePointer\n textual convention defined in RFC 2579. In fact, it is\n recommended that the media-specific MIB specify what value\n ifSpecific should/can take for values of ifType. If no MIB\n definitions specific to the particular media are available,\n the value should be set to the OBJECT IDENTIFIER { 0 0 }.", "x-yang-type": "yang:object-identifier-128", "readOnly": true } } } }, "IF-MIB_ifStackEntry": { "type": "array", "description": "Information on a particular relationship between two sub-\n layers, specifying that one sub-layer runs on 'top' of the\n other sub-layer. Each sub-layer corresponds to a conceptual\n row in the ifTable.", "items": { "type": "object", "properties": { "ifStackHigherLayer": { "type": "string", "description": "The value of ifIndex corresponding to the higher sub-layer\n of the relationship, i.e., the sub-layer which runs on 'top'\n of the sub-layer identified by the corresponding instance of\n ifStackLowerLayer. If there is no higher sub-layer (below\n the internetwork layer), then this object has the value 0.", "x-yang-type": "IF-MIB:InterfaceIndexOrZero", "readOnly": true }, "ifStackLowerLayer": { "type": "string", "description": "The value of ifIndex corresponding to the lower sub-layer\n of the relationship, i.e., the sub-layer which runs 'below'\n the sub-layer identified by the corresponding instance of\n ifStackHigherLayer. If there is no lower sub-layer, then\n this object has the value 0.", "x-yang-type": "IF-MIB:InterfaceIndexOrZero", "readOnly": true }, "ifStackStatus": { "type": "string", "description": "The status of the relationship between two sub-layers.\n \n Changing the value of this object from 'active' to\n 'notInService' or 'destroy' will likely have consequences up\n and down the interface stack. Thus, write access to this\n object is likely to be inappropriate for some types of\n interfaces, and many implementations will choose not to\n support write-access for any type of interface.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } } }, "IF-MIB_ifRcvAddressEntry": { "type": "array", "description": "A list of objects identifying an address for which the\n system will accept packets/frames on the particular\n interface identified by the index value ifIndex.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "ifRcvAddressAddress": { "type": "string", "description": "An address for which the system will accept packets/frames\n on this entry's interface.", "x-yang-type": "yang:phys-address", "readOnly": true }, "ifRcvAddressStatus": { "type": "string", "description": "This object is used to create and delete rows in the\n ifRcvAddressTable.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ifRcvAddressType": { "type": "string", "description": "This object has the value nonVolatile(3) for those entries\n in the table which are valid and will not be deleted by the\n next restart of the managed system. Entries having the\n value volatile(2) are valid and exist, but have not been\n saved, so that will not exist after the next restart of the\n managed system. Entries having the value other(1) are valid\n and exist but are not classified as to whether they will\n continue to exist after the next restart.", "readOnly": true } } } }, "restconf-error": { "type": "object", "description": "Standard RESTCONF error response (RFC 8040 Section 7.1)", "properties": { "ietf-restconf:errors": { "type": "object", "properties": { "error": { "type": "array", "items": { "type": "object", "properties": { "error-type": { "type": "string", "enum": [ "transport", "rpc", "protocol", "application" ], "description": "Layer where the error occurred" }, "error-tag": { "type": "string", "description": "Enumerated error tag (e.g. invalid-value, data-missing, access-denied)" }, "error-severity": { "type": "string", "enum": [ "error", "warning" ], "description": "Error severity" }, "error-app-tag": { "type": "string", "description": "Application-specific error tag" }, "error-path": { "type": "string", "description": "YANG instance-identifier of the error node" }, "error-message": { "type": "string", "description": "Human-readable error description" } }, "required": [ "error-type", "error-tag" ] } } } } }, "example": { "ietf-restconf:errors": { "error": [ { "error-type": "protocol", "error-tag": "invalid-value", "error-severity": "error", "error-message": "Invalid input parameter" } ] } } } }, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } } }, "security": [ { "basicAuth": [] } ], "tags": [ { "name": "IF-MIB", "description": "MIB operations for IF-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }