{ "openapi": "3.0.0", "info": { "title": "OSPF-MIB MIB API", "version": "1.0.0", "description": "The MIB module to describe the OSPF Version 2\n Protocol. Note that some objects in this MIB\n module may pose a significant security risk.\n Refer to the Security Considerations section\n in RFC 4750 for more information.\n \n Copyright (C) The IETF Trust (2006).\n This version of this MIB module is part of\n RFC 4750; see the RFC itself for full legal\n 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 OSPF-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/OSPF-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "OSPF-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/OSPF-MIB:ospfGeneralGroup": { "get": { "summary": "Get ospfGeneralGroup data", "description": "Retrieve ospfGeneralGroup operational data from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A 32-bit integer uniquely identifying the\n router in the Autonomous System.\n By convention, to ensure uniqueness, this\n should default to the value of one of the\n router's IP interface addresses.\n \n This object is persistent and when written\n the entity SHOULD save the change to non-volatile storage.", "properties": { "ospfRouterId": { "type": "string", "description": "A 32-bit integer uniquely identifying the\n router in the Autonomous System.\n By convention, to ensure uniqueness, this\n should default to the value of one of the\n router's IP interface addresses.\n \n This object is persistent and when written\n the entity SHOULD save the change to non-volatile storage.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfAdminStat": { "type": "string", "description": "The administrative status of OSPF in the\n router. The value 'enabled' denotes that the\n OSPF Process is active on at least one interface;\n 'disabled' disables it on all interfaces.\n \n This object is persistent and when written\n the entity SHOULD save the change to non-volatile storage.", "x-yang-type": "OSPF-MIB:Status" }, "ospfVersionNumber": { "type": "string", "description": "The current version number of the OSPF protocol is 2." }, "ospfAreaBdrRtrStatus": { "type": "boolean", "description": "A flag to note whether this router is an Area\n Border Router." }, "ospfASBdrRtrStatus": { "type": "boolean", "description": "A flag to note whether this router is configured as\n an Autonomous System Border Router.\n \n This object is persistent and when written the\n entity SHOULD save the change to non-volatile storage." }, "ospfExternLsaCount": { "type": "integer", "description": "The number of external (LS type-5) link state\n advertisements in the link state database.", "minimum": 0, "maximum": 4294967295 }, "ospfExternLsaCksumSum": { "type": "integer", "description": "The 32-bit sum of the LS checksums of\n the external link state advertisements\n contained in the link state database. This sum\n can be used to determine if there has been a\n change in a router's link state database and\n to compare the link state database of two\n routers. The value should be treated as unsigned\n when comparing two sums of checksums.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfTOSSupport": { "type": "boolean", "description": "The router's support for type-of-service routing.\n \n This object is persistent and when written\n the entity SHOULD save the change to non-volatile\n storage." }, "ospfOriginateNewLsas": { "type": "integer", "description": "The number of new link state advertisements\n that have been originated. This number is\n incremented each time the router originates a new\n LSA.\n \n Discontinuities in the value of this counter can\n occur at re-initialization of the management system,\n and at other times as indicated by the value of\n ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ospfRxNewLsas": { "type": "integer", "description": "The number of link state advertisements received\n that are determined to be new instantiations.\n This number does not include newer instantiations\n of self-originated link state advertisements.\n \n Discontinuities in the value of this counter can\n occur at re-initialization of the management system,\n and at other times as indicated by the value of\n ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ospfExtLsdbLimit": { "type": "integer", "description": "The maximum number of non-default\n AS-external LSAs entries that can be stored in the\n link state database. If the value is -1, then\n there is no limit.\n \n When the number of non-default AS-external LSAs\n in a router's link state database reaches\n ospfExtLsdbLimit, the router enters\n overflow state. The router never holds more than\n ospfExtLsdbLimit non-default AS-external LSAs\n in its database. OspfExtLsdbLimit MUST be set\n identically in all routers attached to the OSPF\n backbone and/or any regular OSPF area (i.e.,\n OSPF stub areas and NSSAs are excluded).\n \n This object is persistent and when written\n the entity SHOULD save the change to non-volatile\n storage.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfMulticastExtensions": { "type": "integer", "description": "A bit mask indicating whether the router is\n forwarding IP multicast (Class D) datagrams\n based on the algorithms defined in the\n multicast extensions to OSPF.\n \n Bit 0, if set, indicates that the router can\n \n forward IP multicast datagrams in the router's\n directly attached areas (called intra-area\n multicast routing).\n \n Bit 1, if set, indicates that the router can\n forward IP multicast datagrams between OSPF\n areas (called inter-area multicast routing).\n \n Bit 2, if set, indicates that the router can\n forward IP multicast datagrams between\n Autonomous Systems (called inter-AS multicast\n routing).\n \n Only certain combinations of bit settings are\n allowed, namely: 0 (no multicast forwarding is\n enabled), 1 (intra-area multicasting only), 3\n (intra-area and inter-area multicasting), 5\n (intra-area and inter-AS multicasting), and 7\n (multicasting everywhere). By default, no\n multicast forwarding is enabled.\n \n This object is persistent and when written\n the entity SHOULD save the change to non-volatile\n storage.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfExitOverflowInterval": { "type": "string", "description": "The number of seconds that, after entering\n OverflowState, a router will attempt to leave\n OverflowState. This allows the router to again\n originate non-default AS-external LSAs. When\n set to 0, the router will not leave\n overflow state until restarted.\n \n This object is persistent and when written\n the entity SHOULD save the change to non-volatile\n storage.", "x-yang-type": "OSPF-MIB:PositiveInteger" }, "ospfDemandExtensions": { "type": "boolean", "description": "The router's support for demand routing.\n This object is persistent and when written\n the entity SHOULD save the change to non-volatile\n storage." }, "ospfRFC1583Compatibility": { "type": "boolean", "description": "Indicates metrics used to choose among multiple\n AS-external LSAs. When RFC1583Compatibility is set to\n enabled, only cost will be used when choosing among\n multiple AS-external LSAs advertising the same\n destination. When RFC1583Compatibility is set to\n disabled, preference will be driven first by type of\n path using cost only to break ties.\n \n This object is persistent and when written\n the entity SHOULD save the change to non-volatile\n storage." }, "ospfOpaqueLsaSupport": { "type": "boolean", "description": "The router's support for Opaque LSA types." }, "ospfReferenceBandwidth": { "type": "integer", "description": "Reference bandwidth in kilobits/second for\n \n calculating default interface metrics. The\n default value is 100,000 KBPS (100 MBPS).\n \n This object is persistent and when written\n the entity SHOULD save the change to non-volatile\n storage.", "minimum": 0, "maximum": 4294967295 }, "ospfRestartSupport": { "type": "string", "description": "The router's support for OSPF graceful restart.\n Options include: no restart support, only planned\n restarts, or both planned and unplanned restarts.\n \n This object is persistent and when written\n the entity SHOULD save the change to non-volatile\n storage." }, "ospfRestartInterval": { "type": "integer", "description": "Configured OSPF graceful restart timeout interval.\n \n This object is persistent and when written\n the entity SHOULD save the change to non-volatile\n storage.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfRestartStrictLsaChecking": { "type": "boolean", "description": "Indicates if strict LSA checking is enabled for\n graceful restart.\n \n This object is persistent and when written\n the entity SHOULD save the change to non-volatile\n \n storage." }, "ospfRestartStatus": { "type": "string", "description": "Current status of OSPF graceful restart." }, "ospfRestartAge": { "type": "integer", "description": "Remaining time in current OSPF graceful restart\n interval.", "minimum": 0, "maximum": 4294967295 }, "ospfRestartExitReason": { "type": "string", "description": "Describes the outcome of the last attempt at a\n graceful restart. If the value is 'none', no restart\n has yet been attempted. If the value is 'inProgress',\n a restart attempt is currently underway." }, "ospfAsLsaCount": { "type": "integer", "description": "The number of AS-scope link state\n advertisements in the AS-scope link state database.", "minimum": 0, "maximum": 4294967295 }, "ospfAsLsaCksumSum": { "type": "integer", "description": "The 32-bit unsigned sum of the LS checksums of\n the AS link state advertisements contained in the AS-scope\n link state database. This sum can be used to determine\n if there has been a change in a router's AS-scope link\n state database, and to compare the AS-scope link state\n database of two routers.", "minimum": 0, "maximum": 4294967295 }, "ospfStubRouterSupport": { "type": "boolean", "description": "The router's support for stub router functionality." }, "ospfStubRouterAdvertisement": { "type": "string", "description": "This object controls the advertisement of\n stub router LSAs by the router. The value\n doNotAdvertise will result in the advertisement\n of a standard router LSA and is the default value.\n \n This object is persistent and when written\n the entity SHOULD save the change to non-volatile\n storage." }, "ospfDiscontinuityTime": { "type": "string", "description": "The value of sysUpTime on the most recent occasion\n at which any one of this MIB's counters suffered\n a discontinuity.\n \n If no such discontinuities have occurred since the last\n re-initialization of the local management subsystem,\n then this object contains a zero value.", "x-yang-type": "yang:timestamp" } } }, "example": { "OSPF-MIB:ospfGeneralGroup": { "ospfRouterId": "example-string", "ospfAdminStat": "example-string", "ospfVersionNumber": "example-string", "ospfAreaBdrRtrStatus": true, "ospfASBdrRtrStatus": true, "ospfExternLsaCount": 0, "ospfExternLsaCksumSum": -2147483648, "ospfTOSSupport": true, "ospfOriginateNewLsas": 0, "ospfRxNewLsas": 0, "ospfExtLsdbLimit": -2147483648, "ospfMulticastExtensions": -2147483648, "ospfExitOverflowInterval": "example-string", "ospfDemandExtensions": true, "ospfRFC1583Compatibility": true, "ospfOpaqueLsaSupport": true, "ospfReferenceBandwidth": 0, "ospfRestartSupport": "example-string", "ospfRestartInterval": -2147483648, "ospfRestartStrictLsaChecking": true, "ospfRestartStatus": "up(1)", "ospfRestartAge": 0, "ospfRestartExitReason": "example-string", "ospfAsLsaCount": 0, "ospfAsLsaCksumSum": 0, "ospfStubRouterSupport": true, "ospfStubRouterAdvertisement": "example-string", "ospfDiscontinuityTime": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfGeneralGroup", "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": "/ospfGeneralGroup", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfAreaTable": { "get": { "summary": "Get ospfAreaTable data", "description": "Retrieve ospfAreaTable operational data from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "Information describing the configured parameters and\n cumulative statistics of the router's attached areas.\n The interfaces and virtual links are configured\n as part of these areas. Area 0.0.0.0, by definition,\n is the backbone area.", "properties": { "ospfAreaEntry": { "type": "array", "description": "ospfAreaEntry", "items": { "type": "object", "properties": { "ospfAreaId": { "type": "string", "description": "A 32-bit integer uniquely identifying an area.\n Area ID 0.0.0.0 is used for the OSPF backbone.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfAuthType": { "type": "string", "description": "The authentication type specified for an area.", "x-yang-type": "OSPF-MIB:OspfAuthenticationType" }, "ospfImportAsExtern": { "type": "string", "description": "Indicates if an area is a stub area, NSSA, or standard\n area. Type-5 AS-external LSAs and type-11 Opaque LSAs are\n not imported into stub areas or NSSAs. NSSAs import\n AS-external data as type-7 LSAs" }, "ospfSpfRuns": { "type": "integer", "description": "The number of times that the intra-area route\n table has been calculated using this area's\n link state database. This is typically done\n using Dijkstra's algorithm.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ospfAreaBdrRtrCount": { "type": "integer", "description": "The total number of Area Border Routers reachable\n within this area. This is initially zero and is\n calculated in each Shortest Path First (SPF) pass.", "minimum": 0, "maximum": 4294967295 }, "ospfAsBdrRtrCount": { "type": "integer", "description": "The total number of Autonomous System Border\n Routers reachable within this area. This is\n initially zero and is calculated in each SPF\n pass.", "minimum": 0, "maximum": 4294967295 }, "ospfAreaLsaCount": { "type": "integer", "description": "The total number of link state advertisements\n in this area's link state database, excluding\n AS-external LSAs.", "minimum": 0, "maximum": 4294967295 }, "ospfAreaLsaCksumSum": { "type": "integer", "description": "The 32-bit sum of the link state\n advertisements' LS checksums contained in this\n area's link state database. This sum excludes\n external (LS type-5) link state advertisements.\n The sum can be used to determine if there has\n been a change in a router's link state\n database, and to compare the link state database of\n two routers. The value should be treated as unsigned\n when comparing two sums of checksums.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfAreaSummary": { "type": "string", "description": "The variable ospfAreaSummary controls the\n import of summary LSAs into stub and NSSA areas.\n It has no effect on other areas.\n \n If it is noAreaSummary, the router will not\n originate summary LSAs into the stub or NSSA area.\n It will rely entirely on its default route.\n \n If it is sendAreaSummary, the router will both\n summarize and propagate summary LSAs." }, "ospfAreaStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfAreaNssaTranslatorRole": { "type": "string", "description": "Indicates an NSSA border router's ability to\n perform NSSA translation of type-7 LSAs into\n type-5 LSAs." }, "ospfAreaNssaTranslatorState": { "type": "string", "description": "Indicates if and how an NSSA border router is\n performing NSSA translation of type-7 LSAs into type-5\n \n LSAs. When this object is set to enabled, the NSSA Border\n router's OspfAreaNssaExtTranslatorRole has been set to\n always. When this object is set to elected, a candidate\n NSSA Border router is Translating type-7 LSAs into type-5.\n When this object is set to disabled, a candidate NSSA\n border router is NOT translating type-7 LSAs into type-5." }, "ospfAreaNssaTranslatorStabilityInterval": { "type": "string", "description": "The number of seconds after an elected translator\n determines its services are no longer required, that\n it should continue to perform its translation duties.", "x-yang-type": "OSPF-MIB:PositiveInteger" }, "ospfAreaNssaTranslatorEvents": { "type": "integer", "description": "Indicates the number of translator state changes\n that have occurred since the last boot-up.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "OSPF-MIB:ospfAreaTable": { "ospfAreaEntry": [ { "ospfAreaId": "example-string", "ospfAuthType": "ethernetCsmacd(6)", "ospfImportAsExtern": "example-string", "ospfSpfRuns": 0, "ospfAreaBdrRtrCount": 0, "ospfAsBdrRtrCount": 0, "ospfAreaLsaCount": 0, "ospfAreaLsaCksumSum": -2147483648, "ospfAreaSummary": "example-string", "ospfAreaStatus": "up(1)", "ospfAreaNssaTranslatorRole": "example-string", "ospfAreaNssaTranslatorState": "up(1)", "ospfAreaNssaTranslatorStabilityInterval": "example-string", "ospfAreaNssaTranslatorEvents": 0 }, { "ospfAreaId": "example-string", "ospfAuthType": "ethernetCsmacd(6)", "ospfImportAsExtern": "example-string", "ospfSpfRuns": 0, "ospfAreaBdrRtrCount": 0, "ospfAsBdrRtrCount": 0, "ospfAreaLsaCount": 0, "ospfAreaLsaCksumSum": -2147483648, "ospfAreaSummary": "example-string", "ospfAreaStatus": "up(1)", "ospfAreaNssaTranslatorRole": "example-string", "ospfAreaNssaTranslatorState": "up(1)", "ospfAreaNssaTranslatorStabilityInterval": "example-string", "ospfAreaNssaTranslatorEvents": 0 }, { "ospfAreaId": "example-string", "ospfAuthType": "ethernetCsmacd(6)", "ospfImportAsExtern": "example-string", "ospfSpfRuns": 0, "ospfAreaBdrRtrCount": 0, "ospfAsBdrRtrCount": 0, "ospfAreaLsaCount": 0, "ospfAreaLsaCksumSum": -2147483648, "ospfAreaSummary": "example-string", "ospfAreaStatus": "up(1)", "ospfAreaNssaTranslatorRole": "example-string", "ospfAreaNssaTranslatorState": "up(1)", "ospfAreaNssaTranslatorStabilityInterval": "example-string", "ospfAreaNssaTranslatorEvents": 0 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfAreaTable", "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": "/ospfAreaTable", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfAreaTable/ospfAreaEntry": { "get": { "summary": "Get ospfAreaEntry list", "description": "Retrieve list of ospfAreaEntry entries from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "ospfAreaEntry", "items": { "type": "object", "properties": { "ospfAreaId": { "type": "string", "description": "A 32-bit integer uniquely identifying an area.\n Area ID 0.0.0.0 is used for the OSPF backbone.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfAuthType": { "type": "string", "description": "The authentication type specified for an area.", "x-yang-type": "OSPF-MIB:OspfAuthenticationType" }, "ospfImportAsExtern": { "type": "string", "description": "Indicates if an area is a stub area, NSSA, or standard\n area. Type-5 AS-external LSAs and type-11 Opaque LSAs are\n not imported into stub areas or NSSAs. NSSAs import\n AS-external data as type-7 LSAs" }, "ospfSpfRuns": { "type": "integer", "description": "The number of times that the intra-area route\n table has been calculated using this area's\n link state database. This is typically done\n using Dijkstra's algorithm.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ospfAreaBdrRtrCount": { "type": "integer", "description": "The total number of Area Border Routers reachable\n within this area. This is initially zero and is\n calculated in each Shortest Path First (SPF) pass.", "minimum": 0, "maximum": 4294967295 }, "ospfAsBdrRtrCount": { "type": "integer", "description": "The total number of Autonomous System Border\n Routers reachable within this area. This is\n initially zero and is calculated in each SPF\n pass.", "minimum": 0, "maximum": 4294967295 }, "ospfAreaLsaCount": { "type": "integer", "description": "The total number of link state advertisements\n in this area's link state database, excluding\n AS-external LSAs.", "minimum": 0, "maximum": 4294967295 }, "ospfAreaLsaCksumSum": { "type": "integer", "description": "The 32-bit sum of the link state\n advertisements' LS checksums contained in this\n area's link state database. This sum excludes\n external (LS type-5) link state advertisements.\n The sum can be used to determine if there has\n been a change in a router's link state\n database, and to compare the link state database of\n two routers. The value should be treated as unsigned\n when comparing two sums of checksums.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfAreaSummary": { "type": "string", "description": "The variable ospfAreaSummary controls the\n import of summary LSAs into stub and NSSA areas.\n It has no effect on other areas.\n \n If it is noAreaSummary, the router will not\n originate summary LSAs into the stub or NSSA area.\n It will rely entirely on its default route.\n \n If it is sendAreaSummary, the router will both\n summarize and propagate summary LSAs." }, "ospfAreaStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfAreaNssaTranslatorRole": { "type": "string", "description": "Indicates an NSSA border router's ability to\n perform NSSA translation of type-7 LSAs into\n type-5 LSAs." }, "ospfAreaNssaTranslatorState": { "type": "string", "description": "Indicates if and how an NSSA border router is\n performing NSSA translation of type-7 LSAs into type-5\n \n LSAs. When this object is set to enabled, the NSSA Border\n router's OspfAreaNssaExtTranslatorRole has been set to\n always. When this object is set to elected, a candidate\n NSSA Border router is Translating type-7 LSAs into type-5.\n When this object is set to disabled, a candidate NSSA\n border router is NOT translating type-7 LSAs into type-5." }, "ospfAreaNssaTranslatorStabilityInterval": { "type": "string", "description": "The number of seconds after an elected translator\n determines its services are no longer required, that\n it should continue to perform its translation duties.", "x-yang-type": "OSPF-MIB:PositiveInteger" }, "ospfAreaNssaTranslatorEvents": { "type": "integer", "description": "Indicates the number of translator state changes\n that have occurred since the last boot-up.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "OSPF-MIB:ospfAreaEntry": [ { "ospfAreaId": "example-string", "ospfAuthType": "ethernetCsmacd(6)", "ospfImportAsExtern": "example-string", "ospfSpfRuns": 0, "ospfAreaBdrRtrCount": 0, "ospfAsBdrRtrCount": 0, "ospfAreaLsaCount": 0, "ospfAreaLsaCksumSum": -2147483648, "ospfAreaSummary": "example-string", "ospfAreaStatus": "up(1)", "ospfAreaNssaTranslatorRole": "example-string", "ospfAreaNssaTranslatorState": "up(1)", "ospfAreaNssaTranslatorStabilityInterval": "example-string", "ospfAreaNssaTranslatorEvents": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfAreaEntry", "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": "/ospfAreaTable/ospfAreaEntry", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfAreaTable/ospfAreaEntry={ospfAreaId}": { "get": { "summary": "Get ospfAreaEntry entry", "description": "Retrieve specific ospfAreaEntry entry by key from MIB", "tags": [ "OSPF-MIB" ], "parameters": [ { "name": "ospfAreaId", "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": { "ospfAreaId": { "type": "string", "description": "A 32-bit integer uniquely identifying an area.\n Area ID 0.0.0.0 is used for the OSPF backbone.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfAuthType": { "type": "string", "description": "The authentication type specified for an area.", "x-yang-type": "OSPF-MIB:OspfAuthenticationType" }, "ospfImportAsExtern": { "type": "string", "description": "Indicates if an area is a stub area, NSSA, or standard\n area. Type-5 AS-external LSAs and type-11 Opaque LSAs are\n not imported into stub areas or NSSAs. NSSAs import\n AS-external data as type-7 LSAs" }, "ospfSpfRuns": { "type": "integer", "description": "The number of times that the intra-area route\n table has been calculated using this area's\n link state database. This is typically done\n using Dijkstra's algorithm.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ospfAreaBdrRtrCount": { "type": "integer", "description": "The total number of Area Border Routers reachable\n within this area. This is initially zero and is\n calculated in each Shortest Path First (SPF) pass.", "minimum": 0, "maximum": 4294967295 }, "ospfAsBdrRtrCount": { "type": "integer", "description": "The total number of Autonomous System Border\n Routers reachable within this area. This is\n initially zero and is calculated in each SPF\n pass.", "minimum": 0, "maximum": 4294967295 }, "ospfAreaLsaCount": { "type": "integer", "description": "The total number of link state advertisements\n in this area's link state database, excluding\n AS-external LSAs.", "minimum": 0, "maximum": 4294967295 }, "ospfAreaLsaCksumSum": { "type": "integer", "description": "The 32-bit sum of the link state\n advertisements' LS checksums contained in this\n area's link state database. This sum excludes\n external (LS type-5) link state advertisements.\n The sum can be used to determine if there has\n been a change in a router's link state\n database, and to compare the link state database of\n two routers. The value should be treated as unsigned\n when comparing two sums of checksums.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfAreaSummary": { "type": "string", "description": "The variable ospfAreaSummary controls the\n import of summary LSAs into stub and NSSA areas.\n It has no effect on other areas.\n \n If it is noAreaSummary, the router will not\n originate summary LSAs into the stub or NSSA area.\n It will rely entirely on its default route.\n \n If it is sendAreaSummary, the router will both\n summarize and propagate summary LSAs." }, "ospfAreaStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfAreaNssaTranslatorRole": { "type": "string", "description": "Indicates an NSSA border router's ability to\n perform NSSA translation of type-7 LSAs into\n type-5 LSAs." }, "ospfAreaNssaTranslatorState": { "type": "string", "description": "Indicates if and how an NSSA border router is\n performing NSSA translation of type-7 LSAs into type-5\n \n LSAs. When this object is set to enabled, the NSSA Border\n router's OspfAreaNssaExtTranslatorRole has been set to\n always. When this object is set to elected, a candidate\n NSSA Border router is Translating type-7 LSAs into type-5.\n When this object is set to disabled, a candidate NSSA\n border router is NOT translating type-7 LSAs into type-5." }, "ospfAreaNssaTranslatorStabilityInterval": { "type": "string", "description": "The number of seconds after an elected translator\n determines its services are no longer required, that\n it should continue to perform its translation duties.", "x-yang-type": "OSPF-MIB:PositiveInteger" }, "ospfAreaNssaTranslatorEvents": { "type": "integer", "description": "Indicates the number of translator state changes\n that have occurred since the last boot-up.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "OSPF-MIB:ospfAreaEntry": { "ospfAreaId": "example-string", "ospfAuthType": "ethernetCsmacd(6)", "ospfImportAsExtern": "example-string", "ospfSpfRuns": 0, "ospfAreaBdrRtrCount": 0, "ospfAsBdrRtrCount": 0, "ospfAreaLsaCount": 0, "ospfAreaLsaCksumSum": -2147483648, "ospfAreaSummary": "example-string", "ospfAreaStatus": "up(1)", "ospfAreaNssaTranslatorRole": "example-string", "ospfAreaNssaTranslatorState": "up(1)", "ospfAreaNssaTranslatorStabilityInterval": "example-string", "ospfAreaNssaTranslatorEvents": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfAreaEntry-2" }, "x-yang-path": "/ospfAreaTable/ospfAreaEntry={ospfAreaId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfAreaId" ] }, "/data/OSPF-MIB:ospfStubAreaTable": { "get": { "summary": "Get ospfStubAreaTable data", "description": "Retrieve ospfStubAreaTable operational data from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The set of metrics that will be advertised\n by a default Area Border Router into a stub area.", "properties": { "ospfStubAreaEntry": { "type": "array", "description": "The metric for a given Type of Service that\n will be advertised by a default Area Border\n Router into a stub area.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfStubAreaId": { "type": "string", "description": "The 32-bit identifier for the stub area. On\n creation, this can be derived from the\n instance.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfStubTOS": { "type": "string", "description": "The Type of Service associated with the\n metric. On creation, this can be derived from\n \n the instance.", "x-yang-type": "OSPF-MIB:TOSType" }, "ospfStubMetric": { "type": "string", "description": "The metric value applied at the indicated Type\n of Service. By default, this equals the least\n metric at the Type of Service among the\n interfaces to other areas.", "x-yang-type": "OSPF-MIB:BigMetric" }, "ospfStubStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfStubMetricType": { "type": "string", "description": "This variable displays the type of metric\n advertised as a default route." } } } } } }, "example": { "OSPF-MIB:ospfStubAreaTable": { "ospfStubAreaEntry": [ { "ospfStubAreaId": "example-string", "ospfStubTOS": "example-string", "ospfStubMetric": "example-string", "ospfStubStatus": "up(1)", "ospfStubMetricType": "ethernetCsmacd(6)" }, { "ospfStubAreaId": "example-string", "ospfStubTOS": "example-string", "ospfStubMetric": "example-string", "ospfStubStatus": "up(1)", "ospfStubMetricType": "ethernetCsmacd(6)" }, { "ospfStubAreaId": "example-string", "ospfStubTOS": "example-string", "ospfStubMetric": "example-string", "ospfStubStatus": "up(1)", "ospfStubMetricType": "ethernetCsmacd(6)" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfStubAreaTable", "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": "/ospfStubAreaTable", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfStubAreaTable/ospfStubAreaEntry": { "get": { "summary": "Get ospfStubAreaEntry list", "description": "Retrieve list of ospfStubAreaEntry entries from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "The metric for a given Type of Service that\n will be advertised by a default Area Border\n Router into a stub area.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfStubAreaId": { "type": "string", "description": "The 32-bit identifier for the stub area. On\n creation, this can be derived from the\n instance.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfStubTOS": { "type": "string", "description": "The Type of Service associated with the\n metric. On creation, this can be derived from\n \n the instance.", "x-yang-type": "OSPF-MIB:TOSType" }, "ospfStubMetric": { "type": "string", "description": "The metric value applied at the indicated Type\n of Service. By default, this equals the least\n metric at the Type of Service among the\n interfaces to other areas.", "x-yang-type": "OSPF-MIB:BigMetric" }, "ospfStubStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfStubMetricType": { "type": "string", "description": "This variable displays the type of metric\n advertised as a default route." } } } }, "example": { "OSPF-MIB:ospfStubAreaEntry": [ { "ospfStubAreaId": "example-string", "ospfStubTOS": "example-string", "ospfStubMetric": "example-string", "ospfStubStatus": "up(1)", "ospfStubMetricType": "ethernetCsmacd(6)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfStubAreaEntry", "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": "/ospfStubAreaTable/ospfStubAreaEntry", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfLsdbTable": { "get": { "summary": "Get ospfLsdbTable data", "description": "Retrieve ospfLsdbTable operational data from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The OSPF Process's link state database (LSDB).\n The LSDB contains the link state advertisements\n from throughout the areas that the device is attached to.", "properties": { "ospfLsdbEntry": { "type": "array", "description": "A single link state advertisement.", "items": { "type": "object", "properties": { "ospfLsdbAreaId": { "type": "string", "description": "The 32-bit identifier of the area from which\n the LSA was received.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement\n format.\n \n Note: External link state advertisements are permitted\n for backward compatibility, but should be displayed\n in the ospfAsLsdbTable rather than here." }, "ospfLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing either a Router ID or an IP address;\n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address" }, "ospfLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate Link State\n Advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfLsdbAge": { "type": "integer", "description": "This field is the age of the link state advertisement\n in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete contents of\n the advertisement, excepting the age field. The age field\n is excepted so that an advertisement's age can be\n incremented without updating the checksum. The checksum\n used is the same that is used for ISO connectionless\n \n datagrams; it is commonly referred to as the\n Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.\n \n Note that for variable length LSAs, SNMP agents\n may not be able to return the largest string size.", "format": "binary" } } } } } }, "example": { "OSPF-MIB:ospfLsdbTable": { "ospfLsdbEntry": [ { "ospfLsdbAreaId": "example-string", "ospfLsdbType": "ethernetCsmacd(6)", "ospfLsdbLsid": "example-string", "ospfLsdbRouterId": "example-string", "ospfLsdbSequence": -2147483648, "ospfLsdbAge": -2147483648, "ospfLsdbChecksum": -2147483648, "ospfLsdbAdvertisement": "example-string" }, { "ospfLsdbAreaId": "example-string", "ospfLsdbType": "ethernetCsmacd(6)", "ospfLsdbLsid": "example-string", "ospfLsdbRouterId": "example-string", "ospfLsdbSequence": -2147483648, "ospfLsdbAge": -2147483648, "ospfLsdbChecksum": -2147483648, "ospfLsdbAdvertisement": "example-string" }, { "ospfLsdbAreaId": "example-string", "ospfLsdbType": "ethernetCsmacd(6)", "ospfLsdbLsid": "example-string", "ospfLsdbRouterId": "example-string", "ospfLsdbSequence": -2147483648, "ospfLsdbAge": -2147483648, "ospfLsdbChecksum": -2147483648, "ospfLsdbAdvertisement": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfLsdbTable", "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": "/ospfLsdbTable", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfLsdbTable/ospfLsdbEntry": { "get": { "summary": "Get ospfLsdbEntry list", "description": "Retrieve list of ospfLsdbEntry entries from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A single link state advertisement.", "items": { "type": "object", "properties": { "ospfLsdbAreaId": { "type": "string", "description": "The 32-bit identifier of the area from which\n the LSA was received.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement\n format.\n \n Note: External link state advertisements are permitted\n for backward compatibility, but should be displayed\n in the ospfAsLsdbTable rather than here." }, "ospfLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing either a Router ID or an IP address;\n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address" }, "ospfLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate Link State\n Advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfLsdbAge": { "type": "integer", "description": "This field is the age of the link state advertisement\n in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete contents of\n the advertisement, excepting the age field. The age field\n is excepted so that an advertisement's age can be\n incremented without updating the checksum. The checksum\n used is the same that is used for ISO connectionless\n \n datagrams; it is commonly referred to as the\n Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.\n \n Note that for variable length LSAs, SNMP agents\n may not be able to return the largest string size.", "format": "binary" } } } }, "example": { "OSPF-MIB:ospfLsdbEntry": [ { "ospfLsdbAreaId": "example-string", "ospfLsdbType": "ethernetCsmacd(6)", "ospfLsdbLsid": "example-string", "ospfLsdbRouterId": "example-string", "ospfLsdbSequence": -2147483648, "ospfLsdbAge": -2147483648, "ospfLsdbChecksum": -2147483648, "ospfLsdbAdvertisement": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfLsdbEntry", "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": "/ospfLsdbTable/ospfLsdbEntry", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfAreaRangeTable": { "get": { "summary": "Get ospfAreaRangeTable data", "description": "Retrieve ospfAreaRangeTable operational data from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "ospfAreaRangeTable", "properties": { "ospfAreaRangeEntry": { "type": "array", "description": "A single area address range.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfAreaRangeAreaId": { "type": "string", "description": "The area that the address range is to be found\n within.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfAreaRangeNet": { "type": "string", "description": "The IP address of the net or subnet indicated\n by the range.", "format": "inet:ipv4-address" }, "ospfAreaRangeMask": { "type": "string", "description": "The subnet mask that pertains to the net or\n subnet.", "format": "inet:ipv4-address" }, "ospfAreaRangeStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfAreaRangeEffect": { "type": "string", "description": "Subnets subsumed by ranges either trigger the\n advertisement of the indicated summary\n (advertiseMatching) or result in the subnet's not\n being advertised at all outside the area." } } } } } }, "example": { "OSPF-MIB:ospfAreaRangeTable": { "ospfAreaRangeEntry": [ { "ospfAreaRangeAreaId": "example-string", "ospfAreaRangeNet": "example-string", "ospfAreaRangeMask": "example-string", "ospfAreaRangeStatus": "up(1)", "ospfAreaRangeEffect": "example-string" }, { "ospfAreaRangeAreaId": "example-string", "ospfAreaRangeNet": "example-string", "ospfAreaRangeMask": "example-string", "ospfAreaRangeStatus": "up(1)", "ospfAreaRangeEffect": "example-string" }, { "ospfAreaRangeAreaId": "example-string", "ospfAreaRangeNet": "example-string", "ospfAreaRangeMask": "example-string", "ospfAreaRangeStatus": "up(1)", "ospfAreaRangeEffect": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfAreaRangeTable", "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": "/ospfAreaRangeTable", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfAreaRangeTable/ospfAreaRangeEntry": { "get": { "summary": "Get ospfAreaRangeEntry list", "description": "Retrieve list of ospfAreaRangeEntry entries from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A single area address range.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfAreaRangeAreaId": { "type": "string", "description": "The area that the address range is to be found\n within.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfAreaRangeNet": { "type": "string", "description": "The IP address of the net or subnet indicated\n by the range.", "format": "inet:ipv4-address" }, "ospfAreaRangeMask": { "type": "string", "description": "The subnet mask that pertains to the net or\n subnet.", "format": "inet:ipv4-address" }, "ospfAreaRangeStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfAreaRangeEffect": { "type": "string", "description": "Subnets subsumed by ranges either trigger the\n advertisement of the indicated summary\n (advertiseMatching) or result in the subnet's not\n being advertised at all outside the area." } } } }, "example": { "OSPF-MIB:ospfAreaRangeEntry": [ { "ospfAreaRangeAreaId": "example-string", "ospfAreaRangeNet": "example-string", "ospfAreaRangeMask": "example-string", "ospfAreaRangeStatus": "up(1)", "ospfAreaRangeEffect": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfAreaRangeEntry", "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": "/ospfAreaRangeTable/ospfAreaRangeEntry", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfHostTable": { "get": { "summary": "Get ospfHostTable data", "description": "Retrieve ospfHostTable operational data from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The Host/Metric Table indicates what hosts are directly\n \n attached to the router, what metrics and types\n of service should be advertised for them,\n and what areas they are found within.", "properties": { "ospfHostEntry": { "type": "array", "description": "A metric to be advertised, for a given type of\n service, when a given host is reachable.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfHostIpAddress": { "type": "string", "description": "The IP address of the host.", "format": "inet:ipv4-address" }, "ospfHostTOS": { "type": "string", "description": "The Type of Service of the route being configured.", "x-yang-type": "OSPF-MIB:TOSType" }, "ospfHostMetric": { "type": "string", "description": "The metric to be advertised.", "x-yang-type": "OSPF-MIB:Metric" }, "ospfHostStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfHostAreaID": { "type": "string", "description": "The OSPF area to which the host belongs.\n Deprecated by ospfHostCfgAreaID.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfHostCfgAreaID": { "type": "string", "description": "To configure the OSPF area to which the host belongs.", "x-yang-type": "OSPF-MIB:AreaID" } } } } } }, "example": { "OSPF-MIB:ospfHostTable": { "ospfHostEntry": [ { "ospfHostIpAddress": "192.168.1.1", "ospfHostTOS": "example-string", "ospfHostMetric": "example-string", "ospfHostStatus": "up(1)", "ospfHostAreaID": "example-string", "ospfHostCfgAreaID": "example-string" }, { "ospfHostIpAddress": "192.168.1.1", "ospfHostTOS": "example-string", "ospfHostMetric": "example-string", "ospfHostStatus": "up(1)", "ospfHostAreaID": "example-string", "ospfHostCfgAreaID": "example-string" }, { "ospfHostIpAddress": "192.168.1.1", "ospfHostTOS": "example-string", "ospfHostMetric": "example-string", "ospfHostStatus": "up(1)", "ospfHostAreaID": "example-string", "ospfHostCfgAreaID": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfHostTable", "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": "/ospfHostTable", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfHostTable/ospfHostEntry": { "get": { "summary": "Get ospfHostEntry list", "description": "Retrieve list of ospfHostEntry entries from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A metric to be advertised, for a given type of\n service, when a given host is reachable.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfHostIpAddress": { "type": "string", "description": "The IP address of the host.", "format": "inet:ipv4-address" }, "ospfHostTOS": { "type": "string", "description": "The Type of Service of the route being configured.", "x-yang-type": "OSPF-MIB:TOSType" }, "ospfHostMetric": { "type": "string", "description": "The metric to be advertised.", "x-yang-type": "OSPF-MIB:Metric" }, "ospfHostStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfHostAreaID": { "type": "string", "description": "The OSPF area to which the host belongs.\n Deprecated by ospfHostCfgAreaID.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfHostCfgAreaID": { "type": "string", "description": "To configure the OSPF area to which the host belongs.", "x-yang-type": "OSPF-MIB:AreaID" } } } }, "example": { "OSPF-MIB:ospfHostEntry": [ { "ospfHostIpAddress": "192.168.1.1", "ospfHostTOS": "example-string", "ospfHostMetric": "example-string", "ospfHostStatus": "up(1)", "ospfHostAreaID": "example-string", "ospfHostCfgAreaID": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfHostEntry", "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": "/ospfHostTable/ospfHostEntry", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfIfTable": { "get": { "summary": "Get ospfIfTable data", "description": "Retrieve ospfIfTable operational data from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The OSPF Interface Table describes the interfaces\n from the viewpoint of OSPF.\n It augments the ipAddrTable with OSPF specific information.", "properties": { "ospfIfEntry": { "type": "array", "description": "The OSPF interface entry describes one interface\n from the viewpoint of OSPF.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfIfIpAddress": { "type": "string", "description": "The IP address of this OSPF interface.", "format": "inet:ipv4-address" }, "ospfAddressLessIf": { "type": "string", "description": "For the purpose of easing the instancing of\n addressed and addressless interfaces; this\n variable takes the value 0 on interfaces with\n IP addresses and the corresponding value of\n ifIndex for interfaces having no IP address.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "ospfIfAreaId": { "type": "string", "description": "A 32-bit integer uniquely identifying the area\n to which the interface connects. Area ID\n 0.0.0.0 is used for the OSPF backbone.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfIfType": { "type": "string", "description": "The OSPF interface type.\n By way of a default, this field may be intuited\n from the corresponding value of ifType.\n Broadcast LANs, such as Ethernet and IEEE 802.5,\n take the value 'broadcast', X.25 and similar\n technologies take the value 'nbma', and links\n that are definitively point to point take the\n value 'pointToPoint'." }, "ospfIfAdminStat": { "type": "string", "description": "The OSPF interface's administrative status.\n The value formed on the interface, and the interface\n will be advertised as an internal route to some area.\n The value 'disabled' denotes that the interface is\n external to OSPF.", "x-yang-type": "OSPF-MIB:Status" }, "ospfIfRtrPriority": { "type": "string", "description": "The priority of this interface. Used in\n multi-access networks, this field is used in\n the designated router election algorithm. The\n value 0 signifies that the router is not eligible\n to become the designated router on this particular\n network. In the event of a tie in this value,\n routers will use their Router ID as a tie breaker.", "x-yang-type": "OSPF-MIB:DesignatedRouterPriority" }, "ospfIfTransitDelay": { "type": "string", "description": "The estimated number of seconds it takes to\n transmit a link state update packet over this\n interface. Note that the minimal value SHOULD be\n 1 second.", "x-yang-type": "OSPF-MIB:UpToMaxAge" }, "ospfIfRetransInterval": { "type": "string", "description": "The number of seconds between link state advertisement\n retransmissions, for adjacencies belonging to this\n interface. This value is also used when retransmitting\n \n database description and Link State request packets.\n Note that minimal value SHOULD be 1 second.", "x-yang-type": "OSPF-MIB:UpToMaxAge" }, "ospfIfHelloInterval": { "type": "string", "description": "The length of time, in seconds, between the Hello packets\n that the router sends on the interface. This value must be\n the same for all routers attached to a common network.", "x-yang-type": "OSPF-MIB:HelloRange" }, "ospfIfRtrDeadInterval": { "type": "string", "description": "The number of seconds that a router's Hello packets have\n not been seen before its neighbors declare the router down.\n This should be some multiple of the Hello interval. This\n value must be the same for all routers attached to a common\n network.", "x-yang-type": "OSPF-MIB:PositiveInteger" }, "ospfIfPollInterval": { "type": "string", "description": "The larger time interval, in seconds, between the Hello\n packets sent to an inactive non-broadcast multi-access\n neighbor.", "x-yang-type": "OSPF-MIB:PositiveInteger" }, "ospfIfState": { "type": "string", "description": "The OSPF Interface State." }, "ospfIfDesignatedRouter": { "type": "string", "description": "The IP address of the designated router.", "format": "inet:ipv4-address" }, "ospfIfBackupDesignatedRouter": { "type": "string", "description": "The IP address of the backup designated\n router.", "format": "inet:ipv4-address" }, "ospfIfEvents": { "type": "integer", "description": "The number of times this OSPF interface has\n changed its state or an error has occurred.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ospfIfAuthKey": { "type": "string", "description": "The cleartext password used as an OSPF\n authentication key when simplePassword security\n is enabled. This object does not access any OSPF\n cryptogaphic (e.g., MD5) authentication key under\n any circumstance.\n \n If the key length is shorter than 8 octets, the\n agent will left adjust and zero fill to 8 octets.\n \n Unauthenticated interfaces need no authentication\n key, and simple password authentication cannot use\n a key of more than 8 octets.\n \n Note that the use of simplePassword authentication\n is NOT recommended when there is concern regarding\n attack upon the OSPF system. SimplePassword\n authentication is only sufficient to protect against\n accidental misconfigurations because it re-uses\n cleartext passwords [RFC1704].\n \n When read, ospfIfAuthKey always returns an octet\n string of length zero.", "format": "binary" }, "ospfIfStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfIfMulticastForwarding": { "type": "string", "description": "The way multicasts should be forwarded on this\n interface: not forwarded, forwarded as data\n link multicasts, or forwarded as data link\n unicasts. Data link multicasting is not\n meaningful on point-to-point and NBMA interfaces,\n and setting ospfMulticastForwarding to 0 effectively\n disables all multicast forwarding." }, "ospfIfDemand": { "type": "boolean", "description": "Indicates whether Demand OSPF procedures (hello\n suppression to FULL neighbors and setting the\n DoNotAge flag on propagated LSAs) should be\n performed on this interface." }, "ospfIfAuthType": { "type": "string", "description": "The authentication type specified for an interface.\n \n Note that this object can be used to engage\n in significant attacks against an OSPF router.", "x-yang-type": "OSPF-MIB:OspfAuthenticationType" }, "ospfIfLsaCount": { "type": "integer", "description": "The total number of link-local link state advertisements\n in this interface's link-local link state database.", "minimum": 0, "maximum": 4294967295 }, "ospfIfLsaCksumSum": { "type": "integer", "description": "The 32-bit unsigned sum of the Link State\n Advertisements' LS checksums contained in this\n interface's link-local link state database.\n The sum can be used to determine if there has\n been a change in the interface's link state\n database and to compare the interface link state\n database of routers attached to the same subnet.", "minimum": 0, "maximum": 4294967295 }, "ospfIfDesignatedRouterId": { "type": "string", "description": "The Router ID of the designated router.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfIfBackupDesignatedRouterId": { "type": "string", "description": "The Router ID of the backup designated router.", "x-yang-type": "OSPF-MIB:RouterID" } } } } } }, "example": { "OSPF-MIB:ospfIfTable": { "ospfIfEntry": [ { "ospfIfIpAddress": "192.168.1.1", "ospfAddressLessIf": "192.168.1.1", "ospfIfAreaId": "example-string", "ospfIfType": "ethernetCsmacd(6)", "ospfIfAdminStat": "example-string", "ospfIfRtrPriority": "example-string", "ospfIfTransitDelay": "example-string", "ospfIfRetransInterval": "example-string", "ospfIfHelloInterval": "example-string", "ospfIfRtrDeadInterval": "example-string", "ospfIfPollInterval": "example-string", "ospfIfState": "up(1)", "ospfIfDesignatedRouter": "example-string", "ospfIfBackupDesignatedRouter": "example-string", "ospfIfEvents": 0, "ospfIfAuthKey": "example-string", "ospfIfStatus": "up(1)", "ospfIfMulticastForwarding": "example-string", "ospfIfDemand": true, "ospfIfAuthType": "ethernetCsmacd(6)", "ospfIfLsaCount": 0, "ospfIfLsaCksumSum": 0, "ospfIfDesignatedRouterId": "example-string", "ospfIfBackupDesignatedRouterId": "example-string" }, { "ospfIfIpAddress": "192.168.1.1", "ospfAddressLessIf": "192.168.1.1", "ospfIfAreaId": "example-string", "ospfIfType": "ethernetCsmacd(6)", "ospfIfAdminStat": "example-string", "ospfIfRtrPriority": "example-string", "ospfIfTransitDelay": "example-string", "ospfIfRetransInterval": "example-string", "ospfIfHelloInterval": "example-string", "ospfIfRtrDeadInterval": "example-string", "ospfIfPollInterval": "example-string", "ospfIfState": "up(1)", "ospfIfDesignatedRouter": "example-string", "ospfIfBackupDesignatedRouter": "example-string", "ospfIfEvents": 0, "ospfIfAuthKey": "example-string", "ospfIfStatus": "up(1)", "ospfIfMulticastForwarding": "example-string", "ospfIfDemand": true, "ospfIfAuthType": "ethernetCsmacd(6)", "ospfIfLsaCount": 0, "ospfIfLsaCksumSum": 0, "ospfIfDesignatedRouterId": "example-string", "ospfIfBackupDesignatedRouterId": "example-string" }, { "ospfIfIpAddress": "192.168.1.1", "ospfAddressLessIf": "192.168.1.1", "ospfIfAreaId": "example-string", "ospfIfType": "ethernetCsmacd(6)", "ospfIfAdminStat": "example-string", "ospfIfRtrPriority": "example-string", "ospfIfTransitDelay": "example-string", "ospfIfRetransInterval": "example-string", "ospfIfHelloInterval": "example-string", "ospfIfRtrDeadInterval": "example-string", "ospfIfPollInterval": "example-string", "ospfIfState": "up(1)", "ospfIfDesignatedRouter": "example-string", "ospfIfBackupDesignatedRouter": "example-string", "ospfIfEvents": 0, "ospfIfAuthKey": "example-string", "ospfIfStatus": "up(1)", "ospfIfMulticastForwarding": "example-string", "ospfIfDemand": true, "ospfIfAuthType": "ethernetCsmacd(6)", "ospfIfLsaCount": 0, "ospfIfLsaCksumSum": 0, "ospfIfDesignatedRouterId": "example-string", "ospfIfBackupDesignatedRouterId": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfIfTable", "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": "/ospfIfTable", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfIfTable/ospfIfEntry": { "get": { "summary": "Get ospfIfEntry list", "description": "Retrieve list of ospfIfEntry entries from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "The OSPF interface entry describes one interface\n from the viewpoint of OSPF.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfIfIpAddress": { "type": "string", "description": "The IP address of this OSPF interface.", "format": "inet:ipv4-address" }, "ospfAddressLessIf": { "type": "string", "description": "For the purpose of easing the instancing of\n addressed and addressless interfaces; this\n variable takes the value 0 on interfaces with\n IP addresses and the corresponding value of\n ifIndex for interfaces having no IP address.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "ospfIfAreaId": { "type": "string", "description": "A 32-bit integer uniquely identifying the area\n to which the interface connects. Area ID\n 0.0.0.0 is used for the OSPF backbone.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfIfType": { "type": "string", "description": "The OSPF interface type.\n By way of a default, this field may be intuited\n from the corresponding value of ifType.\n Broadcast LANs, such as Ethernet and IEEE 802.5,\n take the value 'broadcast', X.25 and similar\n technologies take the value 'nbma', and links\n that are definitively point to point take the\n value 'pointToPoint'." }, "ospfIfAdminStat": { "type": "string", "description": "The OSPF interface's administrative status.\n The value formed on the interface, and the interface\n will be advertised as an internal route to some area.\n The value 'disabled' denotes that the interface is\n external to OSPF.", "x-yang-type": "OSPF-MIB:Status" }, "ospfIfRtrPriority": { "type": "string", "description": "The priority of this interface. Used in\n multi-access networks, this field is used in\n the designated router election algorithm. The\n value 0 signifies that the router is not eligible\n to become the designated router on this particular\n network. In the event of a tie in this value,\n routers will use their Router ID as a tie breaker.", "x-yang-type": "OSPF-MIB:DesignatedRouterPriority" }, "ospfIfTransitDelay": { "type": "string", "description": "The estimated number of seconds it takes to\n transmit a link state update packet over this\n interface. Note that the minimal value SHOULD be\n 1 second.", "x-yang-type": "OSPF-MIB:UpToMaxAge" }, "ospfIfRetransInterval": { "type": "string", "description": "The number of seconds between link state advertisement\n retransmissions, for adjacencies belonging to this\n interface. This value is also used when retransmitting\n \n database description and Link State request packets.\n Note that minimal value SHOULD be 1 second.", "x-yang-type": "OSPF-MIB:UpToMaxAge" }, "ospfIfHelloInterval": { "type": "string", "description": "The length of time, in seconds, between the Hello packets\n that the router sends on the interface. This value must be\n the same for all routers attached to a common network.", "x-yang-type": "OSPF-MIB:HelloRange" }, "ospfIfRtrDeadInterval": { "type": "string", "description": "The number of seconds that a router's Hello packets have\n not been seen before its neighbors declare the router down.\n This should be some multiple of the Hello interval. This\n value must be the same for all routers attached to a common\n network.", "x-yang-type": "OSPF-MIB:PositiveInteger" }, "ospfIfPollInterval": { "type": "string", "description": "The larger time interval, in seconds, between the Hello\n packets sent to an inactive non-broadcast multi-access\n neighbor.", "x-yang-type": "OSPF-MIB:PositiveInteger" }, "ospfIfState": { "type": "string", "description": "The OSPF Interface State." }, "ospfIfDesignatedRouter": { "type": "string", "description": "The IP address of the designated router.", "format": "inet:ipv4-address" }, "ospfIfBackupDesignatedRouter": { "type": "string", "description": "The IP address of the backup designated\n router.", "format": "inet:ipv4-address" }, "ospfIfEvents": { "type": "integer", "description": "The number of times this OSPF interface has\n changed its state or an error has occurred.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ospfIfAuthKey": { "type": "string", "description": "The cleartext password used as an OSPF\n authentication key when simplePassword security\n is enabled. This object does not access any OSPF\n cryptogaphic (e.g., MD5) authentication key under\n any circumstance.\n \n If the key length is shorter than 8 octets, the\n agent will left adjust and zero fill to 8 octets.\n \n Unauthenticated interfaces need no authentication\n key, and simple password authentication cannot use\n a key of more than 8 octets.\n \n Note that the use of simplePassword authentication\n is NOT recommended when there is concern regarding\n attack upon the OSPF system. SimplePassword\n authentication is only sufficient to protect against\n accidental misconfigurations because it re-uses\n cleartext passwords [RFC1704].\n \n When read, ospfIfAuthKey always returns an octet\n string of length zero.", "format": "binary" }, "ospfIfStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfIfMulticastForwarding": { "type": "string", "description": "The way multicasts should be forwarded on this\n interface: not forwarded, forwarded as data\n link multicasts, or forwarded as data link\n unicasts. Data link multicasting is not\n meaningful on point-to-point and NBMA interfaces,\n and setting ospfMulticastForwarding to 0 effectively\n disables all multicast forwarding." }, "ospfIfDemand": { "type": "boolean", "description": "Indicates whether Demand OSPF procedures (hello\n suppression to FULL neighbors and setting the\n DoNotAge flag on propagated LSAs) should be\n performed on this interface." }, "ospfIfAuthType": { "type": "string", "description": "The authentication type specified for an interface.\n \n Note that this object can be used to engage\n in significant attacks against an OSPF router.", "x-yang-type": "OSPF-MIB:OspfAuthenticationType" }, "ospfIfLsaCount": { "type": "integer", "description": "The total number of link-local link state advertisements\n in this interface's link-local link state database.", "minimum": 0, "maximum": 4294967295 }, "ospfIfLsaCksumSum": { "type": "integer", "description": "The 32-bit unsigned sum of the Link State\n Advertisements' LS checksums contained in this\n interface's link-local link state database.\n The sum can be used to determine if there has\n been a change in the interface's link state\n database and to compare the interface link state\n database of routers attached to the same subnet.", "minimum": 0, "maximum": 4294967295 }, "ospfIfDesignatedRouterId": { "type": "string", "description": "The Router ID of the designated router.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfIfBackupDesignatedRouterId": { "type": "string", "description": "The Router ID of the backup designated router.", "x-yang-type": "OSPF-MIB:RouterID" } } } }, "example": { "OSPF-MIB:ospfIfEntry": [ { "ospfIfIpAddress": "192.168.1.1", "ospfAddressLessIf": "192.168.1.1", "ospfIfAreaId": "example-string", "ospfIfType": "ethernetCsmacd(6)", "ospfIfAdminStat": "example-string", "ospfIfRtrPriority": "example-string", "ospfIfTransitDelay": "example-string", "ospfIfRetransInterval": "example-string", "ospfIfHelloInterval": "example-string", "ospfIfRtrDeadInterval": "example-string", "ospfIfPollInterval": "example-string", "ospfIfState": "up(1)", "ospfIfDesignatedRouter": "example-string", "ospfIfBackupDesignatedRouter": "example-string", "ospfIfEvents": 0, "ospfIfAuthKey": "example-string", "ospfIfStatus": "up(1)", "ospfIfMulticastForwarding": "example-string", "ospfIfDemand": true, "ospfIfAuthType": "ethernetCsmacd(6)", "ospfIfLsaCount": 0, "ospfIfLsaCksumSum": 0, "ospfIfDesignatedRouterId": "example-string", "ospfIfBackupDesignatedRouterId": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfIfEntry", "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": "/ospfIfTable/ospfIfEntry", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfIfMetricTable": { "get": { "summary": "Get ospfIfMetricTable data", "description": "Retrieve ospfIfMetricTable operational data from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "ospfIfMetricTable", "properties": { "ospfIfMetricEntry": { "type": "array", "description": "A particular TOS metric for a non-virtual interface\n identified by the interface index.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfIfMetricIpAddress": { "type": "string", "description": "The IP address of this OSPF interface. On row\n creation, this can be derived from the instance.", "format": "inet:ipv4-address" }, "ospfIfMetricAddressLessIf": { "type": "string", "description": "For the purpose of easing the instancing of\n addressed and addressless interfaces; this\n variable takes the value 0 on interfaces with\n IP addresses and the value of ifIndex for\n interfaces having no IP address. On row\n creation, this can be derived from the instance.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "ospfIfMetricTOS": { "type": "string", "description": "The Type of Service metric being referenced.\n On row creation, this can be derived from the\n instance.", "x-yang-type": "OSPF-MIB:TOSType" }, "ospfIfMetricValue": { "type": "string", "description": "The metric of using this Type of Service on\n this interface. The default value of the TOS 0\n metric is 10^8 / ifSpeed.", "x-yang-type": "OSPF-MIB:Metric" }, "ospfIfMetricStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "OSPF-MIB:ospfIfMetricTable": { "ospfIfMetricEntry": [ { "ospfIfMetricIpAddress": "192.168.1.1", "ospfIfMetricAddressLessIf": "192.168.1.1", "ospfIfMetricTOS": "example-string", "ospfIfMetricValue": "example-string", "ospfIfMetricStatus": "up(1)" }, { "ospfIfMetricIpAddress": "192.168.1.1", "ospfIfMetricAddressLessIf": "192.168.1.1", "ospfIfMetricTOS": "example-string", "ospfIfMetricValue": "example-string", "ospfIfMetricStatus": "up(1)" }, { "ospfIfMetricIpAddress": "192.168.1.1", "ospfIfMetricAddressLessIf": "192.168.1.1", "ospfIfMetricTOS": "example-string", "ospfIfMetricValue": "example-string", "ospfIfMetricStatus": "up(1)" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfIfMetricTable", "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": "/ospfIfMetricTable", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfIfMetricTable/ospfIfMetricEntry": { "get": { "summary": "Get ospfIfMetricEntry list", "description": "Retrieve list of ospfIfMetricEntry entries from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A particular TOS metric for a non-virtual interface\n identified by the interface index.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfIfMetricIpAddress": { "type": "string", "description": "The IP address of this OSPF interface. On row\n creation, this can be derived from the instance.", "format": "inet:ipv4-address" }, "ospfIfMetricAddressLessIf": { "type": "string", "description": "For the purpose of easing the instancing of\n addressed and addressless interfaces; this\n variable takes the value 0 on interfaces with\n IP addresses and the value of ifIndex for\n interfaces having no IP address. On row\n creation, this can be derived from the instance.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "ospfIfMetricTOS": { "type": "string", "description": "The Type of Service metric being referenced.\n On row creation, this can be derived from the\n instance.", "x-yang-type": "OSPF-MIB:TOSType" }, "ospfIfMetricValue": { "type": "string", "description": "The metric of using this Type of Service on\n this interface. The default value of the TOS 0\n metric is 10^8 / ifSpeed.", "x-yang-type": "OSPF-MIB:Metric" }, "ospfIfMetricStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "OSPF-MIB:ospfIfMetricEntry": [ { "ospfIfMetricIpAddress": "192.168.1.1", "ospfIfMetricAddressLessIf": "192.168.1.1", "ospfIfMetricTOS": "example-string", "ospfIfMetricValue": "example-string", "ospfIfMetricStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfIfMetricEntry", "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": "/ospfIfMetricTable/ospfIfMetricEntry", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfVirtIfTable": { "get": { "summary": "Get ospfVirtIfTable data", "description": "Retrieve ospfVirtIfTable operational data from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "Information about this router's virtual interfaces\n that the OSPF Process is configured to carry on.", "properties": { "ospfVirtIfEntry": { "type": "array", "description": "Information about a single virtual interface.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfVirtIfAreaId": { "type": "string", "description": "The transit area that the virtual link\n traverses. By definition, this is not 0.0.0.0.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfVirtIfNeighbor": { "type": "string", "description": "The Router ID of the virtual neighbor.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfVirtIfTransitDelay": { "type": "string", "description": "The estimated number of seconds it takes to\n transmit a Link State update packet over this\n interface. Note that the minimal value SHOULD be\n 1 second.", "x-yang-type": "OSPF-MIB:UpToMaxAge" }, "ospfVirtIfRetransInterval": { "type": "string", "description": "The number of seconds between link state\n avertisement retransmissions, for adjacencies\n belonging to this interface. This value is\n also used when retransmitting database\n description and Link State request packets. This\n value should be well over the expected\n round-trip time. Note that the minimal value SHOULD be\n 1 second.", "x-yang-type": "OSPF-MIB:UpToMaxAge" }, "ospfVirtIfHelloInterval": { "type": "string", "description": "The length of time, in seconds, between the\n Hello packets that the router sends on the\n interface. This value must be the same for the\n virtual neighbor.", "x-yang-type": "OSPF-MIB:HelloRange" }, "ospfVirtIfRtrDeadInterval": { "type": "string", "description": "The number of seconds that a router's Hello\n packets have not been seen before its\n neighbors declare the router down. This should be\n some multiple of the Hello interval. This\n value must be the same for the virtual neighbor.", "x-yang-type": "OSPF-MIB:PositiveInteger" }, "ospfVirtIfState": { "type": "string", "description": "OSPF virtual interface states." }, "ospfVirtIfEvents": { "type": "integer", "description": "The number of state changes or error events on\n this virtual link.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ospfVirtIfAuthKey": { "type": "string", "description": "The cleartext password used as an OSPF\n authentication key when simplePassword security\n is enabled. This object does not access any OSPF\n cryptogaphic (e.g., MD5) authentication key under\n any circumstance.\n \n If the key length is shorter than 8 octets, the\n agent will left adjust and zero fill to 8 octets.\n \n Unauthenticated interfaces need no authentication\n key, and simple password authentication cannot use\n a key of more than 8 octets.\n \n Note that the use of simplePassword authentication\n is NOT recommended when there is concern regarding\n attack upon the OSPF system. SimplePassword\n authentication is only sufficient to protect against\n accidental misconfigurations because it re-uses\n cleartext passwords. [RFC1704]\n \n When read, ospfIfAuthKey always returns an octet\n string of length zero.", "format": "binary" }, "ospfVirtIfStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfVirtIfAuthType": { "type": "string", "description": "The authentication type specified for a virtual interface.\n \n Note that this object can be used to engage\n in significant attacks against an OSPF router.", "x-yang-type": "OSPF-MIB:OspfAuthenticationType" }, "ospfVirtIfLsaCount": { "type": "integer", "description": "The total number of link-local link state advertisements\n in this virtual interface's link-local link state database.", "minimum": 0, "maximum": 4294967295 }, "ospfVirtIfLsaCksumSum": { "type": "integer", "description": "The 32-bit unsigned sum of the link state\n advertisements' LS checksums contained in this\n virtual interface's link-local link state database.\n The sum can be used to determine if there has\n been a change in the virtual interface's link state\n database, and to compare the virtual interface\n link state database of the virtual neighbors.", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "OSPF-MIB:ospfVirtIfTable": { "ospfVirtIfEntry": [ { "ospfVirtIfAreaId": "example-string", "ospfVirtIfNeighbor": "example-string", "ospfVirtIfTransitDelay": "example-string", "ospfVirtIfRetransInterval": "example-string", "ospfVirtIfHelloInterval": "example-string", "ospfVirtIfRtrDeadInterval": "example-string", "ospfVirtIfState": "up(1)", "ospfVirtIfEvents": 0, "ospfVirtIfAuthKey": "example-string", "ospfVirtIfStatus": "up(1)", "ospfVirtIfAuthType": "ethernetCsmacd(6)", "ospfVirtIfLsaCount": 0, "ospfVirtIfLsaCksumSum": 0 }, { "ospfVirtIfAreaId": "example-string", "ospfVirtIfNeighbor": "example-string", "ospfVirtIfTransitDelay": "example-string", "ospfVirtIfRetransInterval": "example-string", "ospfVirtIfHelloInterval": "example-string", "ospfVirtIfRtrDeadInterval": "example-string", "ospfVirtIfState": "up(1)", "ospfVirtIfEvents": 0, "ospfVirtIfAuthKey": "example-string", "ospfVirtIfStatus": "up(1)", "ospfVirtIfAuthType": "ethernetCsmacd(6)", "ospfVirtIfLsaCount": 0, "ospfVirtIfLsaCksumSum": 0 }, { "ospfVirtIfAreaId": "example-string", "ospfVirtIfNeighbor": "example-string", "ospfVirtIfTransitDelay": "example-string", "ospfVirtIfRetransInterval": "example-string", "ospfVirtIfHelloInterval": "example-string", "ospfVirtIfRtrDeadInterval": "example-string", "ospfVirtIfState": "up(1)", "ospfVirtIfEvents": 0, "ospfVirtIfAuthKey": "example-string", "ospfVirtIfStatus": "up(1)", "ospfVirtIfAuthType": "ethernetCsmacd(6)", "ospfVirtIfLsaCount": 0, "ospfVirtIfLsaCksumSum": 0 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfVirtIfTable", "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": "/ospfVirtIfTable", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfVirtIfTable/ospfVirtIfEntry": { "get": { "summary": "Get ospfVirtIfEntry list", "description": "Retrieve list of ospfVirtIfEntry entries from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about a single virtual interface.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfVirtIfAreaId": { "type": "string", "description": "The transit area that the virtual link\n traverses. By definition, this is not 0.0.0.0.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfVirtIfNeighbor": { "type": "string", "description": "The Router ID of the virtual neighbor.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfVirtIfTransitDelay": { "type": "string", "description": "The estimated number of seconds it takes to\n transmit a Link State update packet over this\n interface. Note that the minimal value SHOULD be\n 1 second.", "x-yang-type": "OSPF-MIB:UpToMaxAge" }, "ospfVirtIfRetransInterval": { "type": "string", "description": "The number of seconds between link state\n avertisement retransmissions, for adjacencies\n belonging to this interface. This value is\n also used when retransmitting database\n description and Link State request packets. This\n value should be well over the expected\n round-trip time. Note that the minimal value SHOULD be\n 1 second.", "x-yang-type": "OSPF-MIB:UpToMaxAge" }, "ospfVirtIfHelloInterval": { "type": "string", "description": "The length of time, in seconds, between the\n Hello packets that the router sends on the\n interface. This value must be the same for the\n virtual neighbor.", "x-yang-type": "OSPF-MIB:HelloRange" }, "ospfVirtIfRtrDeadInterval": { "type": "string", "description": "The number of seconds that a router's Hello\n packets have not been seen before its\n neighbors declare the router down. This should be\n some multiple of the Hello interval. This\n value must be the same for the virtual neighbor.", "x-yang-type": "OSPF-MIB:PositiveInteger" }, "ospfVirtIfState": { "type": "string", "description": "OSPF virtual interface states." }, "ospfVirtIfEvents": { "type": "integer", "description": "The number of state changes or error events on\n this virtual link.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ospfVirtIfAuthKey": { "type": "string", "description": "The cleartext password used as an OSPF\n authentication key when simplePassword security\n is enabled. This object does not access any OSPF\n cryptogaphic (e.g., MD5) authentication key under\n any circumstance.\n \n If the key length is shorter than 8 octets, the\n agent will left adjust and zero fill to 8 octets.\n \n Unauthenticated interfaces need no authentication\n key, and simple password authentication cannot use\n a key of more than 8 octets.\n \n Note that the use of simplePassword authentication\n is NOT recommended when there is concern regarding\n attack upon the OSPF system. SimplePassword\n authentication is only sufficient to protect against\n accidental misconfigurations because it re-uses\n cleartext passwords. [RFC1704]\n \n When read, ospfIfAuthKey always returns an octet\n string of length zero.", "format": "binary" }, "ospfVirtIfStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfVirtIfAuthType": { "type": "string", "description": "The authentication type specified for a virtual interface.\n \n Note that this object can be used to engage\n in significant attacks against an OSPF router.", "x-yang-type": "OSPF-MIB:OspfAuthenticationType" }, "ospfVirtIfLsaCount": { "type": "integer", "description": "The total number of link-local link state advertisements\n in this virtual interface's link-local link state database.", "minimum": 0, "maximum": 4294967295 }, "ospfVirtIfLsaCksumSum": { "type": "integer", "description": "The 32-bit unsigned sum of the link state\n advertisements' LS checksums contained in this\n virtual interface's link-local link state database.\n The sum can be used to determine if there has\n been a change in the virtual interface's link state\n database, and to compare the virtual interface\n link state database of the virtual neighbors.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "OSPF-MIB:ospfVirtIfEntry": [ { "ospfVirtIfAreaId": "example-string", "ospfVirtIfNeighbor": "example-string", "ospfVirtIfTransitDelay": "example-string", "ospfVirtIfRetransInterval": "example-string", "ospfVirtIfHelloInterval": "example-string", "ospfVirtIfRtrDeadInterval": "example-string", "ospfVirtIfState": "up(1)", "ospfVirtIfEvents": 0, "ospfVirtIfAuthKey": "example-string", "ospfVirtIfStatus": "up(1)", "ospfVirtIfAuthType": "ethernetCsmacd(6)", "ospfVirtIfLsaCount": 0, "ospfVirtIfLsaCksumSum": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfVirtIfEntry", "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": "/ospfVirtIfTable/ospfVirtIfEntry", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfNbrTable": { "get": { "summary": "Get ospfNbrTable data", "description": "Retrieve ospfNbrTable operational data from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table describing all non-virtual neighbors\n in the locality of the OSPF router.", "properties": { "ospfNbrEntry": { "type": "array", "description": "The information regarding a single neighbor.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n \n storage.", "items": { "type": "object", "properties": { "ospfNbrIpAddr": { "type": "string", "description": "The IP address this neighbor is using in its\n IP source address. Note that, on addressless\n links, this will not be 0.0.0.0 but the\n \n address of another of the neighbor's interfaces.", "format": "inet:ipv4-address" }, "ospfNbrAddressLessIndex": { "type": "string", "description": "On an interface having an IP address, zero.\n On addressless interfaces, the corresponding\n value of ifIndex in the Internet Standard MIB.\n On row creation, this can be derived from the\n instance.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "ospfNbrRtrId": { "type": "string", "description": "A 32-bit integer (represented as a type\n IpAddress) uniquely identifying the neighboring\n router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfNbrOptions": { "type": "integer", "description": "A bit mask corresponding to the neighbor's\n options field.\n \n Bit 0, if set, indicates that the system will\n operate on Type of Service metrics other than\n TOS 0. If zero, the neighbor will ignore all\n metrics except the TOS 0 metric.\n \n Bit 1, if set, indicates that the associated\n area accepts and operates on external\n information; if zero, it is a stub area.\n \n Bit 2, if set, indicates that the system is\n capable of routing IP multicast datagrams, that is\n that it implements the multicast extensions to\n OSPF.\n \n Bit 3, if set, indicates that the associated\n area is an NSSA. These areas are capable of\n carrying type-7 external advertisements, which\n are translated into type-5 external advertisements\n at NSSA borders.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfNbrPriority": { "type": "string", "description": "The priority of this neighbor in the designated\n router election algorithm. The value 0 signifies\n that the neighbor is not eligible to become\n the designated router on this particular network.", "x-yang-type": "OSPF-MIB:DesignatedRouterPriority" }, "ospfNbrState": { "type": "string", "description": "The state of the relationship with this neighbor." }, "ospfNbrEvents": { "type": "integer", "description": "The number of times this neighbor relationship\n has changed state or an error has occurred.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ospfNbrLsRetransQLen": { "type": "integer", "description": "The current length of the retransmission\n queue.", "minimum": 0, "maximum": 4294967295 }, "ospfNbmaNbrStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfNbmaNbrPermanence": { "type": "string", "description": "This variable displays the status of the entry;\n 'dynamic' and 'permanent' refer to how the neighbor\n became known." }, "ospfNbrHelloSuppressed": { "type": "boolean", "description": "Indicates whether Hellos are being suppressed\n to the neighbor." }, "ospfNbrRestartHelperStatus": { "type": "string", "description": "Indicates whether the router is acting\n as a graceful restart helper for the neighbor." }, "ospfNbrRestartHelperAge": { "type": "integer", "description": "Remaining time in current OSPF graceful restart\n interval, if the router is acting as a restart\n helper for the neighbor.", "minimum": 0, "maximum": 4294967295 }, "ospfNbrRestartHelperExitReason": { "type": "string", "description": "Describes the outcome of the last attempt at acting\n as a graceful restart helper for the neighbor." } } } } } }, "example": { "OSPF-MIB:ospfNbrTable": { "ospfNbrEntry": [ { "ospfNbrIpAddr": "192.168.1.1", "ospfNbrAddressLessIndex": "1", "ospfNbrRtrId": "example-string", "ospfNbrOptions": -2147483648, "ospfNbrPriority": "example-string", "ospfNbrState": "up(1)", "ospfNbrEvents": 0, "ospfNbrLsRetransQLen": 0, "ospfNbmaNbrStatus": "up(1)", "ospfNbmaNbrPermanence": "example-string", "ospfNbrHelloSuppressed": true, "ospfNbrRestartHelperStatus": "up(1)", "ospfNbrRestartHelperAge": 0, "ospfNbrRestartHelperExitReason": "example-string" }, { "ospfNbrIpAddr": "192.168.1.1", "ospfNbrAddressLessIndex": "2", "ospfNbrRtrId": "example-string", "ospfNbrOptions": -2147483648, "ospfNbrPriority": "example-string", "ospfNbrState": "up(1)", "ospfNbrEvents": 0, "ospfNbrLsRetransQLen": 0, "ospfNbmaNbrStatus": "up(1)", "ospfNbmaNbrPermanence": "example-string", "ospfNbrHelloSuppressed": true, "ospfNbrRestartHelperStatus": "up(1)", "ospfNbrRestartHelperAge": 0, "ospfNbrRestartHelperExitReason": "example-string" }, { "ospfNbrIpAddr": "192.168.1.1", "ospfNbrAddressLessIndex": "3", "ospfNbrRtrId": "example-string", "ospfNbrOptions": -2147483648, "ospfNbrPriority": "example-string", "ospfNbrState": "up(1)", "ospfNbrEvents": 0, "ospfNbrLsRetransQLen": 0, "ospfNbmaNbrStatus": "up(1)", "ospfNbmaNbrPermanence": "example-string", "ospfNbrHelloSuppressed": true, "ospfNbrRestartHelperStatus": "up(1)", "ospfNbrRestartHelperAge": 0, "ospfNbrRestartHelperExitReason": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfNbrTable", "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": "/ospfNbrTable", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfNbrTable/ospfNbrEntry": { "get": { "summary": "Get ospfNbrEntry list", "description": "Retrieve list of ospfNbrEntry entries from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "The information regarding a single neighbor.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n \n storage.", "items": { "type": "object", "properties": { "ospfNbrIpAddr": { "type": "string", "description": "The IP address this neighbor is using in its\n IP source address. Note that, on addressless\n links, this will not be 0.0.0.0 but the\n \n address of another of the neighbor's interfaces.", "format": "inet:ipv4-address" }, "ospfNbrAddressLessIndex": { "type": "string", "description": "On an interface having an IP address, zero.\n On addressless interfaces, the corresponding\n value of ifIndex in the Internet Standard MIB.\n On row creation, this can be derived from the\n instance.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "ospfNbrRtrId": { "type": "string", "description": "A 32-bit integer (represented as a type\n IpAddress) uniquely identifying the neighboring\n router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfNbrOptions": { "type": "integer", "description": "A bit mask corresponding to the neighbor's\n options field.\n \n Bit 0, if set, indicates that the system will\n operate on Type of Service metrics other than\n TOS 0. If zero, the neighbor will ignore all\n metrics except the TOS 0 metric.\n \n Bit 1, if set, indicates that the associated\n area accepts and operates on external\n information; if zero, it is a stub area.\n \n Bit 2, if set, indicates that the system is\n capable of routing IP multicast datagrams, that is\n that it implements the multicast extensions to\n OSPF.\n \n Bit 3, if set, indicates that the associated\n area is an NSSA. These areas are capable of\n carrying type-7 external advertisements, which\n are translated into type-5 external advertisements\n at NSSA borders.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfNbrPriority": { "type": "string", "description": "The priority of this neighbor in the designated\n router election algorithm. The value 0 signifies\n that the neighbor is not eligible to become\n the designated router on this particular network.", "x-yang-type": "OSPF-MIB:DesignatedRouterPriority" }, "ospfNbrState": { "type": "string", "description": "The state of the relationship with this neighbor." }, "ospfNbrEvents": { "type": "integer", "description": "The number of times this neighbor relationship\n has changed state or an error has occurred.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ospfNbrLsRetransQLen": { "type": "integer", "description": "The current length of the retransmission\n queue.", "minimum": 0, "maximum": 4294967295 }, "ospfNbmaNbrStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfNbmaNbrPermanence": { "type": "string", "description": "This variable displays the status of the entry;\n 'dynamic' and 'permanent' refer to how the neighbor\n became known." }, "ospfNbrHelloSuppressed": { "type": "boolean", "description": "Indicates whether Hellos are being suppressed\n to the neighbor." }, "ospfNbrRestartHelperStatus": { "type": "string", "description": "Indicates whether the router is acting\n as a graceful restart helper for the neighbor." }, "ospfNbrRestartHelperAge": { "type": "integer", "description": "Remaining time in current OSPF graceful restart\n interval, if the router is acting as a restart\n helper for the neighbor.", "minimum": 0, "maximum": 4294967295 }, "ospfNbrRestartHelperExitReason": { "type": "string", "description": "Describes the outcome of the last attempt at acting\n as a graceful restart helper for the neighbor." } } } }, "example": { "OSPF-MIB:ospfNbrEntry": [ { "ospfNbrIpAddr": "192.168.1.1", "ospfNbrAddressLessIndex": "192.168.1.1", "ospfNbrRtrId": "example-string", "ospfNbrOptions": -2147483648, "ospfNbrPriority": "example-string", "ospfNbrState": "up(1)", "ospfNbrEvents": 0, "ospfNbrLsRetransQLen": 0, "ospfNbmaNbrStatus": "up(1)", "ospfNbmaNbrPermanence": "example-string", "ospfNbrHelloSuppressed": true, "ospfNbrRestartHelperStatus": "up(1)", "ospfNbrRestartHelperAge": 0, "ospfNbrRestartHelperExitReason": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfNbrEntry", "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": "/ospfNbrTable/ospfNbrEntry", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfVirtNbrTable": { "get": { "summary": "Get ospfVirtNbrTable data", "description": "Retrieve ospfVirtNbrTable operational data from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table describes all virtual neighbors.\n Since virtual links are configured\n in the Virtual Interface Table, this table is read-only.", "properties": { "ospfVirtNbrEntry": { "type": "array", "description": "Virtual neighbor information.", "items": { "type": "object", "properties": { "ospfVirtNbrArea": { "type": "string", "description": "The Transit Area Identifier.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfVirtNbrRtrId": { "type": "string", "description": "A 32-bit integer uniquely identifying the\n neighboring router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfVirtNbrIpAddr": { "type": "string", "description": "The IP address this virtual neighbor is using.", "format": "inet:ipv4-address" }, "ospfVirtNbrOptions": { "type": "integer", "description": "A bit mask corresponding to the neighbor's\n options field.\n \n Bit 1, if set, indicates that the system will\n operate on Type of Service metrics other than\n TOS 0. If zero, the neighbor will ignore all\n metrics except the TOS 0 metric.\n \n Bit 2, if set, indicates that the system is\n network multicast capable, i.e., that it\n implements OSPF multicast routing.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfVirtNbrState": { "type": "string", "description": "The state of the virtual neighbor relationship." }, "ospfVirtNbrEvents": { "type": "integer", "description": "The number of times this virtual link has\n changed its state or an error has occurred.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ospfVirtNbrLsRetransQLen": { "type": "integer", "description": "The current length of the retransmission\n queue.", "minimum": 0, "maximum": 4294967295 }, "ospfVirtNbrHelloSuppressed": { "type": "boolean", "description": "Indicates whether Hellos are being suppressed\n to the neighbor." }, "ospfVirtNbrRestartHelperStatus": { "type": "string", "description": "Indicates whether the router is acting\n as a graceful restart helper for the neighbor." }, "ospfVirtNbrRestartHelperAge": { "type": "integer", "description": "Remaining time in current OSPF graceful restart\n interval, if the router is acting as a restart\n helper for the neighbor.", "minimum": 0, "maximum": 4294967295 }, "ospfVirtNbrRestartHelperExitReason": { "type": "string", "description": "Describes the outcome of the last attempt at acting\n as a graceful restart helper for the neighbor." } } } } } }, "example": { "OSPF-MIB:ospfVirtNbrTable": { "ospfVirtNbrEntry": [ { "ospfVirtNbrArea": "example-string", "ospfVirtNbrRtrId": "example-string", "ospfVirtNbrIpAddr": "192.168.1.1", "ospfVirtNbrOptions": -2147483648, "ospfVirtNbrState": "up(1)", "ospfVirtNbrEvents": 0, "ospfVirtNbrLsRetransQLen": 0, "ospfVirtNbrHelloSuppressed": true, "ospfVirtNbrRestartHelperStatus": "up(1)", "ospfVirtNbrRestartHelperAge": 0, "ospfVirtNbrRestartHelperExitReason": "example-string" }, { "ospfVirtNbrArea": "example-string", "ospfVirtNbrRtrId": "example-string", "ospfVirtNbrIpAddr": "192.168.1.1", "ospfVirtNbrOptions": -2147483648, "ospfVirtNbrState": "up(1)", "ospfVirtNbrEvents": 0, "ospfVirtNbrLsRetransQLen": 0, "ospfVirtNbrHelloSuppressed": true, "ospfVirtNbrRestartHelperStatus": "up(1)", "ospfVirtNbrRestartHelperAge": 0, "ospfVirtNbrRestartHelperExitReason": "example-string" }, { "ospfVirtNbrArea": "example-string", "ospfVirtNbrRtrId": "example-string", "ospfVirtNbrIpAddr": "192.168.1.1", "ospfVirtNbrOptions": -2147483648, "ospfVirtNbrState": "up(1)", "ospfVirtNbrEvents": 0, "ospfVirtNbrLsRetransQLen": 0, "ospfVirtNbrHelloSuppressed": true, "ospfVirtNbrRestartHelperStatus": "up(1)", "ospfVirtNbrRestartHelperAge": 0, "ospfVirtNbrRestartHelperExitReason": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfVirtNbrTable", "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": "/ospfVirtNbrTable", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfVirtNbrTable/ospfVirtNbrEntry": { "get": { "summary": "Get ospfVirtNbrEntry list", "description": "Retrieve list of ospfVirtNbrEntry entries from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Virtual neighbor information.", "items": { "type": "object", "properties": { "ospfVirtNbrArea": { "type": "string", "description": "The Transit Area Identifier.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfVirtNbrRtrId": { "type": "string", "description": "A 32-bit integer uniquely identifying the\n neighboring router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfVirtNbrIpAddr": { "type": "string", "description": "The IP address this virtual neighbor is using.", "format": "inet:ipv4-address" }, "ospfVirtNbrOptions": { "type": "integer", "description": "A bit mask corresponding to the neighbor's\n options field.\n \n Bit 1, if set, indicates that the system will\n operate on Type of Service metrics other than\n TOS 0. If zero, the neighbor will ignore all\n metrics except the TOS 0 metric.\n \n Bit 2, if set, indicates that the system is\n network multicast capable, i.e., that it\n implements OSPF multicast routing.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfVirtNbrState": { "type": "string", "description": "The state of the virtual neighbor relationship." }, "ospfVirtNbrEvents": { "type": "integer", "description": "The number of times this virtual link has\n changed its state or an error has occurred.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ospfVirtNbrLsRetransQLen": { "type": "integer", "description": "The current length of the retransmission\n queue.", "minimum": 0, "maximum": 4294967295 }, "ospfVirtNbrHelloSuppressed": { "type": "boolean", "description": "Indicates whether Hellos are being suppressed\n to the neighbor." }, "ospfVirtNbrRestartHelperStatus": { "type": "string", "description": "Indicates whether the router is acting\n as a graceful restart helper for the neighbor." }, "ospfVirtNbrRestartHelperAge": { "type": "integer", "description": "Remaining time in current OSPF graceful restart\n interval, if the router is acting as a restart\n helper for the neighbor.", "minimum": 0, "maximum": 4294967295 }, "ospfVirtNbrRestartHelperExitReason": { "type": "string", "description": "Describes the outcome of the last attempt at acting\n as a graceful restart helper for the neighbor." } } } }, "example": { "OSPF-MIB:ospfVirtNbrEntry": [ { "ospfVirtNbrArea": "example-string", "ospfVirtNbrRtrId": "example-string", "ospfVirtNbrIpAddr": "192.168.1.1", "ospfVirtNbrOptions": -2147483648, "ospfVirtNbrState": "up(1)", "ospfVirtNbrEvents": 0, "ospfVirtNbrLsRetransQLen": 0, "ospfVirtNbrHelloSuppressed": true, "ospfVirtNbrRestartHelperStatus": "up(1)", "ospfVirtNbrRestartHelperAge": 0, "ospfVirtNbrRestartHelperExitReason": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfVirtNbrEntry", "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": "/ospfVirtNbrTable/ospfVirtNbrEntry", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfExtLsdbTable": { "get": { "summary": "Get ospfExtLsdbTable data", "description": "Retrieve ospfExtLsdbTable operational data from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The OSPF Process's external LSA link state database.\n \n This table is identical to the OSPF LSDB Table\n in format, but contains only external link state\n advertisements. The purpose is to allow external\n \n LSAs to be displayed once for the router rather\n than once in each non-stub area.\n \n Note that external LSAs are also in the AS-scope link state\n database.", "properties": { "ospfExtLsdbEntry": { "type": "array", "description": "A single link state advertisement.", "items": { "type": "object", "properties": { "ospfExtLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement\n format." }, "ospfExtLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing either a Router ID or an IP address;\n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address" }, "ospfExtLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfExtLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate link state\n advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfExtLsdbAge": { "type": "integer", "description": "This field is the age of the link state\n advertisement in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfExtLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete\n contents of the advertisement, excepting the\n age field. The age field is excepted so that\n an advertisement's age can be incremented\n without updating the checksum. The checksum\n used is the same that is used for ISO\n connectionless datagrams; it is commonly referred\n to as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfExtLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.", "format": "binary" } } } } } }, "example": { "OSPF-MIB:ospfExtLsdbTable": { "ospfExtLsdbEntry": [ { "ospfExtLsdbType": "ethernetCsmacd(6)", "ospfExtLsdbLsid": "example-string", "ospfExtLsdbRouterId": "example-string", "ospfExtLsdbSequence": -2147483648, "ospfExtLsdbAge": -2147483648, "ospfExtLsdbChecksum": -2147483648, "ospfExtLsdbAdvertisement": "example-string" }, { "ospfExtLsdbType": "ethernetCsmacd(6)", "ospfExtLsdbLsid": "example-string", "ospfExtLsdbRouterId": "example-string", "ospfExtLsdbSequence": -2147483648, "ospfExtLsdbAge": -2147483648, "ospfExtLsdbChecksum": -2147483648, "ospfExtLsdbAdvertisement": "example-string" }, { "ospfExtLsdbType": "ethernetCsmacd(6)", "ospfExtLsdbLsid": "example-string", "ospfExtLsdbRouterId": "example-string", "ospfExtLsdbSequence": -2147483648, "ospfExtLsdbAge": -2147483648, "ospfExtLsdbChecksum": -2147483648, "ospfExtLsdbAdvertisement": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfExtLsdbTable", "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": "/ospfExtLsdbTable", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfExtLsdbTable/ospfExtLsdbEntry": { "get": { "summary": "Get ospfExtLsdbEntry list", "description": "Retrieve list of ospfExtLsdbEntry entries from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A single link state advertisement.", "items": { "type": "object", "properties": { "ospfExtLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement\n format." }, "ospfExtLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing either a Router ID or an IP address;\n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address" }, "ospfExtLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfExtLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate link state\n advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfExtLsdbAge": { "type": "integer", "description": "This field is the age of the link state\n advertisement in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfExtLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete\n contents of the advertisement, excepting the\n age field. The age field is excepted so that\n an advertisement's age can be incremented\n without updating the checksum. The checksum\n used is the same that is used for ISO\n connectionless datagrams; it is commonly referred\n to as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfExtLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.", "format": "binary" } } } }, "example": { "OSPF-MIB:ospfExtLsdbEntry": [ { "ospfExtLsdbType": "ethernetCsmacd(6)", "ospfExtLsdbLsid": "example-string", "ospfExtLsdbRouterId": "example-string", "ospfExtLsdbSequence": -2147483648, "ospfExtLsdbAge": -2147483648, "ospfExtLsdbChecksum": -2147483648, "ospfExtLsdbAdvertisement": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfExtLsdbEntry", "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": "/ospfExtLsdbTable/ospfExtLsdbEntry", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfAreaAggregateTable": { "get": { "summary": "Get ospfAreaAggregateTable data", "description": "Retrieve ospfAreaAggregateTable operational data from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "ospfAreaAggregateTable", "properties": { "ospfAreaAggregateEntry": { "type": "array", "description": "A single area aggregate entry.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfAreaAggregateAreaID": { "type": "string", "description": "The area within which the address aggregate is to be\n found.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfAreaAggregateLsdbType": { "type": "string", "description": "The type of the address aggregate. This field\n specifies the Lsdb type that this address\n aggregate applies to." }, "ospfAreaAggregateNet": { "type": "string", "description": "The IP address of the net or subnet indicated\n by the range.", "format": "inet:ipv4-address" }, "ospfAreaAggregateMask": { "type": "string", "description": "The subnet mask that pertains to the net or\n subnet.", "format": "inet:ipv4-address" }, "ospfAreaAggregateStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfAreaAggregateEffect": { "type": "string", "description": "Subnets subsumed by ranges either trigger the\n advertisement of the indicated aggregate\n (advertiseMatching) or result in the subnet's not\n being advertised at all outside the area." }, "ospfAreaAggregateExtRouteTag": { "type": "integer", "description": "External route tag to be included in NSSA (type-7)\n LSAs.", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "OSPF-MIB:ospfAreaAggregateTable": { "ospfAreaAggregateEntry": [ { "ospfAreaAggregateAreaID": "example-string", "ospfAreaAggregateLsdbType": "ethernetCsmacd(6)", "ospfAreaAggregateNet": "example-string", "ospfAreaAggregateMask": "example-string", "ospfAreaAggregateStatus": "up(1)", "ospfAreaAggregateEffect": "example-string", "ospfAreaAggregateExtRouteTag": 0 }, { "ospfAreaAggregateAreaID": "example-string", "ospfAreaAggregateLsdbType": "ethernetCsmacd(6)", "ospfAreaAggregateNet": "example-string", "ospfAreaAggregateMask": "example-string", "ospfAreaAggregateStatus": "up(1)", "ospfAreaAggregateEffect": "example-string", "ospfAreaAggregateExtRouteTag": 0 }, { "ospfAreaAggregateAreaID": "example-string", "ospfAreaAggregateLsdbType": "ethernetCsmacd(6)", "ospfAreaAggregateNet": "example-string", "ospfAreaAggregateMask": "example-string", "ospfAreaAggregateStatus": "up(1)", "ospfAreaAggregateEffect": "example-string", "ospfAreaAggregateExtRouteTag": 0 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfAreaAggregateTable", "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": "/ospfAreaAggregateTable", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfAreaAggregateTable/ospfAreaAggregateEntry": { "get": { "summary": "Get ospfAreaAggregateEntry list", "description": "Retrieve list of ospfAreaAggregateEntry entries from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A single area aggregate entry.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfAreaAggregateAreaID": { "type": "string", "description": "The area within which the address aggregate is to be\n found.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfAreaAggregateLsdbType": { "type": "string", "description": "The type of the address aggregate. This field\n specifies the Lsdb type that this address\n aggregate applies to." }, "ospfAreaAggregateNet": { "type": "string", "description": "The IP address of the net or subnet indicated\n by the range.", "format": "inet:ipv4-address" }, "ospfAreaAggregateMask": { "type": "string", "description": "The subnet mask that pertains to the net or\n subnet.", "format": "inet:ipv4-address" }, "ospfAreaAggregateStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfAreaAggregateEffect": { "type": "string", "description": "Subnets subsumed by ranges either trigger the\n advertisement of the indicated aggregate\n (advertiseMatching) or result in the subnet's not\n being advertised at all outside the area." }, "ospfAreaAggregateExtRouteTag": { "type": "integer", "description": "External route tag to be included in NSSA (type-7)\n LSAs.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "OSPF-MIB:ospfAreaAggregateEntry": [ { "ospfAreaAggregateAreaID": "example-string", "ospfAreaAggregateLsdbType": "ethernetCsmacd(6)", "ospfAreaAggregateNet": "example-string", "ospfAreaAggregateMask": "example-string", "ospfAreaAggregateStatus": "up(1)", "ospfAreaAggregateEffect": "example-string", "ospfAreaAggregateExtRouteTag": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfAreaAggregateEntry", "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": "/ospfAreaAggregateTable/ospfAreaAggregateEntry", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfLocalLsdbTable": { "get": { "summary": "Get ospfLocalLsdbTable data", "description": "Retrieve ospfLocalLsdbTable operational data from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The OSPF Process's link-local link state database\n for non-virtual links.\n This table is identical to the OSPF LSDB Table\n in format, but contains only link-local Link State\n Advertisements for non-virtual links. The purpose is\n to allow link-local LSAs to be displayed for each\n non-virtual interface. This table is implemented to\n support type-9 LSAs that are defined\n in 'The OSPF Opaque LSA Option'.", "properties": { "ospfLocalLsdbEntry": { "type": "array", "description": "A single link state advertisement.", "items": { "type": "object", "properties": { "ospfLocalLsdbIpAddress": { "type": "string", "description": "The IP address of the interface from\n which the LSA was received if the interface is\n numbered.", "format": "inet:ipv4-address" }, "ospfLocalLsdbAddressLessIf": { "type": "string", "description": "The interface index of the interface from\n which the LSA was received if the interface is\n unnumbered.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "ospfLocalLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate\n advertisement format." }, "ospfLocalLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing a 32-bit identifier in IP address format;\n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address" }, "ospfLocalLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfLocalLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate link state\n advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfLocalLsdbAge": { "type": "integer", "description": "This field is the age of the link state\n advertisement in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfLocalLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete\n contents of the advertisement, excepting the\n age field. The age field is excepted so that\n an advertisement's age can be incremented\n without updating the checksum. The checksum\n used is the same that is used for ISO\n connectionless datagrams; it is commonly referred\n to as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfLocalLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.\n \n Note that for variable length LSAs, SNMP agents\n may not be able to return the largest string size.", "format": "binary" } } } } } }, "example": { "OSPF-MIB:ospfLocalLsdbTable": { "ospfLocalLsdbEntry": [ { "ospfLocalLsdbIpAddress": "192.168.1.1", "ospfLocalLsdbAddressLessIf": "192.168.1.1", "ospfLocalLsdbType": "ethernetCsmacd(6)", "ospfLocalLsdbLsid": "example-string", "ospfLocalLsdbRouterId": "example-string", "ospfLocalLsdbSequence": -2147483648, "ospfLocalLsdbAge": -2147483648, "ospfLocalLsdbChecksum": -2147483648, "ospfLocalLsdbAdvertisement": "example-string" }, { "ospfLocalLsdbIpAddress": "192.168.1.1", "ospfLocalLsdbAddressLessIf": "192.168.1.1", "ospfLocalLsdbType": "ethernetCsmacd(6)", "ospfLocalLsdbLsid": "example-string", "ospfLocalLsdbRouterId": "example-string", "ospfLocalLsdbSequence": -2147483648, "ospfLocalLsdbAge": -2147483648, "ospfLocalLsdbChecksum": -2147483648, "ospfLocalLsdbAdvertisement": "example-string" }, { "ospfLocalLsdbIpAddress": "192.168.1.1", "ospfLocalLsdbAddressLessIf": "192.168.1.1", "ospfLocalLsdbType": "ethernetCsmacd(6)", "ospfLocalLsdbLsid": "example-string", "ospfLocalLsdbRouterId": "example-string", "ospfLocalLsdbSequence": -2147483648, "ospfLocalLsdbAge": -2147483648, "ospfLocalLsdbChecksum": -2147483648, "ospfLocalLsdbAdvertisement": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfLocalLsdbTable", "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": "/ospfLocalLsdbTable", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfLocalLsdbTable/ospfLocalLsdbEntry": { "get": { "summary": "Get ospfLocalLsdbEntry list", "description": "Retrieve list of ospfLocalLsdbEntry entries from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A single link state advertisement.", "items": { "type": "object", "properties": { "ospfLocalLsdbIpAddress": { "type": "string", "description": "The IP address of the interface from\n which the LSA was received if the interface is\n numbered.", "format": "inet:ipv4-address" }, "ospfLocalLsdbAddressLessIf": { "type": "string", "description": "The interface index of the interface from\n which the LSA was received if the interface is\n unnumbered.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "ospfLocalLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate\n advertisement format." }, "ospfLocalLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing a 32-bit identifier in IP address format;\n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address" }, "ospfLocalLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfLocalLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate link state\n advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfLocalLsdbAge": { "type": "integer", "description": "This field is the age of the link state\n advertisement in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfLocalLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete\n contents of the advertisement, excepting the\n age field. The age field is excepted so that\n an advertisement's age can be incremented\n without updating the checksum. The checksum\n used is the same that is used for ISO\n connectionless datagrams; it is commonly referred\n to as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfLocalLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.\n \n Note that for variable length LSAs, SNMP agents\n may not be able to return the largest string size.", "format": "binary" } } } }, "example": { "OSPF-MIB:ospfLocalLsdbEntry": [ { "ospfLocalLsdbIpAddress": "192.168.1.1", "ospfLocalLsdbAddressLessIf": "192.168.1.1", "ospfLocalLsdbType": "ethernetCsmacd(6)", "ospfLocalLsdbLsid": "example-string", "ospfLocalLsdbRouterId": "example-string", "ospfLocalLsdbSequence": -2147483648, "ospfLocalLsdbAge": -2147483648, "ospfLocalLsdbChecksum": -2147483648, "ospfLocalLsdbAdvertisement": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfLocalLsdbEntry", "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": "/ospfLocalLsdbTable/ospfLocalLsdbEntry", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfVirtLocalLsdbTable": { "get": { "summary": "Get ospfVirtLocalLsdbTable data", "description": "Retrieve ospfVirtLocalLsdbTable operational data from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The OSPF Process's link-local link state database\n for virtual links.\n \n This table is identical to the OSPF LSDB Table\n in format, but contains only link-local Link State\n Advertisements for virtual links. The purpose is to\n allow link-local LSAs to be displayed for each virtual\n interface. This table is implemented to support type-9 LSAs\n that are defined in 'The OSPF Opaque LSA Option'.", "properties": { "ospfVirtLocalLsdbEntry": { "type": "array", "description": "A single link state advertisement.", "items": { "type": "object", "properties": { "ospfVirtLocalLsdbTransitArea": { "type": "string", "description": "The transit area that the virtual link\n traverses. By definition, this is not 0.0.0.0.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfVirtLocalLsdbNeighbor": { "type": "string", "description": "The Router ID of the virtual neighbor.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfVirtLocalLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate\n advertisement format." }, "ospfVirtLocalLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing a 32-bit identifier in IP address format;\n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address" }, "ospfVirtLocalLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfVirtLocalLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate link state\n advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfVirtLocalLsdbAge": { "type": "integer", "description": "This field is the age of the link state\n advertisement in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfVirtLocalLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete\n contents of the advertisement, excepting the\n age field. The age field is excepted so that\n \n an advertisement's age can be incremented\n without updating the checksum. The checksum\n used is the same that is used for ISO\n connectionless datagrams; it is commonly\n referred to as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfVirtLocalLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.", "format": "binary" } } } } } }, "example": { "OSPF-MIB:ospfVirtLocalLsdbTable": { "ospfVirtLocalLsdbEntry": [ { "ospfVirtLocalLsdbTransitArea": "example-string", "ospfVirtLocalLsdbNeighbor": "example-string", "ospfVirtLocalLsdbType": "ethernetCsmacd(6)", "ospfVirtLocalLsdbLsid": "example-string", "ospfVirtLocalLsdbRouterId": "example-string", "ospfVirtLocalLsdbSequence": -2147483648, "ospfVirtLocalLsdbAge": -2147483648, "ospfVirtLocalLsdbChecksum": -2147483648, "ospfVirtLocalLsdbAdvertisement": "example-string" }, { "ospfVirtLocalLsdbTransitArea": "example-string", "ospfVirtLocalLsdbNeighbor": "example-string", "ospfVirtLocalLsdbType": "ethernetCsmacd(6)", "ospfVirtLocalLsdbLsid": "example-string", "ospfVirtLocalLsdbRouterId": "example-string", "ospfVirtLocalLsdbSequence": -2147483648, "ospfVirtLocalLsdbAge": -2147483648, "ospfVirtLocalLsdbChecksum": -2147483648, "ospfVirtLocalLsdbAdvertisement": "example-string" }, { "ospfVirtLocalLsdbTransitArea": "example-string", "ospfVirtLocalLsdbNeighbor": "example-string", "ospfVirtLocalLsdbType": "ethernetCsmacd(6)", "ospfVirtLocalLsdbLsid": "example-string", "ospfVirtLocalLsdbRouterId": "example-string", "ospfVirtLocalLsdbSequence": -2147483648, "ospfVirtLocalLsdbAge": -2147483648, "ospfVirtLocalLsdbChecksum": -2147483648, "ospfVirtLocalLsdbAdvertisement": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfVirtLocalLsdbTable", "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": "/ospfVirtLocalLsdbTable", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfVirtLocalLsdbTable/ospfVirtLocalLsdbEntry": { "get": { "summary": "Get ospfVirtLocalLsdbEntry list", "description": "Retrieve list of ospfVirtLocalLsdbEntry entries from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A single link state advertisement.", "items": { "type": "object", "properties": { "ospfVirtLocalLsdbTransitArea": { "type": "string", "description": "The transit area that the virtual link\n traverses. By definition, this is not 0.0.0.0.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfVirtLocalLsdbNeighbor": { "type": "string", "description": "The Router ID of the virtual neighbor.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfVirtLocalLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate\n advertisement format." }, "ospfVirtLocalLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing a 32-bit identifier in IP address format;\n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address" }, "ospfVirtLocalLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfVirtLocalLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate link state\n advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfVirtLocalLsdbAge": { "type": "integer", "description": "This field is the age of the link state\n advertisement in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfVirtLocalLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete\n contents of the advertisement, excepting the\n age field. The age field is excepted so that\n \n an advertisement's age can be incremented\n without updating the checksum. The checksum\n used is the same that is used for ISO\n connectionless datagrams; it is commonly\n referred to as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfVirtLocalLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.", "format": "binary" } } } }, "example": { "OSPF-MIB:ospfVirtLocalLsdbEntry": [ { "ospfVirtLocalLsdbTransitArea": "example-string", "ospfVirtLocalLsdbNeighbor": "example-string", "ospfVirtLocalLsdbType": "ethernetCsmacd(6)", "ospfVirtLocalLsdbLsid": "example-string", "ospfVirtLocalLsdbRouterId": "example-string", "ospfVirtLocalLsdbSequence": -2147483648, "ospfVirtLocalLsdbAge": -2147483648, "ospfVirtLocalLsdbChecksum": -2147483648, "ospfVirtLocalLsdbAdvertisement": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfVirtLocalLsdbEntry", "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": "/ospfVirtLocalLsdbTable/ospfVirtLocalLsdbEntry", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfAsLsdbTable": { "get": { "summary": "Get ospfAsLsdbTable data", "description": "Retrieve ospfAsLsdbTable operational data from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The OSPF Process's AS-scope LSA link state database.\n The database contains the AS-scope Link State\n Advertisements from throughout the areas that\n the device is attached to.\n \n This table is identical to the OSPF LSDB Table\n in format, but contains only AS-scope Link State\n Advertisements. The purpose is to allow AS-scope\n LSAs to be displayed once for the router rather\n than once in each non-stub area.", "properties": { "ospfAsLsdbEntry": { "type": "array", "description": "A single link state advertisement.", "items": { "type": "object", "properties": { "ospfAsLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate\n advertisement format." }, "ospfAsLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing either a Router ID or an IP address;\n \n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address" }, "ospfAsLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfAsLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate link state\n advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfAsLsdbAge": { "type": "integer", "description": "This field is the age of the link state\n advertisement in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfAsLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete\n contents of the advertisement, excepting the\n age field. The age field is excepted so that\n an advertisement's age can be incremented\n without updating the checksum. The checksum\n used is the same that is used for ISO\n connectionless datagrams; it is commonly referred\n to as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfAsLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.", "format": "binary" } } } } } }, "example": { "OSPF-MIB:ospfAsLsdbTable": { "ospfAsLsdbEntry": [ { "ospfAsLsdbType": "ethernetCsmacd(6)", "ospfAsLsdbLsid": "example-string", "ospfAsLsdbRouterId": "example-string", "ospfAsLsdbSequence": -2147483648, "ospfAsLsdbAge": -2147483648, "ospfAsLsdbChecksum": -2147483648, "ospfAsLsdbAdvertisement": "example-string" }, { "ospfAsLsdbType": "ethernetCsmacd(6)", "ospfAsLsdbLsid": "example-string", "ospfAsLsdbRouterId": "example-string", "ospfAsLsdbSequence": -2147483648, "ospfAsLsdbAge": -2147483648, "ospfAsLsdbChecksum": -2147483648, "ospfAsLsdbAdvertisement": "example-string" }, { "ospfAsLsdbType": "ethernetCsmacd(6)", "ospfAsLsdbLsid": "example-string", "ospfAsLsdbRouterId": "example-string", "ospfAsLsdbSequence": -2147483648, "ospfAsLsdbAge": -2147483648, "ospfAsLsdbChecksum": -2147483648, "ospfAsLsdbAdvertisement": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfAsLsdbTable", "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": "/ospfAsLsdbTable", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfAsLsdbTable/ospfAsLsdbEntry": { "get": { "summary": "Get ospfAsLsdbEntry list", "description": "Retrieve list of ospfAsLsdbEntry entries from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A single link state advertisement.", "items": { "type": "object", "properties": { "ospfAsLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate\n advertisement format." }, "ospfAsLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing either a Router ID or an IP address;\n \n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address" }, "ospfAsLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfAsLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate link state\n advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfAsLsdbAge": { "type": "integer", "description": "This field is the age of the link state\n advertisement in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfAsLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete\n contents of the advertisement, excepting the\n age field. The age field is excepted so that\n an advertisement's age can be incremented\n without updating the checksum. The checksum\n used is the same that is used for ISO\n connectionless datagrams; it is commonly referred\n to as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfAsLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.", "format": "binary" } } } }, "example": { "OSPF-MIB:ospfAsLsdbEntry": [ { "ospfAsLsdbType": "ethernetCsmacd(6)", "ospfAsLsdbLsid": "example-string", "ospfAsLsdbRouterId": "example-string", "ospfAsLsdbSequence": -2147483648, "ospfAsLsdbAge": -2147483648, "ospfAsLsdbChecksum": -2147483648, "ospfAsLsdbAdvertisement": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfAsLsdbEntry", "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": "/ospfAsLsdbTable/ospfAsLsdbEntry", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfAreaLsaCountTable": { "get": { "summary": "Get ospfAreaLsaCountTable data", "description": "Retrieve ospfAreaLsaCountTable operational data from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table maintains per-area, per-LSA-type counters", "properties": { "ospfAreaLsaCountEntry": { "type": "array", "description": "An entry with a number of link advertisements\n \n of a given type for a given area.", "items": { "type": "object", "properties": { "ospfAreaLsaCountAreaId": { "type": "string", "description": "This entry Area ID.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfAreaLsaCountLsaType": { "type": "string", "description": "This entry LSA type." }, "ospfAreaLsaCountNumber": { "type": "integer", "description": "Number of LSAs of a given type for a given area.", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "OSPF-MIB:ospfAreaLsaCountTable": { "ospfAreaLsaCountEntry": [ { "ospfAreaLsaCountAreaId": "example-string", "ospfAreaLsaCountLsaType": "ethernetCsmacd(6)", "ospfAreaLsaCountNumber": 0 }, { "ospfAreaLsaCountAreaId": "example-string", "ospfAreaLsaCountLsaType": "ethernetCsmacd(6)", "ospfAreaLsaCountNumber": 0 }, { "ospfAreaLsaCountAreaId": "example-string", "ospfAreaLsaCountLsaType": "ethernetCsmacd(6)", "ospfAreaLsaCountNumber": 0 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfAreaLsaCountTable", "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": "/ospfAreaLsaCountTable", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfAreaLsaCountTable/ospfAreaLsaCountEntry": { "get": { "summary": "Get ospfAreaLsaCountEntry list", "description": "Retrieve list of ospfAreaLsaCountEntry entries from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry with a number of link advertisements\n \n of a given type for a given area.", "items": { "type": "object", "properties": { "ospfAreaLsaCountAreaId": { "type": "string", "description": "This entry Area ID.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfAreaLsaCountLsaType": { "type": "string", "description": "This entry LSA type." }, "ospfAreaLsaCountNumber": { "type": "integer", "description": "Number of LSAs of a given type for a given area.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "OSPF-MIB:ospfAreaLsaCountEntry": [ { "ospfAreaLsaCountAreaId": "example-string", "ospfAreaLsaCountLsaType": "ethernetCsmacd(6)", "ospfAreaLsaCountNumber": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfAreaLsaCountEntry", "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": "/ospfAreaLsaCountTable/ospfAreaLsaCountEntry", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfAreaEntry": { "get": { "summary": "Get ospfAreaEntry list", "description": "Retrieve list of ospfAreaEntry entries from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "ospfAreaEntry", "items": { "type": "object", "properties": { "ospfAreaId": { "type": "string", "description": "A 32-bit integer uniquely identifying an area.\n Area ID 0.0.0.0 is used for the OSPF backbone.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfAuthType": { "type": "string", "description": "The authentication type specified for an area.", "x-yang-type": "OSPF-MIB:OspfAuthenticationType" }, "ospfImportAsExtern": { "type": "string", "description": "Indicates if an area is a stub area, NSSA, or standard\n area. Type-5 AS-external LSAs and type-11 Opaque LSAs are\n not imported into stub areas or NSSAs. NSSAs import\n AS-external data as type-7 LSAs" }, "ospfSpfRuns": { "type": "integer", "description": "The number of times that the intra-area route\n table has been calculated using this area's\n link state database. This is typically done\n using Dijkstra's algorithm.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ospfAreaBdrRtrCount": { "type": "integer", "description": "The total number of Area Border Routers reachable\n within this area. This is initially zero and is\n calculated in each Shortest Path First (SPF) pass.", "minimum": 0, "maximum": 4294967295 }, "ospfAsBdrRtrCount": { "type": "integer", "description": "The total number of Autonomous System Border\n Routers reachable within this area. This is\n initially zero and is calculated in each SPF\n pass.", "minimum": 0, "maximum": 4294967295 }, "ospfAreaLsaCount": { "type": "integer", "description": "The total number of link state advertisements\n in this area's link state database, excluding\n AS-external LSAs.", "minimum": 0, "maximum": 4294967295 }, "ospfAreaLsaCksumSum": { "type": "integer", "description": "The 32-bit sum of the link state\n advertisements' LS checksums contained in this\n area's link state database. This sum excludes\n external (LS type-5) link state advertisements.\n The sum can be used to determine if there has\n been a change in a router's link state\n database, and to compare the link state database of\n two routers. The value should be treated as unsigned\n when comparing two sums of checksums.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfAreaSummary": { "type": "string", "description": "The variable ospfAreaSummary controls the\n import of summary LSAs into stub and NSSA areas.\n It has no effect on other areas.\n \n If it is noAreaSummary, the router will not\n originate summary LSAs into the stub or NSSA area.\n It will rely entirely on its default route.\n \n If it is sendAreaSummary, the router will both\n summarize and propagate summary LSAs." }, "ospfAreaStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfAreaNssaTranslatorRole": { "type": "string", "description": "Indicates an NSSA border router's ability to\n perform NSSA translation of type-7 LSAs into\n type-5 LSAs." }, "ospfAreaNssaTranslatorState": { "type": "string", "description": "Indicates if and how an NSSA border router is\n performing NSSA translation of type-7 LSAs into type-5\n \n LSAs. When this object is set to enabled, the NSSA Border\n router's OspfAreaNssaExtTranslatorRole has been set to\n always. When this object is set to elected, a candidate\n NSSA Border router is Translating type-7 LSAs into type-5.\n When this object is set to disabled, a candidate NSSA\n border router is NOT translating type-7 LSAs into type-5." }, "ospfAreaNssaTranslatorStabilityInterval": { "type": "string", "description": "The number of seconds after an elected translator\n determines its services are no longer required, that\n it should continue to perform its translation duties.", "x-yang-type": "OSPF-MIB:PositiveInteger" }, "ospfAreaNssaTranslatorEvents": { "type": "integer", "description": "Indicates the number of translator state changes\n that have occurred since the last boot-up.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "OSPF-MIB:ospfAreaEntry": [ { "ospfAreaId": "example-string", "ospfAuthType": "ethernetCsmacd(6)", "ospfImportAsExtern": "example-string", "ospfSpfRuns": 0, "ospfAreaBdrRtrCount": 0, "ospfAsBdrRtrCount": 0, "ospfAreaLsaCount": 0, "ospfAreaLsaCksumSum": -2147483648, "ospfAreaSummary": "example-string", "ospfAreaStatus": "up(1)", "ospfAreaNssaTranslatorRole": "example-string", "ospfAreaNssaTranslatorState": "up(1)", "ospfAreaNssaTranslatorStabilityInterval": "example-string", "ospfAreaNssaTranslatorEvents": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfAreaEntry-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": "/ospfAreaEntry", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfAreaEntry={ospfAreaId}": { "get": { "summary": "Get ospfAreaEntry entry", "description": "Retrieve specific ospfAreaEntry entry by key from MIB", "tags": [ "OSPF-MIB" ], "parameters": [ { "name": "ospfAreaId", "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": { "ospfAreaId": { "type": "string", "description": "A 32-bit integer uniquely identifying an area.\n Area ID 0.0.0.0 is used for the OSPF backbone.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfAuthType": { "type": "string", "description": "The authentication type specified for an area.", "x-yang-type": "OSPF-MIB:OspfAuthenticationType" }, "ospfImportAsExtern": { "type": "string", "description": "Indicates if an area is a stub area, NSSA, or standard\n area. Type-5 AS-external LSAs and type-11 Opaque LSAs are\n not imported into stub areas or NSSAs. NSSAs import\n AS-external data as type-7 LSAs" }, "ospfSpfRuns": { "type": "integer", "description": "The number of times that the intra-area route\n table has been calculated using this area's\n link state database. This is typically done\n using Dijkstra's algorithm.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ospfAreaBdrRtrCount": { "type": "integer", "description": "The total number of Area Border Routers reachable\n within this area. This is initially zero and is\n calculated in each Shortest Path First (SPF) pass.", "minimum": 0, "maximum": 4294967295 }, "ospfAsBdrRtrCount": { "type": "integer", "description": "The total number of Autonomous System Border\n Routers reachable within this area. This is\n initially zero and is calculated in each SPF\n pass.", "minimum": 0, "maximum": 4294967295 }, "ospfAreaLsaCount": { "type": "integer", "description": "The total number of link state advertisements\n in this area's link state database, excluding\n AS-external LSAs.", "minimum": 0, "maximum": 4294967295 }, "ospfAreaLsaCksumSum": { "type": "integer", "description": "The 32-bit sum of the link state\n advertisements' LS checksums contained in this\n area's link state database. This sum excludes\n external (LS type-5) link state advertisements.\n The sum can be used to determine if there has\n been a change in a router's link state\n database, and to compare the link state database of\n two routers. The value should be treated as unsigned\n when comparing two sums of checksums.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfAreaSummary": { "type": "string", "description": "The variable ospfAreaSummary controls the\n import of summary LSAs into stub and NSSA areas.\n It has no effect on other areas.\n \n If it is noAreaSummary, the router will not\n originate summary LSAs into the stub or NSSA area.\n It will rely entirely on its default route.\n \n If it is sendAreaSummary, the router will both\n summarize and propagate summary LSAs." }, "ospfAreaStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfAreaNssaTranslatorRole": { "type": "string", "description": "Indicates an NSSA border router's ability to\n perform NSSA translation of type-7 LSAs into\n type-5 LSAs." }, "ospfAreaNssaTranslatorState": { "type": "string", "description": "Indicates if and how an NSSA border router is\n performing NSSA translation of type-7 LSAs into type-5\n \n LSAs. When this object is set to enabled, the NSSA Border\n router's OspfAreaNssaExtTranslatorRole has been set to\n always. When this object is set to elected, a candidate\n NSSA Border router is Translating type-7 LSAs into type-5.\n When this object is set to disabled, a candidate NSSA\n border router is NOT translating type-7 LSAs into type-5." }, "ospfAreaNssaTranslatorStabilityInterval": { "type": "string", "description": "The number of seconds after an elected translator\n determines its services are no longer required, that\n it should continue to perform its translation duties.", "x-yang-type": "OSPF-MIB:PositiveInteger" }, "ospfAreaNssaTranslatorEvents": { "type": "integer", "description": "Indicates the number of translator state changes\n that have occurred since the last boot-up.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "OSPF-MIB:ospfAreaEntry": { "ospfAreaId": "example-string", "ospfAuthType": "ethernetCsmacd(6)", "ospfImportAsExtern": "example-string", "ospfSpfRuns": 0, "ospfAreaBdrRtrCount": 0, "ospfAsBdrRtrCount": 0, "ospfAreaLsaCount": 0, "ospfAreaLsaCksumSum": -2147483648, "ospfAreaSummary": "example-string", "ospfAreaStatus": "up(1)", "ospfAreaNssaTranslatorRole": "example-string", "ospfAreaNssaTranslatorState": "up(1)", "ospfAreaNssaTranslatorStabilityInterval": "example-string", "ospfAreaNssaTranslatorEvents": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfAreaEntry-4" }, "x-yang-path": "/ospfAreaEntry={ospfAreaId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfAreaId" ] }, "/data/OSPF-MIB:ospfStubAreaEntry": { "get": { "summary": "Get ospfStubAreaEntry list", "description": "Retrieve list of ospfStubAreaEntry entries from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "The metric for a given Type of Service that\n will be advertised by a default Area Border\n Router into a stub area.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfStubAreaId": { "type": "string", "description": "The 32-bit identifier for the stub area. On\n creation, this can be derived from the\n instance.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfStubTOS": { "type": "string", "description": "The Type of Service associated with the\n metric. On creation, this can be derived from\n \n the instance.", "x-yang-type": "OSPF-MIB:TOSType" }, "ospfStubMetric": { "type": "string", "description": "The metric value applied at the indicated Type\n of Service. By default, this equals the least\n metric at the Type of Service among the\n interfaces to other areas.", "x-yang-type": "OSPF-MIB:BigMetric" }, "ospfStubStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfStubMetricType": { "type": "string", "description": "This variable displays the type of metric\n advertised as a default route." } } } }, "example": { "OSPF-MIB:ospfStubAreaEntry": [ { "ospfStubAreaId": "example-string", "ospfStubTOS": "example-string", "ospfStubMetric": "example-string", "ospfStubStatus": "up(1)", "ospfStubMetricType": "ethernetCsmacd(6)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfStubAreaEntry-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": "/ospfStubAreaEntry", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfLsdbEntry": { "get": { "summary": "Get ospfLsdbEntry list", "description": "Retrieve list of ospfLsdbEntry entries from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A single link state advertisement.", "items": { "type": "object", "properties": { "ospfLsdbAreaId": { "type": "string", "description": "The 32-bit identifier of the area from which\n the LSA was received.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement\n format.\n \n Note: External link state advertisements are permitted\n for backward compatibility, but should be displayed\n in the ospfAsLsdbTable rather than here." }, "ospfLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing either a Router ID or an IP address;\n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address" }, "ospfLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate Link State\n Advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfLsdbAge": { "type": "integer", "description": "This field is the age of the link state advertisement\n in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete contents of\n the advertisement, excepting the age field. The age field\n is excepted so that an advertisement's age can be\n incremented without updating the checksum. The checksum\n used is the same that is used for ISO connectionless\n \n datagrams; it is commonly referred to as the\n Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.\n \n Note that for variable length LSAs, SNMP agents\n may not be able to return the largest string size.", "format": "binary" } } } }, "example": { "OSPF-MIB:ospfLsdbEntry": [ { "ospfLsdbAreaId": "example-string", "ospfLsdbType": "ethernetCsmacd(6)", "ospfLsdbLsid": "example-string", "ospfLsdbRouterId": "example-string", "ospfLsdbSequence": -2147483648, "ospfLsdbAge": -2147483648, "ospfLsdbChecksum": -2147483648, "ospfLsdbAdvertisement": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfLsdbEntry-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": "/ospfLsdbEntry", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfAreaRangeEntry": { "get": { "summary": "Get ospfAreaRangeEntry list", "description": "Retrieve list of ospfAreaRangeEntry entries from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A single area address range.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfAreaRangeAreaId": { "type": "string", "description": "The area that the address range is to be found\n within.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfAreaRangeNet": { "type": "string", "description": "The IP address of the net or subnet indicated\n by the range.", "format": "inet:ipv4-address" }, "ospfAreaRangeMask": { "type": "string", "description": "The subnet mask that pertains to the net or\n subnet.", "format": "inet:ipv4-address" }, "ospfAreaRangeStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfAreaRangeEffect": { "type": "string", "description": "Subnets subsumed by ranges either trigger the\n advertisement of the indicated summary\n (advertiseMatching) or result in the subnet's not\n being advertised at all outside the area." } } } }, "example": { "OSPF-MIB:ospfAreaRangeEntry": [ { "ospfAreaRangeAreaId": "example-string", "ospfAreaRangeNet": "example-string", "ospfAreaRangeMask": "example-string", "ospfAreaRangeStatus": "up(1)", "ospfAreaRangeEffect": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfAreaRangeEntry-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": "/ospfAreaRangeEntry", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfHostEntry": { "get": { "summary": "Get ospfHostEntry list", "description": "Retrieve list of ospfHostEntry entries from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A metric to be advertised, for a given type of\n service, when a given host is reachable.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfHostIpAddress": { "type": "string", "description": "The IP address of the host.", "format": "inet:ipv4-address" }, "ospfHostTOS": { "type": "string", "description": "The Type of Service of the route being configured.", "x-yang-type": "OSPF-MIB:TOSType" }, "ospfHostMetric": { "type": "string", "description": "The metric to be advertised.", "x-yang-type": "OSPF-MIB:Metric" }, "ospfHostStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfHostAreaID": { "type": "string", "description": "The OSPF area to which the host belongs.\n Deprecated by ospfHostCfgAreaID.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfHostCfgAreaID": { "type": "string", "description": "To configure the OSPF area to which the host belongs.", "x-yang-type": "OSPF-MIB:AreaID" } } } }, "example": { "OSPF-MIB:ospfHostEntry": [ { "ospfHostIpAddress": "192.168.1.1", "ospfHostTOS": "example-string", "ospfHostMetric": "example-string", "ospfHostStatus": "up(1)", "ospfHostAreaID": "example-string", "ospfHostCfgAreaID": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfHostEntry-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": "/ospfHostEntry", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfIfEntry": { "get": { "summary": "Get ospfIfEntry list", "description": "Retrieve list of ospfIfEntry entries from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "The OSPF interface entry describes one interface\n from the viewpoint of OSPF.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfIfIpAddress": { "type": "string", "description": "The IP address of this OSPF interface.", "format": "inet:ipv4-address" }, "ospfAddressLessIf": { "type": "string", "description": "For the purpose of easing the instancing of\n addressed and addressless interfaces; this\n variable takes the value 0 on interfaces with\n IP addresses and the corresponding value of\n ifIndex for interfaces having no IP address.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "ospfIfAreaId": { "type": "string", "description": "A 32-bit integer uniquely identifying the area\n to which the interface connects. Area ID\n 0.0.0.0 is used for the OSPF backbone.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfIfType": { "type": "string", "description": "The OSPF interface type.\n By way of a default, this field may be intuited\n from the corresponding value of ifType.\n Broadcast LANs, such as Ethernet and IEEE 802.5,\n take the value 'broadcast', X.25 and similar\n technologies take the value 'nbma', and links\n that are definitively point to point take the\n value 'pointToPoint'." }, "ospfIfAdminStat": { "type": "string", "description": "The OSPF interface's administrative status.\n The value formed on the interface, and the interface\n will be advertised as an internal route to some area.\n The value 'disabled' denotes that the interface is\n external to OSPF.", "x-yang-type": "OSPF-MIB:Status" }, "ospfIfRtrPriority": { "type": "string", "description": "The priority of this interface. Used in\n multi-access networks, this field is used in\n the designated router election algorithm. The\n value 0 signifies that the router is not eligible\n to become the designated router on this particular\n network. In the event of a tie in this value,\n routers will use their Router ID as a tie breaker.", "x-yang-type": "OSPF-MIB:DesignatedRouterPriority" }, "ospfIfTransitDelay": { "type": "string", "description": "The estimated number of seconds it takes to\n transmit a link state update packet over this\n interface. Note that the minimal value SHOULD be\n 1 second.", "x-yang-type": "OSPF-MIB:UpToMaxAge" }, "ospfIfRetransInterval": { "type": "string", "description": "The number of seconds between link state advertisement\n retransmissions, for adjacencies belonging to this\n interface. This value is also used when retransmitting\n \n database description and Link State request packets.\n Note that minimal value SHOULD be 1 second.", "x-yang-type": "OSPF-MIB:UpToMaxAge" }, "ospfIfHelloInterval": { "type": "string", "description": "The length of time, in seconds, between the Hello packets\n that the router sends on the interface. This value must be\n the same for all routers attached to a common network.", "x-yang-type": "OSPF-MIB:HelloRange" }, "ospfIfRtrDeadInterval": { "type": "string", "description": "The number of seconds that a router's Hello packets have\n not been seen before its neighbors declare the router down.\n This should be some multiple of the Hello interval. This\n value must be the same for all routers attached to a common\n network.", "x-yang-type": "OSPF-MIB:PositiveInteger" }, "ospfIfPollInterval": { "type": "string", "description": "The larger time interval, in seconds, between the Hello\n packets sent to an inactive non-broadcast multi-access\n neighbor.", "x-yang-type": "OSPF-MIB:PositiveInteger" }, "ospfIfState": { "type": "string", "description": "The OSPF Interface State." }, "ospfIfDesignatedRouter": { "type": "string", "description": "The IP address of the designated router.", "format": "inet:ipv4-address" }, "ospfIfBackupDesignatedRouter": { "type": "string", "description": "The IP address of the backup designated\n router.", "format": "inet:ipv4-address" }, "ospfIfEvents": { "type": "integer", "description": "The number of times this OSPF interface has\n changed its state or an error has occurred.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ospfIfAuthKey": { "type": "string", "description": "The cleartext password used as an OSPF\n authentication key when simplePassword security\n is enabled. This object does not access any OSPF\n cryptogaphic (e.g., MD5) authentication key under\n any circumstance.\n \n If the key length is shorter than 8 octets, the\n agent will left adjust and zero fill to 8 octets.\n \n Unauthenticated interfaces need no authentication\n key, and simple password authentication cannot use\n a key of more than 8 octets.\n \n Note that the use of simplePassword authentication\n is NOT recommended when there is concern regarding\n attack upon the OSPF system. SimplePassword\n authentication is only sufficient to protect against\n accidental misconfigurations because it re-uses\n cleartext passwords [RFC1704].\n \n When read, ospfIfAuthKey always returns an octet\n string of length zero.", "format": "binary" }, "ospfIfStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfIfMulticastForwarding": { "type": "string", "description": "The way multicasts should be forwarded on this\n interface: not forwarded, forwarded as data\n link multicasts, or forwarded as data link\n unicasts. Data link multicasting is not\n meaningful on point-to-point and NBMA interfaces,\n and setting ospfMulticastForwarding to 0 effectively\n disables all multicast forwarding." }, "ospfIfDemand": { "type": "boolean", "description": "Indicates whether Demand OSPF procedures (hello\n suppression to FULL neighbors and setting the\n DoNotAge flag on propagated LSAs) should be\n performed on this interface." }, "ospfIfAuthType": { "type": "string", "description": "The authentication type specified for an interface.\n \n Note that this object can be used to engage\n in significant attacks against an OSPF router.", "x-yang-type": "OSPF-MIB:OspfAuthenticationType" }, "ospfIfLsaCount": { "type": "integer", "description": "The total number of link-local link state advertisements\n in this interface's link-local link state database.", "minimum": 0, "maximum": 4294967295 }, "ospfIfLsaCksumSum": { "type": "integer", "description": "The 32-bit unsigned sum of the Link State\n Advertisements' LS checksums contained in this\n interface's link-local link state database.\n The sum can be used to determine if there has\n been a change in the interface's link state\n database and to compare the interface link state\n database of routers attached to the same subnet.", "minimum": 0, "maximum": 4294967295 }, "ospfIfDesignatedRouterId": { "type": "string", "description": "The Router ID of the designated router.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfIfBackupDesignatedRouterId": { "type": "string", "description": "The Router ID of the backup designated router.", "x-yang-type": "OSPF-MIB:RouterID" } } } }, "example": { "OSPF-MIB:ospfIfEntry": [ { "ospfIfIpAddress": "192.168.1.1", "ospfAddressLessIf": "192.168.1.1", "ospfIfAreaId": "example-string", "ospfIfType": "ethernetCsmacd(6)", "ospfIfAdminStat": "example-string", "ospfIfRtrPriority": "example-string", "ospfIfTransitDelay": "example-string", "ospfIfRetransInterval": "example-string", "ospfIfHelloInterval": "example-string", "ospfIfRtrDeadInterval": "example-string", "ospfIfPollInterval": "example-string", "ospfIfState": "up(1)", "ospfIfDesignatedRouter": "example-string", "ospfIfBackupDesignatedRouter": "example-string", "ospfIfEvents": 0, "ospfIfAuthKey": "example-string", "ospfIfStatus": "up(1)", "ospfIfMulticastForwarding": "example-string", "ospfIfDemand": true, "ospfIfAuthType": "ethernetCsmacd(6)", "ospfIfLsaCount": 0, "ospfIfLsaCksumSum": 0, "ospfIfDesignatedRouterId": "example-string", "ospfIfBackupDesignatedRouterId": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfIfEntry-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": "/ospfIfEntry", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfIfMetricEntry": { "get": { "summary": "Get ospfIfMetricEntry list", "description": "Retrieve list of ospfIfMetricEntry entries from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A particular TOS metric for a non-virtual interface\n identified by the interface index.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfIfMetricIpAddress": { "type": "string", "description": "The IP address of this OSPF interface. On row\n creation, this can be derived from the instance.", "format": "inet:ipv4-address" }, "ospfIfMetricAddressLessIf": { "type": "string", "description": "For the purpose of easing the instancing of\n addressed and addressless interfaces; this\n variable takes the value 0 on interfaces with\n IP addresses and the value of ifIndex for\n interfaces having no IP address. On row\n creation, this can be derived from the instance.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "ospfIfMetricTOS": { "type": "string", "description": "The Type of Service metric being referenced.\n On row creation, this can be derived from the\n instance.", "x-yang-type": "OSPF-MIB:TOSType" }, "ospfIfMetricValue": { "type": "string", "description": "The metric of using this Type of Service on\n this interface. The default value of the TOS 0\n metric is 10^8 / ifSpeed.", "x-yang-type": "OSPF-MIB:Metric" }, "ospfIfMetricStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "OSPF-MIB:ospfIfMetricEntry": [ { "ospfIfMetricIpAddress": "192.168.1.1", "ospfIfMetricAddressLessIf": "192.168.1.1", "ospfIfMetricTOS": "example-string", "ospfIfMetricValue": "example-string", "ospfIfMetricStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfIfMetricEntry-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": "/ospfIfMetricEntry", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfVirtIfEntry": { "get": { "summary": "Get ospfVirtIfEntry list", "description": "Retrieve list of ospfVirtIfEntry entries from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about a single virtual interface.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfVirtIfAreaId": { "type": "string", "description": "The transit area that the virtual link\n traverses. By definition, this is not 0.0.0.0.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfVirtIfNeighbor": { "type": "string", "description": "The Router ID of the virtual neighbor.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfVirtIfTransitDelay": { "type": "string", "description": "The estimated number of seconds it takes to\n transmit a Link State update packet over this\n interface. Note that the minimal value SHOULD be\n 1 second.", "x-yang-type": "OSPF-MIB:UpToMaxAge" }, "ospfVirtIfRetransInterval": { "type": "string", "description": "The number of seconds between link state\n avertisement retransmissions, for adjacencies\n belonging to this interface. This value is\n also used when retransmitting database\n description and Link State request packets. This\n value should be well over the expected\n round-trip time. Note that the minimal value SHOULD be\n 1 second.", "x-yang-type": "OSPF-MIB:UpToMaxAge" }, "ospfVirtIfHelloInterval": { "type": "string", "description": "The length of time, in seconds, between the\n Hello packets that the router sends on the\n interface. This value must be the same for the\n virtual neighbor.", "x-yang-type": "OSPF-MIB:HelloRange" }, "ospfVirtIfRtrDeadInterval": { "type": "string", "description": "The number of seconds that a router's Hello\n packets have not been seen before its\n neighbors declare the router down. This should be\n some multiple of the Hello interval. This\n value must be the same for the virtual neighbor.", "x-yang-type": "OSPF-MIB:PositiveInteger" }, "ospfVirtIfState": { "type": "string", "description": "OSPF virtual interface states." }, "ospfVirtIfEvents": { "type": "integer", "description": "The number of state changes or error events on\n this virtual link.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ospfVirtIfAuthKey": { "type": "string", "description": "The cleartext password used as an OSPF\n authentication key when simplePassword security\n is enabled. This object does not access any OSPF\n cryptogaphic (e.g., MD5) authentication key under\n any circumstance.\n \n If the key length is shorter than 8 octets, the\n agent will left adjust and zero fill to 8 octets.\n \n Unauthenticated interfaces need no authentication\n key, and simple password authentication cannot use\n a key of more than 8 octets.\n \n Note that the use of simplePassword authentication\n is NOT recommended when there is concern regarding\n attack upon the OSPF system. SimplePassword\n authentication is only sufficient to protect against\n accidental misconfigurations because it re-uses\n cleartext passwords. [RFC1704]\n \n When read, ospfIfAuthKey always returns an octet\n string of length zero.", "format": "binary" }, "ospfVirtIfStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfVirtIfAuthType": { "type": "string", "description": "The authentication type specified for a virtual interface.\n \n Note that this object can be used to engage\n in significant attacks against an OSPF router.", "x-yang-type": "OSPF-MIB:OspfAuthenticationType" }, "ospfVirtIfLsaCount": { "type": "integer", "description": "The total number of link-local link state advertisements\n in this virtual interface's link-local link state database.", "minimum": 0, "maximum": 4294967295 }, "ospfVirtIfLsaCksumSum": { "type": "integer", "description": "The 32-bit unsigned sum of the link state\n advertisements' LS checksums contained in this\n virtual interface's link-local link state database.\n The sum can be used to determine if there has\n been a change in the virtual interface's link state\n database, and to compare the virtual interface\n link state database of the virtual neighbors.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "OSPF-MIB:ospfVirtIfEntry": [ { "ospfVirtIfAreaId": "example-string", "ospfVirtIfNeighbor": "example-string", "ospfVirtIfTransitDelay": "example-string", "ospfVirtIfRetransInterval": "example-string", "ospfVirtIfHelloInterval": "example-string", "ospfVirtIfRtrDeadInterval": "example-string", "ospfVirtIfState": "up(1)", "ospfVirtIfEvents": 0, "ospfVirtIfAuthKey": "example-string", "ospfVirtIfStatus": "up(1)", "ospfVirtIfAuthType": "ethernetCsmacd(6)", "ospfVirtIfLsaCount": 0, "ospfVirtIfLsaCksumSum": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfVirtIfEntry-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": "/ospfVirtIfEntry", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfNbrEntry": { "get": { "summary": "Get ospfNbrEntry list", "description": "Retrieve list of ospfNbrEntry entries from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "The information regarding a single neighbor.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n \n storage.", "items": { "type": "object", "properties": { "ospfNbrIpAddr": { "type": "string", "description": "The IP address this neighbor is using in its\n IP source address. Note that, on addressless\n links, this will not be 0.0.0.0 but the\n \n address of another of the neighbor's interfaces.", "format": "inet:ipv4-address" }, "ospfNbrAddressLessIndex": { "type": "string", "description": "On an interface having an IP address, zero.\n On addressless interfaces, the corresponding\n value of ifIndex in the Internet Standard MIB.\n On row creation, this can be derived from the\n instance.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "ospfNbrRtrId": { "type": "string", "description": "A 32-bit integer (represented as a type\n IpAddress) uniquely identifying the neighboring\n router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfNbrOptions": { "type": "integer", "description": "A bit mask corresponding to the neighbor's\n options field.\n \n Bit 0, if set, indicates that the system will\n operate on Type of Service metrics other than\n TOS 0. If zero, the neighbor will ignore all\n metrics except the TOS 0 metric.\n \n Bit 1, if set, indicates that the associated\n area accepts and operates on external\n information; if zero, it is a stub area.\n \n Bit 2, if set, indicates that the system is\n capable of routing IP multicast datagrams, that is\n that it implements the multicast extensions to\n OSPF.\n \n Bit 3, if set, indicates that the associated\n area is an NSSA. These areas are capable of\n carrying type-7 external advertisements, which\n are translated into type-5 external advertisements\n at NSSA borders.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfNbrPriority": { "type": "string", "description": "The priority of this neighbor in the designated\n router election algorithm. The value 0 signifies\n that the neighbor is not eligible to become\n the designated router on this particular network.", "x-yang-type": "OSPF-MIB:DesignatedRouterPriority" }, "ospfNbrState": { "type": "string", "description": "The state of the relationship with this neighbor." }, "ospfNbrEvents": { "type": "integer", "description": "The number of times this neighbor relationship\n has changed state or an error has occurred.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ospfNbrLsRetransQLen": { "type": "integer", "description": "The current length of the retransmission\n queue.", "minimum": 0, "maximum": 4294967295 }, "ospfNbmaNbrStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfNbmaNbrPermanence": { "type": "string", "description": "This variable displays the status of the entry;\n 'dynamic' and 'permanent' refer to how the neighbor\n became known." }, "ospfNbrHelloSuppressed": { "type": "boolean", "description": "Indicates whether Hellos are being suppressed\n to the neighbor." }, "ospfNbrRestartHelperStatus": { "type": "string", "description": "Indicates whether the router is acting\n as a graceful restart helper for the neighbor." }, "ospfNbrRestartHelperAge": { "type": "integer", "description": "Remaining time in current OSPF graceful restart\n interval, if the router is acting as a restart\n helper for the neighbor.", "minimum": 0, "maximum": 4294967295 }, "ospfNbrRestartHelperExitReason": { "type": "string", "description": "Describes the outcome of the last attempt at acting\n as a graceful restart helper for the neighbor." } } } }, "example": { "OSPF-MIB:ospfNbrEntry": [ { "ospfNbrIpAddr": "192.168.1.1", "ospfNbrAddressLessIndex": "192.168.1.1", "ospfNbrRtrId": "example-string", "ospfNbrOptions": -2147483648, "ospfNbrPriority": "example-string", "ospfNbrState": "up(1)", "ospfNbrEvents": 0, "ospfNbrLsRetransQLen": 0, "ospfNbmaNbrStatus": "up(1)", "ospfNbmaNbrPermanence": "example-string", "ospfNbrHelloSuppressed": true, "ospfNbrRestartHelperStatus": "up(1)", "ospfNbrRestartHelperAge": 0, "ospfNbrRestartHelperExitReason": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfNbrEntry-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": "/ospfNbrEntry", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfVirtNbrEntry": { "get": { "summary": "Get ospfVirtNbrEntry list", "description": "Retrieve list of ospfVirtNbrEntry entries from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Virtual neighbor information.", "items": { "type": "object", "properties": { "ospfVirtNbrArea": { "type": "string", "description": "The Transit Area Identifier.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfVirtNbrRtrId": { "type": "string", "description": "A 32-bit integer uniquely identifying the\n neighboring router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfVirtNbrIpAddr": { "type": "string", "description": "The IP address this virtual neighbor is using.", "format": "inet:ipv4-address" }, "ospfVirtNbrOptions": { "type": "integer", "description": "A bit mask corresponding to the neighbor's\n options field.\n \n Bit 1, if set, indicates that the system will\n operate on Type of Service metrics other than\n TOS 0. If zero, the neighbor will ignore all\n metrics except the TOS 0 metric.\n \n Bit 2, if set, indicates that the system is\n network multicast capable, i.e., that it\n implements OSPF multicast routing.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfVirtNbrState": { "type": "string", "description": "The state of the virtual neighbor relationship." }, "ospfVirtNbrEvents": { "type": "integer", "description": "The number of times this virtual link has\n changed its state or an error has occurred.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ospfVirtNbrLsRetransQLen": { "type": "integer", "description": "The current length of the retransmission\n queue.", "minimum": 0, "maximum": 4294967295 }, "ospfVirtNbrHelloSuppressed": { "type": "boolean", "description": "Indicates whether Hellos are being suppressed\n to the neighbor." }, "ospfVirtNbrRestartHelperStatus": { "type": "string", "description": "Indicates whether the router is acting\n as a graceful restart helper for the neighbor." }, "ospfVirtNbrRestartHelperAge": { "type": "integer", "description": "Remaining time in current OSPF graceful restart\n interval, if the router is acting as a restart\n helper for the neighbor.", "minimum": 0, "maximum": 4294967295 }, "ospfVirtNbrRestartHelperExitReason": { "type": "string", "description": "Describes the outcome of the last attempt at acting\n as a graceful restart helper for the neighbor." } } } }, "example": { "OSPF-MIB:ospfVirtNbrEntry": [ { "ospfVirtNbrArea": "example-string", "ospfVirtNbrRtrId": "example-string", "ospfVirtNbrIpAddr": "192.168.1.1", "ospfVirtNbrOptions": -2147483648, "ospfVirtNbrState": "up(1)", "ospfVirtNbrEvents": 0, "ospfVirtNbrLsRetransQLen": 0, "ospfVirtNbrHelloSuppressed": true, "ospfVirtNbrRestartHelperStatus": "up(1)", "ospfVirtNbrRestartHelperAge": 0, "ospfVirtNbrRestartHelperExitReason": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfVirtNbrEntry-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": "/ospfVirtNbrEntry", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfExtLsdbEntry": { "get": { "summary": "Get ospfExtLsdbEntry list", "description": "Retrieve list of ospfExtLsdbEntry entries from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A single link state advertisement.", "items": { "type": "object", "properties": { "ospfExtLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement\n format." }, "ospfExtLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing either a Router ID or an IP address;\n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address" }, "ospfExtLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfExtLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate link state\n advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfExtLsdbAge": { "type": "integer", "description": "This field is the age of the link state\n advertisement in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfExtLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete\n contents of the advertisement, excepting the\n age field. The age field is excepted so that\n an advertisement's age can be incremented\n without updating the checksum. The checksum\n used is the same that is used for ISO\n connectionless datagrams; it is commonly referred\n to as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfExtLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.", "format": "binary" } } } }, "example": { "OSPF-MIB:ospfExtLsdbEntry": [ { "ospfExtLsdbType": "ethernetCsmacd(6)", "ospfExtLsdbLsid": "example-string", "ospfExtLsdbRouterId": "example-string", "ospfExtLsdbSequence": -2147483648, "ospfExtLsdbAge": -2147483648, "ospfExtLsdbChecksum": -2147483648, "ospfExtLsdbAdvertisement": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfExtLsdbEntry-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": "/ospfExtLsdbEntry", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfAreaAggregateEntry": { "get": { "summary": "Get ospfAreaAggregateEntry list", "description": "Retrieve list of ospfAreaAggregateEntry entries from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A single area aggregate entry.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfAreaAggregateAreaID": { "type": "string", "description": "The area within which the address aggregate is to be\n found.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfAreaAggregateLsdbType": { "type": "string", "description": "The type of the address aggregate. This field\n specifies the Lsdb type that this address\n aggregate applies to." }, "ospfAreaAggregateNet": { "type": "string", "description": "The IP address of the net or subnet indicated\n by the range.", "format": "inet:ipv4-address" }, "ospfAreaAggregateMask": { "type": "string", "description": "The subnet mask that pertains to the net or\n subnet.", "format": "inet:ipv4-address" }, "ospfAreaAggregateStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfAreaAggregateEffect": { "type": "string", "description": "Subnets subsumed by ranges either trigger the\n advertisement of the indicated aggregate\n (advertiseMatching) or result in the subnet's not\n being advertised at all outside the area." }, "ospfAreaAggregateExtRouteTag": { "type": "integer", "description": "External route tag to be included in NSSA (type-7)\n LSAs.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "OSPF-MIB:ospfAreaAggregateEntry": [ { "ospfAreaAggregateAreaID": "example-string", "ospfAreaAggregateLsdbType": "ethernetCsmacd(6)", "ospfAreaAggregateNet": "example-string", "ospfAreaAggregateMask": "example-string", "ospfAreaAggregateStatus": "up(1)", "ospfAreaAggregateEffect": "example-string", "ospfAreaAggregateExtRouteTag": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfAreaAggregateEntry-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": "/ospfAreaAggregateEntry", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfLocalLsdbEntry": { "get": { "summary": "Get ospfLocalLsdbEntry list", "description": "Retrieve list of ospfLocalLsdbEntry entries from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A single link state advertisement.", "items": { "type": "object", "properties": { "ospfLocalLsdbIpAddress": { "type": "string", "description": "The IP address of the interface from\n which the LSA was received if the interface is\n numbered.", "format": "inet:ipv4-address" }, "ospfLocalLsdbAddressLessIf": { "type": "string", "description": "The interface index of the interface from\n which the LSA was received if the interface is\n unnumbered.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "ospfLocalLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate\n advertisement format." }, "ospfLocalLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing a 32-bit identifier in IP address format;\n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address" }, "ospfLocalLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfLocalLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate link state\n advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfLocalLsdbAge": { "type": "integer", "description": "This field is the age of the link state\n advertisement in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfLocalLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete\n contents of the advertisement, excepting the\n age field. The age field is excepted so that\n an advertisement's age can be incremented\n without updating the checksum. The checksum\n used is the same that is used for ISO\n connectionless datagrams; it is commonly referred\n to as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfLocalLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.\n \n Note that for variable length LSAs, SNMP agents\n may not be able to return the largest string size.", "format": "binary" } } } }, "example": { "OSPF-MIB:ospfLocalLsdbEntry": [ { "ospfLocalLsdbIpAddress": "192.168.1.1", "ospfLocalLsdbAddressLessIf": "192.168.1.1", "ospfLocalLsdbType": "ethernetCsmacd(6)", "ospfLocalLsdbLsid": "example-string", "ospfLocalLsdbRouterId": "example-string", "ospfLocalLsdbSequence": -2147483648, "ospfLocalLsdbAge": -2147483648, "ospfLocalLsdbChecksum": -2147483648, "ospfLocalLsdbAdvertisement": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfLocalLsdbEntry-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": "/ospfLocalLsdbEntry", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfVirtLocalLsdbEntry": { "get": { "summary": "Get ospfVirtLocalLsdbEntry list", "description": "Retrieve list of ospfVirtLocalLsdbEntry entries from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A single link state advertisement.", "items": { "type": "object", "properties": { "ospfVirtLocalLsdbTransitArea": { "type": "string", "description": "The transit area that the virtual link\n traverses. By definition, this is not 0.0.0.0.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfVirtLocalLsdbNeighbor": { "type": "string", "description": "The Router ID of the virtual neighbor.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfVirtLocalLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate\n advertisement format." }, "ospfVirtLocalLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing a 32-bit identifier in IP address format;\n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address" }, "ospfVirtLocalLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfVirtLocalLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate link state\n advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfVirtLocalLsdbAge": { "type": "integer", "description": "This field is the age of the link state\n advertisement in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfVirtLocalLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete\n contents of the advertisement, excepting the\n age field. The age field is excepted so that\n \n an advertisement's age can be incremented\n without updating the checksum. The checksum\n used is the same that is used for ISO\n connectionless datagrams; it is commonly\n referred to as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfVirtLocalLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.", "format": "binary" } } } }, "example": { "OSPF-MIB:ospfVirtLocalLsdbEntry": [ { "ospfVirtLocalLsdbTransitArea": "example-string", "ospfVirtLocalLsdbNeighbor": "example-string", "ospfVirtLocalLsdbType": "ethernetCsmacd(6)", "ospfVirtLocalLsdbLsid": "example-string", "ospfVirtLocalLsdbRouterId": "example-string", "ospfVirtLocalLsdbSequence": -2147483648, "ospfVirtLocalLsdbAge": -2147483648, "ospfVirtLocalLsdbChecksum": -2147483648, "ospfVirtLocalLsdbAdvertisement": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfVirtLocalLsdbEntry-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": "/ospfVirtLocalLsdbEntry", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfAsLsdbEntry": { "get": { "summary": "Get ospfAsLsdbEntry list", "description": "Retrieve list of ospfAsLsdbEntry entries from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A single link state advertisement.", "items": { "type": "object", "properties": { "ospfAsLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate\n advertisement format." }, "ospfAsLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing either a Router ID or an IP address;\n \n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address" }, "ospfAsLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfAsLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate link state\n advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfAsLsdbAge": { "type": "integer", "description": "This field is the age of the link state\n advertisement in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfAsLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete\n contents of the advertisement, excepting the\n age field. The age field is excepted so that\n an advertisement's age can be incremented\n without updating the checksum. The checksum\n used is the same that is used for ISO\n connectionless datagrams; it is commonly referred\n to as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfAsLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.", "format": "binary" } } } }, "example": { "OSPF-MIB:ospfAsLsdbEntry": [ { "ospfAsLsdbType": "ethernetCsmacd(6)", "ospfAsLsdbLsid": "example-string", "ospfAsLsdbRouterId": "example-string", "ospfAsLsdbSequence": -2147483648, "ospfAsLsdbAge": -2147483648, "ospfAsLsdbChecksum": -2147483648, "ospfAsLsdbAdvertisement": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfAsLsdbEntry-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": "/ospfAsLsdbEntry", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfAreaLsaCountEntry": { "get": { "summary": "Get ospfAreaLsaCountEntry list", "description": "Retrieve list of ospfAreaLsaCountEntry entries from MIB", "tags": [ "OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry with a number of link advertisements\n \n of a given type for a given area.", "items": { "type": "object", "properties": { "ospfAreaLsaCountAreaId": { "type": "string", "description": "This entry Area ID.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfAreaLsaCountLsaType": { "type": "string", "description": "This entry LSA type." }, "ospfAreaLsaCountNumber": { "type": "integer", "description": "Number of LSAs of a given type for a given area.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "OSPF-MIB:ospfAreaLsaCountEntry": [ { "ospfAreaLsaCountAreaId": "example-string", "ospfAreaLsaCountLsaType": "ethernetCsmacd(6)", "ospfAreaLsaCountNumber": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfAreaLsaCountEntry-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": "/ospfAreaLsaCountEntry", "x-restconf-kind": "container" }, "/data/OSPF-MIB:ospfStubAreaTable/ospfStubAreaEntry={ospfStubAreaId},{ospfStubTOS}": { "get": { "summary": "Get ospfStubAreaEntry entry", "description": "Retrieve specific ospfStubAreaEntry entry by key from MIB", "tags": [ "OSPF-MIB" ], "parameters": [ { "name": "ospfStubAreaId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfStubTOS", "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": { "ospfStubAreaId": { "type": "string", "description": "The 32-bit identifier for the stub area. On\n creation, this can be derived from the\n instance.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfStubTOS": { "type": "string", "description": "The Type of Service associated with the\n metric. On creation, this can be derived from\n \n the instance.", "x-yang-type": "OSPF-MIB:TOSType" }, "ospfStubMetric": { "type": "string", "description": "The metric value applied at the indicated Type\n of Service. By default, this equals the least\n metric at the Type of Service among the\n interfaces to other areas.", "x-yang-type": "OSPF-MIB:BigMetric" }, "ospfStubStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfStubMetricType": { "type": "string", "description": "This variable displays the type of metric\n advertised as a default route." } } }, "example": { "OSPF-MIB:ospfStubAreaEntry": { "ospfStubAreaId": "example-string", "ospfStubTOS": "example-string", "ospfStubMetric": "example-string", "ospfStubStatus": "up(1)", "ospfStubMetricType": "ethernetCsmacd(6)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfStubAreaEntry-2" }, "x-yang-path": "/ospfStubAreaTable/ospfStubAreaEntry={ospfStubAreaId ospfStubTOS}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfStubAreaId ospfStubTOS" ] }, "/data/OSPF-MIB:ospfLsdbTable/ospfLsdbEntry={ospfLsdbAreaId},{ospfLsdbType},{ospfLsdbLsid},{ospfLsdbRouterId}": { "get": { "summary": "Get ospfLsdbEntry entry", "description": "Retrieve specific ospfLsdbEntry entry by key from MIB", "tags": [ "OSPF-MIB" ], "parameters": [ { "name": "ospfLsdbAreaId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfLsdbType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfLsdbLsid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfLsdbRouterId", "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": { "ospfLsdbAreaId": { "type": "string", "description": "The 32-bit identifier of the area from which\n the LSA was received.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement\n format.\n \n Note: External link state advertisements are permitted\n for backward compatibility, but should be displayed\n in the ospfAsLsdbTable rather than here." }, "ospfLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing either a Router ID or an IP address;\n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address" }, "ospfLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate Link State\n Advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfLsdbAge": { "type": "integer", "description": "This field is the age of the link state advertisement\n in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete contents of\n the advertisement, excepting the age field. The age field\n is excepted so that an advertisement's age can be\n incremented without updating the checksum. The checksum\n used is the same that is used for ISO connectionless\n \n datagrams; it is commonly referred to as the\n Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.\n \n Note that for variable length LSAs, SNMP agents\n may not be able to return the largest string size.", "format": "binary" } } }, "example": { "OSPF-MIB:ospfLsdbEntry": { "ospfLsdbAreaId": "example-string", "ospfLsdbType": "ethernetCsmacd(6)", "ospfLsdbLsid": "example-string", "ospfLsdbRouterId": "example-string", "ospfLsdbSequence": -2147483648, "ospfLsdbAge": -2147483648, "ospfLsdbChecksum": -2147483648, "ospfLsdbAdvertisement": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfLsdbEntry-2" }, "x-yang-path": "/ospfLsdbTable/ospfLsdbEntry={ospfLsdbAreaId ospfLsdbType ospfLsdbLsid ospfLsdbRouterId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfLsdbAreaId ospfLsdbType ospfLsdbLsid ospfLsdbRouterId" ] }, "/data/OSPF-MIB:ospfAreaRangeTable/ospfAreaRangeEntry={ospfAreaRangeAreaId},{ospfAreaRangeNet}": { "get": { "summary": "Get ospfAreaRangeEntry entry", "description": "Retrieve specific ospfAreaRangeEntry entry by key from MIB", "tags": [ "OSPF-MIB" ], "parameters": [ { "name": "ospfAreaRangeAreaId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfAreaRangeNet", "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": { "ospfAreaRangeAreaId": { "type": "string", "description": "The area that the address range is to be found\n within.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfAreaRangeNet": { "type": "string", "description": "The IP address of the net or subnet indicated\n by the range.", "format": "inet:ipv4-address" }, "ospfAreaRangeMask": { "type": "string", "description": "The subnet mask that pertains to the net or\n subnet.", "format": "inet:ipv4-address" }, "ospfAreaRangeStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfAreaRangeEffect": { "type": "string", "description": "Subnets subsumed by ranges either trigger the\n advertisement of the indicated summary\n (advertiseMatching) or result in the subnet's not\n being advertised at all outside the area." } } }, "example": { "OSPF-MIB:ospfAreaRangeEntry": { "ospfAreaRangeAreaId": "example-string", "ospfAreaRangeNet": "example-string", "ospfAreaRangeMask": "example-string", "ospfAreaRangeStatus": "up(1)", "ospfAreaRangeEffect": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfAreaRangeEntry-2" }, "x-yang-path": "/ospfAreaRangeTable/ospfAreaRangeEntry={ospfAreaRangeAreaId ospfAreaRangeNet}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfAreaRangeAreaId ospfAreaRangeNet" ] }, "/data/OSPF-MIB:ospfHostTable/ospfHostEntry={ospfHostIpAddress},{ospfHostTOS}": { "get": { "summary": "Get ospfHostEntry entry", "description": "Retrieve specific ospfHostEntry entry by key from MIB", "tags": [ "OSPF-MIB" ], "parameters": [ { "name": "ospfHostIpAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfHostTOS", "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": { "ospfHostIpAddress": { "type": "string", "description": "The IP address of the host.", "format": "inet:ipv4-address" }, "ospfHostTOS": { "type": "string", "description": "The Type of Service of the route being configured.", "x-yang-type": "OSPF-MIB:TOSType" }, "ospfHostMetric": { "type": "string", "description": "The metric to be advertised.", "x-yang-type": "OSPF-MIB:Metric" }, "ospfHostStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfHostAreaID": { "type": "string", "description": "The OSPF area to which the host belongs.\n Deprecated by ospfHostCfgAreaID.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfHostCfgAreaID": { "type": "string", "description": "To configure the OSPF area to which the host belongs.", "x-yang-type": "OSPF-MIB:AreaID" } } }, "example": { "OSPF-MIB:ospfHostEntry": { "ospfHostIpAddress": "192.168.1.1", "ospfHostTOS": "example-string", "ospfHostMetric": "example-string", "ospfHostStatus": "up(1)", "ospfHostAreaID": "example-string", "ospfHostCfgAreaID": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfHostEntry-2" }, "x-yang-path": "/ospfHostTable/ospfHostEntry={ospfHostIpAddress ospfHostTOS}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfHostIpAddress ospfHostTOS" ] }, "/data/OSPF-MIB:ospfIfTable/ospfIfEntry={ospfIfIpAddress},{ospfAddressLessIf}": { "get": { "summary": "Get ospfIfEntry entry", "description": "Retrieve specific ospfIfEntry entry by key from MIB", "tags": [ "OSPF-MIB" ], "parameters": [ { "name": "ospfIfIpAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfAddressLessIf", "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": { "ospfIfIpAddress": { "type": "string", "description": "The IP address of this OSPF interface.", "format": "inet:ipv4-address" }, "ospfAddressLessIf": { "type": "string", "description": "For the purpose of easing the instancing of\n addressed and addressless interfaces; this\n variable takes the value 0 on interfaces with\n IP addresses and the corresponding value of\n ifIndex for interfaces having no IP address.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "ospfIfAreaId": { "type": "string", "description": "A 32-bit integer uniquely identifying the area\n to which the interface connects. Area ID\n 0.0.0.0 is used for the OSPF backbone.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfIfType": { "type": "string", "description": "The OSPF interface type.\n By way of a default, this field may be intuited\n from the corresponding value of ifType.\n Broadcast LANs, such as Ethernet and IEEE 802.5,\n take the value 'broadcast', X.25 and similar\n technologies take the value 'nbma', and links\n that are definitively point to point take the\n value 'pointToPoint'." }, "ospfIfAdminStat": { "type": "string", "description": "The OSPF interface's administrative status.\n The value formed on the interface, and the interface\n will be advertised as an internal route to some area.\n The value 'disabled' denotes that the interface is\n external to OSPF.", "x-yang-type": "OSPF-MIB:Status" }, "ospfIfRtrPriority": { "type": "string", "description": "The priority of this interface. Used in\n multi-access networks, this field is used in\n the designated router election algorithm. The\n value 0 signifies that the router is not eligible\n to become the designated router on this particular\n network. In the event of a tie in this value,\n routers will use their Router ID as a tie breaker.", "x-yang-type": "OSPF-MIB:DesignatedRouterPriority" }, "ospfIfTransitDelay": { "type": "string", "description": "The estimated number of seconds it takes to\n transmit a link state update packet over this\n interface. Note that the minimal value SHOULD be\n 1 second.", "x-yang-type": "OSPF-MIB:UpToMaxAge" }, "ospfIfRetransInterval": { "type": "string", "description": "The number of seconds between link state advertisement\n retransmissions, for adjacencies belonging to this\n interface. This value is also used when retransmitting\n \n database description and Link State request packets.\n Note that minimal value SHOULD be 1 second.", "x-yang-type": "OSPF-MIB:UpToMaxAge" }, "ospfIfHelloInterval": { "type": "string", "description": "The length of time, in seconds, between the Hello packets\n that the router sends on the interface. This value must be\n the same for all routers attached to a common network.", "x-yang-type": "OSPF-MIB:HelloRange" }, "ospfIfRtrDeadInterval": { "type": "string", "description": "The number of seconds that a router's Hello packets have\n not been seen before its neighbors declare the router down.\n This should be some multiple of the Hello interval. This\n value must be the same for all routers attached to a common\n network.", "x-yang-type": "OSPF-MIB:PositiveInteger" }, "ospfIfPollInterval": { "type": "string", "description": "The larger time interval, in seconds, between the Hello\n packets sent to an inactive non-broadcast multi-access\n neighbor.", "x-yang-type": "OSPF-MIB:PositiveInteger" }, "ospfIfState": { "type": "string", "description": "The OSPF Interface State." }, "ospfIfDesignatedRouter": { "type": "string", "description": "The IP address of the designated router.", "format": "inet:ipv4-address" }, "ospfIfBackupDesignatedRouter": { "type": "string", "description": "The IP address of the backup designated\n router.", "format": "inet:ipv4-address" }, "ospfIfEvents": { "type": "integer", "description": "The number of times this OSPF interface has\n changed its state or an error has occurred.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ospfIfAuthKey": { "type": "string", "description": "The cleartext password used as an OSPF\n authentication key when simplePassword security\n is enabled. This object does not access any OSPF\n cryptogaphic (e.g., MD5) authentication key under\n any circumstance.\n \n If the key length is shorter than 8 octets, the\n agent will left adjust and zero fill to 8 octets.\n \n Unauthenticated interfaces need no authentication\n key, and simple password authentication cannot use\n a key of more than 8 octets.\n \n Note that the use of simplePassword authentication\n is NOT recommended when there is concern regarding\n attack upon the OSPF system. SimplePassword\n authentication is only sufficient to protect against\n accidental misconfigurations because it re-uses\n cleartext passwords [RFC1704].\n \n When read, ospfIfAuthKey always returns an octet\n string of length zero.", "format": "binary" }, "ospfIfStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfIfMulticastForwarding": { "type": "string", "description": "The way multicasts should be forwarded on this\n interface: not forwarded, forwarded as data\n link multicasts, or forwarded as data link\n unicasts. Data link multicasting is not\n meaningful on point-to-point and NBMA interfaces,\n and setting ospfMulticastForwarding to 0 effectively\n disables all multicast forwarding." }, "ospfIfDemand": { "type": "boolean", "description": "Indicates whether Demand OSPF procedures (hello\n suppression to FULL neighbors and setting the\n DoNotAge flag on propagated LSAs) should be\n performed on this interface." }, "ospfIfAuthType": { "type": "string", "description": "The authentication type specified for an interface.\n \n Note that this object can be used to engage\n in significant attacks against an OSPF router.", "x-yang-type": "OSPF-MIB:OspfAuthenticationType" }, "ospfIfLsaCount": { "type": "integer", "description": "The total number of link-local link state advertisements\n in this interface's link-local link state database.", "minimum": 0, "maximum": 4294967295 }, "ospfIfLsaCksumSum": { "type": "integer", "description": "The 32-bit unsigned sum of the Link State\n Advertisements' LS checksums contained in this\n interface's link-local link state database.\n The sum can be used to determine if there has\n been a change in the interface's link state\n database and to compare the interface link state\n database of routers attached to the same subnet.", "minimum": 0, "maximum": 4294967295 }, "ospfIfDesignatedRouterId": { "type": "string", "description": "The Router ID of the designated router.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfIfBackupDesignatedRouterId": { "type": "string", "description": "The Router ID of the backup designated router.", "x-yang-type": "OSPF-MIB:RouterID" } } }, "example": { "OSPF-MIB:ospfIfEntry": { "ospfIfIpAddress": "192.168.1.1", "ospfAddressLessIf": "192.168.1.1", "ospfIfAreaId": "example-string", "ospfIfType": "ethernetCsmacd(6)", "ospfIfAdminStat": "example-string", "ospfIfRtrPriority": "example-string", "ospfIfTransitDelay": "example-string", "ospfIfRetransInterval": "example-string", "ospfIfHelloInterval": "example-string", "ospfIfRtrDeadInterval": "example-string", "ospfIfPollInterval": "example-string", "ospfIfState": "up(1)", "ospfIfDesignatedRouter": "example-string", "ospfIfBackupDesignatedRouter": "example-string", "ospfIfEvents": 0, "ospfIfAuthKey": "example-string", "ospfIfStatus": "up(1)", "ospfIfMulticastForwarding": "example-string", "ospfIfDemand": true, "ospfIfAuthType": "ethernetCsmacd(6)", "ospfIfLsaCount": 0, "ospfIfLsaCksumSum": 0, "ospfIfDesignatedRouterId": "example-string", "ospfIfBackupDesignatedRouterId": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfIfEntry-2" }, "x-yang-path": "/ospfIfTable/ospfIfEntry={ospfIfIpAddress ospfAddressLessIf}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfIfIpAddress ospfAddressLessIf" ] }, "/data/OSPF-MIB:ospfIfMetricTable/ospfIfMetricEntry={ospfIfMetricIpAddress},{ospfIfMetricAddressLessIf},{ospfIfMetricTOS}": { "get": { "summary": "Get ospfIfMetricEntry entry", "description": "Retrieve specific ospfIfMetricEntry entry by key from MIB", "tags": [ "OSPF-MIB" ], "parameters": [ { "name": "ospfIfMetricIpAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfIfMetricAddressLessIf", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfIfMetricTOS", "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": { "ospfIfMetricIpAddress": { "type": "string", "description": "The IP address of this OSPF interface. On row\n creation, this can be derived from the instance.", "format": "inet:ipv4-address" }, "ospfIfMetricAddressLessIf": { "type": "string", "description": "For the purpose of easing the instancing of\n addressed and addressless interfaces; this\n variable takes the value 0 on interfaces with\n IP addresses and the value of ifIndex for\n interfaces having no IP address. On row\n creation, this can be derived from the instance.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "ospfIfMetricTOS": { "type": "string", "description": "The Type of Service metric being referenced.\n On row creation, this can be derived from the\n instance.", "x-yang-type": "OSPF-MIB:TOSType" }, "ospfIfMetricValue": { "type": "string", "description": "The metric of using this Type of Service on\n this interface. The default value of the TOS 0\n metric is 10^8 / ifSpeed.", "x-yang-type": "OSPF-MIB:Metric" }, "ospfIfMetricStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "OSPF-MIB:ospfIfMetricEntry": { "ospfIfMetricIpAddress": "192.168.1.1", "ospfIfMetricAddressLessIf": "192.168.1.1", "ospfIfMetricTOS": "example-string", "ospfIfMetricValue": "example-string", "ospfIfMetricStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfIfMetricEntry-2" }, "x-yang-path": "/ospfIfMetricTable/ospfIfMetricEntry={ospfIfMetricIpAddress ospfIfMetricAddressLessIf ospfIfMetricTOS}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfIfMetricIpAddress ospfIfMetricAddressLessIf ospfIfMetricTOS" ] }, "/data/OSPF-MIB:ospfVirtIfTable/ospfVirtIfEntry={ospfVirtIfAreaId},{ospfVirtIfNeighbor}": { "get": { "summary": "Get ospfVirtIfEntry entry", "description": "Retrieve specific ospfVirtIfEntry entry by key from MIB", "tags": [ "OSPF-MIB" ], "parameters": [ { "name": "ospfVirtIfAreaId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfVirtIfNeighbor", "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": { "ospfVirtIfAreaId": { "type": "string", "description": "The transit area that the virtual link\n traverses. By definition, this is not 0.0.0.0.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfVirtIfNeighbor": { "type": "string", "description": "The Router ID of the virtual neighbor.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfVirtIfTransitDelay": { "type": "string", "description": "The estimated number of seconds it takes to\n transmit a Link State update packet over this\n interface. Note that the minimal value SHOULD be\n 1 second.", "x-yang-type": "OSPF-MIB:UpToMaxAge" }, "ospfVirtIfRetransInterval": { "type": "string", "description": "The number of seconds between link state\n avertisement retransmissions, for adjacencies\n belonging to this interface. This value is\n also used when retransmitting database\n description and Link State request packets. This\n value should be well over the expected\n round-trip time. Note that the minimal value SHOULD be\n 1 second.", "x-yang-type": "OSPF-MIB:UpToMaxAge" }, "ospfVirtIfHelloInterval": { "type": "string", "description": "The length of time, in seconds, between the\n Hello packets that the router sends on the\n interface. This value must be the same for the\n virtual neighbor.", "x-yang-type": "OSPF-MIB:HelloRange" }, "ospfVirtIfRtrDeadInterval": { "type": "string", "description": "The number of seconds that a router's Hello\n packets have not been seen before its\n neighbors declare the router down. This should be\n some multiple of the Hello interval. This\n value must be the same for the virtual neighbor.", "x-yang-type": "OSPF-MIB:PositiveInteger" }, "ospfVirtIfState": { "type": "string", "description": "OSPF virtual interface states." }, "ospfVirtIfEvents": { "type": "integer", "description": "The number of state changes or error events on\n this virtual link.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ospfVirtIfAuthKey": { "type": "string", "description": "The cleartext password used as an OSPF\n authentication key when simplePassword security\n is enabled. This object does not access any OSPF\n cryptogaphic (e.g., MD5) authentication key under\n any circumstance.\n \n If the key length is shorter than 8 octets, the\n agent will left adjust and zero fill to 8 octets.\n \n Unauthenticated interfaces need no authentication\n key, and simple password authentication cannot use\n a key of more than 8 octets.\n \n Note that the use of simplePassword authentication\n is NOT recommended when there is concern regarding\n attack upon the OSPF system. SimplePassword\n authentication is only sufficient to protect against\n accidental misconfigurations because it re-uses\n cleartext passwords. [RFC1704]\n \n When read, ospfIfAuthKey always returns an octet\n string of length zero.", "format": "binary" }, "ospfVirtIfStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfVirtIfAuthType": { "type": "string", "description": "The authentication type specified for a virtual interface.\n \n Note that this object can be used to engage\n in significant attacks against an OSPF router.", "x-yang-type": "OSPF-MIB:OspfAuthenticationType" }, "ospfVirtIfLsaCount": { "type": "integer", "description": "The total number of link-local link state advertisements\n in this virtual interface's link-local link state database.", "minimum": 0, "maximum": 4294967295 }, "ospfVirtIfLsaCksumSum": { "type": "integer", "description": "The 32-bit unsigned sum of the link state\n advertisements' LS checksums contained in this\n virtual interface's link-local link state database.\n The sum can be used to determine if there has\n been a change in the virtual interface's link state\n database, and to compare the virtual interface\n link state database of the virtual neighbors.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "OSPF-MIB:ospfVirtIfEntry": { "ospfVirtIfAreaId": "example-string", "ospfVirtIfNeighbor": "example-string", "ospfVirtIfTransitDelay": "example-string", "ospfVirtIfRetransInterval": "example-string", "ospfVirtIfHelloInterval": "example-string", "ospfVirtIfRtrDeadInterval": "example-string", "ospfVirtIfState": "up(1)", "ospfVirtIfEvents": 0, "ospfVirtIfAuthKey": "example-string", "ospfVirtIfStatus": "up(1)", "ospfVirtIfAuthType": "ethernetCsmacd(6)", "ospfVirtIfLsaCount": 0, "ospfVirtIfLsaCksumSum": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfVirtIfEntry-2" }, "x-yang-path": "/ospfVirtIfTable/ospfVirtIfEntry={ospfVirtIfAreaId ospfVirtIfNeighbor}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfVirtIfAreaId ospfVirtIfNeighbor" ] }, "/data/OSPF-MIB:ospfNbrTable/ospfNbrEntry={ospfNbrIpAddr},{ospfNbrAddressLessIndex}": { "get": { "summary": "Get ospfNbrEntry entry", "description": "Retrieve specific ospfNbrEntry entry by key from MIB", "tags": [ "OSPF-MIB" ], "parameters": [ { "name": "ospfNbrIpAddr", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfNbrAddressLessIndex", "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": { "ospfNbrIpAddr": { "type": "string", "description": "The IP address this neighbor is using in its\n IP source address. Note that, on addressless\n links, this will not be 0.0.0.0 but the\n \n address of another of the neighbor's interfaces.", "format": "inet:ipv4-address" }, "ospfNbrAddressLessIndex": { "type": "string", "description": "On an interface having an IP address, zero.\n On addressless interfaces, the corresponding\n value of ifIndex in the Internet Standard MIB.\n On row creation, this can be derived from the\n instance.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "ospfNbrRtrId": { "type": "string", "description": "A 32-bit integer (represented as a type\n IpAddress) uniquely identifying the neighboring\n router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfNbrOptions": { "type": "integer", "description": "A bit mask corresponding to the neighbor's\n options field.\n \n Bit 0, if set, indicates that the system will\n operate on Type of Service metrics other than\n TOS 0. If zero, the neighbor will ignore all\n metrics except the TOS 0 metric.\n \n Bit 1, if set, indicates that the associated\n area accepts and operates on external\n information; if zero, it is a stub area.\n \n Bit 2, if set, indicates that the system is\n capable of routing IP multicast datagrams, that is\n that it implements the multicast extensions to\n OSPF.\n \n Bit 3, if set, indicates that the associated\n area is an NSSA. These areas are capable of\n carrying type-7 external advertisements, which\n are translated into type-5 external advertisements\n at NSSA borders.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfNbrPriority": { "type": "string", "description": "The priority of this neighbor in the designated\n router election algorithm. The value 0 signifies\n that the neighbor is not eligible to become\n the designated router on this particular network.", "x-yang-type": "OSPF-MIB:DesignatedRouterPriority" }, "ospfNbrState": { "type": "string", "description": "The state of the relationship with this neighbor." }, "ospfNbrEvents": { "type": "integer", "description": "The number of times this neighbor relationship\n has changed state or an error has occurred.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ospfNbrLsRetransQLen": { "type": "integer", "description": "The current length of the retransmission\n queue.", "minimum": 0, "maximum": 4294967295 }, "ospfNbmaNbrStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfNbmaNbrPermanence": { "type": "string", "description": "This variable displays the status of the entry;\n 'dynamic' and 'permanent' refer to how the neighbor\n became known." }, "ospfNbrHelloSuppressed": { "type": "boolean", "description": "Indicates whether Hellos are being suppressed\n to the neighbor." }, "ospfNbrRestartHelperStatus": { "type": "string", "description": "Indicates whether the router is acting\n as a graceful restart helper for the neighbor." }, "ospfNbrRestartHelperAge": { "type": "integer", "description": "Remaining time in current OSPF graceful restart\n interval, if the router is acting as a restart\n helper for the neighbor.", "minimum": 0, "maximum": 4294967295 }, "ospfNbrRestartHelperExitReason": { "type": "string", "description": "Describes the outcome of the last attempt at acting\n as a graceful restart helper for the neighbor." } } }, "example": { "OSPF-MIB:ospfNbrEntry": { "ospfNbrIpAddr": "192.168.1.1", "ospfNbrAddressLessIndex": "192.168.1.1", "ospfNbrRtrId": "example-string", "ospfNbrOptions": -2147483648, "ospfNbrPriority": "example-string", "ospfNbrState": "up(1)", "ospfNbrEvents": 0, "ospfNbrLsRetransQLen": 0, "ospfNbmaNbrStatus": "up(1)", "ospfNbmaNbrPermanence": "example-string", "ospfNbrHelloSuppressed": true, "ospfNbrRestartHelperStatus": "up(1)", "ospfNbrRestartHelperAge": 0, "ospfNbrRestartHelperExitReason": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfNbrEntry-2" }, "x-yang-path": "/ospfNbrTable/ospfNbrEntry={ospfNbrIpAddr ospfNbrAddressLessIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfNbrIpAddr ospfNbrAddressLessIndex" ] }, "/data/OSPF-MIB:ospfVirtNbrTable/ospfVirtNbrEntry={ospfVirtNbrArea},{ospfVirtNbrRtrId}": { "get": { "summary": "Get ospfVirtNbrEntry entry", "description": "Retrieve specific ospfVirtNbrEntry entry by key from MIB", "tags": [ "OSPF-MIB" ], "parameters": [ { "name": "ospfVirtNbrArea", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfVirtNbrRtrId", "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": { "ospfVirtNbrArea": { "type": "string", "description": "The Transit Area Identifier.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfVirtNbrRtrId": { "type": "string", "description": "A 32-bit integer uniquely identifying the\n neighboring router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfVirtNbrIpAddr": { "type": "string", "description": "The IP address this virtual neighbor is using.", "format": "inet:ipv4-address" }, "ospfVirtNbrOptions": { "type": "integer", "description": "A bit mask corresponding to the neighbor's\n options field.\n \n Bit 1, if set, indicates that the system will\n operate on Type of Service metrics other than\n TOS 0. If zero, the neighbor will ignore all\n metrics except the TOS 0 metric.\n \n Bit 2, if set, indicates that the system is\n network multicast capable, i.e., that it\n implements OSPF multicast routing.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfVirtNbrState": { "type": "string", "description": "The state of the virtual neighbor relationship." }, "ospfVirtNbrEvents": { "type": "integer", "description": "The number of times this virtual link has\n changed its state or an error has occurred.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ospfVirtNbrLsRetransQLen": { "type": "integer", "description": "The current length of the retransmission\n queue.", "minimum": 0, "maximum": 4294967295 }, "ospfVirtNbrHelloSuppressed": { "type": "boolean", "description": "Indicates whether Hellos are being suppressed\n to the neighbor." }, "ospfVirtNbrRestartHelperStatus": { "type": "string", "description": "Indicates whether the router is acting\n as a graceful restart helper for the neighbor." }, "ospfVirtNbrRestartHelperAge": { "type": "integer", "description": "Remaining time in current OSPF graceful restart\n interval, if the router is acting as a restart\n helper for the neighbor.", "minimum": 0, "maximum": 4294967295 }, "ospfVirtNbrRestartHelperExitReason": { "type": "string", "description": "Describes the outcome of the last attempt at acting\n as a graceful restart helper for the neighbor." } } }, "example": { "OSPF-MIB:ospfVirtNbrEntry": { "ospfVirtNbrArea": "example-string", "ospfVirtNbrRtrId": "example-string", "ospfVirtNbrIpAddr": "192.168.1.1", "ospfVirtNbrOptions": -2147483648, "ospfVirtNbrState": "up(1)", "ospfVirtNbrEvents": 0, "ospfVirtNbrLsRetransQLen": 0, "ospfVirtNbrHelloSuppressed": true, "ospfVirtNbrRestartHelperStatus": "up(1)", "ospfVirtNbrRestartHelperAge": 0, "ospfVirtNbrRestartHelperExitReason": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfVirtNbrEntry-2" }, "x-yang-path": "/ospfVirtNbrTable/ospfVirtNbrEntry={ospfVirtNbrArea ospfVirtNbrRtrId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfVirtNbrArea ospfVirtNbrRtrId" ] }, "/data/OSPF-MIB:ospfExtLsdbTable/ospfExtLsdbEntry={ospfExtLsdbType},{ospfExtLsdbLsid},{ospfExtLsdbRouterId}": { "get": { "summary": "Get ospfExtLsdbEntry entry", "description": "Retrieve specific ospfExtLsdbEntry entry by key from MIB", "tags": [ "OSPF-MIB" ], "parameters": [ { "name": "ospfExtLsdbType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfExtLsdbLsid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfExtLsdbRouterId", "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": { "ospfExtLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement\n format." }, "ospfExtLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing either a Router ID or an IP address;\n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address" }, "ospfExtLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfExtLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate link state\n advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfExtLsdbAge": { "type": "integer", "description": "This field is the age of the link state\n advertisement in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfExtLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete\n contents of the advertisement, excepting the\n age field. The age field is excepted so that\n an advertisement's age can be incremented\n without updating the checksum. The checksum\n used is the same that is used for ISO\n connectionless datagrams; it is commonly referred\n to as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfExtLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.", "format": "binary" } } }, "example": { "OSPF-MIB:ospfExtLsdbEntry": { "ospfExtLsdbType": "ethernetCsmacd(6)", "ospfExtLsdbLsid": "example-string", "ospfExtLsdbRouterId": "example-string", "ospfExtLsdbSequence": -2147483648, "ospfExtLsdbAge": -2147483648, "ospfExtLsdbChecksum": -2147483648, "ospfExtLsdbAdvertisement": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfExtLsdbEntry-2" }, "x-yang-path": "/ospfExtLsdbTable/ospfExtLsdbEntry={ospfExtLsdbType ospfExtLsdbLsid ospfExtLsdbRouterId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfExtLsdbType ospfExtLsdbLsid ospfExtLsdbRouterId" ] }, "/data/OSPF-MIB:ospfAreaAggregateTable/ospfAreaAggregateEntry={ospfAreaAggregateAreaID},{ospfAreaAggregateLsdbType},{ospfAreaAggregateNet},{ospfAreaAggregateMask}": { "get": { "summary": "Get ospfAreaAggregateEntry entry", "description": "Retrieve specific ospfAreaAggregateEntry entry by key from MIB", "tags": [ "OSPF-MIB" ], "parameters": [ { "name": "ospfAreaAggregateAreaID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfAreaAggregateLsdbType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfAreaAggregateNet", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfAreaAggregateMask", "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": { "ospfAreaAggregateAreaID": { "type": "string", "description": "The area within which the address aggregate is to be\n found.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfAreaAggregateLsdbType": { "type": "string", "description": "The type of the address aggregate. This field\n specifies the Lsdb type that this address\n aggregate applies to." }, "ospfAreaAggregateNet": { "type": "string", "description": "The IP address of the net or subnet indicated\n by the range.", "format": "inet:ipv4-address" }, "ospfAreaAggregateMask": { "type": "string", "description": "The subnet mask that pertains to the net or\n subnet.", "format": "inet:ipv4-address" }, "ospfAreaAggregateStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfAreaAggregateEffect": { "type": "string", "description": "Subnets subsumed by ranges either trigger the\n advertisement of the indicated aggregate\n (advertiseMatching) or result in the subnet's not\n being advertised at all outside the area." }, "ospfAreaAggregateExtRouteTag": { "type": "integer", "description": "External route tag to be included in NSSA (type-7)\n LSAs.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "OSPF-MIB:ospfAreaAggregateEntry": { "ospfAreaAggregateAreaID": "example-string", "ospfAreaAggregateLsdbType": "ethernetCsmacd(6)", "ospfAreaAggregateNet": "example-string", "ospfAreaAggregateMask": "example-string", "ospfAreaAggregateStatus": "up(1)", "ospfAreaAggregateEffect": "example-string", "ospfAreaAggregateExtRouteTag": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfAreaAggregateEntry-2" }, "x-yang-path": "/ospfAreaAggregateTable/ospfAreaAggregateEntry={ospfAreaAggregateAreaID ospfAreaAggregateLsdbType ospfAreaAggregateNet ospfAreaAggregateMask}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfAreaAggregateAreaID ospfAreaAggregateLsdbType ospfAreaAggregateNet ospfAreaAggregateMask" ] }, "/data/OSPF-MIB:ospfLocalLsdbTable/ospfLocalLsdbEntry={ospfLocalLsdbIpAddress},{ospfLocalLsdbAddressLessIf},{ospfLocalLsdbType},{ospfLocalLsdbLsid},{ospfLocalLsdbRouterId}": { "get": { "summary": "Get ospfLocalLsdbEntry entry", "description": "Retrieve specific ospfLocalLsdbEntry entry by key from MIB", "tags": [ "OSPF-MIB" ], "parameters": [ { "name": "ospfLocalLsdbIpAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfLocalLsdbAddressLessIf", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfLocalLsdbType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfLocalLsdbLsid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfLocalLsdbRouterId", "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": { "ospfLocalLsdbIpAddress": { "type": "string", "description": "The IP address of the interface from\n which the LSA was received if the interface is\n numbered.", "format": "inet:ipv4-address" }, "ospfLocalLsdbAddressLessIf": { "type": "string", "description": "The interface index of the interface from\n which the LSA was received if the interface is\n unnumbered.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "ospfLocalLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate\n advertisement format." }, "ospfLocalLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing a 32-bit identifier in IP address format;\n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address" }, "ospfLocalLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfLocalLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate link state\n advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfLocalLsdbAge": { "type": "integer", "description": "This field is the age of the link state\n advertisement in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfLocalLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete\n contents of the advertisement, excepting the\n age field. The age field is excepted so that\n an advertisement's age can be incremented\n without updating the checksum. The checksum\n used is the same that is used for ISO\n connectionless datagrams; it is commonly referred\n to as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfLocalLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.\n \n Note that for variable length LSAs, SNMP agents\n may not be able to return the largest string size.", "format": "binary" } } }, "example": { "OSPF-MIB:ospfLocalLsdbEntry": { "ospfLocalLsdbIpAddress": "192.168.1.1", "ospfLocalLsdbAddressLessIf": "192.168.1.1", "ospfLocalLsdbType": "ethernetCsmacd(6)", "ospfLocalLsdbLsid": "example-string", "ospfLocalLsdbRouterId": "example-string", "ospfLocalLsdbSequence": -2147483648, "ospfLocalLsdbAge": -2147483648, "ospfLocalLsdbChecksum": -2147483648, "ospfLocalLsdbAdvertisement": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfLocalLsdbEntry-2" }, "x-yang-path": "/ospfLocalLsdbTable/ospfLocalLsdbEntry={ospfLocalLsdbIpAddress ospfLocalLsdbAddressLessIf ospfLocalLsdbType ospfLocalLsdbLsid ospfLocalLsdbRouterId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfLocalLsdbIpAddress ospfLocalLsdbAddressLessIf ospfLocalLsdbType ospfLocalLsdbLsid ospfLocalLsdbRouterId" ] }, "/data/OSPF-MIB:ospfVirtLocalLsdbTable/ospfVirtLocalLsdbEntry={ospfVirtLocalLsdbTransitArea},{ospfVirtLocalLsdbNeighbor},{ospfVirtLocalLsdbType},{ospfVirtLocalLsdbLsid},{ospfVirtLocalLsdbRouterId}": { "get": { "summary": "Get ospfVirtLocalLsdbEntry entry", "description": "Retrieve specific ospfVirtLocalLsdbEntry entry by key from MIB", "tags": [ "OSPF-MIB" ], "parameters": [ { "name": "ospfVirtLocalLsdbTransitArea", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfVirtLocalLsdbNeighbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfVirtLocalLsdbType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfVirtLocalLsdbLsid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfVirtLocalLsdbRouterId", "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": { "ospfVirtLocalLsdbTransitArea": { "type": "string", "description": "The transit area that the virtual link\n traverses. By definition, this is not 0.0.0.0.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfVirtLocalLsdbNeighbor": { "type": "string", "description": "The Router ID of the virtual neighbor.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfVirtLocalLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate\n advertisement format." }, "ospfVirtLocalLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing a 32-bit identifier in IP address format;\n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address" }, "ospfVirtLocalLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfVirtLocalLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate link state\n advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfVirtLocalLsdbAge": { "type": "integer", "description": "This field is the age of the link state\n advertisement in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfVirtLocalLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete\n contents of the advertisement, excepting the\n age field. The age field is excepted so that\n \n an advertisement's age can be incremented\n without updating the checksum. The checksum\n used is the same that is used for ISO\n connectionless datagrams; it is commonly\n referred to as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfVirtLocalLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.", "format": "binary" } } }, "example": { "OSPF-MIB:ospfVirtLocalLsdbEntry": { "ospfVirtLocalLsdbTransitArea": "example-string", "ospfVirtLocalLsdbNeighbor": "example-string", "ospfVirtLocalLsdbType": "ethernetCsmacd(6)", "ospfVirtLocalLsdbLsid": "example-string", "ospfVirtLocalLsdbRouterId": "example-string", "ospfVirtLocalLsdbSequence": -2147483648, "ospfVirtLocalLsdbAge": -2147483648, "ospfVirtLocalLsdbChecksum": -2147483648, "ospfVirtLocalLsdbAdvertisement": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfVirtLocalLsdbEntry-2" }, "x-yang-path": "/ospfVirtLocalLsdbTable/ospfVirtLocalLsdbEntry={ospfVirtLocalLsdbTransitArea ospfVirtLocalLsdbNeighbor ospfVirtLocalLsdbType ospfVirtLocalLsdbLsid ospfVirtLocalLsdbRouterId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfVirtLocalLsdbTransitArea ospfVirtLocalLsdbNeighbor ospfVirtLocalLsdbType ospfVirtLocalLsdbLsid ospfVirtLocalLsdbRouterId" ] }, "/data/OSPF-MIB:ospfAsLsdbTable/ospfAsLsdbEntry={ospfAsLsdbType},{ospfAsLsdbLsid},{ospfAsLsdbRouterId}": { "get": { "summary": "Get ospfAsLsdbEntry entry", "description": "Retrieve specific ospfAsLsdbEntry entry by key from MIB", "tags": [ "OSPF-MIB" ], "parameters": [ { "name": "ospfAsLsdbType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfAsLsdbLsid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfAsLsdbRouterId", "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": { "ospfAsLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate\n advertisement format." }, "ospfAsLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing either a Router ID or an IP address;\n \n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address" }, "ospfAsLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfAsLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate link state\n advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfAsLsdbAge": { "type": "integer", "description": "This field is the age of the link state\n advertisement in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfAsLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete\n contents of the advertisement, excepting the\n age field. The age field is excepted so that\n an advertisement's age can be incremented\n without updating the checksum. The checksum\n used is the same that is used for ISO\n connectionless datagrams; it is commonly referred\n to as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfAsLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.", "format": "binary" } } }, "example": { "OSPF-MIB:ospfAsLsdbEntry": { "ospfAsLsdbType": "ethernetCsmacd(6)", "ospfAsLsdbLsid": "example-string", "ospfAsLsdbRouterId": "example-string", "ospfAsLsdbSequence": -2147483648, "ospfAsLsdbAge": -2147483648, "ospfAsLsdbChecksum": -2147483648, "ospfAsLsdbAdvertisement": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfAsLsdbEntry-2" }, "x-yang-path": "/ospfAsLsdbTable/ospfAsLsdbEntry={ospfAsLsdbType ospfAsLsdbLsid ospfAsLsdbRouterId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfAsLsdbType ospfAsLsdbLsid ospfAsLsdbRouterId" ] }, "/data/OSPF-MIB:ospfAreaLsaCountTable/ospfAreaLsaCountEntry={ospfAreaLsaCountAreaId},{ospfAreaLsaCountLsaType}": { "get": { "summary": "Get ospfAreaLsaCountEntry entry", "description": "Retrieve specific ospfAreaLsaCountEntry entry by key from MIB", "tags": [ "OSPF-MIB" ], "parameters": [ { "name": "ospfAreaLsaCountAreaId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfAreaLsaCountLsaType", "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": { "ospfAreaLsaCountAreaId": { "type": "string", "description": "This entry Area ID.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfAreaLsaCountLsaType": { "type": "string", "description": "This entry LSA type." }, "ospfAreaLsaCountNumber": { "type": "integer", "description": "Number of LSAs of a given type for a given area.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "OSPF-MIB:ospfAreaLsaCountEntry": { "ospfAreaLsaCountAreaId": "example-string", "ospfAreaLsaCountLsaType": "ethernetCsmacd(6)", "ospfAreaLsaCountNumber": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfAreaLsaCountEntry-2" }, "x-yang-path": "/ospfAreaLsaCountTable/ospfAreaLsaCountEntry={ospfAreaLsaCountAreaId ospfAreaLsaCountLsaType}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfAreaLsaCountAreaId ospfAreaLsaCountLsaType" ] }, "/data/OSPF-MIB:ospfStubAreaEntry={ospfStubAreaId},{ospfStubTOS}": { "get": { "summary": "Get ospfStubAreaEntry entry", "description": "Retrieve specific ospfStubAreaEntry entry by key from MIB", "tags": [ "OSPF-MIB" ], "parameters": [ { "name": "ospfStubAreaId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfStubTOS", "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": { "ospfStubAreaId": { "type": "string", "description": "The 32-bit identifier for the stub area. On\n creation, this can be derived from the\n instance.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfStubTOS": { "type": "string", "description": "The Type of Service associated with the\n metric. On creation, this can be derived from\n \n the instance.", "x-yang-type": "OSPF-MIB:TOSType" }, "ospfStubMetric": { "type": "string", "description": "The metric value applied at the indicated Type\n of Service. By default, this equals the least\n metric at the Type of Service among the\n interfaces to other areas.", "x-yang-type": "OSPF-MIB:BigMetric" }, "ospfStubStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfStubMetricType": { "type": "string", "description": "This variable displays the type of metric\n advertised as a default route." } } }, "example": { "OSPF-MIB:ospfStubAreaEntry": { "ospfStubAreaId": "example-string", "ospfStubTOS": "example-string", "ospfStubMetric": "example-string", "ospfStubStatus": "up(1)", "ospfStubMetricType": "ethernetCsmacd(6)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfStubAreaEntry-4" }, "x-yang-path": "/ospfStubAreaEntry={ospfStubAreaId ospfStubTOS}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfStubAreaId ospfStubTOS" ] }, "/data/OSPF-MIB:ospfLsdbEntry={ospfLsdbAreaId},{ospfLsdbType},{ospfLsdbLsid},{ospfLsdbRouterId}": { "get": { "summary": "Get ospfLsdbEntry entry", "description": "Retrieve specific ospfLsdbEntry entry by key from MIB", "tags": [ "OSPF-MIB" ], "parameters": [ { "name": "ospfLsdbAreaId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfLsdbType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfLsdbLsid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfLsdbRouterId", "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": { "ospfLsdbAreaId": { "type": "string", "description": "The 32-bit identifier of the area from which\n the LSA was received.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement\n format.\n \n Note: External link state advertisements are permitted\n for backward compatibility, but should be displayed\n in the ospfAsLsdbTable rather than here." }, "ospfLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing either a Router ID or an IP address;\n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address" }, "ospfLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate Link State\n Advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfLsdbAge": { "type": "integer", "description": "This field is the age of the link state advertisement\n in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete contents of\n the advertisement, excepting the age field. The age field\n is excepted so that an advertisement's age can be\n incremented without updating the checksum. The checksum\n used is the same that is used for ISO connectionless\n \n datagrams; it is commonly referred to as the\n Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.\n \n Note that for variable length LSAs, SNMP agents\n may not be able to return the largest string size.", "format": "binary" } } }, "example": { "OSPF-MIB:ospfLsdbEntry": { "ospfLsdbAreaId": "example-string", "ospfLsdbType": "ethernetCsmacd(6)", "ospfLsdbLsid": "example-string", "ospfLsdbRouterId": "example-string", "ospfLsdbSequence": -2147483648, "ospfLsdbAge": -2147483648, "ospfLsdbChecksum": -2147483648, "ospfLsdbAdvertisement": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfLsdbEntry-4" }, "x-yang-path": "/ospfLsdbEntry={ospfLsdbAreaId ospfLsdbType ospfLsdbLsid ospfLsdbRouterId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfLsdbAreaId ospfLsdbType ospfLsdbLsid ospfLsdbRouterId" ] }, "/data/OSPF-MIB:ospfAreaRangeEntry={ospfAreaRangeAreaId},{ospfAreaRangeNet}": { "get": { "summary": "Get ospfAreaRangeEntry entry", "description": "Retrieve specific ospfAreaRangeEntry entry by key from MIB", "tags": [ "OSPF-MIB" ], "parameters": [ { "name": "ospfAreaRangeAreaId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfAreaRangeNet", "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": { "ospfAreaRangeAreaId": { "type": "string", "description": "The area that the address range is to be found\n within.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfAreaRangeNet": { "type": "string", "description": "The IP address of the net or subnet indicated\n by the range.", "format": "inet:ipv4-address" }, "ospfAreaRangeMask": { "type": "string", "description": "The subnet mask that pertains to the net or\n subnet.", "format": "inet:ipv4-address" }, "ospfAreaRangeStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfAreaRangeEffect": { "type": "string", "description": "Subnets subsumed by ranges either trigger the\n advertisement of the indicated summary\n (advertiseMatching) or result in the subnet's not\n being advertised at all outside the area." } } }, "example": { "OSPF-MIB:ospfAreaRangeEntry": { "ospfAreaRangeAreaId": "example-string", "ospfAreaRangeNet": "example-string", "ospfAreaRangeMask": "example-string", "ospfAreaRangeStatus": "up(1)", "ospfAreaRangeEffect": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfAreaRangeEntry-4" }, "x-yang-path": "/ospfAreaRangeEntry={ospfAreaRangeAreaId ospfAreaRangeNet}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfAreaRangeAreaId ospfAreaRangeNet" ] }, "/data/OSPF-MIB:ospfHostEntry={ospfHostIpAddress},{ospfHostTOS}": { "get": { "summary": "Get ospfHostEntry entry", "description": "Retrieve specific ospfHostEntry entry by key from MIB", "tags": [ "OSPF-MIB" ], "parameters": [ { "name": "ospfHostIpAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfHostTOS", "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": { "ospfHostIpAddress": { "type": "string", "description": "The IP address of the host.", "format": "inet:ipv4-address" }, "ospfHostTOS": { "type": "string", "description": "The Type of Service of the route being configured.", "x-yang-type": "OSPF-MIB:TOSType" }, "ospfHostMetric": { "type": "string", "description": "The metric to be advertised.", "x-yang-type": "OSPF-MIB:Metric" }, "ospfHostStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfHostAreaID": { "type": "string", "description": "The OSPF area to which the host belongs.\n Deprecated by ospfHostCfgAreaID.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfHostCfgAreaID": { "type": "string", "description": "To configure the OSPF area to which the host belongs.", "x-yang-type": "OSPF-MIB:AreaID" } } }, "example": { "OSPF-MIB:ospfHostEntry": { "ospfHostIpAddress": "192.168.1.1", "ospfHostTOS": "example-string", "ospfHostMetric": "example-string", "ospfHostStatus": "up(1)", "ospfHostAreaID": "example-string", "ospfHostCfgAreaID": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfHostEntry-4" }, "x-yang-path": "/ospfHostEntry={ospfHostIpAddress ospfHostTOS}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfHostIpAddress ospfHostTOS" ] }, "/data/OSPF-MIB:ospfIfEntry={ospfIfIpAddress},{ospfAddressLessIf}": { "get": { "summary": "Get ospfIfEntry entry", "description": "Retrieve specific ospfIfEntry entry by key from MIB", "tags": [ "OSPF-MIB" ], "parameters": [ { "name": "ospfIfIpAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfAddressLessIf", "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": { "ospfIfIpAddress": { "type": "string", "description": "The IP address of this OSPF interface.", "format": "inet:ipv4-address" }, "ospfAddressLessIf": { "type": "string", "description": "For the purpose of easing the instancing of\n addressed and addressless interfaces; this\n variable takes the value 0 on interfaces with\n IP addresses and the corresponding value of\n ifIndex for interfaces having no IP address.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "ospfIfAreaId": { "type": "string", "description": "A 32-bit integer uniquely identifying the area\n to which the interface connects. Area ID\n 0.0.0.0 is used for the OSPF backbone.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfIfType": { "type": "string", "description": "The OSPF interface type.\n By way of a default, this field may be intuited\n from the corresponding value of ifType.\n Broadcast LANs, such as Ethernet and IEEE 802.5,\n take the value 'broadcast', X.25 and similar\n technologies take the value 'nbma', and links\n that are definitively point to point take the\n value 'pointToPoint'." }, "ospfIfAdminStat": { "type": "string", "description": "The OSPF interface's administrative status.\n The value formed on the interface, and the interface\n will be advertised as an internal route to some area.\n The value 'disabled' denotes that the interface is\n external to OSPF.", "x-yang-type": "OSPF-MIB:Status" }, "ospfIfRtrPriority": { "type": "string", "description": "The priority of this interface. Used in\n multi-access networks, this field is used in\n the designated router election algorithm. The\n value 0 signifies that the router is not eligible\n to become the designated router on this particular\n network. In the event of a tie in this value,\n routers will use their Router ID as a tie breaker.", "x-yang-type": "OSPF-MIB:DesignatedRouterPriority" }, "ospfIfTransitDelay": { "type": "string", "description": "The estimated number of seconds it takes to\n transmit a link state update packet over this\n interface. Note that the minimal value SHOULD be\n 1 second.", "x-yang-type": "OSPF-MIB:UpToMaxAge" }, "ospfIfRetransInterval": { "type": "string", "description": "The number of seconds between link state advertisement\n retransmissions, for adjacencies belonging to this\n interface. This value is also used when retransmitting\n \n database description and Link State request packets.\n Note that minimal value SHOULD be 1 second.", "x-yang-type": "OSPF-MIB:UpToMaxAge" }, "ospfIfHelloInterval": { "type": "string", "description": "The length of time, in seconds, between the Hello packets\n that the router sends on the interface. This value must be\n the same for all routers attached to a common network.", "x-yang-type": "OSPF-MIB:HelloRange" }, "ospfIfRtrDeadInterval": { "type": "string", "description": "The number of seconds that a router's Hello packets have\n not been seen before its neighbors declare the router down.\n This should be some multiple of the Hello interval. This\n value must be the same for all routers attached to a common\n network.", "x-yang-type": "OSPF-MIB:PositiveInteger" }, "ospfIfPollInterval": { "type": "string", "description": "The larger time interval, in seconds, between the Hello\n packets sent to an inactive non-broadcast multi-access\n neighbor.", "x-yang-type": "OSPF-MIB:PositiveInteger" }, "ospfIfState": { "type": "string", "description": "The OSPF Interface State." }, "ospfIfDesignatedRouter": { "type": "string", "description": "The IP address of the designated router.", "format": "inet:ipv4-address" }, "ospfIfBackupDesignatedRouter": { "type": "string", "description": "The IP address of the backup designated\n router.", "format": "inet:ipv4-address" }, "ospfIfEvents": { "type": "integer", "description": "The number of times this OSPF interface has\n changed its state or an error has occurred.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ospfIfAuthKey": { "type": "string", "description": "The cleartext password used as an OSPF\n authentication key when simplePassword security\n is enabled. This object does not access any OSPF\n cryptogaphic (e.g., MD5) authentication key under\n any circumstance.\n \n If the key length is shorter than 8 octets, the\n agent will left adjust and zero fill to 8 octets.\n \n Unauthenticated interfaces need no authentication\n key, and simple password authentication cannot use\n a key of more than 8 octets.\n \n Note that the use of simplePassword authentication\n is NOT recommended when there is concern regarding\n attack upon the OSPF system. SimplePassword\n authentication is only sufficient to protect against\n accidental misconfigurations because it re-uses\n cleartext passwords [RFC1704].\n \n When read, ospfIfAuthKey always returns an octet\n string of length zero.", "format": "binary" }, "ospfIfStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfIfMulticastForwarding": { "type": "string", "description": "The way multicasts should be forwarded on this\n interface: not forwarded, forwarded as data\n link multicasts, or forwarded as data link\n unicasts. Data link multicasting is not\n meaningful on point-to-point and NBMA interfaces,\n and setting ospfMulticastForwarding to 0 effectively\n disables all multicast forwarding." }, "ospfIfDemand": { "type": "boolean", "description": "Indicates whether Demand OSPF procedures (hello\n suppression to FULL neighbors and setting the\n DoNotAge flag on propagated LSAs) should be\n performed on this interface." }, "ospfIfAuthType": { "type": "string", "description": "The authentication type specified for an interface.\n \n Note that this object can be used to engage\n in significant attacks against an OSPF router.", "x-yang-type": "OSPF-MIB:OspfAuthenticationType" }, "ospfIfLsaCount": { "type": "integer", "description": "The total number of link-local link state advertisements\n in this interface's link-local link state database.", "minimum": 0, "maximum": 4294967295 }, "ospfIfLsaCksumSum": { "type": "integer", "description": "The 32-bit unsigned sum of the Link State\n Advertisements' LS checksums contained in this\n interface's link-local link state database.\n The sum can be used to determine if there has\n been a change in the interface's link state\n database and to compare the interface link state\n database of routers attached to the same subnet.", "minimum": 0, "maximum": 4294967295 }, "ospfIfDesignatedRouterId": { "type": "string", "description": "The Router ID of the designated router.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfIfBackupDesignatedRouterId": { "type": "string", "description": "The Router ID of the backup designated router.", "x-yang-type": "OSPF-MIB:RouterID" } } }, "example": { "OSPF-MIB:ospfIfEntry": { "ospfIfIpAddress": "192.168.1.1", "ospfAddressLessIf": "192.168.1.1", "ospfIfAreaId": "example-string", "ospfIfType": "ethernetCsmacd(6)", "ospfIfAdminStat": "example-string", "ospfIfRtrPriority": "example-string", "ospfIfTransitDelay": "example-string", "ospfIfRetransInterval": "example-string", "ospfIfHelloInterval": "example-string", "ospfIfRtrDeadInterval": "example-string", "ospfIfPollInterval": "example-string", "ospfIfState": "up(1)", "ospfIfDesignatedRouter": "example-string", "ospfIfBackupDesignatedRouter": "example-string", "ospfIfEvents": 0, "ospfIfAuthKey": "example-string", "ospfIfStatus": "up(1)", "ospfIfMulticastForwarding": "example-string", "ospfIfDemand": true, "ospfIfAuthType": "ethernetCsmacd(6)", "ospfIfLsaCount": 0, "ospfIfLsaCksumSum": 0, "ospfIfDesignatedRouterId": "example-string", "ospfIfBackupDesignatedRouterId": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfIfEntry-4" }, "x-yang-path": "/ospfIfEntry={ospfIfIpAddress ospfAddressLessIf}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfIfIpAddress ospfAddressLessIf" ] }, "/data/OSPF-MIB:ospfIfMetricEntry={ospfIfMetricIpAddress},{ospfIfMetricAddressLessIf},{ospfIfMetricTOS}": { "get": { "summary": "Get ospfIfMetricEntry entry", "description": "Retrieve specific ospfIfMetricEntry entry by key from MIB", "tags": [ "OSPF-MIB" ], "parameters": [ { "name": "ospfIfMetricIpAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfIfMetricAddressLessIf", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfIfMetricTOS", "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": { "ospfIfMetricIpAddress": { "type": "string", "description": "The IP address of this OSPF interface. On row\n creation, this can be derived from the instance.", "format": "inet:ipv4-address" }, "ospfIfMetricAddressLessIf": { "type": "string", "description": "For the purpose of easing the instancing of\n addressed and addressless interfaces; this\n variable takes the value 0 on interfaces with\n IP addresses and the value of ifIndex for\n interfaces having no IP address. On row\n creation, this can be derived from the instance.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "ospfIfMetricTOS": { "type": "string", "description": "The Type of Service metric being referenced.\n On row creation, this can be derived from the\n instance.", "x-yang-type": "OSPF-MIB:TOSType" }, "ospfIfMetricValue": { "type": "string", "description": "The metric of using this Type of Service on\n this interface. The default value of the TOS 0\n metric is 10^8 / ifSpeed.", "x-yang-type": "OSPF-MIB:Metric" }, "ospfIfMetricStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "OSPF-MIB:ospfIfMetricEntry": { "ospfIfMetricIpAddress": "192.168.1.1", "ospfIfMetricAddressLessIf": "192.168.1.1", "ospfIfMetricTOS": "example-string", "ospfIfMetricValue": "example-string", "ospfIfMetricStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfIfMetricEntry-4" }, "x-yang-path": "/ospfIfMetricEntry={ospfIfMetricIpAddress ospfIfMetricAddressLessIf ospfIfMetricTOS}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfIfMetricIpAddress ospfIfMetricAddressLessIf ospfIfMetricTOS" ] }, "/data/OSPF-MIB:ospfVirtIfEntry={ospfVirtIfAreaId},{ospfVirtIfNeighbor}": { "get": { "summary": "Get ospfVirtIfEntry entry", "description": "Retrieve specific ospfVirtIfEntry entry by key from MIB", "tags": [ "OSPF-MIB" ], "parameters": [ { "name": "ospfVirtIfAreaId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfVirtIfNeighbor", "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": { "ospfVirtIfAreaId": { "type": "string", "description": "The transit area that the virtual link\n traverses. By definition, this is not 0.0.0.0.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfVirtIfNeighbor": { "type": "string", "description": "The Router ID of the virtual neighbor.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfVirtIfTransitDelay": { "type": "string", "description": "The estimated number of seconds it takes to\n transmit a Link State update packet over this\n interface. Note that the minimal value SHOULD be\n 1 second.", "x-yang-type": "OSPF-MIB:UpToMaxAge" }, "ospfVirtIfRetransInterval": { "type": "string", "description": "The number of seconds between link state\n avertisement retransmissions, for adjacencies\n belonging to this interface. This value is\n also used when retransmitting database\n description and Link State request packets. This\n value should be well over the expected\n round-trip time. Note that the minimal value SHOULD be\n 1 second.", "x-yang-type": "OSPF-MIB:UpToMaxAge" }, "ospfVirtIfHelloInterval": { "type": "string", "description": "The length of time, in seconds, between the\n Hello packets that the router sends on the\n interface. This value must be the same for the\n virtual neighbor.", "x-yang-type": "OSPF-MIB:HelloRange" }, "ospfVirtIfRtrDeadInterval": { "type": "string", "description": "The number of seconds that a router's Hello\n packets have not been seen before its\n neighbors declare the router down. This should be\n some multiple of the Hello interval. This\n value must be the same for the virtual neighbor.", "x-yang-type": "OSPF-MIB:PositiveInteger" }, "ospfVirtIfState": { "type": "string", "description": "OSPF virtual interface states." }, "ospfVirtIfEvents": { "type": "integer", "description": "The number of state changes or error events on\n this virtual link.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ospfVirtIfAuthKey": { "type": "string", "description": "The cleartext password used as an OSPF\n authentication key when simplePassword security\n is enabled. This object does not access any OSPF\n cryptogaphic (e.g., MD5) authentication key under\n any circumstance.\n \n If the key length is shorter than 8 octets, the\n agent will left adjust and zero fill to 8 octets.\n \n Unauthenticated interfaces need no authentication\n key, and simple password authentication cannot use\n a key of more than 8 octets.\n \n Note that the use of simplePassword authentication\n is NOT recommended when there is concern regarding\n attack upon the OSPF system. SimplePassword\n authentication is only sufficient to protect against\n accidental misconfigurations because it re-uses\n cleartext passwords. [RFC1704]\n \n When read, ospfIfAuthKey always returns an octet\n string of length zero.", "format": "binary" }, "ospfVirtIfStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfVirtIfAuthType": { "type": "string", "description": "The authentication type specified for a virtual interface.\n \n Note that this object can be used to engage\n in significant attacks against an OSPF router.", "x-yang-type": "OSPF-MIB:OspfAuthenticationType" }, "ospfVirtIfLsaCount": { "type": "integer", "description": "The total number of link-local link state advertisements\n in this virtual interface's link-local link state database.", "minimum": 0, "maximum": 4294967295 }, "ospfVirtIfLsaCksumSum": { "type": "integer", "description": "The 32-bit unsigned sum of the link state\n advertisements' LS checksums contained in this\n virtual interface's link-local link state database.\n The sum can be used to determine if there has\n been a change in the virtual interface's link state\n database, and to compare the virtual interface\n link state database of the virtual neighbors.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "OSPF-MIB:ospfVirtIfEntry": { "ospfVirtIfAreaId": "example-string", "ospfVirtIfNeighbor": "example-string", "ospfVirtIfTransitDelay": "example-string", "ospfVirtIfRetransInterval": "example-string", "ospfVirtIfHelloInterval": "example-string", "ospfVirtIfRtrDeadInterval": "example-string", "ospfVirtIfState": "up(1)", "ospfVirtIfEvents": 0, "ospfVirtIfAuthKey": "example-string", "ospfVirtIfStatus": "up(1)", "ospfVirtIfAuthType": "ethernetCsmacd(6)", "ospfVirtIfLsaCount": 0, "ospfVirtIfLsaCksumSum": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfVirtIfEntry-4" }, "x-yang-path": "/ospfVirtIfEntry={ospfVirtIfAreaId ospfVirtIfNeighbor}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfVirtIfAreaId ospfVirtIfNeighbor" ] }, "/data/OSPF-MIB:ospfNbrEntry={ospfNbrIpAddr},{ospfNbrAddressLessIndex}": { "get": { "summary": "Get ospfNbrEntry entry", "description": "Retrieve specific ospfNbrEntry entry by key from MIB", "tags": [ "OSPF-MIB" ], "parameters": [ { "name": "ospfNbrIpAddr", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfNbrAddressLessIndex", "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": { "ospfNbrIpAddr": { "type": "string", "description": "The IP address this neighbor is using in its\n IP source address. Note that, on addressless\n links, this will not be 0.0.0.0 but the\n \n address of another of the neighbor's interfaces.", "format": "inet:ipv4-address" }, "ospfNbrAddressLessIndex": { "type": "string", "description": "On an interface having an IP address, zero.\n On addressless interfaces, the corresponding\n value of ifIndex in the Internet Standard MIB.\n On row creation, this can be derived from the\n instance.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "ospfNbrRtrId": { "type": "string", "description": "A 32-bit integer (represented as a type\n IpAddress) uniquely identifying the neighboring\n router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfNbrOptions": { "type": "integer", "description": "A bit mask corresponding to the neighbor's\n options field.\n \n Bit 0, if set, indicates that the system will\n operate on Type of Service metrics other than\n TOS 0. If zero, the neighbor will ignore all\n metrics except the TOS 0 metric.\n \n Bit 1, if set, indicates that the associated\n area accepts and operates on external\n information; if zero, it is a stub area.\n \n Bit 2, if set, indicates that the system is\n capable of routing IP multicast datagrams, that is\n that it implements the multicast extensions to\n OSPF.\n \n Bit 3, if set, indicates that the associated\n area is an NSSA. These areas are capable of\n carrying type-7 external advertisements, which\n are translated into type-5 external advertisements\n at NSSA borders.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfNbrPriority": { "type": "string", "description": "The priority of this neighbor in the designated\n router election algorithm. The value 0 signifies\n that the neighbor is not eligible to become\n the designated router on this particular network.", "x-yang-type": "OSPF-MIB:DesignatedRouterPriority" }, "ospfNbrState": { "type": "string", "description": "The state of the relationship with this neighbor." }, "ospfNbrEvents": { "type": "integer", "description": "The number of times this neighbor relationship\n has changed state or an error has occurred.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ospfNbrLsRetransQLen": { "type": "integer", "description": "The current length of the retransmission\n queue.", "minimum": 0, "maximum": 4294967295 }, "ospfNbmaNbrStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfNbmaNbrPermanence": { "type": "string", "description": "This variable displays the status of the entry;\n 'dynamic' and 'permanent' refer to how the neighbor\n became known." }, "ospfNbrHelloSuppressed": { "type": "boolean", "description": "Indicates whether Hellos are being suppressed\n to the neighbor." }, "ospfNbrRestartHelperStatus": { "type": "string", "description": "Indicates whether the router is acting\n as a graceful restart helper for the neighbor." }, "ospfNbrRestartHelperAge": { "type": "integer", "description": "Remaining time in current OSPF graceful restart\n interval, if the router is acting as a restart\n helper for the neighbor.", "minimum": 0, "maximum": 4294967295 }, "ospfNbrRestartHelperExitReason": { "type": "string", "description": "Describes the outcome of the last attempt at acting\n as a graceful restart helper for the neighbor." } } }, "example": { "OSPF-MIB:ospfNbrEntry": { "ospfNbrIpAddr": "192.168.1.1", "ospfNbrAddressLessIndex": "192.168.1.1", "ospfNbrRtrId": "example-string", "ospfNbrOptions": -2147483648, "ospfNbrPriority": "example-string", "ospfNbrState": "up(1)", "ospfNbrEvents": 0, "ospfNbrLsRetransQLen": 0, "ospfNbmaNbrStatus": "up(1)", "ospfNbmaNbrPermanence": "example-string", "ospfNbrHelloSuppressed": true, "ospfNbrRestartHelperStatus": "up(1)", "ospfNbrRestartHelperAge": 0, "ospfNbrRestartHelperExitReason": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfNbrEntry-4" }, "x-yang-path": "/ospfNbrEntry={ospfNbrIpAddr ospfNbrAddressLessIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfNbrIpAddr ospfNbrAddressLessIndex" ] }, "/data/OSPF-MIB:ospfVirtNbrEntry={ospfVirtNbrArea},{ospfVirtNbrRtrId}": { "get": { "summary": "Get ospfVirtNbrEntry entry", "description": "Retrieve specific ospfVirtNbrEntry entry by key from MIB", "tags": [ "OSPF-MIB" ], "parameters": [ { "name": "ospfVirtNbrArea", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfVirtNbrRtrId", "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": { "ospfVirtNbrArea": { "type": "string", "description": "The Transit Area Identifier.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfVirtNbrRtrId": { "type": "string", "description": "A 32-bit integer uniquely identifying the\n neighboring router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfVirtNbrIpAddr": { "type": "string", "description": "The IP address this virtual neighbor is using.", "format": "inet:ipv4-address" }, "ospfVirtNbrOptions": { "type": "integer", "description": "A bit mask corresponding to the neighbor's\n options field.\n \n Bit 1, if set, indicates that the system will\n operate on Type of Service metrics other than\n TOS 0. If zero, the neighbor will ignore all\n metrics except the TOS 0 metric.\n \n Bit 2, if set, indicates that the system is\n network multicast capable, i.e., that it\n implements OSPF multicast routing.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfVirtNbrState": { "type": "string", "description": "The state of the virtual neighbor relationship." }, "ospfVirtNbrEvents": { "type": "integer", "description": "The number of times this virtual link has\n changed its state or an error has occurred.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "ospfVirtNbrLsRetransQLen": { "type": "integer", "description": "The current length of the retransmission\n queue.", "minimum": 0, "maximum": 4294967295 }, "ospfVirtNbrHelloSuppressed": { "type": "boolean", "description": "Indicates whether Hellos are being suppressed\n to the neighbor." }, "ospfVirtNbrRestartHelperStatus": { "type": "string", "description": "Indicates whether the router is acting\n as a graceful restart helper for the neighbor." }, "ospfVirtNbrRestartHelperAge": { "type": "integer", "description": "Remaining time in current OSPF graceful restart\n interval, if the router is acting as a restart\n helper for the neighbor.", "minimum": 0, "maximum": 4294967295 }, "ospfVirtNbrRestartHelperExitReason": { "type": "string", "description": "Describes the outcome of the last attempt at acting\n as a graceful restart helper for the neighbor." } } }, "example": { "OSPF-MIB:ospfVirtNbrEntry": { "ospfVirtNbrArea": "example-string", "ospfVirtNbrRtrId": "example-string", "ospfVirtNbrIpAddr": "192.168.1.1", "ospfVirtNbrOptions": -2147483648, "ospfVirtNbrState": "up(1)", "ospfVirtNbrEvents": 0, "ospfVirtNbrLsRetransQLen": 0, "ospfVirtNbrHelloSuppressed": true, "ospfVirtNbrRestartHelperStatus": "up(1)", "ospfVirtNbrRestartHelperAge": 0, "ospfVirtNbrRestartHelperExitReason": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfVirtNbrEntry-4" }, "x-yang-path": "/ospfVirtNbrEntry={ospfVirtNbrArea ospfVirtNbrRtrId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfVirtNbrArea ospfVirtNbrRtrId" ] }, "/data/OSPF-MIB:ospfExtLsdbEntry={ospfExtLsdbType},{ospfExtLsdbLsid},{ospfExtLsdbRouterId}": { "get": { "summary": "Get ospfExtLsdbEntry entry", "description": "Retrieve specific ospfExtLsdbEntry entry by key from MIB", "tags": [ "OSPF-MIB" ], "parameters": [ { "name": "ospfExtLsdbType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfExtLsdbLsid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfExtLsdbRouterId", "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": { "ospfExtLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement\n format." }, "ospfExtLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing either a Router ID or an IP address;\n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address" }, "ospfExtLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfExtLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate link state\n advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfExtLsdbAge": { "type": "integer", "description": "This field is the age of the link state\n advertisement in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfExtLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete\n contents of the advertisement, excepting the\n age field. The age field is excepted so that\n an advertisement's age can be incremented\n without updating the checksum. The checksum\n used is the same that is used for ISO\n connectionless datagrams; it is commonly referred\n to as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfExtLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.", "format": "binary" } } }, "example": { "OSPF-MIB:ospfExtLsdbEntry": { "ospfExtLsdbType": "ethernetCsmacd(6)", "ospfExtLsdbLsid": "example-string", "ospfExtLsdbRouterId": "example-string", "ospfExtLsdbSequence": -2147483648, "ospfExtLsdbAge": -2147483648, "ospfExtLsdbChecksum": -2147483648, "ospfExtLsdbAdvertisement": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfExtLsdbEntry-4" }, "x-yang-path": "/ospfExtLsdbEntry={ospfExtLsdbType ospfExtLsdbLsid ospfExtLsdbRouterId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfExtLsdbType ospfExtLsdbLsid ospfExtLsdbRouterId" ] }, "/data/OSPF-MIB:ospfAreaAggregateEntry={ospfAreaAggregateAreaID},{ospfAreaAggregateLsdbType},{ospfAreaAggregateNet},{ospfAreaAggregateMask}": { "get": { "summary": "Get ospfAreaAggregateEntry entry", "description": "Retrieve specific ospfAreaAggregateEntry entry by key from MIB", "tags": [ "OSPF-MIB" ], "parameters": [ { "name": "ospfAreaAggregateAreaID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfAreaAggregateLsdbType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfAreaAggregateNet", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfAreaAggregateMask", "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": { "ospfAreaAggregateAreaID": { "type": "string", "description": "The area within which the address aggregate is to be\n found.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfAreaAggregateLsdbType": { "type": "string", "description": "The type of the address aggregate. This field\n specifies the Lsdb type that this address\n aggregate applies to." }, "ospfAreaAggregateNet": { "type": "string", "description": "The IP address of the net or subnet indicated\n by the range.", "format": "inet:ipv4-address" }, "ospfAreaAggregateMask": { "type": "string", "description": "The subnet mask that pertains to the net or\n subnet.", "format": "inet:ipv4-address" }, "ospfAreaAggregateStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ospfAreaAggregateEffect": { "type": "string", "description": "Subnets subsumed by ranges either trigger the\n advertisement of the indicated aggregate\n (advertiseMatching) or result in the subnet's not\n being advertised at all outside the area." }, "ospfAreaAggregateExtRouteTag": { "type": "integer", "description": "External route tag to be included in NSSA (type-7)\n LSAs.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "OSPF-MIB:ospfAreaAggregateEntry": { "ospfAreaAggregateAreaID": "example-string", "ospfAreaAggregateLsdbType": "ethernetCsmacd(6)", "ospfAreaAggregateNet": "example-string", "ospfAreaAggregateMask": "example-string", "ospfAreaAggregateStatus": "up(1)", "ospfAreaAggregateEffect": "example-string", "ospfAreaAggregateExtRouteTag": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfAreaAggregateEntry-4" }, "x-yang-path": "/ospfAreaAggregateEntry={ospfAreaAggregateAreaID ospfAreaAggregateLsdbType ospfAreaAggregateNet ospfAreaAggregateMask}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfAreaAggregateAreaID ospfAreaAggregateLsdbType ospfAreaAggregateNet ospfAreaAggregateMask" ] }, "/data/OSPF-MIB:ospfLocalLsdbEntry={ospfLocalLsdbIpAddress},{ospfLocalLsdbAddressLessIf},{ospfLocalLsdbType},{ospfLocalLsdbLsid},{ospfLocalLsdbRouterId}": { "get": { "summary": "Get ospfLocalLsdbEntry entry", "description": "Retrieve specific ospfLocalLsdbEntry entry by key from MIB", "tags": [ "OSPF-MIB" ], "parameters": [ { "name": "ospfLocalLsdbIpAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfLocalLsdbAddressLessIf", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfLocalLsdbType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfLocalLsdbLsid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfLocalLsdbRouterId", "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": { "ospfLocalLsdbIpAddress": { "type": "string", "description": "The IP address of the interface from\n which the LSA was received if the interface is\n numbered.", "format": "inet:ipv4-address" }, "ospfLocalLsdbAddressLessIf": { "type": "string", "description": "The interface index of the interface from\n which the LSA was received if the interface is\n unnumbered.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "ospfLocalLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate\n advertisement format." }, "ospfLocalLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing a 32-bit identifier in IP address format;\n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address" }, "ospfLocalLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfLocalLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate link state\n advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfLocalLsdbAge": { "type": "integer", "description": "This field is the age of the link state\n advertisement in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfLocalLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete\n contents of the advertisement, excepting the\n age field. The age field is excepted so that\n an advertisement's age can be incremented\n without updating the checksum. The checksum\n used is the same that is used for ISO\n connectionless datagrams; it is commonly referred\n to as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfLocalLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.\n \n Note that for variable length LSAs, SNMP agents\n may not be able to return the largest string size.", "format": "binary" } } }, "example": { "OSPF-MIB:ospfLocalLsdbEntry": { "ospfLocalLsdbIpAddress": "192.168.1.1", "ospfLocalLsdbAddressLessIf": "192.168.1.1", "ospfLocalLsdbType": "ethernetCsmacd(6)", "ospfLocalLsdbLsid": "example-string", "ospfLocalLsdbRouterId": "example-string", "ospfLocalLsdbSequence": -2147483648, "ospfLocalLsdbAge": -2147483648, "ospfLocalLsdbChecksum": -2147483648, "ospfLocalLsdbAdvertisement": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfLocalLsdbEntry-4" }, "x-yang-path": "/ospfLocalLsdbEntry={ospfLocalLsdbIpAddress ospfLocalLsdbAddressLessIf ospfLocalLsdbType ospfLocalLsdbLsid ospfLocalLsdbRouterId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfLocalLsdbIpAddress ospfLocalLsdbAddressLessIf ospfLocalLsdbType ospfLocalLsdbLsid ospfLocalLsdbRouterId" ] }, "/data/OSPF-MIB:ospfVirtLocalLsdbEntry={ospfVirtLocalLsdbTransitArea},{ospfVirtLocalLsdbNeighbor},{ospfVirtLocalLsdbType},{ospfVirtLocalLsdbLsid},{ospfVirtLocalLsdbRouterId}": { "get": { "summary": "Get ospfVirtLocalLsdbEntry entry", "description": "Retrieve specific ospfVirtLocalLsdbEntry entry by key from MIB", "tags": [ "OSPF-MIB" ], "parameters": [ { "name": "ospfVirtLocalLsdbTransitArea", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfVirtLocalLsdbNeighbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfVirtLocalLsdbType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfVirtLocalLsdbLsid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfVirtLocalLsdbRouterId", "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": { "ospfVirtLocalLsdbTransitArea": { "type": "string", "description": "The transit area that the virtual link\n traverses. By definition, this is not 0.0.0.0.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfVirtLocalLsdbNeighbor": { "type": "string", "description": "The Router ID of the virtual neighbor.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfVirtLocalLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate\n advertisement format." }, "ospfVirtLocalLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing a 32-bit identifier in IP address format;\n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address" }, "ospfVirtLocalLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfVirtLocalLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate link state\n advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfVirtLocalLsdbAge": { "type": "integer", "description": "This field is the age of the link state\n advertisement in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfVirtLocalLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete\n contents of the advertisement, excepting the\n age field. The age field is excepted so that\n \n an advertisement's age can be incremented\n without updating the checksum. The checksum\n used is the same that is used for ISO\n connectionless datagrams; it is commonly\n referred to as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfVirtLocalLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.", "format": "binary" } } }, "example": { "OSPF-MIB:ospfVirtLocalLsdbEntry": { "ospfVirtLocalLsdbTransitArea": "example-string", "ospfVirtLocalLsdbNeighbor": "example-string", "ospfVirtLocalLsdbType": "ethernetCsmacd(6)", "ospfVirtLocalLsdbLsid": "example-string", "ospfVirtLocalLsdbRouterId": "example-string", "ospfVirtLocalLsdbSequence": -2147483648, "ospfVirtLocalLsdbAge": -2147483648, "ospfVirtLocalLsdbChecksum": -2147483648, "ospfVirtLocalLsdbAdvertisement": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfVirtLocalLsdbEntry-4" }, "x-yang-path": "/ospfVirtLocalLsdbEntry={ospfVirtLocalLsdbTransitArea ospfVirtLocalLsdbNeighbor ospfVirtLocalLsdbType ospfVirtLocalLsdbLsid ospfVirtLocalLsdbRouterId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfVirtLocalLsdbTransitArea ospfVirtLocalLsdbNeighbor ospfVirtLocalLsdbType ospfVirtLocalLsdbLsid ospfVirtLocalLsdbRouterId" ] }, "/data/OSPF-MIB:ospfAsLsdbEntry={ospfAsLsdbType},{ospfAsLsdbLsid},{ospfAsLsdbRouterId}": { "get": { "summary": "Get ospfAsLsdbEntry entry", "description": "Retrieve specific ospfAsLsdbEntry entry by key from MIB", "tags": [ "OSPF-MIB" ], "parameters": [ { "name": "ospfAsLsdbType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfAsLsdbLsid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfAsLsdbRouterId", "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": { "ospfAsLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate\n advertisement format." }, "ospfAsLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing either a Router ID or an IP address;\n \n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address" }, "ospfAsLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID" }, "ospfAsLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate link state\n advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfAsLsdbAge": { "type": "integer", "description": "This field is the age of the link state\n advertisement in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfAsLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete\n contents of the advertisement, excepting the\n age field. The age field is excepted so that\n an advertisement's age can be incremented\n without updating the checksum. The checksum\n used is the same that is used for ISO\n connectionless datagrams; it is commonly referred\n to as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647 }, "ospfAsLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.", "format": "binary" } } }, "example": { "OSPF-MIB:ospfAsLsdbEntry": { "ospfAsLsdbType": "ethernetCsmacd(6)", "ospfAsLsdbLsid": "example-string", "ospfAsLsdbRouterId": "example-string", "ospfAsLsdbSequence": -2147483648, "ospfAsLsdbAge": -2147483648, "ospfAsLsdbChecksum": -2147483648, "ospfAsLsdbAdvertisement": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfAsLsdbEntry-4" }, "x-yang-path": "/ospfAsLsdbEntry={ospfAsLsdbType ospfAsLsdbLsid ospfAsLsdbRouterId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfAsLsdbType ospfAsLsdbLsid ospfAsLsdbRouterId" ] }, "/data/OSPF-MIB:ospfAreaLsaCountEntry={ospfAreaLsaCountAreaId},{ospfAreaLsaCountLsaType}": { "get": { "summary": "Get ospfAreaLsaCountEntry entry", "description": "Retrieve specific ospfAreaLsaCountEntry entry by key from MIB", "tags": [ "OSPF-MIB" ], "parameters": [ { "name": "ospfAreaLsaCountAreaId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ospfAreaLsaCountLsaType", "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": { "ospfAreaLsaCountAreaId": { "type": "string", "description": "This entry Area ID.", "x-yang-type": "OSPF-MIB:AreaID" }, "ospfAreaLsaCountLsaType": { "type": "string", "description": "This entry LSA type." }, "ospfAreaLsaCountNumber": { "type": "integer", "description": "Number of LSAs of a given type for a given area.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "OSPF-MIB:ospfAreaLsaCountEntry": { "ospfAreaLsaCountAreaId": "example-string", "ospfAreaLsaCountLsaType": "ethernetCsmacd(6)", "ospfAreaLsaCountNumber": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ospfAreaLsaCountEntry-4" }, "x-yang-path": "/ospfAreaLsaCountEntry={ospfAreaLsaCountAreaId ospfAreaLsaCountLsaType}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfAreaLsaCountAreaId ospfAreaLsaCountLsaType" ] } }, "components": { "schemas": { "OSPF-MIB_OSPF-MIB": { "type": "object", "description": "OSPF-MIB", "properties": { "ospfAreaEntry": { "type": "array", "description": "ospfAreaEntry", "items": { "type": "object", "properties": { "ospfAreaId": { "type": "string", "description": "A 32-bit integer uniquely identifying an area.\n Area ID 0.0.0.0 is used for the OSPF backbone.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true }, "ospfAuthType": { "type": "string", "description": "The authentication type specified for an area.", "x-yang-type": "OSPF-MIB:OspfAuthenticationType", "readOnly": true }, "ospfImportAsExtern": { "type": "string", "description": "Indicates if an area is a stub area, NSSA, or standard\n area. Type-5 AS-external LSAs and type-11 Opaque LSAs are\n not imported into stub areas or NSSAs. NSSAs import\n AS-external data as type-7 LSAs", "readOnly": true }, "ospfSpfRuns": { "type": "integer", "description": "The number of times that the intra-area route\n table has been calculated using this area's\n link state database. This is typically done\n using Dijkstra's algorithm.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfAreaBdrRtrCount": { "type": "integer", "description": "The total number of Area Border Routers reachable\n within this area. This is initially zero and is\n calculated in each Shortest Path First (SPF) pass.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfAsBdrRtrCount": { "type": "integer", "description": "The total number of Autonomous System Border\n Routers reachable within this area. This is\n initially zero and is calculated in each SPF\n pass.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfAreaLsaCount": { "type": "integer", "description": "The total number of link state advertisements\n in this area's link state database, excluding\n AS-external LSAs.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfAreaLsaCksumSum": { "type": "integer", "description": "The 32-bit sum of the link state\n advertisements' LS checksums contained in this\n area's link state database. This sum excludes\n external (LS type-5) link state advertisements.\n The sum can be used to determine if there has\n been a change in a router's link state\n database, and to compare the link state database of\n two routers. The value should be treated as unsigned\n when comparing two sums of checksums.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfAreaSummary": { "type": "string", "description": "The variable ospfAreaSummary controls the\n import of summary LSAs into stub and NSSA areas.\n It has no effect on other areas.\n \n If it is noAreaSummary, the router will not\n originate summary LSAs into the stub or NSSA area.\n It will rely entirely on its default route.\n \n If it is sendAreaSummary, the router will both\n summarize and propagate summary LSAs.", "readOnly": true }, "ospfAreaStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ospfAreaNssaTranslatorRole": { "type": "string", "description": "Indicates an NSSA border router's ability to\n perform NSSA translation of type-7 LSAs into\n type-5 LSAs.", "readOnly": true }, "ospfAreaNssaTranslatorState": { "type": "string", "description": "Indicates if and how an NSSA border router is\n performing NSSA translation of type-7 LSAs into type-5\n \n LSAs. When this object is set to enabled, the NSSA Border\n router's OspfAreaNssaExtTranslatorRole has been set to\n always. When this object is set to elected, a candidate\n NSSA Border router is Translating type-7 LSAs into type-5.\n When this object is set to disabled, a candidate NSSA\n border router is NOT translating type-7 LSAs into type-5.", "readOnly": true }, "ospfAreaNssaTranslatorStabilityInterval": { "type": "string", "description": "The number of seconds after an elected translator\n determines its services are no longer required, that\n it should continue to perform its translation duties.", "x-yang-type": "OSPF-MIB:PositiveInteger", "readOnly": true }, "ospfAreaNssaTranslatorEvents": { "type": "integer", "description": "Indicates the number of translator state changes\n that have occurred since the last boot-up.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "ospfStubAreaEntry": { "type": "array", "description": "The metric for a given Type of Service that\n will be advertised by a default Area Border\n Router into a stub area.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfStubAreaId": { "type": "string", "description": "The 32-bit identifier for the stub area. On\n creation, this can be derived from the\n instance.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true }, "ospfStubTOS": { "type": "string", "description": "The Type of Service associated with the\n metric. On creation, this can be derived from\n \n the instance.", "x-yang-type": "OSPF-MIB:TOSType", "readOnly": true }, "ospfStubMetric": { "type": "string", "description": "The metric value applied at the indicated Type\n of Service. By default, this equals the least\n metric at the Type of Service among the\n interfaces to other areas.", "x-yang-type": "OSPF-MIB:BigMetric", "readOnly": true }, "ospfStubStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ospfStubMetricType": { "type": "string", "description": "This variable displays the type of metric\n advertised as a default route.", "readOnly": true } } }, "readOnly": true }, "ospfLsdbEntry": { "type": "array", "description": "A single link state advertisement.", "items": { "type": "object", "properties": { "ospfLsdbAreaId": { "type": "string", "description": "The 32-bit identifier of the area from which\n the LSA was received.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true }, "ospfLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement\n format.\n \n Note: External link state advertisements are permitted\n for backward compatibility, but should be displayed\n in the ospfAsLsdbTable rather than here.", "readOnly": true }, "ospfLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing either a Router ID or an IP address;\n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address", "readOnly": true }, "ospfLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true }, "ospfLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate Link State\n Advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfLsdbAge": { "type": "integer", "description": "This field is the age of the link state advertisement\n in seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete contents of\n the advertisement, excepting the age field. The age field\n is excepted so that an advertisement's age can be\n incremented without updating the checksum. The checksum\n used is the same that is used for ISO connectionless\n \n datagrams; it is commonly referred to as the\n Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.\n \n Note that for variable length LSAs, SNMP agents\n may not be able to return the largest string size.", "format": "binary", "readOnly": true } } }, "readOnly": true }, "ospfAreaRangeEntry": { "type": "array", "description": "A single area address range.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfAreaRangeAreaId": { "type": "string", "description": "The area that the address range is to be found\n within.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true }, "ospfAreaRangeNet": { "type": "string", "description": "The IP address of the net or subnet indicated\n by the range.", "format": "inet:ipv4-address", "readOnly": true }, "ospfAreaRangeMask": { "type": "string", "description": "The subnet mask that pertains to the net or\n subnet.", "format": "inet:ipv4-address", "readOnly": true }, "ospfAreaRangeStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ospfAreaRangeEffect": { "type": "string", "description": "Subnets subsumed by ranges either trigger the\n advertisement of the indicated summary\n (advertiseMatching) or result in the subnet's not\n being advertised at all outside the area.", "readOnly": true } } }, "readOnly": true }, "ospfHostEntry": { "type": "array", "description": "A metric to be advertised, for a given type of\n service, when a given host is reachable.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfHostIpAddress": { "type": "string", "description": "The IP address of the host.", "format": "inet:ipv4-address", "readOnly": true }, "ospfHostTOS": { "type": "string", "description": "The Type of Service of the route being configured.", "x-yang-type": "OSPF-MIB:TOSType", "readOnly": true }, "ospfHostMetric": { "type": "string", "description": "The metric to be advertised.", "x-yang-type": "OSPF-MIB:Metric", "readOnly": true }, "ospfHostStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ospfHostAreaID": { "type": "string", "description": "The OSPF area to which the host belongs.\n Deprecated by ospfHostCfgAreaID.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true }, "ospfHostCfgAreaID": { "type": "string", "description": "To configure the OSPF area to which the host belongs.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true } } }, "readOnly": true }, "ospfIfEntry": { "type": "array", "description": "The OSPF interface entry describes one interface\n from the viewpoint of OSPF.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfIfIpAddress": { "type": "string", "description": "The IP address of this OSPF interface.", "format": "inet:ipv4-address", "readOnly": true }, "ospfAddressLessIf": { "type": "string", "description": "For the purpose of easing the instancing of\n addressed and addressless interfaces; this\n variable takes the value 0 on interfaces with\n IP addresses and the corresponding value of\n ifIndex for interfaces having no IP address.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "ospfIfAreaId": { "type": "string", "description": "A 32-bit integer uniquely identifying the area\n to which the interface connects. Area ID\n 0.0.0.0 is used for the OSPF backbone.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true }, "ospfIfType": { "type": "string", "description": "The OSPF interface type.\n By way of a default, this field may be intuited\n from the corresponding value of ifType.\n Broadcast LANs, such as Ethernet and IEEE 802.5,\n take the value 'broadcast', X.25 and similar\n technologies take the value 'nbma', and links\n that are definitively point to point take the\n value 'pointToPoint'.", "readOnly": true }, "ospfIfAdminStat": { "type": "string", "description": "The OSPF interface's administrative status.\n The value formed on the interface, and the interface\n will be advertised as an internal route to some area.\n The value 'disabled' denotes that the interface is\n external to OSPF.", "x-yang-type": "OSPF-MIB:Status", "readOnly": true }, "ospfIfRtrPriority": { "type": "string", "description": "The priority of this interface. Used in\n multi-access networks, this field is used in\n the designated router election algorithm. The\n value 0 signifies that the router is not eligible\n to become the designated router on this particular\n network. In the event of a tie in this value,\n routers will use their Router ID as a tie breaker.", "x-yang-type": "OSPF-MIB:DesignatedRouterPriority", "readOnly": true }, "ospfIfTransitDelay": { "type": "string", "description": "The estimated number of seconds it takes to\n transmit a link state update packet over this\n interface. Note that the minimal value SHOULD be\n 1 second.", "x-yang-type": "OSPF-MIB:UpToMaxAge", "readOnly": true }, "ospfIfRetransInterval": { "type": "string", "description": "The number of seconds between link state advertisement\n retransmissions, for adjacencies belonging to this\n interface. This value is also used when retransmitting\n \n database description and Link State request packets.\n Note that minimal value SHOULD be 1 second.", "x-yang-type": "OSPF-MIB:UpToMaxAge", "readOnly": true }, "ospfIfHelloInterval": { "type": "string", "description": "The length of time, in seconds, between the Hello packets\n that the router sends on the interface. This value must be\n the same for all routers attached to a common network.", "x-yang-type": "OSPF-MIB:HelloRange", "readOnly": true }, "ospfIfRtrDeadInterval": { "type": "string", "description": "The number of seconds that a router's Hello packets have\n not been seen before its neighbors declare the router down.\n This should be some multiple of the Hello interval. This\n value must be the same for all routers attached to a common\n network.", "x-yang-type": "OSPF-MIB:PositiveInteger", "readOnly": true }, "ospfIfPollInterval": { "type": "string", "description": "The larger time interval, in seconds, between the Hello\n packets sent to an inactive non-broadcast multi-access\n neighbor.", "x-yang-type": "OSPF-MIB:PositiveInteger", "readOnly": true }, "ospfIfState": { "type": "string", "description": "The OSPF Interface State.", "readOnly": true }, "ospfIfDesignatedRouter": { "type": "string", "description": "The IP address of the designated router.", "format": "inet:ipv4-address", "readOnly": true }, "ospfIfBackupDesignatedRouter": { "type": "string", "description": "The IP address of the backup designated\n router.", "format": "inet:ipv4-address", "readOnly": true }, "ospfIfEvents": { "type": "integer", "description": "The number of times this OSPF interface has\n changed its state or an error has occurred.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfIfAuthKey": { "type": "string", "description": "The cleartext password used as an OSPF\n authentication key when simplePassword security\n is enabled. This object does not access any OSPF\n cryptogaphic (e.g., MD5) authentication key under\n any circumstance.\n \n If the key length is shorter than 8 octets, the\n agent will left adjust and zero fill to 8 octets.\n \n Unauthenticated interfaces need no authentication\n key, and simple password authentication cannot use\n a key of more than 8 octets.\n \n Note that the use of simplePassword authentication\n is NOT recommended when there is concern regarding\n attack upon the OSPF system. SimplePassword\n authentication is only sufficient to protect against\n accidental misconfigurations because it re-uses\n cleartext passwords [RFC1704].\n \n When read, ospfIfAuthKey always returns an octet\n string of length zero.", "format": "binary", "readOnly": true }, "ospfIfStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ospfIfMulticastForwarding": { "type": "string", "description": "The way multicasts should be forwarded on this\n interface: not forwarded, forwarded as data\n link multicasts, or forwarded as data link\n unicasts. Data link multicasting is not\n meaningful on point-to-point and NBMA interfaces,\n and setting ospfMulticastForwarding to 0 effectively\n disables all multicast forwarding.", "readOnly": true }, "ospfIfDemand": { "type": "boolean", "description": "Indicates whether Demand OSPF procedures (hello\n suppression to FULL neighbors and setting the\n DoNotAge flag on propagated LSAs) should be\n performed on this interface.", "readOnly": true }, "ospfIfAuthType": { "type": "string", "description": "The authentication type specified for an interface.\n \n Note that this object can be used to engage\n in significant attacks against an OSPF router.", "x-yang-type": "OSPF-MIB:OspfAuthenticationType", "readOnly": true }, "ospfIfLsaCount": { "type": "integer", "description": "The total number of link-local link state advertisements\n in this interface's link-local link state database.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfIfLsaCksumSum": { "type": "integer", "description": "The 32-bit unsigned sum of the Link State\n Advertisements' LS checksums contained in this\n interface's link-local link state database.\n The sum can be used to determine if there has\n been a change in the interface's link state\n database and to compare the interface link state\n database of routers attached to the same subnet.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfIfDesignatedRouterId": { "type": "string", "description": "The Router ID of the designated router.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true }, "ospfIfBackupDesignatedRouterId": { "type": "string", "description": "The Router ID of the backup designated router.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true } } }, "readOnly": true }, "ospfIfMetricEntry": { "type": "array", "description": "A particular TOS metric for a non-virtual interface\n identified by the interface index.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfIfMetricIpAddress": { "type": "string", "description": "The IP address of this OSPF interface. On row\n creation, this can be derived from the instance.", "format": "inet:ipv4-address", "readOnly": true }, "ospfIfMetricAddressLessIf": { "type": "string", "description": "For the purpose of easing the instancing of\n addressed and addressless interfaces; this\n variable takes the value 0 on interfaces with\n IP addresses and the value of ifIndex for\n interfaces having no IP address. On row\n creation, this can be derived from the instance.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "ospfIfMetricTOS": { "type": "string", "description": "The Type of Service metric being referenced.\n On row creation, this can be derived from the\n instance.", "x-yang-type": "OSPF-MIB:TOSType", "readOnly": true }, "ospfIfMetricValue": { "type": "string", "description": "The metric of using this Type of Service on\n this interface. The default value of the TOS 0\n metric is 10^8 / ifSpeed.", "x-yang-type": "OSPF-MIB:Metric", "readOnly": true }, "ospfIfMetricStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "ospfVirtIfEntry": { "type": "array", "description": "Information about a single virtual interface.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfVirtIfAreaId": { "type": "string", "description": "The transit area that the virtual link\n traverses. By definition, this is not 0.0.0.0.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true }, "ospfVirtIfNeighbor": { "type": "string", "description": "The Router ID of the virtual neighbor.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true }, "ospfVirtIfTransitDelay": { "type": "string", "description": "The estimated number of seconds it takes to\n transmit a Link State update packet over this\n interface. Note that the minimal value SHOULD be\n 1 second.", "x-yang-type": "OSPF-MIB:UpToMaxAge", "readOnly": true }, "ospfVirtIfRetransInterval": { "type": "string", "description": "The number of seconds between link state\n avertisement retransmissions, for adjacencies\n belonging to this interface. This value is\n also used when retransmitting database\n description and Link State request packets. This\n value should be well over the expected\n round-trip time. Note that the minimal value SHOULD be\n 1 second.", "x-yang-type": "OSPF-MIB:UpToMaxAge", "readOnly": true }, "ospfVirtIfHelloInterval": { "type": "string", "description": "The length of time, in seconds, between the\n Hello packets that the router sends on the\n interface. This value must be the same for the\n virtual neighbor.", "x-yang-type": "OSPF-MIB:HelloRange", "readOnly": true }, "ospfVirtIfRtrDeadInterval": { "type": "string", "description": "The number of seconds that a router's Hello\n packets have not been seen before its\n neighbors declare the router down. This should be\n some multiple of the Hello interval. This\n value must be the same for the virtual neighbor.", "x-yang-type": "OSPF-MIB:PositiveInteger", "readOnly": true }, "ospfVirtIfState": { "type": "string", "description": "OSPF virtual interface states.", "readOnly": true }, "ospfVirtIfEvents": { "type": "integer", "description": "The number of state changes or error events on\n this virtual link.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfVirtIfAuthKey": { "type": "string", "description": "The cleartext password used as an OSPF\n authentication key when simplePassword security\n is enabled. This object does not access any OSPF\n cryptogaphic (e.g., MD5) authentication key under\n any circumstance.\n \n If the key length is shorter than 8 octets, the\n agent will left adjust and zero fill to 8 octets.\n \n Unauthenticated interfaces need no authentication\n key, and simple password authentication cannot use\n a key of more than 8 octets.\n \n Note that the use of simplePassword authentication\n is NOT recommended when there is concern regarding\n attack upon the OSPF system. SimplePassword\n authentication is only sufficient to protect against\n accidental misconfigurations because it re-uses\n cleartext passwords. [RFC1704]\n \n When read, ospfIfAuthKey always returns an octet\n string of length zero.", "format": "binary", "readOnly": true }, "ospfVirtIfStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ospfVirtIfAuthType": { "type": "string", "description": "The authentication type specified for a virtual interface.\n \n Note that this object can be used to engage\n in significant attacks against an OSPF router.", "x-yang-type": "OSPF-MIB:OspfAuthenticationType", "readOnly": true }, "ospfVirtIfLsaCount": { "type": "integer", "description": "The total number of link-local link state advertisements\n in this virtual interface's link-local link state database.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfVirtIfLsaCksumSum": { "type": "integer", "description": "The 32-bit unsigned sum of the link state\n advertisements' LS checksums contained in this\n virtual interface's link-local link state database.\n The sum can be used to determine if there has\n been a change in the virtual interface's link state\n database, and to compare the virtual interface\n link state database of the virtual neighbors.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "ospfNbrEntry": { "type": "array", "description": "The information regarding a single neighbor.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n \n storage.", "items": { "type": "object", "properties": { "ospfNbrIpAddr": { "type": "string", "description": "The IP address this neighbor is using in its\n IP source address. Note that, on addressless\n links, this will not be 0.0.0.0 but the\n \n address of another of the neighbor's interfaces.", "format": "inet:ipv4-address", "readOnly": true }, "ospfNbrAddressLessIndex": { "type": "string", "description": "On an interface having an IP address, zero.\n On addressless interfaces, the corresponding\n value of ifIndex in the Internet Standard MIB.\n On row creation, this can be derived from the\n instance.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "ospfNbrRtrId": { "type": "string", "description": "A 32-bit integer (represented as a type\n IpAddress) uniquely identifying the neighboring\n router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true }, "ospfNbrOptions": { "type": "integer", "description": "A bit mask corresponding to the neighbor's\n options field.\n \n Bit 0, if set, indicates that the system will\n operate on Type of Service metrics other than\n TOS 0. If zero, the neighbor will ignore all\n metrics except the TOS 0 metric.\n \n Bit 1, if set, indicates that the associated\n area accepts and operates on external\n information; if zero, it is a stub area.\n \n Bit 2, if set, indicates that the system is\n capable of routing IP multicast datagrams, that is\n that it implements the multicast extensions to\n OSPF.\n \n Bit 3, if set, indicates that the associated\n area is an NSSA. These areas are capable of\n carrying type-7 external advertisements, which\n are translated into type-5 external advertisements\n at NSSA borders.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfNbrPriority": { "type": "string", "description": "The priority of this neighbor in the designated\n router election algorithm. The value 0 signifies\n that the neighbor is not eligible to become\n the designated router on this particular network.", "x-yang-type": "OSPF-MIB:DesignatedRouterPriority", "readOnly": true }, "ospfNbrState": { "type": "string", "description": "The state of the relationship with this neighbor.", "readOnly": true }, "ospfNbrEvents": { "type": "integer", "description": "The number of times this neighbor relationship\n has changed state or an error has occurred.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfNbrLsRetransQLen": { "type": "integer", "description": "The current length of the retransmission\n queue.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfNbmaNbrStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ospfNbmaNbrPermanence": { "type": "string", "description": "This variable displays the status of the entry;\n 'dynamic' and 'permanent' refer to how the neighbor\n became known.", "readOnly": true }, "ospfNbrHelloSuppressed": { "type": "boolean", "description": "Indicates whether Hellos are being suppressed\n to the neighbor.", "readOnly": true }, "ospfNbrRestartHelperStatus": { "type": "string", "description": "Indicates whether the router is acting\n as a graceful restart helper for the neighbor.", "readOnly": true }, "ospfNbrRestartHelperAge": { "type": "integer", "description": "Remaining time in current OSPF graceful restart\n interval, if the router is acting as a restart\n helper for the neighbor.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfNbrRestartHelperExitReason": { "type": "string", "description": "Describes the outcome of the last attempt at acting\n as a graceful restart helper for the neighbor.", "readOnly": true } } }, "readOnly": true }, "ospfVirtNbrEntry": { "type": "array", "description": "Virtual neighbor information.", "items": { "type": "object", "properties": { "ospfVirtNbrArea": { "type": "string", "description": "The Transit Area Identifier.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true }, "ospfVirtNbrRtrId": { "type": "string", "description": "A 32-bit integer uniquely identifying the\n neighboring router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true }, "ospfVirtNbrIpAddr": { "type": "string", "description": "The IP address this virtual neighbor is using.", "format": "inet:ipv4-address", "readOnly": true }, "ospfVirtNbrOptions": { "type": "integer", "description": "A bit mask corresponding to the neighbor's\n options field.\n \n Bit 1, if set, indicates that the system will\n operate on Type of Service metrics other than\n TOS 0. If zero, the neighbor will ignore all\n metrics except the TOS 0 metric.\n \n Bit 2, if set, indicates that the system is\n network multicast capable, i.e., that it\n implements OSPF multicast routing.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfVirtNbrState": { "type": "string", "description": "The state of the virtual neighbor relationship.", "readOnly": true }, "ospfVirtNbrEvents": { "type": "integer", "description": "The number of times this virtual link has\n changed its state or an error has occurred.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfVirtNbrLsRetransQLen": { "type": "integer", "description": "The current length of the retransmission\n queue.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfVirtNbrHelloSuppressed": { "type": "boolean", "description": "Indicates whether Hellos are being suppressed\n to the neighbor.", "readOnly": true }, "ospfVirtNbrRestartHelperStatus": { "type": "string", "description": "Indicates whether the router is acting\n as a graceful restart helper for the neighbor.", "readOnly": true }, "ospfVirtNbrRestartHelperAge": { "type": "integer", "description": "Remaining time in current OSPF graceful restart\n interval, if the router is acting as a restart\n helper for the neighbor.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfVirtNbrRestartHelperExitReason": { "type": "string", "description": "Describes the outcome of the last attempt at acting\n as a graceful restart helper for the neighbor.", "readOnly": true } } }, "readOnly": true }, "ospfExtLsdbEntry": { "type": "array", "description": "A single link state advertisement.", "items": { "type": "object", "properties": { "ospfExtLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement\n format.", "readOnly": true }, "ospfExtLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing either a Router ID or an IP address;\n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address", "readOnly": true }, "ospfExtLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true }, "ospfExtLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate link state\n advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfExtLsdbAge": { "type": "integer", "description": "This field is the age of the link state\n advertisement in seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfExtLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete\n contents of the advertisement, excepting the\n age field. The age field is excepted so that\n an advertisement's age can be incremented\n without updating the checksum. The checksum\n used is the same that is used for ISO\n connectionless datagrams; it is commonly referred\n to as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfExtLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.", "format": "binary", "readOnly": true } } }, "readOnly": true }, "ospfAreaAggregateEntry": { "type": "array", "description": "A single area aggregate entry.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfAreaAggregateAreaID": { "type": "string", "description": "The area within which the address aggregate is to be\n found.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true }, "ospfAreaAggregateLsdbType": { "type": "string", "description": "The type of the address aggregate. This field\n specifies the Lsdb type that this address\n aggregate applies to.", "readOnly": true }, "ospfAreaAggregateNet": { "type": "string", "description": "The IP address of the net or subnet indicated\n by the range.", "format": "inet:ipv4-address", "readOnly": true }, "ospfAreaAggregateMask": { "type": "string", "description": "The subnet mask that pertains to the net or\n subnet.", "format": "inet:ipv4-address", "readOnly": true }, "ospfAreaAggregateStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ospfAreaAggregateEffect": { "type": "string", "description": "Subnets subsumed by ranges either trigger the\n advertisement of the indicated aggregate\n (advertiseMatching) or result in the subnet's not\n being advertised at all outside the area.", "readOnly": true }, "ospfAreaAggregateExtRouteTag": { "type": "integer", "description": "External route tag to be included in NSSA (type-7)\n LSAs.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "ospfLocalLsdbEntry": { "type": "array", "description": "A single link state advertisement.", "items": { "type": "object", "properties": { "ospfLocalLsdbIpAddress": { "type": "string", "description": "The IP address of the interface from\n which the LSA was received if the interface is\n numbered.", "format": "inet:ipv4-address", "readOnly": true }, "ospfLocalLsdbAddressLessIf": { "type": "string", "description": "The interface index of the interface from\n which the LSA was received if the interface is\n unnumbered.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "ospfLocalLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate\n advertisement format.", "readOnly": true }, "ospfLocalLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing a 32-bit identifier in IP address format;\n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address", "readOnly": true }, "ospfLocalLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true }, "ospfLocalLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate link state\n advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfLocalLsdbAge": { "type": "integer", "description": "This field is the age of the link state\n advertisement in seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfLocalLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete\n contents of the advertisement, excepting the\n age field. The age field is excepted so that\n an advertisement's age can be incremented\n without updating the checksum. The checksum\n used is the same that is used for ISO\n connectionless datagrams; it is commonly referred\n to as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfLocalLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.\n \n Note that for variable length LSAs, SNMP agents\n may not be able to return the largest string size.", "format": "binary", "readOnly": true } } }, "readOnly": true }, "ospfVirtLocalLsdbEntry": { "type": "array", "description": "A single link state advertisement.", "items": { "type": "object", "properties": { "ospfVirtLocalLsdbTransitArea": { "type": "string", "description": "The transit area that the virtual link\n traverses. By definition, this is not 0.0.0.0.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true }, "ospfVirtLocalLsdbNeighbor": { "type": "string", "description": "The Router ID of the virtual neighbor.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true }, "ospfVirtLocalLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate\n advertisement format.", "readOnly": true }, "ospfVirtLocalLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing a 32-bit identifier in IP address format;\n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address", "readOnly": true }, "ospfVirtLocalLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true }, "ospfVirtLocalLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate link state\n advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfVirtLocalLsdbAge": { "type": "integer", "description": "This field is the age of the link state\n advertisement in seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfVirtLocalLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete\n contents of the advertisement, excepting the\n age field. The age field is excepted so that\n \n an advertisement's age can be incremented\n without updating the checksum. The checksum\n used is the same that is used for ISO\n connectionless datagrams; it is commonly\n referred to as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfVirtLocalLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.", "format": "binary", "readOnly": true } } }, "readOnly": true }, "ospfAsLsdbEntry": { "type": "array", "description": "A single link state advertisement.", "items": { "type": "object", "properties": { "ospfAsLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate\n advertisement format.", "readOnly": true }, "ospfAsLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing either a Router ID or an IP address;\n \n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address", "readOnly": true }, "ospfAsLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true }, "ospfAsLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate link state\n advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfAsLsdbAge": { "type": "integer", "description": "This field is the age of the link state\n advertisement in seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfAsLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete\n contents of the advertisement, excepting the\n age field. The age field is excepted so that\n an advertisement's age can be incremented\n without updating the checksum. The checksum\n used is the same that is used for ISO\n connectionless datagrams; it is commonly referred\n to as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfAsLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.", "format": "binary", "readOnly": true } } }, "readOnly": true }, "ospfAreaLsaCountEntry": { "type": "array", "description": "An entry with a number of link advertisements\n \n of a given type for a given area.", "items": { "type": "object", "properties": { "ospfAreaLsaCountAreaId": { "type": "string", "description": "This entry Area ID.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true }, "ospfAreaLsaCountLsaType": { "type": "string", "description": "This entry LSA type.", "readOnly": true }, "ospfAreaLsaCountNumber": { "type": "integer", "description": "Number of LSAs of a given type for a given area.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "ospfGeneralGroup": { "type": "object", "description": "A 32-bit integer uniquely identifying the\n router in the Autonomous System.\n By convention, to ensure uniqueness, this\n should default to the value of one of the\n router's IP interface addresses.\n \n This object is persistent and when written\n the entity SHOULD save the change to non-volatile storage.", "properties": { "ospfRouterId": { "type": "string", "description": "A 32-bit integer uniquely identifying the\n router in the Autonomous System.\n By convention, to ensure uniqueness, this\n should default to the value of one of the\n router's IP interface addresses.\n \n This object is persistent and when written\n the entity SHOULD save the change to non-volatile storage.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true }, "ospfAdminStat": { "type": "string", "description": "The administrative status of OSPF in the\n router. The value 'enabled' denotes that the\n OSPF Process is active on at least one interface;\n 'disabled' disables it on all interfaces.\n \n This object is persistent and when written\n the entity SHOULD save the change to non-volatile storage.", "x-yang-type": "OSPF-MIB:Status", "readOnly": true }, "ospfVersionNumber": { "type": "string", "description": "The current version number of the OSPF protocol is 2.", "readOnly": true }, "ospfAreaBdrRtrStatus": { "type": "boolean", "description": "A flag to note whether this router is an Area\n Border Router.", "readOnly": true }, "ospfASBdrRtrStatus": { "type": "boolean", "description": "A flag to note whether this router is configured as\n an Autonomous System Border Router.\n \n This object is persistent and when written the\n entity SHOULD save the change to non-volatile storage.", "readOnly": true }, "ospfExternLsaCount": { "type": "integer", "description": "The number of external (LS type-5) link state\n advertisements in the link state database.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfExternLsaCksumSum": { "type": "integer", "description": "The 32-bit sum of the LS checksums of\n the external link state advertisements\n contained in the link state database. This sum\n can be used to determine if there has been a\n change in a router's link state database and\n to compare the link state database of two\n routers. The value should be treated as unsigned\n when comparing two sums of checksums.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfTOSSupport": { "type": "boolean", "description": "The router's support for type-of-service routing.\n \n This object is persistent and when written\n the entity SHOULD save the change to non-volatile\n storage.", "readOnly": true }, "ospfOriginateNewLsas": { "type": "integer", "description": "The number of new link state advertisements\n that have been originated. This number is\n incremented each time the router originates a new\n LSA.\n \n Discontinuities in the value of this counter can\n occur at re-initialization of the management system,\n and at other times as indicated by the value of\n ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfRxNewLsas": { "type": "integer", "description": "The number of link state advertisements received\n that are determined to be new instantiations.\n This number does not include newer instantiations\n of self-originated link state advertisements.\n \n Discontinuities in the value of this counter can\n occur at re-initialization of the management system,\n and at other times as indicated by the value of\n ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfExtLsdbLimit": { "type": "integer", "description": "The maximum number of non-default\n AS-external LSAs entries that can be stored in the\n link state database. If the value is -1, then\n there is no limit.\n \n When the number of non-default AS-external LSAs\n in a router's link state database reaches\n ospfExtLsdbLimit, the router enters\n overflow state. The router never holds more than\n ospfExtLsdbLimit non-default AS-external LSAs\n in its database. OspfExtLsdbLimit MUST be set\n identically in all routers attached to the OSPF\n backbone and/or any regular OSPF area (i.e.,\n OSPF stub areas and NSSAs are excluded).\n \n This object is persistent and when written\n the entity SHOULD save the change to non-volatile\n storage.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfMulticastExtensions": { "type": "integer", "description": "A bit mask indicating whether the router is\n forwarding IP multicast (Class D) datagrams\n based on the algorithms defined in the\n multicast extensions to OSPF.\n \n Bit 0, if set, indicates that the router can\n \n forward IP multicast datagrams in the router's\n directly attached areas (called intra-area\n multicast routing).\n \n Bit 1, if set, indicates that the router can\n forward IP multicast datagrams between OSPF\n areas (called inter-area multicast routing).\n \n Bit 2, if set, indicates that the router can\n forward IP multicast datagrams between\n Autonomous Systems (called inter-AS multicast\n routing).\n \n Only certain combinations of bit settings are\n allowed, namely: 0 (no multicast forwarding is\n enabled), 1 (intra-area multicasting only), 3\n (intra-area and inter-area multicasting), 5\n (intra-area and inter-AS multicasting), and 7\n (multicasting everywhere). By default, no\n multicast forwarding is enabled.\n \n This object is persistent and when written\n the entity SHOULD save the change to non-volatile\n storage.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfExitOverflowInterval": { "type": "string", "description": "The number of seconds that, after entering\n OverflowState, a router will attempt to leave\n OverflowState. This allows the router to again\n originate non-default AS-external LSAs. When\n set to 0, the router will not leave\n overflow state until restarted.\n \n This object is persistent and when written\n the entity SHOULD save the change to non-volatile\n storage.", "x-yang-type": "OSPF-MIB:PositiveInteger", "readOnly": true }, "ospfDemandExtensions": { "type": "boolean", "description": "The router's support for demand routing.\n This object is persistent and when written\n the entity SHOULD save the change to non-volatile\n storage.", "readOnly": true }, "ospfRFC1583Compatibility": { "type": "boolean", "description": "Indicates metrics used to choose among multiple\n AS-external LSAs. When RFC1583Compatibility is set to\n enabled, only cost will be used when choosing among\n multiple AS-external LSAs advertising the same\n destination. When RFC1583Compatibility is set to\n disabled, preference will be driven first by type of\n path using cost only to break ties.\n \n This object is persistent and when written\n the entity SHOULD save the change to non-volatile\n storage.", "readOnly": true }, "ospfOpaqueLsaSupport": { "type": "boolean", "description": "The router's support for Opaque LSA types.", "readOnly": true }, "ospfReferenceBandwidth": { "type": "integer", "description": "Reference bandwidth in kilobits/second for\n \n calculating default interface metrics. The\n default value is 100,000 KBPS (100 MBPS).\n \n This object is persistent and when written\n the entity SHOULD save the change to non-volatile\n storage.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfRestartSupport": { "type": "string", "description": "The router's support for OSPF graceful restart.\n Options include: no restart support, only planned\n restarts, or both planned and unplanned restarts.\n \n This object is persistent and when written\n the entity SHOULD save the change to non-volatile\n storage.", "readOnly": true }, "ospfRestartInterval": { "type": "integer", "description": "Configured OSPF graceful restart timeout interval.\n \n This object is persistent and when written\n the entity SHOULD save the change to non-volatile\n storage.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfRestartStrictLsaChecking": { "type": "boolean", "description": "Indicates if strict LSA checking is enabled for\n graceful restart.\n \n This object is persistent and when written\n the entity SHOULD save the change to non-volatile\n \n storage.", "readOnly": true }, "ospfRestartStatus": { "type": "string", "description": "Current status of OSPF graceful restart.", "readOnly": true }, "ospfRestartAge": { "type": "integer", "description": "Remaining time in current OSPF graceful restart\n interval.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfRestartExitReason": { "type": "string", "description": "Describes the outcome of the last attempt at a\n graceful restart. If the value is 'none', no restart\n has yet been attempted. If the value is 'inProgress',\n a restart attempt is currently underway.", "readOnly": true }, "ospfAsLsaCount": { "type": "integer", "description": "The number of AS-scope link state\n advertisements in the AS-scope link state database.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfAsLsaCksumSum": { "type": "integer", "description": "The 32-bit unsigned sum of the LS checksums of\n the AS link state advertisements contained in the AS-scope\n link state database. This sum can be used to determine\n if there has been a change in a router's AS-scope link\n state database, and to compare the AS-scope link state\n database of two routers.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfStubRouterSupport": { "type": "boolean", "description": "The router's support for stub router functionality.", "readOnly": true }, "ospfStubRouterAdvertisement": { "type": "string", "description": "This object controls the advertisement of\n stub router LSAs by the router. The value\n doNotAdvertise will result in the advertisement\n of a standard router LSA and is the default value.\n \n This object is persistent and when written\n the entity SHOULD save the change to non-volatile\n storage.", "readOnly": true }, "ospfDiscontinuityTime": { "type": "string", "description": "The value of sysUpTime on the most recent occasion\n at which any one of this MIB's counters suffered\n a discontinuity.\n \n If no such discontinuities have occurred since the last\n re-initialization of the local management subsystem,\n then this object contains a zero value.", "x-yang-type": "yang:timestamp", "readOnly": true } }, "readOnly": true }, "ospfAreaTable": { "type": "object", "description": "Information describing the configured parameters and\n cumulative statistics of the router's attached areas.\n The interfaces and virtual links are configured\n as part of these areas. Area 0.0.0.0, by definition,\n is the backbone area.", "properties": { "ospfAreaEntry": { "type": "array", "description": "ospfAreaEntry", "items": { "type": "object", "properties": { "ospfAreaId": { "type": "string", "description": "A 32-bit integer uniquely identifying an area.\n Area ID 0.0.0.0 is used for the OSPF backbone.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true }, "ospfAuthType": { "type": "string", "description": "The authentication type specified for an area.", "x-yang-type": "OSPF-MIB:OspfAuthenticationType", "readOnly": true }, "ospfImportAsExtern": { "type": "string", "description": "Indicates if an area is a stub area, NSSA, or standard\n area. Type-5 AS-external LSAs and type-11 Opaque LSAs are\n not imported into stub areas or NSSAs. NSSAs import\n AS-external data as type-7 LSAs", "readOnly": true }, "ospfSpfRuns": { "type": "integer", "description": "The number of times that the intra-area route\n table has been calculated using this area's\n link state database. This is typically done\n using Dijkstra's algorithm.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfAreaBdrRtrCount": { "type": "integer", "description": "The total number of Area Border Routers reachable\n within this area. This is initially zero and is\n calculated in each Shortest Path First (SPF) pass.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfAsBdrRtrCount": { "type": "integer", "description": "The total number of Autonomous System Border\n Routers reachable within this area. This is\n initially zero and is calculated in each SPF\n pass.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfAreaLsaCount": { "type": "integer", "description": "The total number of link state advertisements\n in this area's link state database, excluding\n AS-external LSAs.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfAreaLsaCksumSum": { "type": "integer", "description": "The 32-bit sum of the link state\n advertisements' LS checksums contained in this\n area's link state database. This sum excludes\n external (LS type-5) link state advertisements.\n The sum can be used to determine if there has\n been a change in a router's link state\n database, and to compare the link state database of\n two routers. The value should be treated as unsigned\n when comparing two sums of checksums.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfAreaSummary": { "type": "string", "description": "The variable ospfAreaSummary controls the\n import of summary LSAs into stub and NSSA areas.\n It has no effect on other areas.\n \n If it is noAreaSummary, the router will not\n originate summary LSAs into the stub or NSSA area.\n It will rely entirely on its default route.\n \n If it is sendAreaSummary, the router will both\n summarize and propagate summary LSAs.", "readOnly": true }, "ospfAreaStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ospfAreaNssaTranslatorRole": { "type": "string", "description": "Indicates an NSSA border router's ability to\n perform NSSA translation of type-7 LSAs into\n type-5 LSAs.", "readOnly": true }, "ospfAreaNssaTranslatorState": { "type": "string", "description": "Indicates if and how an NSSA border router is\n performing NSSA translation of type-7 LSAs into type-5\n \n LSAs. When this object is set to enabled, the NSSA Border\n router's OspfAreaNssaExtTranslatorRole has been set to\n always. When this object is set to elected, a candidate\n NSSA Border router is Translating type-7 LSAs into type-5.\n When this object is set to disabled, a candidate NSSA\n border router is NOT translating type-7 LSAs into type-5.", "readOnly": true }, "ospfAreaNssaTranslatorStabilityInterval": { "type": "string", "description": "The number of seconds after an elected translator\n determines its services are no longer required, that\n it should continue to perform its translation duties.", "x-yang-type": "OSPF-MIB:PositiveInteger", "readOnly": true }, "ospfAreaNssaTranslatorEvents": { "type": "integer", "description": "Indicates the number of translator state changes\n that have occurred since the last boot-up.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ospfStubAreaTable": { "type": "object", "description": "The set of metrics that will be advertised\n by a default Area Border Router into a stub area.", "properties": { "ospfStubAreaEntry": { "type": "array", "description": "The metric for a given Type of Service that\n will be advertised by a default Area Border\n Router into a stub area.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfStubAreaId": { "type": "string", "description": "The 32-bit identifier for the stub area. On\n creation, this can be derived from the\n instance.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true }, "ospfStubTOS": { "type": "string", "description": "The Type of Service associated with the\n metric. On creation, this can be derived from\n \n the instance.", "x-yang-type": "OSPF-MIB:TOSType", "readOnly": true }, "ospfStubMetric": { "type": "string", "description": "The metric value applied at the indicated Type\n of Service. By default, this equals the least\n metric at the Type of Service among the\n interfaces to other areas.", "x-yang-type": "OSPF-MIB:BigMetric", "readOnly": true }, "ospfStubStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ospfStubMetricType": { "type": "string", "description": "This variable displays the type of metric\n advertised as a default route.", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ospfLsdbTable": { "type": "object", "description": "The OSPF Process's link state database (LSDB).\n The LSDB contains the link state advertisements\n from throughout the areas that the device is attached to.", "properties": { "ospfLsdbEntry": { "type": "array", "description": "A single link state advertisement.", "items": { "type": "object", "properties": { "ospfLsdbAreaId": { "type": "string", "description": "The 32-bit identifier of the area from which\n the LSA was received.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true }, "ospfLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement\n format.\n \n Note: External link state advertisements are permitted\n for backward compatibility, but should be displayed\n in the ospfAsLsdbTable rather than here.", "readOnly": true }, "ospfLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing either a Router ID or an IP address;\n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address", "readOnly": true }, "ospfLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true }, "ospfLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate Link State\n Advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfLsdbAge": { "type": "integer", "description": "This field is the age of the link state advertisement\n in seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete contents of\n the advertisement, excepting the age field. The age field\n is excepted so that an advertisement's age can be\n incremented without updating the checksum. The checksum\n used is the same that is used for ISO connectionless\n \n datagrams; it is commonly referred to as the\n Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.\n \n Note that for variable length LSAs, SNMP agents\n may not be able to return the largest string size.", "format": "binary", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ospfAreaRangeTable": { "type": "object", "description": "ospfAreaRangeTable", "properties": { "ospfAreaRangeEntry": { "type": "array", "description": "A single area address range.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfAreaRangeAreaId": { "type": "string", "description": "The area that the address range is to be found\n within.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true }, "ospfAreaRangeNet": { "type": "string", "description": "The IP address of the net or subnet indicated\n by the range.", "format": "inet:ipv4-address", "readOnly": true }, "ospfAreaRangeMask": { "type": "string", "description": "The subnet mask that pertains to the net or\n subnet.", "format": "inet:ipv4-address", "readOnly": true }, "ospfAreaRangeStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ospfAreaRangeEffect": { "type": "string", "description": "Subnets subsumed by ranges either trigger the\n advertisement of the indicated summary\n (advertiseMatching) or result in the subnet's not\n being advertised at all outside the area.", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ospfHostTable": { "type": "object", "description": "The Host/Metric Table indicates what hosts are directly\n \n attached to the router, what metrics and types\n of service should be advertised for them,\n and what areas they are found within.", "properties": { "ospfHostEntry": { "type": "array", "description": "A metric to be advertised, for a given type of\n service, when a given host is reachable.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfHostIpAddress": { "type": "string", "description": "The IP address of the host.", "format": "inet:ipv4-address", "readOnly": true }, "ospfHostTOS": { "type": "string", "description": "The Type of Service of the route being configured.", "x-yang-type": "OSPF-MIB:TOSType", "readOnly": true }, "ospfHostMetric": { "type": "string", "description": "The metric to be advertised.", "x-yang-type": "OSPF-MIB:Metric", "readOnly": true }, "ospfHostStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ospfHostAreaID": { "type": "string", "description": "The OSPF area to which the host belongs.\n Deprecated by ospfHostCfgAreaID.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true }, "ospfHostCfgAreaID": { "type": "string", "description": "To configure the OSPF area to which the host belongs.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ospfIfTable": { "type": "object", "description": "The OSPF Interface Table describes the interfaces\n from the viewpoint of OSPF.\n It augments the ipAddrTable with OSPF specific information.", "properties": { "ospfIfEntry": { "type": "array", "description": "The OSPF interface entry describes one interface\n from the viewpoint of OSPF.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfIfIpAddress": { "type": "string", "description": "The IP address of this OSPF interface.", "format": "inet:ipv4-address", "readOnly": true }, "ospfAddressLessIf": { "type": "string", "description": "For the purpose of easing the instancing of\n addressed and addressless interfaces; this\n variable takes the value 0 on interfaces with\n IP addresses and the corresponding value of\n ifIndex for interfaces having no IP address.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "ospfIfAreaId": { "type": "string", "description": "A 32-bit integer uniquely identifying the area\n to which the interface connects. Area ID\n 0.0.0.0 is used for the OSPF backbone.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true }, "ospfIfType": { "type": "string", "description": "The OSPF interface type.\n By way of a default, this field may be intuited\n from the corresponding value of ifType.\n Broadcast LANs, such as Ethernet and IEEE 802.5,\n take the value 'broadcast', X.25 and similar\n technologies take the value 'nbma', and links\n that are definitively point to point take the\n value 'pointToPoint'.", "readOnly": true }, "ospfIfAdminStat": { "type": "string", "description": "The OSPF interface's administrative status.\n The value formed on the interface, and the interface\n will be advertised as an internal route to some area.\n The value 'disabled' denotes that the interface is\n external to OSPF.", "x-yang-type": "OSPF-MIB:Status", "readOnly": true }, "ospfIfRtrPriority": { "type": "string", "description": "The priority of this interface. Used in\n multi-access networks, this field is used in\n the designated router election algorithm. The\n value 0 signifies that the router is not eligible\n to become the designated router on this particular\n network. In the event of a tie in this value,\n routers will use their Router ID as a tie breaker.", "x-yang-type": "OSPF-MIB:DesignatedRouterPriority", "readOnly": true }, "ospfIfTransitDelay": { "type": "string", "description": "The estimated number of seconds it takes to\n transmit a link state update packet over this\n interface. Note that the minimal value SHOULD be\n 1 second.", "x-yang-type": "OSPF-MIB:UpToMaxAge", "readOnly": true }, "ospfIfRetransInterval": { "type": "string", "description": "The number of seconds between link state advertisement\n retransmissions, for adjacencies belonging to this\n interface. This value is also used when retransmitting\n \n database description and Link State request packets.\n Note that minimal value SHOULD be 1 second.", "x-yang-type": "OSPF-MIB:UpToMaxAge", "readOnly": true }, "ospfIfHelloInterval": { "type": "string", "description": "The length of time, in seconds, between the Hello packets\n that the router sends on the interface. This value must be\n the same for all routers attached to a common network.", "x-yang-type": "OSPF-MIB:HelloRange", "readOnly": true }, "ospfIfRtrDeadInterval": { "type": "string", "description": "The number of seconds that a router's Hello packets have\n not been seen before its neighbors declare the router down.\n This should be some multiple of the Hello interval. This\n value must be the same for all routers attached to a common\n network.", "x-yang-type": "OSPF-MIB:PositiveInteger", "readOnly": true }, "ospfIfPollInterval": { "type": "string", "description": "The larger time interval, in seconds, between the Hello\n packets sent to an inactive non-broadcast multi-access\n neighbor.", "x-yang-type": "OSPF-MIB:PositiveInteger", "readOnly": true }, "ospfIfState": { "type": "string", "description": "The OSPF Interface State.", "readOnly": true }, "ospfIfDesignatedRouter": { "type": "string", "description": "The IP address of the designated router.", "format": "inet:ipv4-address", "readOnly": true }, "ospfIfBackupDesignatedRouter": { "type": "string", "description": "The IP address of the backup designated\n router.", "format": "inet:ipv4-address", "readOnly": true }, "ospfIfEvents": { "type": "integer", "description": "The number of times this OSPF interface has\n changed its state or an error has occurred.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfIfAuthKey": { "type": "string", "description": "The cleartext password used as an OSPF\n authentication key when simplePassword security\n is enabled. This object does not access any OSPF\n cryptogaphic (e.g., MD5) authentication key under\n any circumstance.\n \n If the key length is shorter than 8 octets, the\n agent will left adjust and zero fill to 8 octets.\n \n Unauthenticated interfaces need no authentication\n key, and simple password authentication cannot use\n a key of more than 8 octets.\n \n Note that the use of simplePassword authentication\n is NOT recommended when there is concern regarding\n attack upon the OSPF system. SimplePassword\n authentication is only sufficient to protect against\n accidental misconfigurations because it re-uses\n cleartext passwords [RFC1704].\n \n When read, ospfIfAuthKey always returns an octet\n string of length zero.", "format": "binary", "readOnly": true }, "ospfIfStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ospfIfMulticastForwarding": { "type": "string", "description": "The way multicasts should be forwarded on this\n interface: not forwarded, forwarded as data\n link multicasts, or forwarded as data link\n unicasts. Data link multicasting is not\n meaningful on point-to-point and NBMA interfaces,\n and setting ospfMulticastForwarding to 0 effectively\n disables all multicast forwarding.", "readOnly": true }, "ospfIfDemand": { "type": "boolean", "description": "Indicates whether Demand OSPF procedures (hello\n suppression to FULL neighbors and setting the\n DoNotAge flag on propagated LSAs) should be\n performed on this interface.", "readOnly": true }, "ospfIfAuthType": { "type": "string", "description": "The authentication type specified for an interface.\n \n Note that this object can be used to engage\n in significant attacks against an OSPF router.", "x-yang-type": "OSPF-MIB:OspfAuthenticationType", "readOnly": true }, "ospfIfLsaCount": { "type": "integer", "description": "The total number of link-local link state advertisements\n in this interface's link-local link state database.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfIfLsaCksumSum": { "type": "integer", "description": "The 32-bit unsigned sum of the Link State\n Advertisements' LS checksums contained in this\n interface's link-local link state database.\n The sum can be used to determine if there has\n been a change in the interface's link state\n database and to compare the interface link state\n database of routers attached to the same subnet.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfIfDesignatedRouterId": { "type": "string", "description": "The Router ID of the designated router.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true }, "ospfIfBackupDesignatedRouterId": { "type": "string", "description": "The Router ID of the backup designated router.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ospfIfMetricTable": { "type": "object", "description": "ospfIfMetricTable", "properties": { "ospfIfMetricEntry": { "type": "array", "description": "A particular TOS metric for a non-virtual interface\n identified by the interface index.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfIfMetricIpAddress": { "type": "string", "description": "The IP address of this OSPF interface. On row\n creation, this can be derived from the instance.", "format": "inet:ipv4-address", "readOnly": true }, "ospfIfMetricAddressLessIf": { "type": "string", "description": "For the purpose of easing the instancing of\n addressed and addressless interfaces; this\n variable takes the value 0 on interfaces with\n IP addresses and the value of ifIndex for\n interfaces having no IP address. On row\n creation, this can be derived from the instance.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "ospfIfMetricTOS": { "type": "string", "description": "The Type of Service metric being referenced.\n On row creation, this can be derived from the\n instance.", "x-yang-type": "OSPF-MIB:TOSType", "readOnly": true }, "ospfIfMetricValue": { "type": "string", "description": "The metric of using this Type of Service on\n this interface. The default value of the TOS 0\n metric is 10^8 / ifSpeed.", "x-yang-type": "OSPF-MIB:Metric", "readOnly": true }, "ospfIfMetricStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ospfVirtIfTable": { "type": "object", "description": "Information about this router's virtual interfaces\n that the OSPF Process is configured to carry on.", "properties": { "ospfVirtIfEntry": { "type": "array", "description": "Information about a single virtual interface.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfVirtIfAreaId": { "type": "string", "description": "The transit area that the virtual link\n traverses. By definition, this is not 0.0.0.0.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true }, "ospfVirtIfNeighbor": { "type": "string", "description": "The Router ID of the virtual neighbor.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true }, "ospfVirtIfTransitDelay": { "type": "string", "description": "The estimated number of seconds it takes to\n transmit a Link State update packet over this\n interface. Note that the minimal value SHOULD be\n 1 second.", "x-yang-type": "OSPF-MIB:UpToMaxAge", "readOnly": true }, "ospfVirtIfRetransInterval": { "type": "string", "description": "The number of seconds between link state\n avertisement retransmissions, for adjacencies\n belonging to this interface. This value is\n also used when retransmitting database\n description and Link State request packets. This\n value should be well over the expected\n round-trip time. Note that the minimal value SHOULD be\n 1 second.", "x-yang-type": "OSPF-MIB:UpToMaxAge", "readOnly": true }, "ospfVirtIfHelloInterval": { "type": "string", "description": "The length of time, in seconds, between the\n Hello packets that the router sends on the\n interface. This value must be the same for the\n virtual neighbor.", "x-yang-type": "OSPF-MIB:HelloRange", "readOnly": true }, "ospfVirtIfRtrDeadInterval": { "type": "string", "description": "The number of seconds that a router's Hello\n packets have not been seen before its\n neighbors declare the router down. This should be\n some multiple of the Hello interval. This\n value must be the same for the virtual neighbor.", "x-yang-type": "OSPF-MIB:PositiveInteger", "readOnly": true }, "ospfVirtIfState": { "type": "string", "description": "OSPF virtual interface states.", "readOnly": true }, "ospfVirtIfEvents": { "type": "integer", "description": "The number of state changes or error events on\n this virtual link.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfVirtIfAuthKey": { "type": "string", "description": "The cleartext password used as an OSPF\n authentication key when simplePassword security\n is enabled. This object does not access any OSPF\n cryptogaphic (e.g., MD5) authentication key under\n any circumstance.\n \n If the key length is shorter than 8 octets, the\n agent will left adjust and zero fill to 8 octets.\n \n Unauthenticated interfaces need no authentication\n key, and simple password authentication cannot use\n a key of more than 8 octets.\n \n Note that the use of simplePassword authentication\n is NOT recommended when there is concern regarding\n attack upon the OSPF system. SimplePassword\n authentication is only sufficient to protect against\n accidental misconfigurations because it re-uses\n cleartext passwords. [RFC1704]\n \n When read, ospfIfAuthKey always returns an octet\n string of length zero.", "format": "binary", "readOnly": true }, "ospfVirtIfStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ospfVirtIfAuthType": { "type": "string", "description": "The authentication type specified for a virtual interface.\n \n Note that this object can be used to engage\n in significant attacks against an OSPF router.", "x-yang-type": "OSPF-MIB:OspfAuthenticationType", "readOnly": true }, "ospfVirtIfLsaCount": { "type": "integer", "description": "The total number of link-local link state advertisements\n in this virtual interface's link-local link state database.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfVirtIfLsaCksumSum": { "type": "integer", "description": "The 32-bit unsigned sum of the link state\n advertisements' LS checksums contained in this\n virtual interface's link-local link state database.\n The sum can be used to determine if there has\n been a change in the virtual interface's link state\n database, and to compare the virtual interface\n link state database of the virtual neighbors.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ospfNbrTable": { "type": "object", "description": "A table describing all non-virtual neighbors\n in the locality of the OSPF router.", "properties": { "ospfNbrEntry": { "type": "array", "description": "The information regarding a single neighbor.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n \n storage.", "items": { "type": "object", "properties": { "ospfNbrIpAddr": { "type": "string", "description": "The IP address this neighbor is using in its\n IP source address. Note that, on addressless\n links, this will not be 0.0.0.0 but the\n \n address of another of the neighbor's interfaces.", "format": "inet:ipv4-address", "readOnly": true }, "ospfNbrAddressLessIndex": { "type": "string", "description": "On an interface having an IP address, zero.\n On addressless interfaces, the corresponding\n value of ifIndex in the Internet Standard MIB.\n On row creation, this can be derived from the\n instance.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "ospfNbrRtrId": { "type": "string", "description": "A 32-bit integer (represented as a type\n IpAddress) uniquely identifying the neighboring\n router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true }, "ospfNbrOptions": { "type": "integer", "description": "A bit mask corresponding to the neighbor's\n options field.\n \n Bit 0, if set, indicates that the system will\n operate on Type of Service metrics other than\n TOS 0. If zero, the neighbor will ignore all\n metrics except the TOS 0 metric.\n \n Bit 1, if set, indicates that the associated\n area accepts and operates on external\n information; if zero, it is a stub area.\n \n Bit 2, if set, indicates that the system is\n capable of routing IP multicast datagrams, that is\n that it implements the multicast extensions to\n OSPF.\n \n Bit 3, if set, indicates that the associated\n area is an NSSA. These areas are capable of\n carrying type-7 external advertisements, which\n are translated into type-5 external advertisements\n at NSSA borders.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfNbrPriority": { "type": "string", "description": "The priority of this neighbor in the designated\n router election algorithm. The value 0 signifies\n that the neighbor is not eligible to become\n the designated router on this particular network.", "x-yang-type": "OSPF-MIB:DesignatedRouterPriority", "readOnly": true }, "ospfNbrState": { "type": "string", "description": "The state of the relationship with this neighbor.", "readOnly": true }, "ospfNbrEvents": { "type": "integer", "description": "The number of times this neighbor relationship\n has changed state or an error has occurred.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfNbrLsRetransQLen": { "type": "integer", "description": "The current length of the retransmission\n queue.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfNbmaNbrStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ospfNbmaNbrPermanence": { "type": "string", "description": "This variable displays the status of the entry;\n 'dynamic' and 'permanent' refer to how the neighbor\n became known.", "readOnly": true }, "ospfNbrHelloSuppressed": { "type": "boolean", "description": "Indicates whether Hellos are being suppressed\n to the neighbor.", "readOnly": true }, "ospfNbrRestartHelperStatus": { "type": "string", "description": "Indicates whether the router is acting\n as a graceful restart helper for the neighbor.", "readOnly": true }, "ospfNbrRestartHelperAge": { "type": "integer", "description": "Remaining time in current OSPF graceful restart\n interval, if the router is acting as a restart\n helper for the neighbor.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfNbrRestartHelperExitReason": { "type": "string", "description": "Describes the outcome of the last attempt at acting\n as a graceful restart helper for the neighbor.", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ospfVirtNbrTable": { "type": "object", "description": "This table describes all virtual neighbors.\n Since virtual links are configured\n in the Virtual Interface Table, this table is read-only.", "properties": { "ospfVirtNbrEntry": { "type": "array", "description": "Virtual neighbor information.", "items": { "type": "object", "properties": { "ospfVirtNbrArea": { "type": "string", "description": "The Transit Area Identifier.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true }, "ospfVirtNbrRtrId": { "type": "string", "description": "A 32-bit integer uniquely identifying the\n neighboring router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true }, "ospfVirtNbrIpAddr": { "type": "string", "description": "The IP address this virtual neighbor is using.", "format": "inet:ipv4-address", "readOnly": true }, "ospfVirtNbrOptions": { "type": "integer", "description": "A bit mask corresponding to the neighbor's\n options field.\n \n Bit 1, if set, indicates that the system will\n operate on Type of Service metrics other than\n TOS 0. If zero, the neighbor will ignore all\n metrics except the TOS 0 metric.\n \n Bit 2, if set, indicates that the system is\n network multicast capable, i.e., that it\n implements OSPF multicast routing.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfVirtNbrState": { "type": "string", "description": "The state of the virtual neighbor relationship.", "readOnly": true }, "ospfVirtNbrEvents": { "type": "integer", "description": "The number of times this virtual link has\n changed its state or an error has occurred.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfVirtNbrLsRetransQLen": { "type": "integer", "description": "The current length of the retransmission\n queue.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfVirtNbrHelloSuppressed": { "type": "boolean", "description": "Indicates whether Hellos are being suppressed\n to the neighbor.", "readOnly": true }, "ospfVirtNbrRestartHelperStatus": { "type": "string", "description": "Indicates whether the router is acting\n as a graceful restart helper for the neighbor.", "readOnly": true }, "ospfVirtNbrRestartHelperAge": { "type": "integer", "description": "Remaining time in current OSPF graceful restart\n interval, if the router is acting as a restart\n helper for the neighbor.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfVirtNbrRestartHelperExitReason": { "type": "string", "description": "Describes the outcome of the last attempt at acting\n as a graceful restart helper for the neighbor.", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ospfExtLsdbTable": { "type": "object", "description": "The OSPF Process's external LSA link state database.\n \n This table is identical to the OSPF LSDB Table\n in format, but contains only external link state\n advertisements. The purpose is to allow external\n \n LSAs to be displayed once for the router rather\n than once in each non-stub area.\n \n Note that external LSAs are also in the AS-scope link state\n database.", "properties": { "ospfExtLsdbEntry": { "type": "array", "description": "A single link state advertisement.", "items": { "type": "object", "properties": { "ospfExtLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement\n format.", "readOnly": true }, "ospfExtLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing either a Router ID or an IP address;\n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address", "readOnly": true }, "ospfExtLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true }, "ospfExtLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate link state\n advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfExtLsdbAge": { "type": "integer", "description": "This field is the age of the link state\n advertisement in seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfExtLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete\n contents of the advertisement, excepting the\n age field. The age field is excepted so that\n an advertisement's age can be incremented\n without updating the checksum. The checksum\n used is the same that is used for ISO\n connectionless datagrams; it is commonly referred\n to as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfExtLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.", "format": "binary", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ospfAreaAggregateTable": { "type": "object", "description": "ospfAreaAggregateTable", "properties": { "ospfAreaAggregateEntry": { "type": "array", "description": "A single area aggregate entry.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfAreaAggregateAreaID": { "type": "string", "description": "The area within which the address aggregate is to be\n found.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true }, "ospfAreaAggregateLsdbType": { "type": "string", "description": "The type of the address aggregate. This field\n specifies the Lsdb type that this address\n aggregate applies to.", "readOnly": true }, "ospfAreaAggregateNet": { "type": "string", "description": "The IP address of the net or subnet indicated\n by the range.", "format": "inet:ipv4-address", "readOnly": true }, "ospfAreaAggregateMask": { "type": "string", "description": "The subnet mask that pertains to the net or\n subnet.", "format": "inet:ipv4-address", "readOnly": true }, "ospfAreaAggregateStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ospfAreaAggregateEffect": { "type": "string", "description": "Subnets subsumed by ranges either trigger the\n advertisement of the indicated aggregate\n (advertiseMatching) or result in the subnet's not\n being advertised at all outside the area.", "readOnly": true }, "ospfAreaAggregateExtRouteTag": { "type": "integer", "description": "External route tag to be included in NSSA (type-7)\n LSAs.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ospfLocalLsdbTable": { "type": "object", "description": "The OSPF Process's link-local link state database\n for non-virtual links.\n This table is identical to the OSPF LSDB Table\n in format, but contains only link-local Link State\n Advertisements for non-virtual links. The purpose is\n to allow link-local LSAs to be displayed for each\n non-virtual interface. This table is implemented to\n support type-9 LSAs that are defined\n in 'The OSPF Opaque LSA Option'.", "properties": { "ospfLocalLsdbEntry": { "type": "array", "description": "A single link state advertisement.", "items": { "type": "object", "properties": { "ospfLocalLsdbIpAddress": { "type": "string", "description": "The IP address of the interface from\n which the LSA was received if the interface is\n numbered.", "format": "inet:ipv4-address", "readOnly": true }, "ospfLocalLsdbAddressLessIf": { "type": "string", "description": "The interface index of the interface from\n which the LSA was received if the interface is\n unnumbered.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "ospfLocalLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate\n advertisement format.", "readOnly": true }, "ospfLocalLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing a 32-bit identifier in IP address format;\n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address", "readOnly": true }, "ospfLocalLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true }, "ospfLocalLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate link state\n advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfLocalLsdbAge": { "type": "integer", "description": "This field is the age of the link state\n advertisement in seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfLocalLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete\n contents of the advertisement, excepting the\n age field. The age field is excepted so that\n an advertisement's age can be incremented\n without updating the checksum. The checksum\n used is the same that is used for ISO\n connectionless datagrams; it is commonly referred\n to as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfLocalLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.\n \n Note that for variable length LSAs, SNMP agents\n may not be able to return the largest string size.", "format": "binary", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ospfVirtLocalLsdbTable": { "type": "object", "description": "The OSPF Process's link-local link state database\n for virtual links.\n \n This table is identical to the OSPF LSDB Table\n in format, but contains only link-local Link State\n Advertisements for virtual links. The purpose is to\n allow link-local LSAs to be displayed for each virtual\n interface. This table is implemented to support type-9 LSAs\n that are defined in 'The OSPF Opaque LSA Option'.", "properties": { "ospfVirtLocalLsdbEntry": { "type": "array", "description": "A single link state advertisement.", "items": { "type": "object", "properties": { "ospfVirtLocalLsdbTransitArea": { "type": "string", "description": "The transit area that the virtual link\n traverses. By definition, this is not 0.0.0.0.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true }, "ospfVirtLocalLsdbNeighbor": { "type": "string", "description": "The Router ID of the virtual neighbor.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true }, "ospfVirtLocalLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate\n advertisement format.", "readOnly": true }, "ospfVirtLocalLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing a 32-bit identifier in IP address format;\n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address", "readOnly": true }, "ospfVirtLocalLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true }, "ospfVirtLocalLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate link state\n advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfVirtLocalLsdbAge": { "type": "integer", "description": "This field is the age of the link state\n advertisement in seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfVirtLocalLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete\n contents of the advertisement, excepting the\n age field. The age field is excepted so that\n \n an advertisement's age can be incremented\n without updating the checksum. The checksum\n used is the same that is used for ISO\n connectionless datagrams; it is commonly\n referred to as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfVirtLocalLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.", "format": "binary", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ospfAsLsdbTable": { "type": "object", "description": "The OSPF Process's AS-scope LSA link state database.\n The database contains the AS-scope Link State\n Advertisements from throughout the areas that\n the device is attached to.\n \n This table is identical to the OSPF LSDB Table\n in format, but contains only AS-scope Link State\n Advertisements. The purpose is to allow AS-scope\n LSAs to be displayed once for the router rather\n than once in each non-stub area.", "properties": { "ospfAsLsdbEntry": { "type": "array", "description": "A single link state advertisement.", "items": { "type": "object", "properties": { "ospfAsLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate\n advertisement format.", "readOnly": true }, "ospfAsLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing either a Router ID or an IP address;\n \n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address", "readOnly": true }, "ospfAsLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true }, "ospfAsLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate link state\n advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfAsLsdbAge": { "type": "integer", "description": "This field is the age of the link state\n advertisement in seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfAsLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete\n contents of the advertisement, excepting the\n age field. The age field is excepted so that\n an advertisement's age can be incremented\n without updating the checksum. The checksum\n used is the same that is used for ISO\n connectionless datagrams; it is commonly referred\n to as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfAsLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.", "format": "binary", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ospfAreaLsaCountTable": { "type": "object", "description": "This table maintains per-area, per-LSA-type counters", "properties": { "ospfAreaLsaCountEntry": { "type": "array", "description": "An entry with a number of link advertisements\n \n of a given type for a given area.", "items": { "type": "object", "properties": { "ospfAreaLsaCountAreaId": { "type": "string", "description": "This entry Area ID.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true }, "ospfAreaLsaCountLsaType": { "type": "string", "description": "This entry LSA type.", "readOnly": true }, "ospfAreaLsaCountNumber": { "type": "integer", "description": "Number of LSAs of a given type for a given area.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "OSPF-MIB_ospfAreaEntry": { "type": "array", "description": "ospfAreaEntry", "items": { "type": "object", "properties": { "ospfAreaId": { "type": "string", "description": "A 32-bit integer uniquely identifying an area.\n Area ID 0.0.0.0 is used for the OSPF backbone.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true }, "ospfAuthType": { "type": "string", "description": "The authentication type specified for an area.", "x-yang-type": "OSPF-MIB:OspfAuthenticationType", "readOnly": true }, "ospfImportAsExtern": { "type": "string", "description": "Indicates if an area is a stub area, NSSA, or standard\n area. Type-5 AS-external LSAs and type-11 Opaque LSAs are\n not imported into stub areas or NSSAs. NSSAs import\n AS-external data as type-7 LSAs", "readOnly": true }, "ospfSpfRuns": { "type": "integer", "description": "The number of times that the intra-area route\n table has been calculated using this area's\n link state database. This is typically done\n using Dijkstra's algorithm.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfAreaBdrRtrCount": { "type": "integer", "description": "The total number of Area Border Routers reachable\n within this area. This is initially zero and is\n calculated in each Shortest Path First (SPF) pass.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfAsBdrRtrCount": { "type": "integer", "description": "The total number of Autonomous System Border\n Routers reachable within this area. This is\n initially zero and is calculated in each SPF\n pass.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfAreaLsaCount": { "type": "integer", "description": "The total number of link state advertisements\n in this area's link state database, excluding\n AS-external LSAs.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfAreaLsaCksumSum": { "type": "integer", "description": "The 32-bit sum of the link state\n advertisements' LS checksums contained in this\n area's link state database. This sum excludes\n external (LS type-5) link state advertisements.\n The sum can be used to determine if there has\n been a change in a router's link state\n database, and to compare the link state database of\n two routers. The value should be treated as unsigned\n when comparing two sums of checksums.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfAreaSummary": { "type": "string", "description": "The variable ospfAreaSummary controls the\n import of summary LSAs into stub and NSSA areas.\n It has no effect on other areas.\n \n If it is noAreaSummary, the router will not\n originate summary LSAs into the stub or NSSA area.\n It will rely entirely on its default route.\n \n If it is sendAreaSummary, the router will both\n summarize and propagate summary LSAs.", "readOnly": true }, "ospfAreaStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ospfAreaNssaTranslatorRole": { "type": "string", "description": "Indicates an NSSA border router's ability to\n perform NSSA translation of type-7 LSAs into\n type-5 LSAs.", "readOnly": true }, "ospfAreaNssaTranslatorState": { "type": "string", "description": "Indicates if and how an NSSA border router is\n performing NSSA translation of type-7 LSAs into type-5\n \n LSAs. When this object is set to enabled, the NSSA Border\n router's OspfAreaNssaExtTranslatorRole has been set to\n always. When this object is set to elected, a candidate\n NSSA Border router is Translating type-7 LSAs into type-5.\n When this object is set to disabled, a candidate NSSA\n border router is NOT translating type-7 LSAs into type-5.", "readOnly": true }, "ospfAreaNssaTranslatorStabilityInterval": { "type": "string", "description": "The number of seconds after an elected translator\n determines its services are no longer required, that\n it should continue to perform its translation duties.", "x-yang-type": "OSPF-MIB:PositiveInteger", "readOnly": true }, "ospfAreaNssaTranslatorEvents": { "type": "integer", "description": "Indicates the number of translator state changes\n that have occurred since the last boot-up.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } } }, "OSPF-MIB_ospfStubAreaEntry": { "type": "array", "description": "The metric for a given Type of Service that\n will be advertised by a default Area Border\n Router into a stub area.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfStubAreaId": { "type": "string", "description": "The 32-bit identifier for the stub area. On\n creation, this can be derived from the\n instance.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true }, "ospfStubTOS": { "type": "string", "description": "The Type of Service associated with the\n metric. On creation, this can be derived from\n \n the instance.", "x-yang-type": "OSPF-MIB:TOSType", "readOnly": true }, "ospfStubMetric": { "type": "string", "description": "The metric value applied at the indicated Type\n of Service. By default, this equals the least\n metric at the Type of Service among the\n interfaces to other areas.", "x-yang-type": "OSPF-MIB:BigMetric", "readOnly": true }, "ospfStubStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ospfStubMetricType": { "type": "string", "description": "This variable displays the type of metric\n advertised as a default route.", "readOnly": true } } } }, "OSPF-MIB_ospfLsdbEntry": { "type": "array", "description": "A single link state advertisement.", "items": { "type": "object", "properties": { "ospfLsdbAreaId": { "type": "string", "description": "The 32-bit identifier of the area from which\n the LSA was received.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true }, "ospfLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement\n format.\n \n Note: External link state advertisements are permitted\n for backward compatibility, but should be displayed\n in the ospfAsLsdbTable rather than here.", "readOnly": true }, "ospfLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing either a Router ID or an IP address;\n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address", "readOnly": true }, "ospfLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true }, "ospfLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate Link State\n Advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfLsdbAge": { "type": "integer", "description": "This field is the age of the link state advertisement\n in seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete contents of\n the advertisement, excepting the age field. The age field\n is excepted so that an advertisement's age can be\n incremented without updating the checksum. The checksum\n used is the same that is used for ISO connectionless\n \n datagrams; it is commonly referred to as the\n Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.\n \n Note that for variable length LSAs, SNMP agents\n may not be able to return the largest string size.", "format": "binary", "readOnly": true } } } }, "OSPF-MIB_ospfAreaRangeEntry": { "type": "array", "description": "A single area address range.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfAreaRangeAreaId": { "type": "string", "description": "The area that the address range is to be found\n within.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true }, "ospfAreaRangeNet": { "type": "string", "description": "The IP address of the net or subnet indicated\n by the range.", "format": "inet:ipv4-address", "readOnly": true }, "ospfAreaRangeMask": { "type": "string", "description": "The subnet mask that pertains to the net or\n subnet.", "format": "inet:ipv4-address", "readOnly": true }, "ospfAreaRangeStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ospfAreaRangeEffect": { "type": "string", "description": "Subnets subsumed by ranges either trigger the\n advertisement of the indicated summary\n (advertiseMatching) or result in the subnet's not\n being advertised at all outside the area.", "readOnly": true } } } }, "OSPF-MIB_ospfHostEntry": { "type": "array", "description": "A metric to be advertised, for a given type of\n service, when a given host is reachable.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfHostIpAddress": { "type": "string", "description": "The IP address of the host.", "format": "inet:ipv4-address", "readOnly": true }, "ospfHostTOS": { "type": "string", "description": "The Type of Service of the route being configured.", "x-yang-type": "OSPF-MIB:TOSType", "readOnly": true }, "ospfHostMetric": { "type": "string", "description": "The metric to be advertised.", "x-yang-type": "OSPF-MIB:Metric", "readOnly": true }, "ospfHostStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ospfHostAreaID": { "type": "string", "description": "The OSPF area to which the host belongs.\n Deprecated by ospfHostCfgAreaID.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true }, "ospfHostCfgAreaID": { "type": "string", "description": "To configure the OSPF area to which the host belongs.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true } } } }, "OSPF-MIB_ospfIfEntry": { "type": "array", "description": "The OSPF interface entry describes one interface\n from the viewpoint of OSPF.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfIfIpAddress": { "type": "string", "description": "The IP address of this OSPF interface.", "format": "inet:ipv4-address", "readOnly": true }, "ospfAddressLessIf": { "type": "string", "description": "For the purpose of easing the instancing of\n addressed and addressless interfaces; this\n variable takes the value 0 on interfaces with\n IP addresses and the corresponding value of\n ifIndex for interfaces having no IP address.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "ospfIfAreaId": { "type": "string", "description": "A 32-bit integer uniquely identifying the area\n to which the interface connects. Area ID\n 0.0.0.0 is used for the OSPF backbone.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true }, "ospfIfType": { "type": "string", "description": "The OSPF interface type.\n By way of a default, this field may be intuited\n from the corresponding value of ifType.\n Broadcast LANs, such as Ethernet and IEEE 802.5,\n take the value 'broadcast', X.25 and similar\n technologies take the value 'nbma', and links\n that are definitively point to point take the\n value 'pointToPoint'.", "readOnly": true }, "ospfIfAdminStat": { "type": "string", "description": "The OSPF interface's administrative status.\n The value formed on the interface, and the interface\n will be advertised as an internal route to some area.\n The value 'disabled' denotes that the interface is\n external to OSPF.", "x-yang-type": "OSPF-MIB:Status", "readOnly": true }, "ospfIfRtrPriority": { "type": "string", "description": "The priority of this interface. Used in\n multi-access networks, this field is used in\n the designated router election algorithm. The\n value 0 signifies that the router is not eligible\n to become the designated router on this particular\n network. In the event of a tie in this value,\n routers will use their Router ID as a tie breaker.", "x-yang-type": "OSPF-MIB:DesignatedRouterPriority", "readOnly": true }, "ospfIfTransitDelay": { "type": "string", "description": "The estimated number of seconds it takes to\n transmit a link state update packet over this\n interface. Note that the minimal value SHOULD be\n 1 second.", "x-yang-type": "OSPF-MIB:UpToMaxAge", "readOnly": true }, "ospfIfRetransInterval": { "type": "string", "description": "The number of seconds between link state advertisement\n retransmissions, for adjacencies belonging to this\n interface. This value is also used when retransmitting\n \n database description and Link State request packets.\n Note that minimal value SHOULD be 1 second.", "x-yang-type": "OSPF-MIB:UpToMaxAge", "readOnly": true }, "ospfIfHelloInterval": { "type": "string", "description": "The length of time, in seconds, between the Hello packets\n that the router sends on the interface. This value must be\n the same for all routers attached to a common network.", "x-yang-type": "OSPF-MIB:HelloRange", "readOnly": true }, "ospfIfRtrDeadInterval": { "type": "string", "description": "The number of seconds that a router's Hello packets have\n not been seen before its neighbors declare the router down.\n This should be some multiple of the Hello interval. This\n value must be the same for all routers attached to a common\n network.", "x-yang-type": "OSPF-MIB:PositiveInteger", "readOnly": true }, "ospfIfPollInterval": { "type": "string", "description": "The larger time interval, in seconds, between the Hello\n packets sent to an inactive non-broadcast multi-access\n neighbor.", "x-yang-type": "OSPF-MIB:PositiveInteger", "readOnly": true }, "ospfIfState": { "type": "string", "description": "The OSPF Interface State.", "readOnly": true }, "ospfIfDesignatedRouter": { "type": "string", "description": "The IP address of the designated router.", "format": "inet:ipv4-address", "readOnly": true }, "ospfIfBackupDesignatedRouter": { "type": "string", "description": "The IP address of the backup designated\n router.", "format": "inet:ipv4-address", "readOnly": true }, "ospfIfEvents": { "type": "integer", "description": "The number of times this OSPF interface has\n changed its state or an error has occurred.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfIfAuthKey": { "type": "string", "description": "The cleartext password used as an OSPF\n authentication key when simplePassword security\n is enabled. This object does not access any OSPF\n cryptogaphic (e.g., MD5) authentication key under\n any circumstance.\n \n If the key length is shorter than 8 octets, the\n agent will left adjust and zero fill to 8 octets.\n \n Unauthenticated interfaces need no authentication\n key, and simple password authentication cannot use\n a key of more than 8 octets.\n \n Note that the use of simplePassword authentication\n is NOT recommended when there is concern regarding\n attack upon the OSPF system. SimplePassword\n authentication is only sufficient to protect against\n accidental misconfigurations because it re-uses\n cleartext passwords [RFC1704].\n \n When read, ospfIfAuthKey always returns an octet\n string of length zero.", "format": "binary", "readOnly": true }, "ospfIfStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ospfIfMulticastForwarding": { "type": "string", "description": "The way multicasts should be forwarded on this\n interface: not forwarded, forwarded as data\n link multicasts, or forwarded as data link\n unicasts. Data link multicasting is not\n meaningful on point-to-point and NBMA interfaces,\n and setting ospfMulticastForwarding to 0 effectively\n disables all multicast forwarding.", "readOnly": true }, "ospfIfDemand": { "type": "boolean", "description": "Indicates whether Demand OSPF procedures (hello\n suppression to FULL neighbors and setting the\n DoNotAge flag on propagated LSAs) should be\n performed on this interface.", "readOnly": true }, "ospfIfAuthType": { "type": "string", "description": "The authentication type specified for an interface.\n \n Note that this object can be used to engage\n in significant attacks against an OSPF router.", "x-yang-type": "OSPF-MIB:OspfAuthenticationType", "readOnly": true }, "ospfIfLsaCount": { "type": "integer", "description": "The total number of link-local link state advertisements\n in this interface's link-local link state database.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfIfLsaCksumSum": { "type": "integer", "description": "The 32-bit unsigned sum of the Link State\n Advertisements' LS checksums contained in this\n interface's link-local link state database.\n The sum can be used to determine if there has\n been a change in the interface's link state\n database and to compare the interface link state\n database of routers attached to the same subnet.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfIfDesignatedRouterId": { "type": "string", "description": "The Router ID of the designated router.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true }, "ospfIfBackupDesignatedRouterId": { "type": "string", "description": "The Router ID of the backup designated router.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true } } } }, "OSPF-MIB_ospfIfMetricEntry": { "type": "array", "description": "A particular TOS metric for a non-virtual interface\n identified by the interface index.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfIfMetricIpAddress": { "type": "string", "description": "The IP address of this OSPF interface. On row\n creation, this can be derived from the instance.", "format": "inet:ipv4-address", "readOnly": true }, "ospfIfMetricAddressLessIf": { "type": "string", "description": "For the purpose of easing the instancing of\n addressed and addressless interfaces; this\n variable takes the value 0 on interfaces with\n IP addresses and the value of ifIndex for\n interfaces having no IP address. On row\n creation, this can be derived from the instance.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "ospfIfMetricTOS": { "type": "string", "description": "The Type of Service metric being referenced.\n On row creation, this can be derived from the\n instance.", "x-yang-type": "OSPF-MIB:TOSType", "readOnly": true }, "ospfIfMetricValue": { "type": "string", "description": "The metric of using this Type of Service on\n this interface. The default value of the TOS 0\n metric is 10^8 / ifSpeed.", "x-yang-type": "OSPF-MIB:Metric", "readOnly": true }, "ospfIfMetricStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } } }, "OSPF-MIB_ospfVirtIfEntry": { "type": "array", "description": "Information about a single virtual interface.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfVirtIfAreaId": { "type": "string", "description": "The transit area that the virtual link\n traverses. By definition, this is not 0.0.0.0.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true }, "ospfVirtIfNeighbor": { "type": "string", "description": "The Router ID of the virtual neighbor.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true }, "ospfVirtIfTransitDelay": { "type": "string", "description": "The estimated number of seconds it takes to\n transmit a Link State update packet over this\n interface. Note that the minimal value SHOULD be\n 1 second.", "x-yang-type": "OSPF-MIB:UpToMaxAge", "readOnly": true }, "ospfVirtIfRetransInterval": { "type": "string", "description": "The number of seconds between link state\n avertisement retransmissions, for adjacencies\n belonging to this interface. This value is\n also used when retransmitting database\n description and Link State request packets. This\n value should be well over the expected\n round-trip time. Note that the minimal value SHOULD be\n 1 second.", "x-yang-type": "OSPF-MIB:UpToMaxAge", "readOnly": true }, "ospfVirtIfHelloInterval": { "type": "string", "description": "The length of time, in seconds, between the\n Hello packets that the router sends on the\n interface. This value must be the same for the\n virtual neighbor.", "x-yang-type": "OSPF-MIB:HelloRange", "readOnly": true }, "ospfVirtIfRtrDeadInterval": { "type": "string", "description": "The number of seconds that a router's Hello\n packets have not been seen before its\n neighbors declare the router down. This should be\n some multiple of the Hello interval. This\n value must be the same for the virtual neighbor.", "x-yang-type": "OSPF-MIB:PositiveInteger", "readOnly": true }, "ospfVirtIfState": { "type": "string", "description": "OSPF virtual interface states.", "readOnly": true }, "ospfVirtIfEvents": { "type": "integer", "description": "The number of state changes or error events on\n this virtual link.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfVirtIfAuthKey": { "type": "string", "description": "The cleartext password used as an OSPF\n authentication key when simplePassword security\n is enabled. This object does not access any OSPF\n cryptogaphic (e.g., MD5) authentication key under\n any circumstance.\n \n If the key length is shorter than 8 octets, the\n agent will left adjust and zero fill to 8 octets.\n \n Unauthenticated interfaces need no authentication\n key, and simple password authentication cannot use\n a key of more than 8 octets.\n \n Note that the use of simplePassword authentication\n is NOT recommended when there is concern regarding\n attack upon the OSPF system. SimplePassword\n authentication is only sufficient to protect against\n accidental misconfigurations because it re-uses\n cleartext passwords. [RFC1704]\n \n When read, ospfIfAuthKey always returns an octet\n string of length zero.", "format": "binary", "readOnly": true }, "ospfVirtIfStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ospfVirtIfAuthType": { "type": "string", "description": "The authentication type specified for a virtual interface.\n \n Note that this object can be used to engage\n in significant attacks against an OSPF router.", "x-yang-type": "OSPF-MIB:OspfAuthenticationType", "readOnly": true }, "ospfVirtIfLsaCount": { "type": "integer", "description": "The total number of link-local link state advertisements\n in this virtual interface's link-local link state database.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfVirtIfLsaCksumSum": { "type": "integer", "description": "The 32-bit unsigned sum of the link state\n advertisements' LS checksums contained in this\n virtual interface's link-local link state database.\n The sum can be used to determine if there has\n been a change in the virtual interface's link state\n database, and to compare the virtual interface\n link state database of the virtual neighbors.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } } }, "OSPF-MIB_ospfNbrEntry": { "type": "array", "description": "The information regarding a single neighbor.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n \n storage.", "items": { "type": "object", "properties": { "ospfNbrIpAddr": { "type": "string", "description": "The IP address this neighbor is using in its\n IP source address. Note that, on addressless\n links, this will not be 0.0.0.0 but the\n \n address of another of the neighbor's interfaces.", "format": "inet:ipv4-address", "readOnly": true }, "ospfNbrAddressLessIndex": { "type": "string", "description": "On an interface having an IP address, zero.\n On addressless interfaces, the corresponding\n value of ifIndex in the Internet Standard MIB.\n On row creation, this can be derived from the\n instance.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "ospfNbrRtrId": { "type": "string", "description": "A 32-bit integer (represented as a type\n IpAddress) uniquely identifying the neighboring\n router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true }, "ospfNbrOptions": { "type": "integer", "description": "A bit mask corresponding to the neighbor's\n options field.\n \n Bit 0, if set, indicates that the system will\n operate on Type of Service metrics other than\n TOS 0. If zero, the neighbor will ignore all\n metrics except the TOS 0 metric.\n \n Bit 1, if set, indicates that the associated\n area accepts and operates on external\n information; if zero, it is a stub area.\n \n Bit 2, if set, indicates that the system is\n capable of routing IP multicast datagrams, that is\n that it implements the multicast extensions to\n OSPF.\n \n Bit 3, if set, indicates that the associated\n area is an NSSA. These areas are capable of\n carrying type-7 external advertisements, which\n are translated into type-5 external advertisements\n at NSSA borders.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfNbrPriority": { "type": "string", "description": "The priority of this neighbor in the designated\n router election algorithm. The value 0 signifies\n that the neighbor is not eligible to become\n the designated router on this particular network.", "x-yang-type": "OSPF-MIB:DesignatedRouterPriority", "readOnly": true }, "ospfNbrState": { "type": "string", "description": "The state of the relationship with this neighbor.", "readOnly": true }, "ospfNbrEvents": { "type": "integer", "description": "The number of times this neighbor relationship\n has changed state or an error has occurred.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfNbrLsRetransQLen": { "type": "integer", "description": "The current length of the retransmission\n queue.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfNbmaNbrStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ospfNbmaNbrPermanence": { "type": "string", "description": "This variable displays the status of the entry;\n 'dynamic' and 'permanent' refer to how the neighbor\n became known.", "readOnly": true }, "ospfNbrHelloSuppressed": { "type": "boolean", "description": "Indicates whether Hellos are being suppressed\n to the neighbor.", "readOnly": true }, "ospfNbrRestartHelperStatus": { "type": "string", "description": "Indicates whether the router is acting\n as a graceful restart helper for the neighbor.", "readOnly": true }, "ospfNbrRestartHelperAge": { "type": "integer", "description": "Remaining time in current OSPF graceful restart\n interval, if the router is acting as a restart\n helper for the neighbor.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfNbrRestartHelperExitReason": { "type": "string", "description": "Describes the outcome of the last attempt at acting\n as a graceful restart helper for the neighbor.", "readOnly": true } } } }, "OSPF-MIB_ospfVirtNbrEntry": { "type": "array", "description": "Virtual neighbor information.", "items": { "type": "object", "properties": { "ospfVirtNbrArea": { "type": "string", "description": "The Transit Area Identifier.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true }, "ospfVirtNbrRtrId": { "type": "string", "description": "A 32-bit integer uniquely identifying the\n neighboring router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true }, "ospfVirtNbrIpAddr": { "type": "string", "description": "The IP address this virtual neighbor is using.", "format": "inet:ipv4-address", "readOnly": true }, "ospfVirtNbrOptions": { "type": "integer", "description": "A bit mask corresponding to the neighbor's\n options field.\n \n Bit 1, if set, indicates that the system will\n operate on Type of Service metrics other than\n TOS 0. If zero, the neighbor will ignore all\n metrics except the TOS 0 metric.\n \n Bit 2, if set, indicates that the system is\n network multicast capable, i.e., that it\n implements OSPF multicast routing.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfVirtNbrState": { "type": "string", "description": "The state of the virtual neighbor relationship.", "readOnly": true }, "ospfVirtNbrEvents": { "type": "integer", "description": "The number of times this virtual link has\n changed its state or an error has occurred.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at other\n times as indicated by the value of ospfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfVirtNbrLsRetransQLen": { "type": "integer", "description": "The current length of the retransmission\n queue.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfVirtNbrHelloSuppressed": { "type": "boolean", "description": "Indicates whether Hellos are being suppressed\n to the neighbor.", "readOnly": true }, "ospfVirtNbrRestartHelperStatus": { "type": "string", "description": "Indicates whether the router is acting\n as a graceful restart helper for the neighbor.", "readOnly": true }, "ospfVirtNbrRestartHelperAge": { "type": "integer", "description": "Remaining time in current OSPF graceful restart\n interval, if the router is acting as a restart\n helper for the neighbor.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ospfVirtNbrRestartHelperExitReason": { "type": "string", "description": "Describes the outcome of the last attempt at acting\n as a graceful restart helper for the neighbor.", "readOnly": true } } } }, "OSPF-MIB_ospfExtLsdbEntry": { "type": "array", "description": "A single link state advertisement.", "items": { "type": "object", "properties": { "ospfExtLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement\n format.", "readOnly": true }, "ospfExtLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing either a Router ID or an IP address;\n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address", "readOnly": true }, "ospfExtLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true }, "ospfExtLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate link state\n advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfExtLsdbAge": { "type": "integer", "description": "This field is the age of the link state\n advertisement in seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfExtLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete\n contents of the advertisement, excepting the\n age field. The age field is excepted so that\n an advertisement's age can be incremented\n without updating the checksum. The checksum\n used is the same that is used for ISO\n connectionless datagrams; it is commonly referred\n to as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfExtLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.", "format": "binary", "readOnly": true } } } }, "OSPF-MIB_ospfAreaAggregateEntry": { "type": "array", "description": "A single area aggregate entry.\n \n Information in this table is persistent and when this object\n is written the entity SHOULD save the change to non-volatile\n storage.", "items": { "type": "object", "properties": { "ospfAreaAggregateAreaID": { "type": "string", "description": "The area within which the address aggregate is to be\n found.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true }, "ospfAreaAggregateLsdbType": { "type": "string", "description": "The type of the address aggregate. This field\n specifies the Lsdb type that this address\n aggregate applies to.", "readOnly": true }, "ospfAreaAggregateNet": { "type": "string", "description": "The IP address of the net or subnet indicated\n by the range.", "format": "inet:ipv4-address", "readOnly": true }, "ospfAreaAggregateMask": { "type": "string", "description": "The subnet mask that pertains to the net or\n subnet.", "format": "inet:ipv4-address", "readOnly": true }, "ospfAreaAggregateStatus": { "type": "string", "description": "This object permits management of the table by\n facilitating actions such as row creation,\n construction, and destruction.\n \n The value of this object has no effect on\n whether other objects in this conceptual row can be\n modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ospfAreaAggregateEffect": { "type": "string", "description": "Subnets subsumed by ranges either trigger the\n advertisement of the indicated aggregate\n (advertiseMatching) or result in the subnet's not\n being advertised at all outside the area.", "readOnly": true }, "ospfAreaAggregateExtRouteTag": { "type": "integer", "description": "External route tag to be included in NSSA (type-7)\n LSAs.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } } }, "OSPF-MIB_ospfLocalLsdbEntry": { "type": "array", "description": "A single link state advertisement.", "items": { "type": "object", "properties": { "ospfLocalLsdbIpAddress": { "type": "string", "description": "The IP address of the interface from\n which the LSA was received if the interface is\n numbered.", "format": "inet:ipv4-address", "readOnly": true }, "ospfLocalLsdbAddressLessIf": { "type": "string", "description": "The interface index of the interface from\n which the LSA was received if the interface is\n unnumbered.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "ospfLocalLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate\n advertisement format.", "readOnly": true }, "ospfLocalLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing a 32-bit identifier in IP address format;\n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address", "readOnly": true }, "ospfLocalLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true }, "ospfLocalLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate link state\n advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfLocalLsdbAge": { "type": "integer", "description": "This field is the age of the link state\n advertisement in seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfLocalLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete\n contents of the advertisement, excepting the\n age field. The age field is excepted so that\n an advertisement's age can be incremented\n without updating the checksum. The checksum\n used is the same that is used for ISO\n connectionless datagrams; it is commonly referred\n to as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfLocalLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.\n \n Note that for variable length LSAs, SNMP agents\n may not be able to return the largest string size.", "format": "binary", "readOnly": true } } } }, "OSPF-MIB_ospfVirtLocalLsdbEntry": { "type": "array", "description": "A single link state advertisement.", "items": { "type": "object", "properties": { "ospfVirtLocalLsdbTransitArea": { "type": "string", "description": "The transit area that the virtual link\n traverses. By definition, this is not 0.0.0.0.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true }, "ospfVirtLocalLsdbNeighbor": { "type": "string", "description": "The Router ID of the virtual neighbor.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true }, "ospfVirtLocalLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate\n advertisement format.", "readOnly": true }, "ospfVirtLocalLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing a 32-bit identifier in IP address format;\n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address", "readOnly": true }, "ospfVirtLocalLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true }, "ospfVirtLocalLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate link state\n advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfVirtLocalLsdbAge": { "type": "integer", "description": "This field is the age of the link state\n advertisement in seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfVirtLocalLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete\n contents of the advertisement, excepting the\n age field. The age field is excepted so that\n \n an advertisement's age can be incremented\n without updating the checksum. The checksum\n used is the same that is used for ISO\n connectionless datagrams; it is commonly\n referred to as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfVirtLocalLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.", "format": "binary", "readOnly": true } } } }, "OSPF-MIB_ospfAsLsdbEntry": { "type": "array", "description": "A single link state advertisement.", "items": { "type": "object", "properties": { "ospfAsLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate\n advertisement format.", "readOnly": true }, "ospfAsLsdbLsid": { "type": "string", "description": "The Link State ID is an LS Type Specific field\n containing either a Router ID or an IP address;\n \n it identifies the piece of the routing domain\n that is being described by the advertisement.", "format": "inet:ipv4-address", "readOnly": true }, "ospfAsLsdbRouterId": { "type": "string", "description": "The 32-bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "OSPF-MIB:RouterID", "readOnly": true }, "ospfAsLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It starts with the value '80000001'h,\n or -'7FFFFFFF'h, and increments until '7FFFFFFF'h.\n Thus, a typical sequence number will be very negative.\n It is used to detect old and duplicate link state\n advertisements. The space of sequence numbers is linearly\n ordered. The larger the sequence number, the more recent\n the advertisement.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfAsLsdbAge": { "type": "integer", "description": "This field is the age of the link state\n advertisement in seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfAsLsdbChecksum": { "type": "integer", "description": "This field is the checksum of the complete\n contents of the advertisement, excepting the\n age field. The age field is excepted so that\n an advertisement's age can be incremented\n without updating the checksum. The checksum\n used is the same that is used for ISO\n connectionless datagrams; it is commonly referred\n to as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ospfAsLsdbAdvertisement": { "type": "string", "description": "The entire link state advertisement, including\n its header.", "format": "binary", "readOnly": true } } } }, "OSPF-MIB_ospfAreaLsaCountEntry": { "type": "array", "description": "An entry with a number of link advertisements\n \n of a given type for a given area.", "items": { "type": "object", "properties": { "ospfAreaLsaCountAreaId": { "type": "string", "description": "This entry Area ID.", "x-yang-type": "OSPF-MIB:AreaID", "readOnly": true }, "ospfAreaLsaCountLsaType": { "type": "string", "description": "This entry LSA type.", "readOnly": true }, "ospfAreaLsaCountNumber": { "type": "integer", "description": "Number of LSAs of a given type for a given area.", "minimum": 0, "maximum": 4294967295, "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": "OSPF-MIB", "description": "MIB operations for OSPF-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }