{ "openapi": "3.0.0", "info": { "title": "SNMPv2-MIB MIB API", "version": "1.0.0", "description": "The MIB module for SNMP entities.\n \n Copyright (C) The Internet Society (2002). This\n version of this MIB module is part of RFC 3418;\n see the RFC itself for full legal notices.\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 SNMPv2-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/SNMPv2-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "SNMPv2-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/SNMPv2-MIB:system": { "get": { "summary": "Get system data", "description": "Retrieve system operational data from MIB", "tags": [ "SNMPv2-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A textual description of the entity. This value should\n include the full name and version identification of\n the system's hardware type, software operating-system,\n and networking software.", "properties": { "sysDescr": { "type": "string", "description": "A textual description of the entity. This value should\n include the full name and version identification of\n the system's hardware type, software operating-system,\n and networking software.", "x-yang-type": "snmpv2-tc:DisplayString" }, "sysObjectID": { "type": "string", "description": "The vendor's authoritative identification of the\n network management subsystem contained in the entity.\n This value is allocated within the SMI enterprises\n subtree (1.3.6.1.4.1) and provides an easy and\n unambiguous means for determining `what kind of box' is\n being managed. For example, if vendor `Flintstones,\n Inc.' was assigned the subtree 1.3.6.1.4.1.424242,\n it could assign the identifier 1.3.6.1.4.1.424242.1.1\n to its `Fred Router'.", "x-yang-type": "yang:object-identifier-128" }, "sysUpTime": { "type": "string", "description": "The time (in hundredths of a second) since the\n network management portion of the system was last\n re-initialized.", "x-yang-type": "yang:timeticks" }, "sysContact": { "type": "string", "description": "The textual identification of the contact person for\n this managed node, together with information on how\n to contact this person. If no contact information is\n known, the value is the zero-length string.", "x-yang-type": "snmpv2-tc:DisplayString" }, "sysName": { "type": "string", "description": "An administratively-assigned name for this managed\n node. By convention, this is the node's fully-qualified\n domain name. If the name is unknown, the value is\n the zero-length string.", "x-yang-type": "snmpv2-tc:DisplayString" }, "sysLocation": { "type": "string", "description": "The physical location of this node (e.g., 'telephone\n closet, 3rd floor'). If the location is unknown, the\n value is the zero-length string.", "x-yang-type": "snmpv2-tc:DisplayString" }, "sysServices": { "type": "integer", "description": "A value which indicates the set of services that this\n entity may potentially offer. The value is a sum.\n This sum initially takes the value zero. Then, for\n each layer, L, in the range 1 through 7, that this node\n performs transactions for, 2 raised to (L - 1) is added\n to the sum. For example, a node which performs only\n routing functions would have a value of 4 (2^(3-1)).\n In contrast, a node which is a host offering application\n services would have a value of 72 (2^(4-1) + 2^(7-1)).\n Note that in the context of the Internet suite of\n protocols, values should be calculated accordingly:\n \n layer functionality\n 1 physical (e.g., repeaters)\n 2 datalink/subnetwork (e.g., bridges)\n 3 internet (e.g., supports the IP)\n 4 end-to-end (e.g., supports the TCP)\n 7 applications (e.g., supports the SMTP)\n \n For systems including OSI protocols, layers 5 and 6\n may also be counted.", "minimum": -2147483648, "maximum": 2147483647 }, "sysORLastChange": { "type": "string", "description": "The value of sysUpTime at the time of the most recent\n change in state or value of any instance of sysORID.", "x-yang-type": "yang:timestamp" } } }, "example": { "SNMPv2-MIB:system": { "sysDescr": "GigabitEthernet1/0/1", "sysObjectID": "example-string", "sysUpTime": "example-string", "sysContact": "example-string", "sysName": "interface-1", "sysLocation": "example-string", "sysServices": -2147483648, "sysORLastChange": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-system", "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": "/system", "x-restconf-kind": "container" }, "/data/SNMPv2-MIB:snmp": { "get": { "summary": "Get snmp data", "description": "Retrieve snmp operational data from MIB", "tags": [ "SNMPv2-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The total number of messages delivered to the SNMP\n entity from the transport service.", "properties": { "snmpInPkts": { "type": "integer", "description": "The total number of messages delivered to the SNMP\n entity from the transport service.", "minimum": 0, "maximum": 4294967295 }, "snmpOutPkts": { "type": "integer", "description": "The total number of SNMP Messages which were\n passed from the SNMP protocol entity to the\n transport service.", "minimum": 0, "maximum": 4294967295 }, "snmpInBadVersions": { "type": "integer", "description": "The total number of SNMP messages which were delivered\n to the SNMP entity and were for an unsupported SNMP\n version.", "minimum": 0, "maximum": 4294967295 }, "snmpInBadCommunityNames": { "type": "integer", "description": "The total number of community-based SNMP messages (for\n example, SNMPv1) delivered to the SNMP entity which\n used an SNMP community name not known to said entity.\n Also, implementations which authenticate community-based\n SNMP messages using check(s) in addition to matching\n the community name (for example, by also checking\n whether the message originated from a transport address\n allowed to use a specified community name) MAY include\n in this value the number of messages which failed the\n additional check(s). It is strongly RECOMMENDED that\n the documentation for any security model which is used\n to authenticate community-based SNMP messages specify\n the precise conditions that contribute to this value.", "minimum": 0, "maximum": 4294967295 }, "snmpInBadCommunityUses": { "type": "integer", "description": "The total number of community-based SNMP messages (for\n example, SNMPv1) delivered to the SNMP entity which\n represented an SNMP operation that was not allowed for\n the SNMP community named in the message. The precise\n conditions under which this counter is incremented\n (if at all) depend on how the SNMP entity implements\n its access control mechanism and how its applications\n interact with that access control mechanism. It is\n strongly RECOMMENDED that the documentation for any\n access control mechanism which is used to control access\n to and visibility of MIB instrumentation specify the\n precise conditions that contribute to this value.", "minimum": 0, "maximum": 4294967295 }, "snmpInASNParseErrs": { "type": "integer", "description": "The total number of ASN.1 or BER errors encountered by\n the SNMP entity when decoding received SNMP messages.", "minimum": 0, "maximum": 4294967295 }, "snmpInTooBigs": { "type": "integer", "description": "The total number of SNMP PDUs which were\n delivered to the SNMP protocol entity and for\n which the value of the error-status field was\n `tooBig'.", "minimum": 0, "maximum": 4294967295 }, "snmpInNoSuchNames": { "type": "integer", "description": "The total number of SNMP PDUs which were\n delivered to the SNMP protocol entity and for\n which the value of the error-status field was\n `noSuchName'.", "minimum": 0, "maximum": 4294967295 }, "snmpInBadValues": { "type": "integer", "description": "The total number of SNMP PDUs which were\n delivered to the SNMP protocol entity and for\n which the value of the error-status field was\n `badValue'.", "minimum": 0, "maximum": 4294967295 }, "snmpInReadOnlys": { "type": "integer", "description": "The total number valid SNMP PDUs which were delivered\n to the SNMP protocol entity and for which the value\n of the error-status field was `readOnly'. It should\n be noted that it is a protocol error to generate an\n SNMP PDU which contains the value `readOnly' in the\n error-status field, as such this object is provided\n as a means of detecting incorrect implementations of\n the SNMP.", "minimum": 0, "maximum": 4294967295 }, "snmpInGenErrs": { "type": "integer", "description": "The total number of SNMP PDUs which were delivered\n to the SNMP protocol entity and for which the value\n of the error-status field was `genErr'.", "minimum": 0, "maximum": 4294967295 }, "snmpInTotalReqVars": { "type": "integer", "description": "The total number of MIB objects which have been\n retrieved successfully by the SNMP protocol entity\n as the result of receiving valid SNMP Get-Request\n and Get-Next PDUs.", "minimum": 0, "maximum": 4294967295 }, "snmpInTotalSetVars": { "type": "integer", "description": "The total number of MIB objects which have been\n altered successfully by the SNMP protocol entity as\n the result of receiving valid SNMP Set-Request PDUs.", "minimum": 0, "maximum": 4294967295 }, "snmpInGetRequests": { "type": "integer", "description": "The total number of SNMP Get-Request PDUs which\n have been accepted and processed by the SNMP\n protocol entity.", "minimum": 0, "maximum": 4294967295 }, "snmpInGetNexts": { "type": "integer", "description": "The total number of SNMP Get-Next PDUs which have been\n accepted and processed by the SNMP protocol entity.", "minimum": 0, "maximum": 4294967295 }, "snmpInSetRequests": { "type": "integer", "description": "The total number of SNMP Set-Request PDUs which\n have been accepted and processed by the SNMP protocol\n entity.", "minimum": 0, "maximum": 4294967295 }, "snmpInGetResponses": { "type": "integer", "description": "The total number of SNMP Get-Response PDUs which\n have been accepted and processed by the SNMP protocol\n entity.", "minimum": 0, "maximum": 4294967295 }, "snmpInTraps": { "type": "integer", "description": "The total number of SNMP Trap PDUs which have been\n accepted and processed by the SNMP protocol entity.", "minimum": 0, "maximum": 4294967295 }, "snmpOutTooBigs": { "type": "integer", "description": "The total number of SNMP PDUs which were generated\n by the SNMP protocol entity and for which the value\n of the error-status field was `tooBig.'", "minimum": 0, "maximum": 4294967295 }, "snmpOutNoSuchNames": { "type": "integer", "description": "The total number of SNMP PDUs which were generated\n by the SNMP protocol entity and for which the value\n of the error-status was `noSuchName'.", "minimum": 0, "maximum": 4294967295 }, "snmpOutBadValues": { "type": "integer", "description": "The total number of SNMP PDUs which were generated\n by the SNMP protocol entity and for which the value\n of the error-status field was `badValue'.", "minimum": 0, "maximum": 4294967295 }, "snmpOutGenErrs": { "type": "integer", "description": "The total number of SNMP PDUs which were generated\n by the SNMP protocol entity and for which the value\n of the error-status field was `genErr'.", "minimum": 0, "maximum": 4294967295 }, "snmpOutGetRequests": { "type": "integer", "description": "The total number of SNMP Get-Request PDUs which\n have been generated by the SNMP protocol entity.", "minimum": 0, "maximum": 4294967295 }, "snmpOutGetNexts": { "type": "integer", "description": "The total number of SNMP Get-Next PDUs which have\n been generated by the SNMP protocol entity.", "minimum": 0, "maximum": 4294967295 }, "snmpOutSetRequests": { "type": "integer", "description": "The total number of SNMP Set-Request PDUs which\n have been generated by the SNMP protocol entity.", "minimum": 0, "maximum": 4294967295 }, "snmpOutGetResponses": { "type": "integer", "description": "The total number of SNMP Get-Response PDUs which\n have been generated by the SNMP protocol entity.", "minimum": 0, "maximum": 4294967295 }, "snmpOutTraps": { "type": "integer", "description": "The total number of SNMP Trap PDUs which have\n been generated by the SNMP protocol entity.", "minimum": 0, "maximum": 4294967295 }, "snmpEnableAuthenTraps": { "type": "string", "description": "Indicates whether the SNMP entity is permitted to\n generate authenticationFailure traps. The value of this\n object overrides any configuration information; as such,\n it provides a means whereby all authenticationFailure\n traps may be disabled.\n \n Note that it is strongly recommended that this object\n be stored in non-volatile memory so that it remains\n constant across re-initializations of the network\n management system." }, "snmpSilentDrops": { "type": "integer", "description": "The total number of Confirmed Class PDUs (such as\n GetRequest-PDUs, GetNextRequest-PDUs,\n GetBulkRequest-PDUs, SetRequest-PDUs, and\n InformRequest-PDUs) delivered to the SNMP entity which\n were silently dropped because the size of a reply\n containing an alternate Response Class PDU (such as a\n Response-PDU) with an empty variable-bindings field\n was greater than either a local constraint or the\n maximum message size associated with the originator of\n the request.", "minimum": 0, "maximum": 4294967295 }, "snmpProxyDrops": { "type": "integer", "description": "The total number of Confirmed Class PDUs\n (such as GetRequest-PDUs, GetNextRequest-PDUs,\n GetBulkRequest-PDUs, SetRequest-PDUs, and\n InformRequest-PDUs) delivered to the SNMP entity which\n were silently dropped because the transmission of\n the (possibly translated) message to a proxy target\n failed in a manner (other than a time-out) such that\n no Response Class PDU (such as a Response-PDU) could\n be returned.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "SNMPv2-MIB:snmp": { "snmpInPkts": 0, "snmpOutPkts": 0, "snmpInBadVersions": 0, "snmpInBadCommunityNames": 0, "snmpInBadCommunityUses": 0, "snmpInASNParseErrs": 0, "snmpInTooBigs": 0, "snmpInNoSuchNames": 0, "snmpInBadValues": 0, "snmpInReadOnlys": 0, "snmpInGenErrs": 0, "snmpInTotalReqVars": 0, "snmpInTotalSetVars": 0, "snmpInGetRequests": 0, "snmpInGetNexts": 0, "snmpInSetRequests": 0, "snmpInGetResponses": 0, "snmpInTraps": 0, "snmpOutTooBigs": 0, "snmpOutNoSuchNames": 0, "snmpOutBadValues": 0, "snmpOutGenErrs": 0, "snmpOutGetRequests": 0, "snmpOutGetNexts": 0, "snmpOutSetRequests": 0, "snmpOutGetResponses": 0, "snmpOutTraps": 0, "snmpEnableAuthenTraps": "example-string", "snmpSilentDrops": 0, "snmpProxyDrops": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-snmp", "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": "/snmp", "x-restconf-kind": "container" }, "/data/SNMPv2-MIB:snmpSet": { "get": { "summary": "Get snmpSet data", "description": "Retrieve snmpSet operational data from MIB", "tags": [ "SNMPv2-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "snmpSet", "properties": { "snmpSetSerialNo": { "type": "string", "description": "An advisory lock used to allow several cooperating\n command generator applications to coordinate their\n use of the SNMP set operation.\n \n This object is used for coarse-grain coordination.\n To achieve fine-grain coordination, one or more similar\n objects might be defined within each MIB group, as\n appropriate.", "x-yang-type": "snmpv2-tc:TestAndIncr" } } }, "example": { "SNMPv2-MIB:snmpSet": { "snmpSetSerialNo": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-snmpSet", "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": "/snmpSet", "x-restconf-kind": "container" }, "/data/SNMPv2-MIB:sysORTable": { "get": { "summary": "Get sysORTable data", "description": "Retrieve sysORTable operational data from MIB", "tags": [ "SNMPv2-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The (conceptual) table listing the capabilities of\n the local SNMP application acting as a command\n responder with respect to various MIB modules.\n SNMP entities having dynamically-configurable support\n of MIB modules will have a dynamically-varying number\n of conceptual rows.", "properties": { "sysOREntry": { "type": "array", "description": "An entry (conceptual row) in the sysORTable.", "items": { "type": "object", "properties": { "sysORIndex": { "type": "integer", "description": "The auxiliary variable used for identifying instances\n of the columnar objects in the sysORTable.", "minimum": -2147483648, "maximum": 2147483647 }, "sysORID": { "type": "string", "description": "An authoritative identification of a capabilities\n statement with respect to various MIB modules supported\n by the local SNMP application acting as a command\n responder.", "x-yang-type": "yang:object-identifier-128" }, "sysORDescr": { "type": "string", "description": "A textual description of the capabilities identified\n by the corresponding instance of sysORID.", "x-yang-type": "snmpv2-tc:DisplayString" }, "sysORUpTime": { "type": "string", "description": "The value of sysUpTime at the time this conceptual\n row was last instantiated.", "x-yang-type": "yang:timestamp" } } } } } }, "example": { "SNMPv2-MIB:sysORTable": { "sysOREntry": [ { "sysORIndex": 1, "sysORID": "example-string", "sysORDescr": "GigabitEthernet1/0/1", "sysORUpTime": "example-string" }, { "sysORIndex": 2, "sysORID": "example-string", "sysORDescr": "GigabitEthernet1/0/1", "sysORUpTime": "example-string" }, { "sysORIndex": 3, "sysORID": "example-string", "sysORDescr": "GigabitEthernet1/0/1", "sysORUpTime": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-sysORTable", "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": "/sysORTable", "x-restconf-kind": "container" }, "/data/SNMPv2-MIB:sysORTable/sysOREntry": { "get": { "summary": "Get sysOREntry list", "description": "Retrieve list of sysOREntry entries from MIB", "tags": [ "SNMPv2-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) in the sysORTable.", "items": { "type": "object", "properties": { "sysORIndex": { "type": "integer", "description": "The auxiliary variable used for identifying instances\n of the columnar objects in the sysORTable.", "minimum": -2147483648, "maximum": 2147483647 }, "sysORID": { "type": "string", "description": "An authoritative identification of a capabilities\n statement with respect to various MIB modules supported\n by the local SNMP application acting as a command\n responder.", "x-yang-type": "yang:object-identifier-128" }, "sysORDescr": { "type": "string", "description": "A textual description of the capabilities identified\n by the corresponding instance of sysORID.", "x-yang-type": "snmpv2-tc:DisplayString" }, "sysORUpTime": { "type": "string", "description": "The value of sysUpTime at the time this conceptual\n row was last instantiated.", "x-yang-type": "yang:timestamp" } } } }, "example": { "SNMPv2-MIB:sysOREntry": [ { "sysORIndex": 1, "sysORID": "example-string", "sysORDescr": "GigabitEthernet1/0/1", "sysORUpTime": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-sysOREntry", "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": "/sysORTable/sysOREntry", "x-restconf-kind": "container" }, "/data/SNMPv2-MIB:sysORTable/sysOREntry={sysORIndex}": { "get": { "summary": "Get sysOREntry entry", "description": "Retrieve specific sysOREntry entry by key from MIB", "tags": [ "SNMPv2-MIB" ], "parameters": [ { "name": "sysORIndex", "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": { "sysORIndex": { "type": "integer", "description": "The auxiliary variable used for identifying instances\n of the columnar objects in the sysORTable.", "minimum": -2147483648, "maximum": 2147483647 }, "sysORID": { "type": "string", "description": "An authoritative identification of a capabilities\n statement with respect to various MIB modules supported\n by the local SNMP application acting as a command\n responder.", "x-yang-type": "yang:object-identifier-128" }, "sysORDescr": { "type": "string", "description": "A textual description of the capabilities identified\n by the corresponding instance of sysORID.", "x-yang-type": "snmpv2-tc:DisplayString" }, "sysORUpTime": { "type": "string", "description": "The value of sysUpTime at the time this conceptual\n row was last instantiated.", "x-yang-type": "yang:timestamp" } } }, "example": { "SNMPv2-MIB:sysOREntry": { "sysORIndex": 1, "sysORID": "example-string", "sysORDescr": "GigabitEthernet1/0/1", "sysORUpTime": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-sysOREntry-2" }, "x-yang-path": "/sysORTable/sysOREntry={sysORIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "sysORIndex" ] }, "/data/SNMPv2-MIB:sysOREntry": { "get": { "summary": "Get sysOREntry list", "description": "Retrieve list of sysOREntry entries from MIB", "tags": [ "SNMPv2-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) in the sysORTable.", "items": { "type": "object", "properties": { "sysORIndex": { "type": "integer", "description": "The auxiliary variable used for identifying instances\n of the columnar objects in the sysORTable.", "minimum": -2147483648, "maximum": 2147483647 }, "sysORID": { "type": "string", "description": "An authoritative identification of a capabilities\n statement with respect to various MIB modules supported\n by the local SNMP application acting as a command\n responder.", "x-yang-type": "yang:object-identifier-128" }, "sysORDescr": { "type": "string", "description": "A textual description of the capabilities identified\n by the corresponding instance of sysORID.", "x-yang-type": "snmpv2-tc:DisplayString" }, "sysORUpTime": { "type": "string", "description": "The value of sysUpTime at the time this conceptual\n row was last instantiated.", "x-yang-type": "yang:timestamp" } } } }, "example": { "SNMPv2-MIB:sysOREntry": [ { "sysORIndex": 1, "sysORID": "example-string", "sysORDescr": "GigabitEthernet1/0/1", "sysORUpTime": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-sysOREntry-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": "/sysOREntry", "x-restconf-kind": "container" }, "/data/SNMPv2-MIB:sysOREntry={sysORIndex}": { "get": { "summary": "Get sysOREntry entry", "description": "Retrieve specific sysOREntry entry by key from MIB", "tags": [ "SNMPv2-MIB" ], "parameters": [ { "name": "sysORIndex", "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": { "sysORIndex": { "type": "integer", "description": "The auxiliary variable used for identifying instances\n of the columnar objects in the sysORTable.", "minimum": -2147483648, "maximum": 2147483647 }, "sysORID": { "type": "string", "description": "An authoritative identification of a capabilities\n statement with respect to various MIB modules supported\n by the local SNMP application acting as a command\n responder.", "x-yang-type": "yang:object-identifier-128" }, "sysORDescr": { "type": "string", "description": "A textual description of the capabilities identified\n by the corresponding instance of sysORID.", "x-yang-type": "snmpv2-tc:DisplayString" }, "sysORUpTime": { "type": "string", "description": "The value of sysUpTime at the time this conceptual\n row was last instantiated.", "x-yang-type": "yang:timestamp" } } }, "example": { "SNMPv2-MIB:sysOREntry": { "sysORIndex": 1, "sysORID": "example-string", "sysORDescr": "GigabitEthernet1/0/1", "sysORUpTime": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-sysOREntry-4" }, "x-yang-path": "/sysOREntry={sysORIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "sysORIndex" ] } }, "components": { "schemas": { "SNMPv2-MIB_SNMPv2-MIB": { "type": "object", "description": "A textual description of the entity. This value should\n include the full name and version identification of\n the system's hardware type, software operating-system,\n and networking software.", "properties": { "sysOREntry": { "type": "array", "description": "An entry (conceptual row) in the sysORTable.", "items": { "type": "object", "properties": { "sysORIndex": { "type": "integer", "description": "The auxiliary variable used for identifying instances\n of the columnar objects in the sysORTable.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "sysORID": { "type": "string", "description": "An authoritative identification of a capabilities\n statement with respect to various MIB modules supported\n by the local SNMP application acting as a command\n responder.", "x-yang-type": "yang:object-identifier-128", "readOnly": true }, "sysORDescr": { "type": "string", "description": "A textual description of the capabilities identified\n by the corresponding instance of sysORID.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "sysORUpTime": { "type": "string", "description": "The value of sysUpTime at the time this conceptual\n row was last instantiated.", "x-yang-type": "yang:timestamp", "readOnly": true } } }, "readOnly": true }, "system": { "type": "object", "description": "A textual description of the entity. This value should\n include the full name and version identification of\n the system's hardware type, software operating-system,\n and networking software.", "properties": { "sysDescr": { "type": "string", "description": "A textual description of the entity. This value should\n include the full name and version identification of\n the system's hardware type, software operating-system,\n and networking software.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "sysObjectID": { "type": "string", "description": "The vendor's authoritative identification of the\n network management subsystem contained in the entity.\n This value is allocated within the SMI enterprises\n subtree (1.3.6.1.4.1) and provides an easy and\n unambiguous means for determining `what kind of box' is\n being managed. For example, if vendor `Flintstones,\n Inc.' was assigned the subtree 1.3.6.1.4.1.424242,\n it could assign the identifier 1.3.6.1.4.1.424242.1.1\n to its `Fred Router'.", "x-yang-type": "yang:object-identifier-128", "readOnly": true }, "sysUpTime": { "type": "string", "description": "The time (in hundredths of a second) since the\n network management portion of the system was last\n re-initialized.", "x-yang-type": "yang:timeticks", "readOnly": true }, "sysContact": { "type": "string", "description": "The textual identification of the contact person for\n this managed node, together with information on how\n to contact this person. If no contact information is\n known, the value is the zero-length string.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "sysName": { "type": "string", "description": "An administratively-assigned name for this managed\n node. By convention, this is the node's fully-qualified\n domain name. If the name is unknown, the value is\n the zero-length string.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "sysLocation": { "type": "string", "description": "The physical location of this node (e.g., 'telephone\n closet, 3rd floor'). If the location is unknown, the\n value is the zero-length string.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "sysServices": { "type": "integer", "description": "A value which indicates the set of services that this\n entity may potentially offer. The value is a sum.\n This sum initially takes the value zero. Then, for\n each layer, L, in the range 1 through 7, that this node\n performs transactions for, 2 raised to (L - 1) is added\n to the sum. For example, a node which performs only\n routing functions would have a value of 4 (2^(3-1)).\n In contrast, a node which is a host offering application\n services would have a value of 72 (2^(4-1) + 2^(7-1)).\n Note that in the context of the Internet suite of\n protocols, values should be calculated accordingly:\n \n layer functionality\n 1 physical (e.g., repeaters)\n 2 datalink/subnetwork (e.g., bridges)\n 3 internet (e.g., supports the IP)\n 4 end-to-end (e.g., supports the TCP)\n 7 applications (e.g., supports the SMTP)\n \n For systems including OSI protocols, layers 5 and 6\n may also be counted.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "sysORLastChange": { "type": "string", "description": "The value of sysUpTime at the time of the most recent\n change in state or value of any instance of sysORID.", "x-yang-type": "yang:timestamp", "readOnly": true } }, "readOnly": true }, "snmp": { "type": "object", "description": "The total number of messages delivered to the SNMP\n entity from the transport service.", "properties": { "snmpInPkts": { "type": "integer", "description": "The total number of messages delivered to the SNMP\n entity from the transport service.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "snmpOutPkts": { "type": "integer", "description": "The total number of SNMP Messages which were\n passed from the SNMP protocol entity to the\n transport service.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "snmpInBadVersions": { "type": "integer", "description": "The total number of SNMP messages which were delivered\n to the SNMP entity and were for an unsupported SNMP\n version.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "snmpInBadCommunityNames": { "type": "integer", "description": "The total number of community-based SNMP messages (for\n example, SNMPv1) delivered to the SNMP entity which\n used an SNMP community name not known to said entity.\n Also, implementations which authenticate community-based\n SNMP messages using check(s) in addition to matching\n the community name (for example, by also checking\n whether the message originated from a transport address\n allowed to use a specified community name) MAY include\n in this value the number of messages which failed the\n additional check(s). It is strongly RECOMMENDED that\n the documentation for any security model which is used\n to authenticate community-based SNMP messages specify\n the precise conditions that contribute to this value.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "snmpInBadCommunityUses": { "type": "integer", "description": "The total number of community-based SNMP messages (for\n example, SNMPv1) delivered to the SNMP entity which\n represented an SNMP operation that was not allowed for\n the SNMP community named in the message. The precise\n conditions under which this counter is incremented\n (if at all) depend on how the SNMP entity implements\n its access control mechanism and how its applications\n interact with that access control mechanism. It is\n strongly RECOMMENDED that the documentation for any\n access control mechanism which is used to control access\n to and visibility of MIB instrumentation specify the\n precise conditions that contribute to this value.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "snmpInASNParseErrs": { "type": "integer", "description": "The total number of ASN.1 or BER errors encountered by\n the SNMP entity when decoding received SNMP messages.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "snmpInTooBigs": { "type": "integer", "description": "The total number of SNMP PDUs which were\n delivered to the SNMP protocol entity and for\n which the value of the error-status field was\n `tooBig'.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "snmpInNoSuchNames": { "type": "integer", "description": "The total number of SNMP PDUs which were\n delivered to the SNMP protocol entity and for\n which the value of the error-status field was\n `noSuchName'.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "snmpInBadValues": { "type": "integer", "description": "The total number of SNMP PDUs which were\n delivered to the SNMP protocol entity and for\n which the value of the error-status field was\n `badValue'.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "snmpInReadOnlys": { "type": "integer", "description": "The total number valid SNMP PDUs which were delivered\n to the SNMP protocol entity and for which the value\n of the error-status field was `readOnly'. It should\n be noted that it is a protocol error to generate an\n SNMP PDU which contains the value `readOnly' in the\n error-status field, as such this object is provided\n as a means of detecting incorrect implementations of\n the SNMP.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "snmpInGenErrs": { "type": "integer", "description": "The total number of SNMP PDUs which were delivered\n to the SNMP protocol entity and for which the value\n of the error-status field was `genErr'.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "snmpInTotalReqVars": { "type": "integer", "description": "The total number of MIB objects which have been\n retrieved successfully by the SNMP protocol entity\n as the result of receiving valid SNMP Get-Request\n and Get-Next PDUs.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "snmpInTotalSetVars": { "type": "integer", "description": "The total number of MIB objects which have been\n altered successfully by the SNMP protocol entity as\n the result of receiving valid SNMP Set-Request PDUs.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "snmpInGetRequests": { "type": "integer", "description": "The total number of SNMP Get-Request PDUs which\n have been accepted and processed by the SNMP\n protocol entity.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "snmpInGetNexts": { "type": "integer", "description": "The total number of SNMP Get-Next PDUs which have been\n accepted and processed by the SNMP protocol entity.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "snmpInSetRequests": { "type": "integer", "description": "The total number of SNMP Set-Request PDUs which\n have been accepted and processed by the SNMP protocol\n entity.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "snmpInGetResponses": { "type": "integer", "description": "The total number of SNMP Get-Response PDUs which\n have been accepted and processed by the SNMP protocol\n entity.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "snmpInTraps": { "type": "integer", "description": "The total number of SNMP Trap PDUs which have been\n accepted and processed by the SNMP protocol entity.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "snmpOutTooBigs": { "type": "integer", "description": "The total number of SNMP PDUs which were generated\n by the SNMP protocol entity and for which the value\n of the error-status field was `tooBig.'", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "snmpOutNoSuchNames": { "type": "integer", "description": "The total number of SNMP PDUs which were generated\n by the SNMP protocol entity and for which the value\n of the error-status was `noSuchName'.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "snmpOutBadValues": { "type": "integer", "description": "The total number of SNMP PDUs which were generated\n by the SNMP protocol entity and for which the value\n of the error-status field was `badValue'.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "snmpOutGenErrs": { "type": "integer", "description": "The total number of SNMP PDUs which were generated\n by the SNMP protocol entity and for which the value\n of the error-status field was `genErr'.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "snmpOutGetRequests": { "type": "integer", "description": "The total number of SNMP Get-Request PDUs which\n have been generated by the SNMP protocol entity.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "snmpOutGetNexts": { "type": "integer", "description": "The total number of SNMP Get-Next PDUs which have\n been generated by the SNMP protocol entity.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "snmpOutSetRequests": { "type": "integer", "description": "The total number of SNMP Set-Request PDUs which\n have been generated by the SNMP protocol entity.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "snmpOutGetResponses": { "type": "integer", "description": "The total number of SNMP Get-Response PDUs which\n have been generated by the SNMP protocol entity.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "snmpOutTraps": { "type": "integer", "description": "The total number of SNMP Trap PDUs which have\n been generated by the SNMP protocol entity.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "snmpEnableAuthenTraps": { "type": "string", "description": "Indicates whether the SNMP entity is permitted to\n generate authenticationFailure traps. The value of this\n object overrides any configuration information; as such,\n it provides a means whereby all authenticationFailure\n traps may be disabled.\n \n Note that it is strongly recommended that this object\n be stored in non-volatile memory so that it remains\n constant across re-initializations of the network\n management system.", "readOnly": true }, "snmpSilentDrops": { "type": "integer", "description": "The total number of Confirmed Class PDUs (such as\n GetRequest-PDUs, GetNextRequest-PDUs,\n GetBulkRequest-PDUs, SetRequest-PDUs, and\n InformRequest-PDUs) delivered to the SNMP entity which\n were silently dropped because the size of a reply\n containing an alternate Response Class PDU (such as a\n Response-PDU) with an empty variable-bindings field\n was greater than either a local constraint or the\n maximum message size associated with the originator of\n the request.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "snmpProxyDrops": { "type": "integer", "description": "The total number of Confirmed Class PDUs\n (such as GetRequest-PDUs, GetNextRequest-PDUs,\n GetBulkRequest-PDUs, SetRequest-PDUs, and\n InformRequest-PDUs) delivered to the SNMP entity which\n were silently dropped because the transmission of\n the (possibly translated) message to a proxy target\n failed in a manner (other than a time-out) such that\n no Response Class PDU (such as a Response-PDU) could\n be returned.", "minimum": 0, "maximum": 4294967295, "readOnly": true } }, "readOnly": true }, "snmpSet": { "type": "object", "description": "snmpSet", "properties": { "snmpSetSerialNo": { "type": "string", "description": "An advisory lock used to allow several cooperating\n command generator applications to coordinate their\n use of the SNMP set operation.\n \n This object is used for coarse-grain coordination.\n To achieve fine-grain coordination, one or more similar\n objects might be defined within each MIB group, as\n appropriate.", "x-yang-type": "snmpv2-tc:TestAndIncr", "readOnly": true } }, "readOnly": true }, "sysORTable": { "type": "object", "description": "The (conceptual) table listing the capabilities of\n the local SNMP application acting as a command\n responder with respect to various MIB modules.\n SNMP entities having dynamically-configurable support\n of MIB modules will have a dynamically-varying number\n of conceptual rows.", "properties": { "sysOREntry": { "type": "array", "description": "An entry (conceptual row) in the sysORTable.", "items": { "type": "object", "properties": { "sysORIndex": { "type": "integer", "description": "The auxiliary variable used for identifying instances\n of the columnar objects in the sysORTable.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "sysORID": { "type": "string", "description": "An authoritative identification of a capabilities\n statement with respect to various MIB modules supported\n by the local SNMP application acting as a command\n responder.", "x-yang-type": "yang:object-identifier-128", "readOnly": true }, "sysORDescr": { "type": "string", "description": "A textual description of the capabilities identified\n by the corresponding instance of sysORID.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "sysORUpTime": { "type": "string", "description": "The value of sysUpTime at the time this conceptual\n row was last instantiated.", "x-yang-type": "yang:timestamp", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "SNMPv2-MIB_sysOREntry": { "type": "array", "description": "An entry (conceptual row) in the sysORTable.", "items": { "type": "object", "properties": { "sysORIndex": { "type": "integer", "description": "The auxiliary variable used for identifying instances\n of the columnar objects in the sysORTable.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "sysORID": { "type": "string", "description": "An authoritative identification of a capabilities\n statement with respect to various MIB modules supported\n by the local SNMP application acting as a command\n responder.", "x-yang-type": "yang:object-identifier-128", "readOnly": true }, "sysORDescr": { "type": "string", "description": "A textual description of the capabilities identified\n by the corresponding instance of sysORID.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "sysORUpTime": { "type": "string", "description": "The value of sysUpTime at the time this conceptual\n row was last instantiated.", "x-yang-type": "yang:timestamp", "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": "SNMPv2-MIB", "description": "MIB operations for SNMPv2-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }