{ "openapi": "3.0.0", "info": { "title": "CISCO-OSPF-MIB MIB API", "version": "1.0.0", "description": "An extension to the MIB module defined in\n RFC 1850 for managing OSPF implimentation. \n Most of the MIB definitions are based on\n the IETF draft \n < draft-ietf-ospf-mib-update-05.txt > . \n Support for OSPF Sham link is also added\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 CISCO-OSPF-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/CISCO-OSPF-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "CISCO-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/CISCO-OSPF-MIB:cospfGeneralGroup": { "get": { "summary": "Get cospfGeneralGroup data", "description": "Retrieve cospfGeneralGroup operational data from MIB", "tags": [ "CISCO-OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "cospfGeneralGroup", "properties": { "cospfRFC1583Compatibility": { "type": "boolean", "description": "Indicates metrics used to choose among multiple AS-\n external-LSAs. When cospfRFC1583Compatibility is set to\n enabled, only cost will be used when choosing among\n multiple AS-external-LSAs advertising the same\n destination. When cospfRFC1583Compatibility is set to\n disabled, preference will be driven first by type of\n path using cost only to break ties." }, "cospfOpaqueLsaSupport": { "type": "boolean", "description": "The router's support for Opaque LSA types." }, "cospfTrafficEngineeringSupport": { "type": "boolean", "description": "The router's support for OSPF traffic engineering." }, "cospfOpaqueASLsaCount": { "type": "integer", "description": "The total number of Opaque AS link-state\n advertisements in the link state database.", "minimum": 0, "maximum": 4294967295 }, "cospfOpaqueASLsaCksumSum": { "type": "integer", "description": "The 32-bit unsigned sum of the Opaque AS \n link-state advertisements' LS checksums contained\n link state database.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-OSPF-MIB:cospfGeneralGroup": { "cospfRFC1583Compatibility": true, "cospfOpaqueLsaSupport": true, "cospfTrafficEngineeringSupport": true, "cospfOpaqueASLsaCount": 0, "cospfOpaqueASLsaCksumSum": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cospfGeneralGroup", "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": "/cospfGeneralGroup", "x-restconf-kind": "container" }, "/data/CISCO-OSPF-MIB:cospfLsdbTable": { "get": { "summary": "Get cospfLsdbTable data", "description": "Retrieve cospfLsdbTable operational data from MIB", "tags": [ "CISCO-OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The OSPF Process's Link State Database. This \n table is meant for Opaque LSA's", "properties": { "cospfLsdbEntry": { "type": "array", "description": "A single Link State Advertisement.", "items": { "type": "object", "properties": { "ospfLsdbAreaId": { "type": "string", "description": "ospfLsdbAreaId", "x-yang-type": "leafref" }, "ospfLsdbLsid": { "type": "string", "description": "ospfLsdbLsid", "x-yang-type": "leafref" }, "ospfLsdbRouterId": { "type": "string", "description": "ospfLsdbRouterId", "x-yang-type": "leafref" }, "cospfLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement format." }, "cospfLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It is used to detect old and duplicate\n link state advertisements. The space of\n sequence numbers is linearly ordered. The\n larger the sequence number the more recent the\n advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfLsdbAge": { "type": "integer", "description": "This field is the age of the link state advertisement in\n seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfLsdbChecksum": { "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 connectionless\n datagrams; it is commonly referred to\n as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfLsdbAdvertisement": { "type": "string", "description": "The entire Link State Advertisement, including\n its header.", "format": "binary" } } } } } }, "example": { "CISCO-OSPF-MIB:cospfLsdbTable": { "cospfLsdbEntry": [ { "ospfLsdbAreaId": "example-string", "ospfLsdbLsid": "example-string", "ospfLsdbRouterId": "example-string", "cospfLsdbType": "ethernetCsmacd(6)", "cospfLsdbSequence": -2147483648, "cospfLsdbAge": -2147483648, "cospfLsdbChecksum": -2147483648, "cospfLsdbAdvertisement": "example-string" }, { "ospfLsdbAreaId": "example-string", "ospfLsdbLsid": "example-string", "ospfLsdbRouterId": "example-string", "cospfLsdbType": "ethernetCsmacd(6)", "cospfLsdbSequence": -2147483648, "cospfLsdbAge": -2147483648, "cospfLsdbChecksum": -2147483648, "cospfLsdbAdvertisement": "example-string" }, { "ospfLsdbAreaId": "example-string", "ospfLsdbLsid": "example-string", "ospfLsdbRouterId": "example-string", "cospfLsdbType": "ethernetCsmacd(6)", "cospfLsdbSequence": -2147483648, "cospfLsdbAge": -2147483648, "cospfLsdbChecksum": -2147483648, "cospfLsdbAdvertisement": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cospfLsdbTable", "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": "/cospfLsdbTable", "x-restconf-kind": "container" }, "/data/CISCO-OSPF-MIB:cospfLsdbTable/cospfLsdbEntry": { "get": { "summary": "Get cospfLsdbEntry list", "description": "Retrieve list of cospfLsdbEntry entries from MIB", "tags": [ "CISCO-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": "ospfLsdbAreaId", "x-yang-type": "leafref" }, "ospfLsdbLsid": { "type": "string", "description": "ospfLsdbLsid", "x-yang-type": "leafref" }, "ospfLsdbRouterId": { "type": "string", "description": "ospfLsdbRouterId", "x-yang-type": "leafref" }, "cospfLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement format." }, "cospfLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It is used to detect old and duplicate\n link state advertisements. The space of\n sequence numbers is linearly ordered. The\n larger the sequence number the more recent the\n advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfLsdbAge": { "type": "integer", "description": "This field is the age of the link state advertisement in\n seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfLsdbChecksum": { "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 connectionless\n datagrams; it is commonly referred to\n as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfLsdbAdvertisement": { "type": "string", "description": "The entire Link State Advertisement, including\n its header.", "format": "binary" } } } }, "example": { "CISCO-OSPF-MIB:cospfLsdbEntry": [ { "ospfLsdbAreaId": "example-string", "ospfLsdbLsid": "example-string", "ospfLsdbRouterId": "example-string", "cospfLsdbType": "ethernetCsmacd(6)", "cospfLsdbSequence": -2147483648, "cospfLsdbAge": -2147483648, "cospfLsdbChecksum": -2147483648, "cospfLsdbAdvertisement": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cospfLsdbEntry", "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": "/cospfLsdbTable/cospfLsdbEntry", "x-restconf-kind": "container" }, "/data/CISCO-OSPF-MIB:cospfShamLinkTable": { "get": { "summary": "Get cospfShamLinkTable data", "description": "Retrieve cospfShamLinkTable operational data from MIB", "tags": [ "CISCO-OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "Information about this router's sham links", "properties": { "cospfShamLinkEntry": { "type": "array", "description": "Information about a single sham link", "items": { "type": "object", "properties": { "cospfShamLinkAreaId": { "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" }, "cospfShamLinkLocalIpAddress": { "type": "string", "description": "The Local IP address of the sham link.", "format": "inet:ipv4-address" }, "cospfShamLinkNeighborId": { "type": "string", "description": "The Router ID of the other end router of the sham\n link.", "x-yang-type": "ospf-mib:RouterID" }, "cospfShamLinkRetransInterval": { "type": "string", "description": "The number of seconds between link-state advertisement\n retransmissions, for adjacencies\n belonging to this link. This value is also\n used when retransmitting database description \n and link-state request packets. This value \n should be well over the expected round trip\n time.", "x-yang-type": "ospf-mib:UpToMaxAge" }, "cospfShamLinkHelloInterval": { "type": "string", "description": "The length of time, in seconds, between the\n Hello packets that the router sends on the sham\n link.", "x-yang-type": "ospf-mib:HelloRange" }, "cospfShamLinkRtrDeadInterval": { "type": "string", "description": "The number of seconds that a router's Hello\n packets have not been seen before it's neighbors\n declare the router down. This should be\n some multiple of the Hello interval.", "x-yang-type": "ospf-mib:PositiveInteger" }, "cospfShamLinkState": { "type": "string", "description": "OSPF sham link states." }, "cospfShamLinkEvents": { "type": "integer", "description": "The number of state changes or error events on\n this sham link", "minimum": 0, "maximum": 4294967295 }, "cospfShamLinkMetric": { "type": "string", "description": "The Metric to be advertised.", "x-yang-type": "ospf-mib:Metric" } } } } } }, "example": { "CISCO-OSPF-MIB:cospfShamLinkTable": { "cospfShamLinkEntry": [ { "cospfShamLinkAreaId": "example-string", "cospfShamLinkLocalIpAddress": "192.168.1.1", "cospfShamLinkNeighborId": "example-string", "cospfShamLinkRetransInterval": "example-string", "cospfShamLinkHelloInterval": "example-string", "cospfShamLinkRtrDeadInterval": "example-string", "cospfShamLinkState": "up(1)", "cospfShamLinkEvents": 0, "cospfShamLinkMetric": "example-string" }, { "cospfShamLinkAreaId": "example-string", "cospfShamLinkLocalIpAddress": "192.168.1.1", "cospfShamLinkNeighborId": "example-string", "cospfShamLinkRetransInterval": "example-string", "cospfShamLinkHelloInterval": "example-string", "cospfShamLinkRtrDeadInterval": "example-string", "cospfShamLinkState": "up(1)", "cospfShamLinkEvents": 0, "cospfShamLinkMetric": "example-string" }, { "cospfShamLinkAreaId": "example-string", "cospfShamLinkLocalIpAddress": "192.168.1.1", "cospfShamLinkNeighborId": "example-string", "cospfShamLinkRetransInterval": "example-string", "cospfShamLinkHelloInterval": "example-string", "cospfShamLinkRtrDeadInterval": "example-string", "cospfShamLinkState": "up(1)", "cospfShamLinkEvents": 0, "cospfShamLinkMetric": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cospfShamLinkTable", "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": "/cospfShamLinkTable", "x-restconf-kind": "container" }, "/data/CISCO-OSPF-MIB:cospfShamLinkTable/cospfShamLinkEntry": { "get": { "summary": "Get cospfShamLinkEntry list", "description": "Retrieve list of cospfShamLinkEntry entries from MIB", "tags": [ "CISCO-OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about a single sham link", "items": { "type": "object", "properties": { "cospfShamLinkAreaId": { "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" }, "cospfShamLinkLocalIpAddress": { "type": "string", "description": "The Local IP address of the sham link.", "format": "inet:ipv4-address" }, "cospfShamLinkNeighborId": { "type": "string", "description": "The Router ID of the other end router of the sham\n link.", "x-yang-type": "ospf-mib:RouterID" }, "cospfShamLinkRetransInterval": { "type": "string", "description": "The number of seconds between link-state advertisement\n retransmissions, for adjacencies\n belonging to this link. This value is also\n used when retransmitting database description \n and link-state request packets. This value \n should be well over the expected round trip\n time.", "x-yang-type": "ospf-mib:UpToMaxAge" }, "cospfShamLinkHelloInterval": { "type": "string", "description": "The length of time, in seconds, between the\n Hello packets that the router sends on the sham\n link.", "x-yang-type": "ospf-mib:HelloRange" }, "cospfShamLinkRtrDeadInterval": { "type": "string", "description": "The number of seconds that a router's Hello\n packets have not been seen before it's neighbors\n declare the router down. This should be\n some multiple of the Hello interval.", "x-yang-type": "ospf-mib:PositiveInteger" }, "cospfShamLinkState": { "type": "string", "description": "OSPF sham link states." }, "cospfShamLinkEvents": { "type": "integer", "description": "The number of state changes or error events on\n this sham link", "minimum": 0, "maximum": 4294967295 }, "cospfShamLinkMetric": { "type": "string", "description": "The Metric to be advertised.", "x-yang-type": "ospf-mib:Metric" } } } }, "example": { "CISCO-OSPF-MIB:cospfShamLinkEntry": [ { "cospfShamLinkAreaId": "example-string", "cospfShamLinkLocalIpAddress": "192.168.1.1", "cospfShamLinkNeighborId": "example-string", "cospfShamLinkRetransInterval": "example-string", "cospfShamLinkHelloInterval": "example-string", "cospfShamLinkRtrDeadInterval": "example-string", "cospfShamLinkState": "up(1)", "cospfShamLinkEvents": 0, "cospfShamLinkMetric": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cospfShamLinkEntry", "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": "/cospfShamLinkTable/cospfShamLinkEntry", "x-restconf-kind": "container" }, "/data/CISCO-OSPF-MIB:cospfLocalLsdbTable": { "get": { "summary": "Get cospfLocalLsdbTable data", "description": "Retrieve cospfLocalLsdbTable operational data from MIB", "tags": [ "CISCO-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.", "properties": { "cospfLocalLsdbEntry": { "type": "array", "description": "A single Link State Advertisement.", "items": { "type": "object", "properties": { "cospfLocalLsdbIpAddress": { "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" }, "cospfLocalLsdbAddressLessIf": { "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" }, "cospfLocalLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement format." }, "cospfLocalLsdbLsid": { "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" }, "cospfLocalLsdbRouterId": { "type": "string", "description": "The 32 bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "ospf-mib:RouterID" }, "cospfLocalLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It is used to detect old and duplicate link\n state advertisements. The space of\n sequence numbers is linearly ordered. The\n larger the sequence number the more recent the\n advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfLocalLsdbAge": { "type": "integer", "description": "This field is the age of the link state advertisement \n in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfLocalLsdbChecksum": { "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 connectionless\n datagrams; it is commonly referred to\n as the Fletcher checksum.", "minimum": 0, "maximum": 4294967295 }, "cospfLocalLsdbAdvertisement": { "type": "string", "description": "The entire Link State Advertisement, including\n its header.", "format": "binary" } } } } } }, "example": { "CISCO-OSPF-MIB:cospfLocalLsdbTable": { "cospfLocalLsdbEntry": [ { "cospfLocalLsdbIpAddress": "192.168.1.1", "cospfLocalLsdbAddressLessIf": "192.168.1.1", "cospfLocalLsdbType": "ethernetCsmacd(6)", "cospfLocalLsdbLsid": "example-string", "cospfLocalLsdbRouterId": "example-string", "cospfLocalLsdbSequence": -2147483648, "cospfLocalLsdbAge": -2147483648, "cospfLocalLsdbChecksum": 0, "cospfLocalLsdbAdvertisement": "example-string" }, { "cospfLocalLsdbIpAddress": "192.168.1.1", "cospfLocalLsdbAddressLessIf": "192.168.1.1", "cospfLocalLsdbType": "ethernetCsmacd(6)", "cospfLocalLsdbLsid": "example-string", "cospfLocalLsdbRouterId": "example-string", "cospfLocalLsdbSequence": -2147483648, "cospfLocalLsdbAge": -2147483648, "cospfLocalLsdbChecksum": 0, "cospfLocalLsdbAdvertisement": "example-string" }, { "cospfLocalLsdbIpAddress": "192.168.1.1", "cospfLocalLsdbAddressLessIf": "192.168.1.1", "cospfLocalLsdbType": "ethernetCsmacd(6)", "cospfLocalLsdbLsid": "example-string", "cospfLocalLsdbRouterId": "example-string", "cospfLocalLsdbSequence": -2147483648, "cospfLocalLsdbAge": -2147483648, "cospfLocalLsdbChecksum": 0, "cospfLocalLsdbAdvertisement": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cospfLocalLsdbTable", "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": "/cospfLocalLsdbTable", "x-restconf-kind": "container" }, "/data/CISCO-OSPF-MIB:cospfLocalLsdbTable/cospfLocalLsdbEntry": { "get": { "summary": "Get cospfLocalLsdbEntry list", "description": "Retrieve list of cospfLocalLsdbEntry entries from MIB", "tags": [ "CISCO-OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A single Link State Advertisement.", "items": { "type": "object", "properties": { "cospfLocalLsdbIpAddress": { "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" }, "cospfLocalLsdbAddressLessIf": { "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" }, "cospfLocalLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement format." }, "cospfLocalLsdbLsid": { "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" }, "cospfLocalLsdbRouterId": { "type": "string", "description": "The 32 bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "ospf-mib:RouterID" }, "cospfLocalLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It is used to detect old and duplicate link\n state advertisements. The space of\n sequence numbers is linearly ordered. The\n larger the sequence number the more recent the\n advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfLocalLsdbAge": { "type": "integer", "description": "This field is the age of the link state advertisement \n in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfLocalLsdbChecksum": { "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 connectionless\n datagrams; it is commonly referred to\n as the Fletcher checksum.", "minimum": 0, "maximum": 4294967295 }, "cospfLocalLsdbAdvertisement": { "type": "string", "description": "The entire Link State Advertisement, including\n its header.", "format": "binary" } } } }, "example": { "CISCO-OSPF-MIB:cospfLocalLsdbEntry": [ { "cospfLocalLsdbIpAddress": "192.168.1.1", "cospfLocalLsdbAddressLessIf": "192.168.1.1", "cospfLocalLsdbType": "ethernetCsmacd(6)", "cospfLocalLsdbLsid": "example-string", "cospfLocalLsdbRouterId": "example-string", "cospfLocalLsdbSequence": -2147483648, "cospfLocalLsdbAge": -2147483648, "cospfLocalLsdbChecksum": 0, "cospfLocalLsdbAdvertisement": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cospfLocalLsdbEntry", "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": "/cospfLocalLsdbTable/cospfLocalLsdbEntry", "x-restconf-kind": "container" }, "/data/CISCO-OSPF-MIB:cospfVirtLocalLsdbTable": { "get": { "summary": "Get cospfVirtLocalLsdbTable data", "description": "Retrieve cospfVirtLocalLsdbTable operational data from MIB", "tags": [ "CISCO-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.", "properties": { "cospfVirtLocalLsdbEntry": { "type": "array", "description": "A single Link State Advertisement.", "items": { "type": "object", "properties": { "cospfVirtLocalLsdbTransitArea": { "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" }, "cospfVirtLocalLsdbNeighbor": { "type": "string", "description": "The Router ID of the Virtual Neighbor.", "x-yang-type": "ospf-mib:RouterID" }, "cospfVirtLocalLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement format." }, "cospfVirtLocalLsdbLsid": { "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" }, "cospfVirtLocalLsdbRouterId": { "type": "string", "description": "The 32 bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "ospf-mib:RouterID" }, "cospfVirtLocalLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It is used to detect old and duplicate\n link state advertisements. The space of\n sequence numbers is linearly ordered. The\n larger the sequence number the more recent the\n advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfVirtLocalLsdbAge": { "type": "integer", "description": "This field is the age of the link state advertisement\n in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfVirtLocalLsdbChecksum": { "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 connectionless\n datagrams; it is commonly referred to\n as the Fletcher checksum.", "minimum": 0, "maximum": 4294967295 }, "cospfVirtLocalLsdbAdvertisement": { "type": "string", "description": "The entire Link State Advertisement, including\n its header.", "format": "binary" } } } } } }, "example": { "CISCO-OSPF-MIB:cospfVirtLocalLsdbTable": { "cospfVirtLocalLsdbEntry": [ { "cospfVirtLocalLsdbTransitArea": "example-string", "cospfVirtLocalLsdbNeighbor": "example-string", "cospfVirtLocalLsdbType": "ethernetCsmacd(6)", "cospfVirtLocalLsdbLsid": "example-string", "cospfVirtLocalLsdbRouterId": "example-string", "cospfVirtLocalLsdbSequence": -2147483648, "cospfVirtLocalLsdbAge": -2147483648, "cospfVirtLocalLsdbChecksum": 0, "cospfVirtLocalLsdbAdvertisement": "example-string" }, { "cospfVirtLocalLsdbTransitArea": "example-string", "cospfVirtLocalLsdbNeighbor": "example-string", "cospfVirtLocalLsdbType": "ethernetCsmacd(6)", "cospfVirtLocalLsdbLsid": "example-string", "cospfVirtLocalLsdbRouterId": "example-string", "cospfVirtLocalLsdbSequence": -2147483648, "cospfVirtLocalLsdbAge": -2147483648, "cospfVirtLocalLsdbChecksum": 0, "cospfVirtLocalLsdbAdvertisement": "example-string" }, { "cospfVirtLocalLsdbTransitArea": "example-string", "cospfVirtLocalLsdbNeighbor": "example-string", "cospfVirtLocalLsdbType": "ethernetCsmacd(6)", "cospfVirtLocalLsdbLsid": "example-string", "cospfVirtLocalLsdbRouterId": "example-string", "cospfVirtLocalLsdbSequence": -2147483648, "cospfVirtLocalLsdbAge": -2147483648, "cospfVirtLocalLsdbChecksum": 0, "cospfVirtLocalLsdbAdvertisement": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cospfVirtLocalLsdbTable", "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": "/cospfVirtLocalLsdbTable", "x-restconf-kind": "container" }, "/data/CISCO-OSPF-MIB:cospfVirtLocalLsdbTable/cospfVirtLocalLsdbEntry": { "get": { "summary": "Get cospfVirtLocalLsdbEntry list", "description": "Retrieve list of cospfVirtLocalLsdbEntry entries from MIB", "tags": [ "CISCO-OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A single Link State Advertisement.", "items": { "type": "object", "properties": { "cospfVirtLocalLsdbTransitArea": { "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" }, "cospfVirtLocalLsdbNeighbor": { "type": "string", "description": "The Router ID of the Virtual Neighbor.", "x-yang-type": "ospf-mib:RouterID" }, "cospfVirtLocalLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement format." }, "cospfVirtLocalLsdbLsid": { "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" }, "cospfVirtLocalLsdbRouterId": { "type": "string", "description": "The 32 bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "ospf-mib:RouterID" }, "cospfVirtLocalLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It is used to detect old and duplicate\n link state advertisements. The space of\n sequence numbers is linearly ordered. The\n larger the sequence number the more recent the\n advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfVirtLocalLsdbAge": { "type": "integer", "description": "This field is the age of the link state advertisement\n in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfVirtLocalLsdbChecksum": { "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 connectionless\n datagrams; it is commonly referred to\n as the Fletcher checksum.", "minimum": 0, "maximum": 4294967295 }, "cospfVirtLocalLsdbAdvertisement": { "type": "string", "description": "The entire Link State Advertisement, including\n its header.", "format": "binary" } } } }, "example": { "CISCO-OSPF-MIB:cospfVirtLocalLsdbEntry": [ { "cospfVirtLocalLsdbTransitArea": "example-string", "cospfVirtLocalLsdbNeighbor": "example-string", "cospfVirtLocalLsdbType": "ethernetCsmacd(6)", "cospfVirtLocalLsdbLsid": "example-string", "cospfVirtLocalLsdbRouterId": "example-string", "cospfVirtLocalLsdbSequence": -2147483648, "cospfVirtLocalLsdbAge": -2147483648, "cospfVirtLocalLsdbChecksum": 0, "cospfVirtLocalLsdbAdvertisement": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cospfVirtLocalLsdbEntry", "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": "/cospfVirtLocalLsdbTable/cospfVirtLocalLsdbEntry", "x-restconf-kind": "container" }, "/data/CISCO-OSPF-MIB:cospfShamLinkNbrTable": { "get": { "summary": "Get cospfShamLinkNbrTable data", "description": "Retrieve cospfShamLinkNbrTable operational data from MIB", "tags": [ "CISCO-OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table of sham link neighbor information.", "properties": { "cospfShamLinkNbrEntry": { "type": "array", "description": "Sham link neighbor information.", "items": { "type": "object", "properties": { "cospfShamLinksLocalIpAddrType": { "type": "string", "description": "cospfShamLinksLocalIpAddrType", "x-yang-type": "leafref" }, "cospfShamLinksLocalIpAddr": { "type": "string", "description": "cospfShamLinksLocalIpAddr", "x-yang-type": "leafref" }, "cospfShamLinkNbrArea": { "type": "string", "description": "The area to which the sham link is part of.", "x-yang-type": "ospf-mib:AreaID" }, "cospfShamLinkNbrIpAddrType": { "type": "string", "description": "The type of internet address of this sham link neighbor's\n IP address.", "x-yang-type": "inet-address:InetAddressType" }, "cospfShamLinkNbrIpAddr": { "type": "string", "description": "The IP address this sham link neighbor is using.", "x-yang-type": "inet-address:InetAddress" }, "cospfShamLinkNbrRtrId": { "type": "string", "description": "A 32-bit integer uniquely identifying the neighboring\n router.", "x-yang-type": "ospf-mib:RouterID" }, "cospfShamLinkNbrOptions": { "type": "integer", "description": "A Bit Mask corresponding to the neighbor's options\n 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; ie, that it implements \n OSPF Multicast Routing.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfShamLinkNbrState": { "type": "string", "description": "The state of this sham link neighbor relation-\n ship." }, "cospfShamLinkNbrEvents": { "type": "integer", "description": "The number of times this sham link has changed\n state or an error has occurred.", "minimum": 0, "maximum": 4294967295 }, "cospfShamLinkNbrLsRetransQLen": { "type": "integer", "description": "The current length of the retransmission\n queue. The retransmission queue is maintained for\n LSAs that have been flooded but not acknowledged\n on this adjacency.", "minimum": 0, "maximum": 4294967295 }, "cospfShamLinkNbrHelloSuppressed": { "type": "boolean", "description": "Indicates whether Hellos are being suppressed\n to the neighbor." } } } } } }, "example": { "CISCO-OSPF-MIB:cospfShamLinkNbrTable": { "cospfShamLinkNbrEntry": [ { "cospfShamLinksLocalIpAddrType": "192.168.1.1", "cospfShamLinksLocalIpAddr": "192.168.1.1", "cospfShamLinkNbrArea": "example-string", "cospfShamLinkNbrIpAddrType": "192.168.1.1", "cospfShamLinkNbrIpAddr": "192.168.1.1", "cospfShamLinkNbrRtrId": "example-string", "cospfShamLinkNbrOptions": -2147483648, "cospfShamLinkNbrState": "up(1)", "cospfShamLinkNbrEvents": 0, "cospfShamLinkNbrLsRetransQLen": 0, "cospfShamLinkNbrHelloSuppressed": true }, { "cospfShamLinksLocalIpAddrType": "192.168.1.1", "cospfShamLinksLocalIpAddr": "192.168.1.1", "cospfShamLinkNbrArea": "example-string", "cospfShamLinkNbrIpAddrType": "192.168.1.1", "cospfShamLinkNbrIpAddr": "192.168.1.1", "cospfShamLinkNbrRtrId": "example-string", "cospfShamLinkNbrOptions": -2147483648, "cospfShamLinkNbrState": "up(1)", "cospfShamLinkNbrEvents": 0, "cospfShamLinkNbrLsRetransQLen": 0, "cospfShamLinkNbrHelloSuppressed": true }, { "cospfShamLinksLocalIpAddrType": "192.168.1.1", "cospfShamLinksLocalIpAddr": "192.168.1.1", "cospfShamLinkNbrArea": "example-string", "cospfShamLinkNbrIpAddrType": "192.168.1.1", "cospfShamLinkNbrIpAddr": "192.168.1.1", "cospfShamLinkNbrRtrId": "example-string", "cospfShamLinkNbrOptions": -2147483648, "cospfShamLinkNbrState": "up(1)", "cospfShamLinkNbrEvents": 0, "cospfShamLinkNbrLsRetransQLen": 0, "cospfShamLinkNbrHelloSuppressed": true } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cospfShamLinkNbrTable", "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": "/cospfShamLinkNbrTable", "x-restconf-kind": "container" }, "/data/CISCO-OSPF-MIB:cospfShamLinkNbrTable/cospfShamLinkNbrEntry": { "get": { "summary": "Get cospfShamLinkNbrEntry list", "description": "Retrieve list of cospfShamLinkNbrEntry entries from MIB", "tags": [ "CISCO-OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Sham link neighbor information.", "items": { "type": "object", "properties": { "cospfShamLinksLocalIpAddrType": { "type": "string", "description": "cospfShamLinksLocalIpAddrType", "x-yang-type": "leafref" }, "cospfShamLinksLocalIpAddr": { "type": "string", "description": "cospfShamLinksLocalIpAddr", "x-yang-type": "leafref" }, "cospfShamLinkNbrArea": { "type": "string", "description": "The area to which the sham link is part of.", "x-yang-type": "ospf-mib:AreaID" }, "cospfShamLinkNbrIpAddrType": { "type": "string", "description": "The type of internet address of this sham link neighbor's\n IP address.", "x-yang-type": "inet-address:InetAddressType" }, "cospfShamLinkNbrIpAddr": { "type": "string", "description": "The IP address this sham link neighbor is using.", "x-yang-type": "inet-address:InetAddress" }, "cospfShamLinkNbrRtrId": { "type": "string", "description": "A 32-bit integer uniquely identifying the neighboring\n router.", "x-yang-type": "ospf-mib:RouterID" }, "cospfShamLinkNbrOptions": { "type": "integer", "description": "A Bit Mask corresponding to the neighbor's options\n 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; ie, that it implements \n OSPF Multicast Routing.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfShamLinkNbrState": { "type": "string", "description": "The state of this sham link neighbor relation-\n ship." }, "cospfShamLinkNbrEvents": { "type": "integer", "description": "The number of times this sham link has changed\n state or an error has occurred.", "minimum": 0, "maximum": 4294967295 }, "cospfShamLinkNbrLsRetransQLen": { "type": "integer", "description": "The current length of the retransmission\n queue. The retransmission queue is maintained for\n LSAs that have been flooded but not acknowledged\n on this adjacency.", "minimum": 0, "maximum": 4294967295 }, "cospfShamLinkNbrHelloSuppressed": { "type": "boolean", "description": "Indicates whether Hellos are being suppressed\n to the neighbor." } } } }, "example": { "CISCO-OSPF-MIB:cospfShamLinkNbrEntry": [ { "cospfShamLinksLocalIpAddrType": "192.168.1.1", "cospfShamLinksLocalIpAddr": "192.168.1.1", "cospfShamLinkNbrArea": "example-string", "cospfShamLinkNbrIpAddrType": "192.168.1.1", "cospfShamLinkNbrIpAddr": "192.168.1.1", "cospfShamLinkNbrRtrId": "example-string", "cospfShamLinkNbrOptions": -2147483648, "cospfShamLinkNbrState": "up(1)", "cospfShamLinkNbrEvents": 0, "cospfShamLinkNbrLsRetransQLen": 0, "cospfShamLinkNbrHelloSuppressed": true } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cospfShamLinkNbrEntry", "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": "/cospfShamLinkNbrTable/cospfShamLinkNbrEntry", "x-restconf-kind": "container" }, "/data/CISCO-OSPF-MIB:cospfShamLinksTable": { "get": { "summary": "Get cospfShamLinksTable data", "description": "Retrieve cospfShamLinksTable operational data from MIB", "tags": [ "CISCO-OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "Information about this router's sham links.", "properties": { "cospfShamLinksEntry": { "type": "array", "description": "Information about a single sham link.", "items": { "type": "object", "properties": { "cospfShamLinksAreaId": { "type": "string", "description": "The area that this sham link is part of.", "x-yang-type": "ospf-mib:AreaID" }, "cospfShamLinksLocalIpAddrType": { "type": "string", "description": "The type of internet address of this sham link's local IP\n address.", "x-yang-type": "inet-address:InetAddressType" }, "cospfShamLinksLocalIpAddr": { "type": "string", "description": "The Local IP address of the sham link.", "x-yang-type": "inet-address:InetAddress" }, "cospfShamLinksRemoteIpAddrType": { "type": "string", "description": "The type of internet address of this sham link's remote IP\n address.", "x-yang-type": "inet-address:InetAddressType" }, "cospfShamLinksRemoteIpAddr": { "type": "string", "description": "The IP address of the other end router of the sham link.", "x-yang-type": "inet-address:InetAddress" }, "cospfShamLinksRetransInterval": { "type": "string", "description": "The number of seconds between link-state advertisement\n retransmissions, for adjacencies belonging to this link.\n This value is also used when retransmitting database \n description and link-state request packets. This value\n should be well over the expected round trip time.", "x-yang-type": "ospf-mib:UpToMaxAge" }, "cospfShamLinksHelloInterval": { "type": "string", "description": "The length of time, in seconds, between the\n Hello packets that the router sends on the sham\n link.", "x-yang-type": "ospf-mib:HelloRange" }, "cospfShamLinksRtrDeadInterval": { "type": "string", "description": "The number of seconds that a router's Hello\n packets have not been seen before it's neighbors\n declare the router down. This should be\n some multiple of the Hello interval.", "x-yang-type": "ospf-mib:PositiveInteger" }, "cospfShamLinksState": { "type": "string", "description": "OSPF sham link states." }, "cospfShamLinksEvents": { "type": "integer", "description": "The number of state changes or error events on\n this sham link", "minimum": 0, "maximum": 4294967295 }, "cospfShamLinksMetric": { "type": "string", "description": "The Metric to be advertised.", "x-yang-type": "ospf-mib:Metric" } } } } } }, "example": { "CISCO-OSPF-MIB:cospfShamLinksTable": { "cospfShamLinksEntry": [ { "cospfShamLinksAreaId": "example-string", "cospfShamLinksLocalIpAddrType": "192.168.1.1", "cospfShamLinksLocalIpAddr": "192.168.1.1", "cospfShamLinksRemoteIpAddrType": "192.168.1.1", "cospfShamLinksRemoteIpAddr": "192.168.1.1", "cospfShamLinksRetransInterval": "example-string", "cospfShamLinksHelloInterval": "example-string", "cospfShamLinksRtrDeadInterval": "example-string", "cospfShamLinksState": "up(1)", "cospfShamLinksEvents": 0, "cospfShamLinksMetric": "example-string" }, { "cospfShamLinksAreaId": "example-string", "cospfShamLinksLocalIpAddrType": "192.168.1.1", "cospfShamLinksLocalIpAddr": "192.168.1.1", "cospfShamLinksRemoteIpAddrType": "192.168.1.1", "cospfShamLinksRemoteIpAddr": "192.168.1.1", "cospfShamLinksRetransInterval": "example-string", "cospfShamLinksHelloInterval": "example-string", "cospfShamLinksRtrDeadInterval": "example-string", "cospfShamLinksState": "up(1)", "cospfShamLinksEvents": 0, "cospfShamLinksMetric": "example-string" }, { "cospfShamLinksAreaId": "example-string", "cospfShamLinksLocalIpAddrType": "192.168.1.1", "cospfShamLinksLocalIpAddr": "192.168.1.1", "cospfShamLinksRemoteIpAddrType": "192.168.1.1", "cospfShamLinksRemoteIpAddr": "192.168.1.1", "cospfShamLinksRetransInterval": "example-string", "cospfShamLinksHelloInterval": "example-string", "cospfShamLinksRtrDeadInterval": "example-string", "cospfShamLinksState": "up(1)", "cospfShamLinksEvents": 0, "cospfShamLinksMetric": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cospfShamLinksTable", "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": "/cospfShamLinksTable", "x-restconf-kind": "container" }, "/data/CISCO-OSPF-MIB:cospfShamLinksTable/cospfShamLinksEntry": { "get": { "summary": "Get cospfShamLinksEntry list", "description": "Retrieve list of cospfShamLinksEntry entries from MIB", "tags": [ "CISCO-OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about a single sham link.", "items": { "type": "object", "properties": { "cospfShamLinksAreaId": { "type": "string", "description": "The area that this sham link is part of.", "x-yang-type": "ospf-mib:AreaID" }, "cospfShamLinksLocalIpAddrType": { "type": "string", "description": "The type of internet address of this sham link's local IP\n address.", "x-yang-type": "inet-address:InetAddressType" }, "cospfShamLinksLocalIpAddr": { "type": "string", "description": "The Local IP address of the sham link.", "x-yang-type": "inet-address:InetAddress" }, "cospfShamLinksRemoteIpAddrType": { "type": "string", "description": "The type of internet address of this sham link's remote IP\n address.", "x-yang-type": "inet-address:InetAddressType" }, "cospfShamLinksRemoteIpAddr": { "type": "string", "description": "The IP address of the other end router of the sham link.", "x-yang-type": "inet-address:InetAddress" }, "cospfShamLinksRetransInterval": { "type": "string", "description": "The number of seconds between link-state advertisement\n retransmissions, for adjacencies belonging to this link.\n This value is also used when retransmitting database \n description and link-state request packets. This value\n should be well over the expected round trip time.", "x-yang-type": "ospf-mib:UpToMaxAge" }, "cospfShamLinksHelloInterval": { "type": "string", "description": "The length of time, in seconds, between the\n Hello packets that the router sends on the sham\n link.", "x-yang-type": "ospf-mib:HelloRange" }, "cospfShamLinksRtrDeadInterval": { "type": "string", "description": "The number of seconds that a router's Hello\n packets have not been seen before it's neighbors\n declare the router down. This should be\n some multiple of the Hello interval.", "x-yang-type": "ospf-mib:PositiveInteger" }, "cospfShamLinksState": { "type": "string", "description": "OSPF sham link states." }, "cospfShamLinksEvents": { "type": "integer", "description": "The number of state changes or error events on\n this sham link", "minimum": 0, "maximum": 4294967295 }, "cospfShamLinksMetric": { "type": "string", "description": "The Metric to be advertised.", "x-yang-type": "ospf-mib:Metric" } } } }, "example": { "CISCO-OSPF-MIB:cospfShamLinksEntry": [ { "cospfShamLinksAreaId": "example-string", "cospfShamLinksLocalIpAddrType": "192.168.1.1", "cospfShamLinksLocalIpAddr": "192.168.1.1", "cospfShamLinksRemoteIpAddrType": "192.168.1.1", "cospfShamLinksRemoteIpAddr": "192.168.1.1", "cospfShamLinksRetransInterval": "example-string", "cospfShamLinksHelloInterval": "example-string", "cospfShamLinksRtrDeadInterval": "example-string", "cospfShamLinksState": "up(1)", "cospfShamLinksEvents": 0, "cospfShamLinksMetric": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cospfShamLinksEntry", "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": "/cospfShamLinksTable/cospfShamLinksEntry", "x-restconf-kind": "container" }, "/data/CISCO-OSPF-MIB:cospfLsdbEntry": { "get": { "summary": "Get cospfLsdbEntry list", "description": "Retrieve list of cospfLsdbEntry entries from MIB", "tags": [ "CISCO-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": "ospfLsdbAreaId", "x-yang-type": "leafref" }, "ospfLsdbLsid": { "type": "string", "description": "ospfLsdbLsid", "x-yang-type": "leafref" }, "ospfLsdbRouterId": { "type": "string", "description": "ospfLsdbRouterId", "x-yang-type": "leafref" }, "cospfLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement format." }, "cospfLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It is used to detect old and duplicate\n link state advertisements. The space of\n sequence numbers is linearly ordered. The\n larger the sequence number the more recent the\n advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfLsdbAge": { "type": "integer", "description": "This field is the age of the link state advertisement in\n seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfLsdbChecksum": { "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 connectionless\n datagrams; it is commonly referred to\n as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfLsdbAdvertisement": { "type": "string", "description": "The entire Link State Advertisement, including\n its header.", "format": "binary" } } } }, "example": { "CISCO-OSPF-MIB:cospfLsdbEntry": [ { "ospfLsdbAreaId": "example-string", "ospfLsdbLsid": "example-string", "ospfLsdbRouterId": "example-string", "cospfLsdbType": "ethernetCsmacd(6)", "cospfLsdbSequence": -2147483648, "cospfLsdbAge": -2147483648, "cospfLsdbChecksum": -2147483648, "cospfLsdbAdvertisement": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cospfLsdbEntry-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": "/cospfLsdbEntry", "x-restconf-kind": "container" }, "/data/CISCO-OSPF-MIB:cospfShamLinkEntry": { "get": { "summary": "Get cospfShamLinkEntry list", "description": "Retrieve list of cospfShamLinkEntry entries from MIB", "tags": [ "CISCO-OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about a single sham link", "items": { "type": "object", "properties": { "cospfShamLinkAreaId": { "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" }, "cospfShamLinkLocalIpAddress": { "type": "string", "description": "The Local IP address of the sham link.", "format": "inet:ipv4-address" }, "cospfShamLinkNeighborId": { "type": "string", "description": "The Router ID of the other end router of the sham\n link.", "x-yang-type": "ospf-mib:RouterID" }, "cospfShamLinkRetransInterval": { "type": "string", "description": "The number of seconds between link-state advertisement\n retransmissions, for adjacencies\n belonging to this link. This value is also\n used when retransmitting database description \n and link-state request packets. This value \n should be well over the expected round trip\n time.", "x-yang-type": "ospf-mib:UpToMaxAge" }, "cospfShamLinkHelloInterval": { "type": "string", "description": "The length of time, in seconds, between the\n Hello packets that the router sends on the sham\n link.", "x-yang-type": "ospf-mib:HelloRange" }, "cospfShamLinkRtrDeadInterval": { "type": "string", "description": "The number of seconds that a router's Hello\n packets have not been seen before it's neighbors\n declare the router down. This should be\n some multiple of the Hello interval.", "x-yang-type": "ospf-mib:PositiveInteger" }, "cospfShamLinkState": { "type": "string", "description": "OSPF sham link states." }, "cospfShamLinkEvents": { "type": "integer", "description": "The number of state changes or error events on\n this sham link", "minimum": 0, "maximum": 4294967295 }, "cospfShamLinkMetric": { "type": "string", "description": "The Metric to be advertised.", "x-yang-type": "ospf-mib:Metric" } } } }, "example": { "CISCO-OSPF-MIB:cospfShamLinkEntry": [ { "cospfShamLinkAreaId": "example-string", "cospfShamLinkLocalIpAddress": "192.168.1.1", "cospfShamLinkNeighborId": "example-string", "cospfShamLinkRetransInterval": "example-string", "cospfShamLinkHelloInterval": "example-string", "cospfShamLinkRtrDeadInterval": "example-string", "cospfShamLinkState": "up(1)", "cospfShamLinkEvents": 0, "cospfShamLinkMetric": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cospfShamLinkEntry-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": "/cospfShamLinkEntry", "x-restconf-kind": "container" }, "/data/CISCO-OSPF-MIB:cospfLocalLsdbEntry": { "get": { "summary": "Get cospfLocalLsdbEntry list", "description": "Retrieve list of cospfLocalLsdbEntry entries from MIB", "tags": [ "CISCO-OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A single Link State Advertisement.", "items": { "type": "object", "properties": { "cospfLocalLsdbIpAddress": { "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" }, "cospfLocalLsdbAddressLessIf": { "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" }, "cospfLocalLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement format." }, "cospfLocalLsdbLsid": { "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" }, "cospfLocalLsdbRouterId": { "type": "string", "description": "The 32 bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "ospf-mib:RouterID" }, "cospfLocalLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It is used to detect old and duplicate link\n state advertisements. The space of\n sequence numbers is linearly ordered. The\n larger the sequence number the more recent the\n advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfLocalLsdbAge": { "type": "integer", "description": "This field is the age of the link state advertisement \n in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfLocalLsdbChecksum": { "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 connectionless\n datagrams; it is commonly referred to\n as the Fletcher checksum.", "minimum": 0, "maximum": 4294967295 }, "cospfLocalLsdbAdvertisement": { "type": "string", "description": "The entire Link State Advertisement, including\n its header.", "format": "binary" } } } }, "example": { "CISCO-OSPF-MIB:cospfLocalLsdbEntry": [ { "cospfLocalLsdbIpAddress": "192.168.1.1", "cospfLocalLsdbAddressLessIf": "192.168.1.1", "cospfLocalLsdbType": "ethernetCsmacd(6)", "cospfLocalLsdbLsid": "example-string", "cospfLocalLsdbRouterId": "example-string", "cospfLocalLsdbSequence": -2147483648, "cospfLocalLsdbAge": -2147483648, "cospfLocalLsdbChecksum": 0, "cospfLocalLsdbAdvertisement": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cospfLocalLsdbEntry-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": "/cospfLocalLsdbEntry", "x-restconf-kind": "container" }, "/data/CISCO-OSPF-MIB:cospfVirtLocalLsdbEntry": { "get": { "summary": "Get cospfVirtLocalLsdbEntry list", "description": "Retrieve list of cospfVirtLocalLsdbEntry entries from MIB", "tags": [ "CISCO-OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A single Link State Advertisement.", "items": { "type": "object", "properties": { "cospfVirtLocalLsdbTransitArea": { "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" }, "cospfVirtLocalLsdbNeighbor": { "type": "string", "description": "The Router ID of the Virtual Neighbor.", "x-yang-type": "ospf-mib:RouterID" }, "cospfVirtLocalLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement format." }, "cospfVirtLocalLsdbLsid": { "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" }, "cospfVirtLocalLsdbRouterId": { "type": "string", "description": "The 32 bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "ospf-mib:RouterID" }, "cospfVirtLocalLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It is used to detect old and duplicate\n link state advertisements. The space of\n sequence numbers is linearly ordered. The\n larger the sequence number the more recent the\n advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfVirtLocalLsdbAge": { "type": "integer", "description": "This field is the age of the link state advertisement\n in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfVirtLocalLsdbChecksum": { "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 connectionless\n datagrams; it is commonly referred to\n as the Fletcher checksum.", "minimum": 0, "maximum": 4294967295 }, "cospfVirtLocalLsdbAdvertisement": { "type": "string", "description": "The entire Link State Advertisement, including\n its header.", "format": "binary" } } } }, "example": { "CISCO-OSPF-MIB:cospfVirtLocalLsdbEntry": [ { "cospfVirtLocalLsdbTransitArea": "example-string", "cospfVirtLocalLsdbNeighbor": "example-string", "cospfVirtLocalLsdbType": "ethernetCsmacd(6)", "cospfVirtLocalLsdbLsid": "example-string", "cospfVirtLocalLsdbRouterId": "example-string", "cospfVirtLocalLsdbSequence": -2147483648, "cospfVirtLocalLsdbAge": -2147483648, "cospfVirtLocalLsdbChecksum": 0, "cospfVirtLocalLsdbAdvertisement": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cospfVirtLocalLsdbEntry-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": "/cospfVirtLocalLsdbEntry", "x-restconf-kind": "container" }, "/data/CISCO-OSPF-MIB:cospfShamLinkNbrEntry": { "get": { "summary": "Get cospfShamLinkNbrEntry list", "description": "Retrieve list of cospfShamLinkNbrEntry entries from MIB", "tags": [ "CISCO-OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Sham link neighbor information.", "items": { "type": "object", "properties": { "cospfShamLinksLocalIpAddrType": { "type": "string", "description": "cospfShamLinksLocalIpAddrType", "x-yang-type": "leafref" }, "cospfShamLinksLocalIpAddr": { "type": "string", "description": "cospfShamLinksLocalIpAddr", "x-yang-type": "leafref" }, "cospfShamLinkNbrArea": { "type": "string", "description": "The area to which the sham link is part of.", "x-yang-type": "ospf-mib:AreaID" }, "cospfShamLinkNbrIpAddrType": { "type": "string", "description": "The type of internet address of this sham link neighbor's\n IP address.", "x-yang-type": "inet-address:InetAddressType" }, "cospfShamLinkNbrIpAddr": { "type": "string", "description": "The IP address this sham link neighbor is using.", "x-yang-type": "inet-address:InetAddress" }, "cospfShamLinkNbrRtrId": { "type": "string", "description": "A 32-bit integer uniquely identifying the neighboring\n router.", "x-yang-type": "ospf-mib:RouterID" }, "cospfShamLinkNbrOptions": { "type": "integer", "description": "A Bit Mask corresponding to the neighbor's options\n 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; ie, that it implements \n OSPF Multicast Routing.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfShamLinkNbrState": { "type": "string", "description": "The state of this sham link neighbor relation-\n ship." }, "cospfShamLinkNbrEvents": { "type": "integer", "description": "The number of times this sham link has changed\n state or an error has occurred.", "minimum": 0, "maximum": 4294967295 }, "cospfShamLinkNbrLsRetransQLen": { "type": "integer", "description": "The current length of the retransmission\n queue. The retransmission queue is maintained for\n LSAs that have been flooded but not acknowledged\n on this adjacency.", "minimum": 0, "maximum": 4294967295 }, "cospfShamLinkNbrHelloSuppressed": { "type": "boolean", "description": "Indicates whether Hellos are being suppressed\n to the neighbor." } } } }, "example": { "CISCO-OSPF-MIB:cospfShamLinkNbrEntry": [ { "cospfShamLinksLocalIpAddrType": "192.168.1.1", "cospfShamLinksLocalIpAddr": "192.168.1.1", "cospfShamLinkNbrArea": "example-string", "cospfShamLinkNbrIpAddrType": "192.168.1.1", "cospfShamLinkNbrIpAddr": "192.168.1.1", "cospfShamLinkNbrRtrId": "example-string", "cospfShamLinkNbrOptions": -2147483648, "cospfShamLinkNbrState": "up(1)", "cospfShamLinkNbrEvents": 0, "cospfShamLinkNbrLsRetransQLen": 0, "cospfShamLinkNbrHelloSuppressed": true } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cospfShamLinkNbrEntry-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": "/cospfShamLinkNbrEntry", "x-restconf-kind": "container" }, "/data/CISCO-OSPF-MIB:cospfShamLinksEntry": { "get": { "summary": "Get cospfShamLinksEntry list", "description": "Retrieve list of cospfShamLinksEntry entries from MIB", "tags": [ "CISCO-OSPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about a single sham link.", "items": { "type": "object", "properties": { "cospfShamLinksAreaId": { "type": "string", "description": "The area that this sham link is part of.", "x-yang-type": "ospf-mib:AreaID" }, "cospfShamLinksLocalIpAddrType": { "type": "string", "description": "The type of internet address of this sham link's local IP\n address.", "x-yang-type": "inet-address:InetAddressType" }, "cospfShamLinksLocalIpAddr": { "type": "string", "description": "The Local IP address of the sham link.", "x-yang-type": "inet-address:InetAddress" }, "cospfShamLinksRemoteIpAddrType": { "type": "string", "description": "The type of internet address of this sham link's remote IP\n address.", "x-yang-type": "inet-address:InetAddressType" }, "cospfShamLinksRemoteIpAddr": { "type": "string", "description": "The IP address of the other end router of the sham link.", "x-yang-type": "inet-address:InetAddress" }, "cospfShamLinksRetransInterval": { "type": "string", "description": "The number of seconds between link-state advertisement\n retransmissions, for adjacencies belonging to this link.\n This value is also used when retransmitting database \n description and link-state request packets. This value\n should be well over the expected round trip time.", "x-yang-type": "ospf-mib:UpToMaxAge" }, "cospfShamLinksHelloInterval": { "type": "string", "description": "The length of time, in seconds, between the\n Hello packets that the router sends on the sham\n link.", "x-yang-type": "ospf-mib:HelloRange" }, "cospfShamLinksRtrDeadInterval": { "type": "string", "description": "The number of seconds that a router's Hello\n packets have not been seen before it's neighbors\n declare the router down. This should be\n some multiple of the Hello interval.", "x-yang-type": "ospf-mib:PositiveInteger" }, "cospfShamLinksState": { "type": "string", "description": "OSPF sham link states." }, "cospfShamLinksEvents": { "type": "integer", "description": "The number of state changes or error events on\n this sham link", "minimum": 0, "maximum": 4294967295 }, "cospfShamLinksMetric": { "type": "string", "description": "The Metric to be advertised.", "x-yang-type": "ospf-mib:Metric" } } } }, "example": { "CISCO-OSPF-MIB:cospfShamLinksEntry": [ { "cospfShamLinksAreaId": "example-string", "cospfShamLinksLocalIpAddrType": "192.168.1.1", "cospfShamLinksLocalIpAddr": "192.168.1.1", "cospfShamLinksRemoteIpAddrType": "192.168.1.1", "cospfShamLinksRemoteIpAddr": "192.168.1.1", "cospfShamLinksRetransInterval": "example-string", "cospfShamLinksHelloInterval": "example-string", "cospfShamLinksRtrDeadInterval": "example-string", "cospfShamLinksState": "up(1)", "cospfShamLinksEvents": 0, "cospfShamLinksMetric": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cospfShamLinksEntry-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": "/cospfShamLinksEntry", "x-restconf-kind": "container" }, "/data/CISCO-OSPF-MIB:cospfLsdbTable/cospfLsdbEntry={ospfLsdbAreaId},{cospfLsdbType},{ospfLsdbLsid},{ospfLsdbRouterId}": { "get": { "summary": "Get cospfLsdbEntry entry", "description": "Retrieve specific cospfLsdbEntry entry by key from MIB", "tags": [ "CISCO-OSPF-MIB" ], "parameters": [ { "name": "ospfLsdbAreaId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfLsdbType", "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": "ospfLsdbAreaId", "x-yang-type": "leafref" }, "ospfLsdbLsid": { "type": "string", "description": "ospfLsdbLsid", "x-yang-type": "leafref" }, "ospfLsdbRouterId": { "type": "string", "description": "ospfLsdbRouterId", "x-yang-type": "leafref" }, "cospfLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement format." }, "cospfLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It is used to detect old and duplicate\n link state advertisements. The space of\n sequence numbers is linearly ordered. The\n larger the sequence number the more recent the\n advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfLsdbAge": { "type": "integer", "description": "This field is the age of the link state advertisement in\n seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfLsdbChecksum": { "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 connectionless\n datagrams; it is commonly referred to\n as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfLsdbAdvertisement": { "type": "string", "description": "The entire Link State Advertisement, including\n its header.", "format": "binary" } } }, "example": { "CISCO-OSPF-MIB:cospfLsdbEntry": { "ospfLsdbAreaId": "example-string", "ospfLsdbLsid": "example-string", "ospfLsdbRouterId": "example-string", "cospfLsdbType": "ethernetCsmacd(6)", "cospfLsdbSequence": -2147483648, "cospfLsdbAge": -2147483648, "cospfLsdbChecksum": -2147483648, "cospfLsdbAdvertisement": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cospfLsdbEntry-2" }, "x-yang-path": "/cospfLsdbTable/cospfLsdbEntry={ospfLsdbAreaId cospfLsdbType ospfLsdbLsid ospfLsdbRouterId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfLsdbAreaId cospfLsdbType ospfLsdbLsid ospfLsdbRouterId" ] }, "/data/CISCO-OSPF-MIB:cospfShamLinkTable/cospfShamLinkEntry={cospfShamLinkAreaId},{cospfShamLinkLocalIpAddress},{cospfShamLinkNeighborId}": { "get": { "summary": "Get cospfShamLinkEntry entry", "description": "Retrieve specific cospfShamLinkEntry entry by key from MIB", "tags": [ "CISCO-OSPF-MIB" ], "parameters": [ { "name": "cospfShamLinkAreaId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfShamLinkLocalIpAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfShamLinkNeighborId", "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": { "cospfShamLinkAreaId": { "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" }, "cospfShamLinkLocalIpAddress": { "type": "string", "description": "The Local IP address of the sham link.", "format": "inet:ipv4-address" }, "cospfShamLinkNeighborId": { "type": "string", "description": "The Router ID of the other end router of the sham\n link.", "x-yang-type": "ospf-mib:RouterID" }, "cospfShamLinkRetransInterval": { "type": "string", "description": "The number of seconds between link-state advertisement\n retransmissions, for adjacencies\n belonging to this link. This value is also\n used when retransmitting database description \n and link-state request packets. This value \n should be well over the expected round trip\n time.", "x-yang-type": "ospf-mib:UpToMaxAge" }, "cospfShamLinkHelloInterval": { "type": "string", "description": "The length of time, in seconds, between the\n Hello packets that the router sends on the sham\n link.", "x-yang-type": "ospf-mib:HelloRange" }, "cospfShamLinkRtrDeadInterval": { "type": "string", "description": "The number of seconds that a router's Hello\n packets have not been seen before it's neighbors\n declare the router down. This should be\n some multiple of the Hello interval.", "x-yang-type": "ospf-mib:PositiveInteger" }, "cospfShamLinkState": { "type": "string", "description": "OSPF sham link states." }, "cospfShamLinkEvents": { "type": "integer", "description": "The number of state changes or error events on\n this sham link", "minimum": 0, "maximum": 4294967295 }, "cospfShamLinkMetric": { "type": "string", "description": "The Metric to be advertised.", "x-yang-type": "ospf-mib:Metric" } } }, "example": { "CISCO-OSPF-MIB:cospfShamLinkEntry": { "cospfShamLinkAreaId": "example-string", "cospfShamLinkLocalIpAddress": "192.168.1.1", "cospfShamLinkNeighborId": "example-string", "cospfShamLinkRetransInterval": "example-string", "cospfShamLinkHelloInterval": "example-string", "cospfShamLinkRtrDeadInterval": "example-string", "cospfShamLinkState": "up(1)", "cospfShamLinkEvents": 0, "cospfShamLinkMetric": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cospfShamLinkEntry-2" }, "x-yang-path": "/cospfShamLinkTable/cospfShamLinkEntry={cospfShamLinkAreaId cospfShamLinkLocalIpAddress cospfShamLinkNeighborId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cospfShamLinkAreaId cospfShamLinkLocalIpAddress cospfShamLinkNeighborId" ] }, "/data/CISCO-OSPF-MIB:cospfLocalLsdbTable/cospfLocalLsdbEntry={cospfLocalLsdbIpAddress},{cospfLocalLsdbAddressLessIf},{cospfLocalLsdbType},{cospfLocalLsdbLsid},{cospfLocalLsdbRouterId}": { "get": { "summary": "Get cospfLocalLsdbEntry entry", "description": "Retrieve specific cospfLocalLsdbEntry entry by key from MIB", "tags": [ "CISCO-OSPF-MIB" ], "parameters": [ { "name": "cospfLocalLsdbIpAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfLocalLsdbAddressLessIf", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfLocalLsdbType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfLocalLsdbLsid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfLocalLsdbRouterId", "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": { "cospfLocalLsdbIpAddress": { "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" }, "cospfLocalLsdbAddressLessIf": { "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" }, "cospfLocalLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement format." }, "cospfLocalLsdbLsid": { "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" }, "cospfLocalLsdbRouterId": { "type": "string", "description": "The 32 bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "ospf-mib:RouterID" }, "cospfLocalLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It is used to detect old and duplicate link\n state advertisements. The space of\n sequence numbers is linearly ordered. The\n larger the sequence number the more recent the\n advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfLocalLsdbAge": { "type": "integer", "description": "This field is the age of the link state advertisement \n in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfLocalLsdbChecksum": { "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 connectionless\n datagrams; it is commonly referred to\n as the Fletcher checksum.", "minimum": 0, "maximum": 4294967295 }, "cospfLocalLsdbAdvertisement": { "type": "string", "description": "The entire Link State Advertisement, including\n its header.", "format": "binary" } } }, "example": { "CISCO-OSPF-MIB:cospfLocalLsdbEntry": { "cospfLocalLsdbIpAddress": "192.168.1.1", "cospfLocalLsdbAddressLessIf": "192.168.1.1", "cospfLocalLsdbType": "ethernetCsmacd(6)", "cospfLocalLsdbLsid": "example-string", "cospfLocalLsdbRouterId": "example-string", "cospfLocalLsdbSequence": -2147483648, "cospfLocalLsdbAge": -2147483648, "cospfLocalLsdbChecksum": 0, "cospfLocalLsdbAdvertisement": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cospfLocalLsdbEntry-2" }, "x-yang-path": "/cospfLocalLsdbTable/cospfLocalLsdbEntry={cospfLocalLsdbIpAddress cospfLocalLsdbAddressLessIf cospfLocalLsdbType cospfLocalLsdbLsid cospfLocalLsdbRouterId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cospfLocalLsdbIpAddress cospfLocalLsdbAddressLessIf cospfLocalLsdbType cospfLocalLsdbLsid cospfLocalLsdbRouterId" ] }, "/data/CISCO-OSPF-MIB:cospfVirtLocalLsdbTable/cospfVirtLocalLsdbEntry={cospfVirtLocalLsdbTransitArea},{cospfVirtLocalLsdbNeighbor},{cospfVirtLocalLsdbType},{cospfVirtLocalLsdbLsid},{cospfVirtLocalLsdbRouterId}": { "get": { "summary": "Get cospfVirtLocalLsdbEntry entry", "description": "Retrieve specific cospfVirtLocalLsdbEntry entry by key from MIB", "tags": [ "CISCO-OSPF-MIB" ], "parameters": [ { "name": "cospfVirtLocalLsdbTransitArea", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfVirtLocalLsdbNeighbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfVirtLocalLsdbType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfVirtLocalLsdbLsid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfVirtLocalLsdbRouterId", "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": { "cospfVirtLocalLsdbTransitArea": { "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" }, "cospfVirtLocalLsdbNeighbor": { "type": "string", "description": "The Router ID of the Virtual Neighbor.", "x-yang-type": "ospf-mib:RouterID" }, "cospfVirtLocalLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement format." }, "cospfVirtLocalLsdbLsid": { "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" }, "cospfVirtLocalLsdbRouterId": { "type": "string", "description": "The 32 bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "ospf-mib:RouterID" }, "cospfVirtLocalLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It is used to detect old and duplicate\n link state advertisements. The space of\n sequence numbers is linearly ordered. The\n larger the sequence number the more recent the\n advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfVirtLocalLsdbAge": { "type": "integer", "description": "This field is the age of the link state advertisement\n in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfVirtLocalLsdbChecksum": { "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 connectionless\n datagrams; it is commonly referred to\n as the Fletcher checksum.", "minimum": 0, "maximum": 4294967295 }, "cospfVirtLocalLsdbAdvertisement": { "type": "string", "description": "The entire Link State Advertisement, including\n its header.", "format": "binary" } } }, "example": { "CISCO-OSPF-MIB:cospfVirtLocalLsdbEntry": { "cospfVirtLocalLsdbTransitArea": "example-string", "cospfVirtLocalLsdbNeighbor": "example-string", "cospfVirtLocalLsdbType": "ethernetCsmacd(6)", "cospfVirtLocalLsdbLsid": "example-string", "cospfVirtLocalLsdbRouterId": "example-string", "cospfVirtLocalLsdbSequence": -2147483648, "cospfVirtLocalLsdbAge": -2147483648, "cospfVirtLocalLsdbChecksum": 0, "cospfVirtLocalLsdbAdvertisement": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cospfVirtLocalLsdbEntry-2" }, "x-yang-path": "/cospfVirtLocalLsdbTable/cospfVirtLocalLsdbEntry={cospfVirtLocalLsdbTransitArea cospfVirtLocalLsdbNeighbor cospfVirtLocalLsdbType cospfVirtLocalLsdbLsid cospfVirtLocalLsdbRouterId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cospfVirtLocalLsdbTransitArea cospfVirtLocalLsdbNeighbor cospfVirtLocalLsdbType cospfVirtLocalLsdbLsid cospfVirtLocalLsdbRouterId" ] }, "/data/CISCO-OSPF-MIB:cospfShamLinkNbrTable/cospfShamLinkNbrEntry={cospfShamLinksLocalIpAddrType},{cospfShamLinksLocalIpAddr},{cospfShamLinkNbrArea},{cospfShamLinkNbrIpAddrType},{cospfShamLinkNbrIpAddr}": { "get": { "summary": "Get cospfShamLinkNbrEntry entry", "description": "Retrieve specific cospfShamLinkNbrEntry entry by key from MIB", "tags": [ "CISCO-OSPF-MIB" ], "parameters": [ { "name": "cospfShamLinksLocalIpAddrType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfShamLinksLocalIpAddr", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfShamLinkNbrArea", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfShamLinkNbrIpAddrType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfShamLinkNbrIpAddr", "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": { "cospfShamLinksLocalIpAddrType": { "type": "string", "description": "cospfShamLinksLocalIpAddrType", "x-yang-type": "leafref" }, "cospfShamLinksLocalIpAddr": { "type": "string", "description": "cospfShamLinksLocalIpAddr", "x-yang-type": "leafref" }, "cospfShamLinkNbrArea": { "type": "string", "description": "The area to which the sham link is part of.", "x-yang-type": "ospf-mib:AreaID" }, "cospfShamLinkNbrIpAddrType": { "type": "string", "description": "The type of internet address of this sham link neighbor's\n IP address.", "x-yang-type": "inet-address:InetAddressType" }, "cospfShamLinkNbrIpAddr": { "type": "string", "description": "The IP address this sham link neighbor is using.", "x-yang-type": "inet-address:InetAddress" }, "cospfShamLinkNbrRtrId": { "type": "string", "description": "A 32-bit integer uniquely identifying the neighboring\n router.", "x-yang-type": "ospf-mib:RouterID" }, "cospfShamLinkNbrOptions": { "type": "integer", "description": "A Bit Mask corresponding to the neighbor's options\n 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; ie, that it implements \n OSPF Multicast Routing.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfShamLinkNbrState": { "type": "string", "description": "The state of this sham link neighbor relation-\n ship." }, "cospfShamLinkNbrEvents": { "type": "integer", "description": "The number of times this sham link has changed\n state or an error has occurred.", "minimum": 0, "maximum": 4294967295 }, "cospfShamLinkNbrLsRetransQLen": { "type": "integer", "description": "The current length of the retransmission\n queue. The retransmission queue is maintained for\n LSAs that have been flooded but not acknowledged\n on this adjacency.", "minimum": 0, "maximum": 4294967295 }, "cospfShamLinkNbrHelloSuppressed": { "type": "boolean", "description": "Indicates whether Hellos are being suppressed\n to the neighbor." } } }, "example": { "CISCO-OSPF-MIB:cospfShamLinkNbrEntry": { "cospfShamLinksLocalIpAddrType": "192.168.1.1", "cospfShamLinksLocalIpAddr": "192.168.1.1", "cospfShamLinkNbrArea": "example-string", "cospfShamLinkNbrIpAddrType": "192.168.1.1", "cospfShamLinkNbrIpAddr": "192.168.1.1", "cospfShamLinkNbrRtrId": "example-string", "cospfShamLinkNbrOptions": -2147483648, "cospfShamLinkNbrState": "up(1)", "cospfShamLinkNbrEvents": 0, "cospfShamLinkNbrLsRetransQLen": 0, "cospfShamLinkNbrHelloSuppressed": true } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cospfShamLinkNbrEntry-2" }, "x-yang-path": "/cospfShamLinkNbrTable/cospfShamLinkNbrEntry={cospfShamLinksLocalIpAddrType cospfShamLinksLocalIpAddr cospfShamLinkNbrArea cospfShamLinkNbrIpAddrType cospfShamLinkNbrIpAddr}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cospfShamLinksLocalIpAddrType cospfShamLinksLocalIpAddr cospfShamLinkNbrArea cospfShamLinkNbrIpAddrType cospfShamLinkNbrIpAddr" ] }, "/data/CISCO-OSPF-MIB:cospfShamLinksTable/cospfShamLinksEntry={cospfShamLinksAreaId},{cospfShamLinksLocalIpAddrType},{cospfShamLinksLocalIpAddr},{cospfShamLinksRemoteIpAddrType},{cospfShamLinksRemoteIpAddr}": { "get": { "summary": "Get cospfShamLinksEntry entry", "description": "Retrieve specific cospfShamLinksEntry entry by key from MIB", "tags": [ "CISCO-OSPF-MIB" ], "parameters": [ { "name": "cospfShamLinksAreaId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfShamLinksLocalIpAddrType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfShamLinksLocalIpAddr", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfShamLinksRemoteIpAddrType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfShamLinksRemoteIpAddr", "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": { "cospfShamLinksAreaId": { "type": "string", "description": "The area that this sham link is part of.", "x-yang-type": "ospf-mib:AreaID" }, "cospfShamLinksLocalIpAddrType": { "type": "string", "description": "The type of internet address of this sham link's local IP\n address.", "x-yang-type": "inet-address:InetAddressType" }, "cospfShamLinksLocalIpAddr": { "type": "string", "description": "The Local IP address of the sham link.", "x-yang-type": "inet-address:InetAddress" }, "cospfShamLinksRemoteIpAddrType": { "type": "string", "description": "The type of internet address of this sham link's remote IP\n address.", "x-yang-type": "inet-address:InetAddressType" }, "cospfShamLinksRemoteIpAddr": { "type": "string", "description": "The IP address of the other end router of the sham link.", "x-yang-type": "inet-address:InetAddress" }, "cospfShamLinksRetransInterval": { "type": "string", "description": "The number of seconds between link-state advertisement\n retransmissions, for adjacencies belonging to this link.\n This value is also used when retransmitting database \n description and link-state request packets. This value\n should be well over the expected round trip time.", "x-yang-type": "ospf-mib:UpToMaxAge" }, "cospfShamLinksHelloInterval": { "type": "string", "description": "The length of time, in seconds, between the\n Hello packets that the router sends on the sham\n link.", "x-yang-type": "ospf-mib:HelloRange" }, "cospfShamLinksRtrDeadInterval": { "type": "string", "description": "The number of seconds that a router's Hello\n packets have not been seen before it's neighbors\n declare the router down. This should be\n some multiple of the Hello interval.", "x-yang-type": "ospf-mib:PositiveInteger" }, "cospfShamLinksState": { "type": "string", "description": "OSPF sham link states." }, "cospfShamLinksEvents": { "type": "integer", "description": "The number of state changes or error events on\n this sham link", "minimum": 0, "maximum": 4294967295 }, "cospfShamLinksMetric": { "type": "string", "description": "The Metric to be advertised.", "x-yang-type": "ospf-mib:Metric" } } }, "example": { "CISCO-OSPF-MIB:cospfShamLinksEntry": { "cospfShamLinksAreaId": "example-string", "cospfShamLinksLocalIpAddrType": "192.168.1.1", "cospfShamLinksLocalIpAddr": "192.168.1.1", "cospfShamLinksRemoteIpAddrType": "192.168.1.1", "cospfShamLinksRemoteIpAddr": "192.168.1.1", "cospfShamLinksRetransInterval": "example-string", "cospfShamLinksHelloInterval": "example-string", "cospfShamLinksRtrDeadInterval": "example-string", "cospfShamLinksState": "up(1)", "cospfShamLinksEvents": 0, "cospfShamLinksMetric": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cospfShamLinksEntry-2" }, "x-yang-path": "/cospfShamLinksTable/cospfShamLinksEntry={cospfShamLinksAreaId cospfShamLinksLocalIpAddrType cospfShamLinksLocalIpAddr cospfShamLinksRemoteIpAddrType cospfShamLinksRemoteIpAddr}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cospfShamLinksAreaId cospfShamLinksLocalIpAddrType cospfShamLinksLocalIpAddr cospfShamLinksRemoteIpAddrType cospfShamLinksRemoteIpAddr" ] }, "/data/CISCO-OSPF-MIB:cospfLsdbEntry={ospfLsdbAreaId},{cospfLsdbType},{ospfLsdbLsid},{ospfLsdbRouterId}": { "get": { "summary": "Get cospfLsdbEntry entry", "description": "Retrieve specific cospfLsdbEntry entry by key from MIB", "tags": [ "CISCO-OSPF-MIB" ], "parameters": [ { "name": "ospfLsdbAreaId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfLsdbType", "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": "ospfLsdbAreaId", "x-yang-type": "leafref" }, "ospfLsdbLsid": { "type": "string", "description": "ospfLsdbLsid", "x-yang-type": "leafref" }, "ospfLsdbRouterId": { "type": "string", "description": "ospfLsdbRouterId", "x-yang-type": "leafref" }, "cospfLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement format." }, "cospfLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It is used to detect old and duplicate\n link state advertisements. The space of\n sequence numbers is linearly ordered. The\n larger the sequence number the more recent the\n advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfLsdbAge": { "type": "integer", "description": "This field is the age of the link state advertisement in\n seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfLsdbChecksum": { "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 connectionless\n datagrams; it is commonly referred to\n as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfLsdbAdvertisement": { "type": "string", "description": "The entire Link State Advertisement, including\n its header.", "format": "binary" } } }, "example": { "CISCO-OSPF-MIB:cospfLsdbEntry": { "ospfLsdbAreaId": "example-string", "ospfLsdbLsid": "example-string", "ospfLsdbRouterId": "example-string", "cospfLsdbType": "ethernetCsmacd(6)", "cospfLsdbSequence": -2147483648, "cospfLsdbAge": -2147483648, "cospfLsdbChecksum": -2147483648, "cospfLsdbAdvertisement": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cospfLsdbEntry-4" }, "x-yang-path": "/cospfLsdbEntry={ospfLsdbAreaId cospfLsdbType ospfLsdbLsid ospfLsdbRouterId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ospfLsdbAreaId cospfLsdbType ospfLsdbLsid ospfLsdbRouterId" ] }, "/data/CISCO-OSPF-MIB:cospfShamLinkEntry={cospfShamLinkAreaId},{cospfShamLinkLocalIpAddress},{cospfShamLinkNeighborId}": { "get": { "summary": "Get cospfShamLinkEntry entry", "description": "Retrieve specific cospfShamLinkEntry entry by key from MIB", "tags": [ "CISCO-OSPF-MIB" ], "parameters": [ { "name": "cospfShamLinkAreaId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfShamLinkLocalIpAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfShamLinkNeighborId", "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": { "cospfShamLinkAreaId": { "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" }, "cospfShamLinkLocalIpAddress": { "type": "string", "description": "The Local IP address of the sham link.", "format": "inet:ipv4-address" }, "cospfShamLinkNeighborId": { "type": "string", "description": "The Router ID of the other end router of the sham\n link.", "x-yang-type": "ospf-mib:RouterID" }, "cospfShamLinkRetransInterval": { "type": "string", "description": "The number of seconds between link-state advertisement\n retransmissions, for adjacencies\n belonging to this link. This value is also\n used when retransmitting database description \n and link-state request packets. This value \n should be well over the expected round trip\n time.", "x-yang-type": "ospf-mib:UpToMaxAge" }, "cospfShamLinkHelloInterval": { "type": "string", "description": "The length of time, in seconds, between the\n Hello packets that the router sends on the sham\n link.", "x-yang-type": "ospf-mib:HelloRange" }, "cospfShamLinkRtrDeadInterval": { "type": "string", "description": "The number of seconds that a router's Hello\n packets have not been seen before it's neighbors\n declare the router down. This should be\n some multiple of the Hello interval.", "x-yang-type": "ospf-mib:PositiveInteger" }, "cospfShamLinkState": { "type": "string", "description": "OSPF sham link states." }, "cospfShamLinkEvents": { "type": "integer", "description": "The number of state changes or error events on\n this sham link", "minimum": 0, "maximum": 4294967295 }, "cospfShamLinkMetric": { "type": "string", "description": "The Metric to be advertised.", "x-yang-type": "ospf-mib:Metric" } } }, "example": { "CISCO-OSPF-MIB:cospfShamLinkEntry": { "cospfShamLinkAreaId": "example-string", "cospfShamLinkLocalIpAddress": "192.168.1.1", "cospfShamLinkNeighborId": "example-string", "cospfShamLinkRetransInterval": "example-string", "cospfShamLinkHelloInterval": "example-string", "cospfShamLinkRtrDeadInterval": "example-string", "cospfShamLinkState": "up(1)", "cospfShamLinkEvents": 0, "cospfShamLinkMetric": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cospfShamLinkEntry-4" }, "x-yang-path": "/cospfShamLinkEntry={cospfShamLinkAreaId cospfShamLinkLocalIpAddress cospfShamLinkNeighborId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cospfShamLinkAreaId cospfShamLinkLocalIpAddress cospfShamLinkNeighborId" ] }, "/data/CISCO-OSPF-MIB:cospfLocalLsdbEntry={cospfLocalLsdbIpAddress},{cospfLocalLsdbAddressLessIf},{cospfLocalLsdbType},{cospfLocalLsdbLsid},{cospfLocalLsdbRouterId}": { "get": { "summary": "Get cospfLocalLsdbEntry entry", "description": "Retrieve specific cospfLocalLsdbEntry entry by key from MIB", "tags": [ "CISCO-OSPF-MIB" ], "parameters": [ { "name": "cospfLocalLsdbIpAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfLocalLsdbAddressLessIf", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfLocalLsdbType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfLocalLsdbLsid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfLocalLsdbRouterId", "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": { "cospfLocalLsdbIpAddress": { "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" }, "cospfLocalLsdbAddressLessIf": { "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" }, "cospfLocalLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement format." }, "cospfLocalLsdbLsid": { "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" }, "cospfLocalLsdbRouterId": { "type": "string", "description": "The 32 bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "ospf-mib:RouterID" }, "cospfLocalLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It is used to detect old and duplicate link\n state advertisements. The space of\n sequence numbers is linearly ordered. The\n larger the sequence number the more recent the\n advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfLocalLsdbAge": { "type": "integer", "description": "This field is the age of the link state advertisement \n in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfLocalLsdbChecksum": { "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 connectionless\n datagrams; it is commonly referred to\n as the Fletcher checksum.", "minimum": 0, "maximum": 4294967295 }, "cospfLocalLsdbAdvertisement": { "type": "string", "description": "The entire Link State Advertisement, including\n its header.", "format": "binary" } } }, "example": { "CISCO-OSPF-MIB:cospfLocalLsdbEntry": { "cospfLocalLsdbIpAddress": "192.168.1.1", "cospfLocalLsdbAddressLessIf": "192.168.1.1", "cospfLocalLsdbType": "ethernetCsmacd(6)", "cospfLocalLsdbLsid": "example-string", "cospfLocalLsdbRouterId": "example-string", "cospfLocalLsdbSequence": -2147483648, "cospfLocalLsdbAge": -2147483648, "cospfLocalLsdbChecksum": 0, "cospfLocalLsdbAdvertisement": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cospfLocalLsdbEntry-4" }, "x-yang-path": "/cospfLocalLsdbEntry={cospfLocalLsdbIpAddress cospfLocalLsdbAddressLessIf cospfLocalLsdbType cospfLocalLsdbLsid cospfLocalLsdbRouterId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cospfLocalLsdbIpAddress cospfLocalLsdbAddressLessIf cospfLocalLsdbType cospfLocalLsdbLsid cospfLocalLsdbRouterId" ] }, "/data/CISCO-OSPF-MIB:cospfVirtLocalLsdbEntry={cospfVirtLocalLsdbTransitArea},{cospfVirtLocalLsdbNeighbor},{cospfVirtLocalLsdbType},{cospfVirtLocalLsdbLsid},{cospfVirtLocalLsdbRouterId}": { "get": { "summary": "Get cospfVirtLocalLsdbEntry entry", "description": "Retrieve specific cospfVirtLocalLsdbEntry entry by key from MIB", "tags": [ "CISCO-OSPF-MIB" ], "parameters": [ { "name": "cospfVirtLocalLsdbTransitArea", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfVirtLocalLsdbNeighbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfVirtLocalLsdbType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfVirtLocalLsdbLsid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfVirtLocalLsdbRouterId", "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": { "cospfVirtLocalLsdbTransitArea": { "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" }, "cospfVirtLocalLsdbNeighbor": { "type": "string", "description": "The Router ID of the Virtual Neighbor.", "x-yang-type": "ospf-mib:RouterID" }, "cospfVirtLocalLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement format." }, "cospfVirtLocalLsdbLsid": { "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" }, "cospfVirtLocalLsdbRouterId": { "type": "string", "description": "The 32 bit number that uniquely identifies the\n originating router in the Autonomous System.", "x-yang-type": "ospf-mib:RouterID" }, "cospfVirtLocalLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It is used to detect old and duplicate\n link state advertisements. The space of\n sequence numbers is linearly ordered. The\n larger the sequence number the more recent the\n advertisement.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfVirtLocalLsdbAge": { "type": "integer", "description": "This field is the age of the link state advertisement\n in seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfVirtLocalLsdbChecksum": { "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 connectionless\n datagrams; it is commonly referred to\n as the Fletcher checksum.", "minimum": 0, "maximum": 4294967295 }, "cospfVirtLocalLsdbAdvertisement": { "type": "string", "description": "The entire Link State Advertisement, including\n its header.", "format": "binary" } } }, "example": { "CISCO-OSPF-MIB:cospfVirtLocalLsdbEntry": { "cospfVirtLocalLsdbTransitArea": "example-string", "cospfVirtLocalLsdbNeighbor": "example-string", "cospfVirtLocalLsdbType": "ethernetCsmacd(6)", "cospfVirtLocalLsdbLsid": "example-string", "cospfVirtLocalLsdbRouterId": "example-string", "cospfVirtLocalLsdbSequence": -2147483648, "cospfVirtLocalLsdbAge": -2147483648, "cospfVirtLocalLsdbChecksum": 0, "cospfVirtLocalLsdbAdvertisement": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cospfVirtLocalLsdbEntry-4" }, "x-yang-path": "/cospfVirtLocalLsdbEntry={cospfVirtLocalLsdbTransitArea cospfVirtLocalLsdbNeighbor cospfVirtLocalLsdbType cospfVirtLocalLsdbLsid cospfVirtLocalLsdbRouterId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cospfVirtLocalLsdbTransitArea cospfVirtLocalLsdbNeighbor cospfVirtLocalLsdbType cospfVirtLocalLsdbLsid cospfVirtLocalLsdbRouterId" ] }, "/data/CISCO-OSPF-MIB:cospfShamLinkNbrEntry={cospfShamLinksLocalIpAddrType},{cospfShamLinksLocalIpAddr},{cospfShamLinkNbrArea},{cospfShamLinkNbrIpAddrType},{cospfShamLinkNbrIpAddr}": { "get": { "summary": "Get cospfShamLinkNbrEntry entry", "description": "Retrieve specific cospfShamLinkNbrEntry entry by key from MIB", "tags": [ "CISCO-OSPF-MIB" ], "parameters": [ { "name": "cospfShamLinksLocalIpAddrType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfShamLinksLocalIpAddr", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfShamLinkNbrArea", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfShamLinkNbrIpAddrType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfShamLinkNbrIpAddr", "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": { "cospfShamLinksLocalIpAddrType": { "type": "string", "description": "cospfShamLinksLocalIpAddrType", "x-yang-type": "leafref" }, "cospfShamLinksLocalIpAddr": { "type": "string", "description": "cospfShamLinksLocalIpAddr", "x-yang-type": "leafref" }, "cospfShamLinkNbrArea": { "type": "string", "description": "The area to which the sham link is part of.", "x-yang-type": "ospf-mib:AreaID" }, "cospfShamLinkNbrIpAddrType": { "type": "string", "description": "The type of internet address of this sham link neighbor's\n IP address.", "x-yang-type": "inet-address:InetAddressType" }, "cospfShamLinkNbrIpAddr": { "type": "string", "description": "The IP address this sham link neighbor is using.", "x-yang-type": "inet-address:InetAddress" }, "cospfShamLinkNbrRtrId": { "type": "string", "description": "A 32-bit integer uniquely identifying the neighboring\n router.", "x-yang-type": "ospf-mib:RouterID" }, "cospfShamLinkNbrOptions": { "type": "integer", "description": "A Bit Mask corresponding to the neighbor's options\n 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; ie, that it implements \n OSPF Multicast Routing.", "minimum": -2147483648, "maximum": 2147483647 }, "cospfShamLinkNbrState": { "type": "string", "description": "The state of this sham link neighbor relation-\n ship." }, "cospfShamLinkNbrEvents": { "type": "integer", "description": "The number of times this sham link has changed\n state or an error has occurred.", "minimum": 0, "maximum": 4294967295 }, "cospfShamLinkNbrLsRetransQLen": { "type": "integer", "description": "The current length of the retransmission\n queue. The retransmission queue is maintained for\n LSAs that have been flooded but not acknowledged\n on this adjacency.", "minimum": 0, "maximum": 4294967295 }, "cospfShamLinkNbrHelloSuppressed": { "type": "boolean", "description": "Indicates whether Hellos are being suppressed\n to the neighbor." } } }, "example": { "CISCO-OSPF-MIB:cospfShamLinkNbrEntry": { "cospfShamLinksLocalIpAddrType": "192.168.1.1", "cospfShamLinksLocalIpAddr": "192.168.1.1", "cospfShamLinkNbrArea": "example-string", "cospfShamLinkNbrIpAddrType": "192.168.1.1", "cospfShamLinkNbrIpAddr": "192.168.1.1", "cospfShamLinkNbrRtrId": "example-string", "cospfShamLinkNbrOptions": -2147483648, "cospfShamLinkNbrState": "up(1)", "cospfShamLinkNbrEvents": 0, "cospfShamLinkNbrLsRetransQLen": 0, "cospfShamLinkNbrHelloSuppressed": true } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cospfShamLinkNbrEntry-4" }, "x-yang-path": "/cospfShamLinkNbrEntry={cospfShamLinksLocalIpAddrType cospfShamLinksLocalIpAddr cospfShamLinkNbrArea cospfShamLinkNbrIpAddrType cospfShamLinkNbrIpAddr}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cospfShamLinksLocalIpAddrType cospfShamLinksLocalIpAddr cospfShamLinkNbrArea cospfShamLinkNbrIpAddrType cospfShamLinkNbrIpAddr" ] }, "/data/CISCO-OSPF-MIB:cospfShamLinksEntry={cospfShamLinksAreaId},{cospfShamLinksLocalIpAddrType},{cospfShamLinksLocalIpAddr},{cospfShamLinksRemoteIpAddrType},{cospfShamLinksRemoteIpAddr}": { "get": { "summary": "Get cospfShamLinksEntry entry", "description": "Retrieve specific cospfShamLinksEntry entry by key from MIB", "tags": [ "CISCO-OSPF-MIB" ], "parameters": [ { "name": "cospfShamLinksAreaId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfShamLinksLocalIpAddrType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfShamLinksLocalIpAddr", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfShamLinksRemoteIpAddrType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cospfShamLinksRemoteIpAddr", "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": { "cospfShamLinksAreaId": { "type": "string", "description": "The area that this sham link is part of.", "x-yang-type": "ospf-mib:AreaID" }, "cospfShamLinksLocalIpAddrType": { "type": "string", "description": "The type of internet address of this sham link's local IP\n address.", "x-yang-type": "inet-address:InetAddressType" }, "cospfShamLinksLocalIpAddr": { "type": "string", "description": "The Local IP address of the sham link.", "x-yang-type": "inet-address:InetAddress" }, "cospfShamLinksRemoteIpAddrType": { "type": "string", "description": "The type of internet address of this sham link's remote IP\n address.", "x-yang-type": "inet-address:InetAddressType" }, "cospfShamLinksRemoteIpAddr": { "type": "string", "description": "The IP address of the other end router of the sham link.", "x-yang-type": "inet-address:InetAddress" }, "cospfShamLinksRetransInterval": { "type": "string", "description": "The number of seconds between link-state advertisement\n retransmissions, for adjacencies belonging to this link.\n This value is also used when retransmitting database \n description and link-state request packets. This value\n should be well over the expected round trip time.", "x-yang-type": "ospf-mib:UpToMaxAge" }, "cospfShamLinksHelloInterval": { "type": "string", "description": "The length of time, in seconds, between the\n Hello packets that the router sends on the sham\n link.", "x-yang-type": "ospf-mib:HelloRange" }, "cospfShamLinksRtrDeadInterval": { "type": "string", "description": "The number of seconds that a router's Hello\n packets have not been seen before it's neighbors\n declare the router down. This should be\n some multiple of the Hello interval.", "x-yang-type": "ospf-mib:PositiveInteger" }, "cospfShamLinksState": { "type": "string", "description": "OSPF sham link states." }, "cospfShamLinksEvents": { "type": "integer", "description": "The number of state changes or error events on\n this sham link", "minimum": 0, "maximum": 4294967295 }, "cospfShamLinksMetric": { "type": "string", "description": "The Metric to be advertised.", "x-yang-type": "ospf-mib:Metric" } } }, "example": { "CISCO-OSPF-MIB:cospfShamLinksEntry": { "cospfShamLinksAreaId": "example-string", "cospfShamLinksLocalIpAddrType": "192.168.1.1", "cospfShamLinksLocalIpAddr": "192.168.1.1", "cospfShamLinksRemoteIpAddrType": "192.168.1.1", "cospfShamLinksRemoteIpAddr": "192.168.1.1", "cospfShamLinksRetransInterval": "example-string", "cospfShamLinksHelloInterval": "example-string", "cospfShamLinksRtrDeadInterval": "example-string", "cospfShamLinksState": "up(1)", "cospfShamLinksEvents": 0, "cospfShamLinksMetric": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cospfShamLinksEntry-4" }, "x-yang-path": "/cospfShamLinksEntry={cospfShamLinksAreaId cospfShamLinksLocalIpAddrType cospfShamLinksLocalIpAddr cospfShamLinksRemoteIpAddrType cospfShamLinksRemoteIpAddr}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cospfShamLinksAreaId cospfShamLinksLocalIpAddrType cospfShamLinksLocalIpAddr cospfShamLinksRemoteIpAddrType cospfShamLinksRemoteIpAddr" ] } }, "components": { "schemas": { "CISCO-OSPF-MIB_CISCO-OSPF-MIB": { "type": "object", "description": "CISCO-OSPF-MIB", "properties": { "cospfLsdbEntry": { "type": "array", "description": "A single Link State Advertisement.", "items": { "type": "object", "properties": { "ospfLsdbAreaId": { "type": "string", "description": "ospfLsdbAreaId", "x-yang-type": "leafref", "readOnly": true }, "ospfLsdbLsid": { "type": "string", "description": "ospfLsdbLsid", "x-yang-type": "leafref", "readOnly": true }, "ospfLsdbRouterId": { "type": "string", "description": "ospfLsdbRouterId", "x-yang-type": "leafref", "readOnly": true }, "cospfLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement format.", "readOnly": true }, "cospfLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It is used to detect old and duplicate\n link state advertisements. The space of\n sequence numbers is linearly ordered. The\n larger the sequence number the more recent the\n advertisement.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cospfLsdbAge": { "type": "integer", "description": "This field is the age of the link state advertisement in\n seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cospfLsdbChecksum": { "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 connectionless\n datagrams; it is commonly referred to\n as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cospfLsdbAdvertisement": { "type": "string", "description": "The entire Link State Advertisement, including\n its header.", "format": "binary", "readOnly": true } } }, "readOnly": true }, "cospfShamLinkEntry": { "type": "array", "description": "Information about a single sham link", "items": { "type": "object", "properties": { "cospfShamLinkAreaId": { "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 }, "cospfShamLinkLocalIpAddress": { "type": "string", "description": "The Local IP address of the sham link.", "format": "inet:ipv4-address", "readOnly": true }, "cospfShamLinkNeighborId": { "type": "string", "description": "The Router ID of the other end router of the sham\n link.", "x-yang-type": "ospf-mib:RouterID", "readOnly": true }, "cospfShamLinkRetransInterval": { "type": "string", "description": "The number of seconds between link-state advertisement\n retransmissions, for adjacencies\n belonging to this link. This value is also\n used when retransmitting database description \n and link-state request packets. This value \n should be well over the expected round trip\n time.", "x-yang-type": "ospf-mib:UpToMaxAge", "readOnly": true }, "cospfShamLinkHelloInterval": { "type": "string", "description": "The length of time, in seconds, between the\n Hello packets that the router sends on the sham\n link.", "x-yang-type": "ospf-mib:HelloRange", "readOnly": true }, "cospfShamLinkRtrDeadInterval": { "type": "string", "description": "The number of seconds that a router's Hello\n packets have not been seen before it's neighbors\n declare the router down. This should be\n some multiple of the Hello interval.", "x-yang-type": "ospf-mib:PositiveInteger", "readOnly": true }, "cospfShamLinkState": { "type": "string", "description": "OSPF sham link states.", "readOnly": true }, "cospfShamLinkEvents": { "type": "integer", "description": "The number of state changes or error events on\n this sham link", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cospfShamLinkMetric": { "type": "string", "description": "The Metric to be advertised.", "x-yang-type": "ospf-mib:Metric", "readOnly": true } } }, "readOnly": true }, "cospfLocalLsdbEntry": { "type": "array", "description": "A single Link State Advertisement.", "items": { "type": "object", "properties": { "cospfLocalLsdbIpAddress": { "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 }, "cospfLocalLsdbAddressLessIf": { "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 }, "cospfLocalLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement format.", "readOnly": true }, "cospfLocalLsdbLsid": { "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 }, "cospfLocalLsdbRouterId": { "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 }, "cospfLocalLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It is used to detect old and duplicate link\n state advertisements. The space of\n sequence numbers is linearly ordered. The\n larger the sequence number the more recent the\n advertisement.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cospfLocalLsdbAge": { "type": "integer", "description": "This field is the age of the link state advertisement \n in seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cospfLocalLsdbChecksum": { "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 connectionless\n datagrams; it is commonly referred to\n as the Fletcher checksum.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cospfLocalLsdbAdvertisement": { "type": "string", "description": "The entire Link State Advertisement, including\n its header.", "format": "binary", "readOnly": true } } }, "readOnly": true }, "cospfVirtLocalLsdbEntry": { "type": "array", "description": "A single Link State Advertisement.", "items": { "type": "object", "properties": { "cospfVirtLocalLsdbTransitArea": { "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 }, "cospfVirtLocalLsdbNeighbor": { "type": "string", "description": "The Router ID of the Virtual Neighbor.", "x-yang-type": "ospf-mib:RouterID", "readOnly": true }, "cospfVirtLocalLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement format.", "readOnly": true }, "cospfVirtLocalLsdbLsid": { "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 }, "cospfVirtLocalLsdbRouterId": { "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 }, "cospfVirtLocalLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It is used to detect old and duplicate\n link state advertisements. The space of\n sequence numbers is linearly ordered. The\n larger the sequence number the more recent the\n advertisement.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cospfVirtLocalLsdbAge": { "type": "integer", "description": "This field is the age of the link state advertisement\n in seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cospfVirtLocalLsdbChecksum": { "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 connectionless\n datagrams; it is commonly referred to\n as the Fletcher checksum.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cospfVirtLocalLsdbAdvertisement": { "type": "string", "description": "The entire Link State Advertisement, including\n its header.", "format": "binary", "readOnly": true } } }, "readOnly": true }, "cospfShamLinkNbrEntry": { "type": "array", "description": "Sham link neighbor information.", "items": { "type": "object", "properties": { "cospfShamLinksLocalIpAddrType": { "type": "string", "description": "cospfShamLinksLocalIpAddrType", "x-yang-type": "leafref", "readOnly": true }, "cospfShamLinksLocalIpAddr": { "type": "string", "description": "cospfShamLinksLocalIpAddr", "x-yang-type": "leafref", "readOnly": true }, "cospfShamLinkNbrArea": { "type": "string", "description": "The area to which the sham link is part of.", "x-yang-type": "ospf-mib:AreaID", "readOnly": true }, "cospfShamLinkNbrIpAddrType": { "type": "string", "description": "The type of internet address of this sham link neighbor's\n IP address.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cospfShamLinkNbrIpAddr": { "type": "string", "description": "The IP address this sham link neighbor is using.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cospfShamLinkNbrRtrId": { "type": "string", "description": "A 32-bit integer uniquely identifying the neighboring\n router.", "x-yang-type": "ospf-mib:RouterID", "readOnly": true }, "cospfShamLinkNbrOptions": { "type": "integer", "description": "A Bit Mask corresponding to the neighbor's options\n 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; ie, that it implements \n OSPF Multicast Routing.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cospfShamLinkNbrState": { "type": "string", "description": "The state of this sham link neighbor relation-\n ship.", "readOnly": true }, "cospfShamLinkNbrEvents": { "type": "integer", "description": "The number of times this sham link has changed\n state or an error has occurred.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cospfShamLinkNbrLsRetransQLen": { "type": "integer", "description": "The current length of the retransmission\n queue. The retransmission queue is maintained for\n LSAs that have been flooded but not acknowledged\n on this adjacency.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cospfShamLinkNbrHelloSuppressed": { "type": "boolean", "description": "Indicates whether Hellos are being suppressed\n to the neighbor.", "readOnly": true } } }, "readOnly": true }, "cospfShamLinksEntry": { "type": "array", "description": "Information about a single sham link.", "items": { "type": "object", "properties": { "cospfShamLinksAreaId": { "type": "string", "description": "The area that this sham link is part of.", "x-yang-type": "ospf-mib:AreaID", "readOnly": true }, "cospfShamLinksLocalIpAddrType": { "type": "string", "description": "The type of internet address of this sham link's local IP\n address.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cospfShamLinksLocalIpAddr": { "type": "string", "description": "The Local IP address of the sham link.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cospfShamLinksRemoteIpAddrType": { "type": "string", "description": "The type of internet address of this sham link's remote IP\n address.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cospfShamLinksRemoteIpAddr": { "type": "string", "description": "The IP address of the other end router of the sham link.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cospfShamLinksRetransInterval": { "type": "string", "description": "The number of seconds between link-state advertisement\n retransmissions, for adjacencies belonging to this link.\n This value is also used when retransmitting database \n description and link-state request packets. This value\n should be well over the expected round trip time.", "x-yang-type": "ospf-mib:UpToMaxAge", "readOnly": true }, "cospfShamLinksHelloInterval": { "type": "string", "description": "The length of time, in seconds, between the\n Hello packets that the router sends on the sham\n link.", "x-yang-type": "ospf-mib:HelloRange", "readOnly": true }, "cospfShamLinksRtrDeadInterval": { "type": "string", "description": "The number of seconds that a router's Hello\n packets have not been seen before it's neighbors\n declare the router down. This should be\n some multiple of the Hello interval.", "x-yang-type": "ospf-mib:PositiveInteger", "readOnly": true }, "cospfShamLinksState": { "type": "string", "description": "OSPF sham link states.", "readOnly": true }, "cospfShamLinksEvents": { "type": "integer", "description": "The number of state changes or error events on\n this sham link", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cospfShamLinksMetric": { "type": "string", "description": "The Metric to be advertised.", "x-yang-type": "ospf-mib:Metric", "readOnly": true } } }, "readOnly": true }, "cospfGeneralGroup": { "type": "object", "description": "cospfGeneralGroup", "properties": { "cospfRFC1583Compatibility": { "type": "boolean", "description": "Indicates metrics used to choose among multiple AS-\n external-LSAs. When cospfRFC1583Compatibility is set to\n enabled, only cost will be used when choosing among\n multiple AS-external-LSAs advertising the same\n destination. When cospfRFC1583Compatibility is set to\n disabled, preference will be driven first by type of\n path using cost only to break ties.", "readOnly": true }, "cospfOpaqueLsaSupport": { "type": "boolean", "description": "The router's support for Opaque LSA types.", "readOnly": true }, "cospfTrafficEngineeringSupport": { "type": "boolean", "description": "The router's support for OSPF traffic engineering.", "readOnly": true }, "cospfOpaqueASLsaCount": { "type": "integer", "description": "The total number of Opaque AS link-state\n advertisements in the link state database.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cospfOpaqueASLsaCksumSum": { "type": "integer", "description": "The 32-bit unsigned sum of the Opaque AS \n link-state advertisements' LS checksums contained\n link state database.", "minimum": 0, "maximum": 4294967295, "readOnly": true } }, "readOnly": true }, "cospfLsdbTable": { "type": "object", "description": "The OSPF Process's Link State Database. This \n table is meant for Opaque LSA's", "properties": { "cospfLsdbEntry": { "type": "array", "description": "A single Link State Advertisement.", "items": { "type": "object", "properties": { "ospfLsdbAreaId": { "type": "string", "description": "ospfLsdbAreaId", "x-yang-type": "leafref", "readOnly": true }, "ospfLsdbLsid": { "type": "string", "description": "ospfLsdbLsid", "x-yang-type": "leafref", "readOnly": true }, "ospfLsdbRouterId": { "type": "string", "description": "ospfLsdbRouterId", "x-yang-type": "leafref", "readOnly": true }, "cospfLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement format.", "readOnly": true }, "cospfLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It is used to detect old and duplicate\n link state advertisements. The space of\n sequence numbers is linearly ordered. The\n larger the sequence number the more recent the\n advertisement.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cospfLsdbAge": { "type": "integer", "description": "This field is the age of the link state advertisement in\n seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cospfLsdbChecksum": { "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 connectionless\n datagrams; it is commonly referred to\n as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cospfLsdbAdvertisement": { "type": "string", "description": "The entire Link State Advertisement, including\n its header.", "format": "binary", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cospfShamLinkTable": { "type": "object", "description": "Information about this router's sham links", "properties": { "cospfShamLinkEntry": { "type": "array", "description": "Information about a single sham link", "items": { "type": "object", "properties": { "cospfShamLinkAreaId": { "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 }, "cospfShamLinkLocalIpAddress": { "type": "string", "description": "The Local IP address of the sham link.", "format": "inet:ipv4-address", "readOnly": true }, "cospfShamLinkNeighborId": { "type": "string", "description": "The Router ID of the other end router of the sham\n link.", "x-yang-type": "ospf-mib:RouterID", "readOnly": true }, "cospfShamLinkRetransInterval": { "type": "string", "description": "The number of seconds between link-state advertisement\n retransmissions, for adjacencies\n belonging to this link. This value is also\n used when retransmitting database description \n and link-state request packets. This value \n should be well over the expected round trip\n time.", "x-yang-type": "ospf-mib:UpToMaxAge", "readOnly": true }, "cospfShamLinkHelloInterval": { "type": "string", "description": "The length of time, in seconds, between the\n Hello packets that the router sends on the sham\n link.", "x-yang-type": "ospf-mib:HelloRange", "readOnly": true }, "cospfShamLinkRtrDeadInterval": { "type": "string", "description": "The number of seconds that a router's Hello\n packets have not been seen before it's neighbors\n declare the router down. This should be\n some multiple of the Hello interval.", "x-yang-type": "ospf-mib:PositiveInteger", "readOnly": true }, "cospfShamLinkState": { "type": "string", "description": "OSPF sham link states.", "readOnly": true }, "cospfShamLinkEvents": { "type": "integer", "description": "The number of state changes or error events on\n this sham link", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cospfShamLinkMetric": { "type": "string", "description": "The Metric to be advertised.", "x-yang-type": "ospf-mib:Metric", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cospfLocalLsdbTable": { "type": "object", "description": "The OSPF Process's Link-Local Link State Database\n for non-virtual links.", "properties": { "cospfLocalLsdbEntry": { "type": "array", "description": "A single Link State Advertisement.", "items": { "type": "object", "properties": { "cospfLocalLsdbIpAddress": { "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 }, "cospfLocalLsdbAddressLessIf": { "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 }, "cospfLocalLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement format.", "readOnly": true }, "cospfLocalLsdbLsid": { "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 }, "cospfLocalLsdbRouterId": { "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 }, "cospfLocalLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It is used to detect old and duplicate link\n state advertisements. The space of\n sequence numbers is linearly ordered. The\n larger the sequence number the more recent the\n advertisement.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cospfLocalLsdbAge": { "type": "integer", "description": "This field is the age of the link state advertisement \n in seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cospfLocalLsdbChecksum": { "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 connectionless\n datagrams; it is commonly referred to\n as the Fletcher checksum.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cospfLocalLsdbAdvertisement": { "type": "string", "description": "The entire Link State Advertisement, including\n its header.", "format": "binary", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cospfVirtLocalLsdbTable": { "type": "object", "description": "The OSPF Process's Link-Local Link State Database\n for virtual links.", "properties": { "cospfVirtLocalLsdbEntry": { "type": "array", "description": "A single Link State Advertisement.", "items": { "type": "object", "properties": { "cospfVirtLocalLsdbTransitArea": { "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 }, "cospfVirtLocalLsdbNeighbor": { "type": "string", "description": "The Router ID of the Virtual Neighbor.", "x-yang-type": "ospf-mib:RouterID", "readOnly": true }, "cospfVirtLocalLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement format.", "readOnly": true }, "cospfVirtLocalLsdbLsid": { "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 }, "cospfVirtLocalLsdbRouterId": { "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 }, "cospfVirtLocalLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It is used to detect old and duplicate\n link state advertisements. The space of\n sequence numbers is linearly ordered. The\n larger the sequence number the more recent the\n advertisement.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cospfVirtLocalLsdbAge": { "type": "integer", "description": "This field is the age of the link state advertisement\n in seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cospfVirtLocalLsdbChecksum": { "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 connectionless\n datagrams; it is commonly referred to\n as the Fletcher checksum.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cospfVirtLocalLsdbAdvertisement": { "type": "string", "description": "The entire Link State Advertisement, including\n its header.", "format": "binary", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cospfShamLinkNbrTable": { "type": "object", "description": "A table of sham link neighbor information.", "properties": { "cospfShamLinkNbrEntry": { "type": "array", "description": "Sham link neighbor information.", "items": { "type": "object", "properties": { "cospfShamLinksLocalIpAddrType": { "type": "string", "description": "cospfShamLinksLocalIpAddrType", "x-yang-type": "leafref", "readOnly": true }, "cospfShamLinksLocalIpAddr": { "type": "string", "description": "cospfShamLinksLocalIpAddr", "x-yang-type": "leafref", "readOnly": true }, "cospfShamLinkNbrArea": { "type": "string", "description": "The area to which the sham link is part of.", "x-yang-type": "ospf-mib:AreaID", "readOnly": true }, "cospfShamLinkNbrIpAddrType": { "type": "string", "description": "The type of internet address of this sham link neighbor's\n IP address.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cospfShamLinkNbrIpAddr": { "type": "string", "description": "The IP address this sham link neighbor is using.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cospfShamLinkNbrRtrId": { "type": "string", "description": "A 32-bit integer uniquely identifying the neighboring\n router.", "x-yang-type": "ospf-mib:RouterID", "readOnly": true }, "cospfShamLinkNbrOptions": { "type": "integer", "description": "A Bit Mask corresponding to the neighbor's options\n 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; ie, that it implements \n OSPF Multicast Routing.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cospfShamLinkNbrState": { "type": "string", "description": "The state of this sham link neighbor relation-\n ship.", "readOnly": true }, "cospfShamLinkNbrEvents": { "type": "integer", "description": "The number of times this sham link has changed\n state or an error has occurred.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cospfShamLinkNbrLsRetransQLen": { "type": "integer", "description": "The current length of the retransmission\n queue. The retransmission queue is maintained for\n LSAs that have been flooded but not acknowledged\n on this adjacency.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cospfShamLinkNbrHelloSuppressed": { "type": "boolean", "description": "Indicates whether Hellos are being suppressed\n to the neighbor.", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cospfShamLinksTable": { "type": "object", "description": "Information about this router's sham links.", "properties": { "cospfShamLinksEntry": { "type": "array", "description": "Information about a single sham link.", "items": { "type": "object", "properties": { "cospfShamLinksAreaId": { "type": "string", "description": "The area that this sham link is part of.", "x-yang-type": "ospf-mib:AreaID", "readOnly": true }, "cospfShamLinksLocalIpAddrType": { "type": "string", "description": "The type of internet address of this sham link's local IP\n address.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cospfShamLinksLocalIpAddr": { "type": "string", "description": "The Local IP address of the sham link.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cospfShamLinksRemoteIpAddrType": { "type": "string", "description": "The type of internet address of this sham link's remote IP\n address.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cospfShamLinksRemoteIpAddr": { "type": "string", "description": "The IP address of the other end router of the sham link.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cospfShamLinksRetransInterval": { "type": "string", "description": "The number of seconds between link-state advertisement\n retransmissions, for adjacencies belonging to this link.\n This value is also used when retransmitting database \n description and link-state request packets. This value\n should be well over the expected round trip time.", "x-yang-type": "ospf-mib:UpToMaxAge", "readOnly": true }, "cospfShamLinksHelloInterval": { "type": "string", "description": "The length of time, in seconds, between the\n Hello packets that the router sends on the sham\n link.", "x-yang-type": "ospf-mib:HelloRange", "readOnly": true }, "cospfShamLinksRtrDeadInterval": { "type": "string", "description": "The number of seconds that a router's Hello\n packets have not been seen before it's neighbors\n declare the router down. This should be\n some multiple of the Hello interval.", "x-yang-type": "ospf-mib:PositiveInteger", "readOnly": true }, "cospfShamLinksState": { "type": "string", "description": "OSPF sham link states.", "readOnly": true }, "cospfShamLinksEvents": { "type": "integer", "description": "The number of state changes or error events on\n this sham link", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cospfShamLinksMetric": { "type": "string", "description": "The Metric to be advertised.", "x-yang-type": "ospf-mib:Metric", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "CISCO-OSPF-MIB_cospfLsdbEntry": { "type": "array", "description": "A single Link State Advertisement.", "items": { "type": "object", "properties": { "ospfLsdbAreaId": { "type": "string", "description": "ospfLsdbAreaId", "x-yang-type": "leafref", "readOnly": true }, "ospfLsdbLsid": { "type": "string", "description": "ospfLsdbLsid", "x-yang-type": "leafref", "readOnly": true }, "ospfLsdbRouterId": { "type": "string", "description": "ospfLsdbRouterId", "x-yang-type": "leafref", "readOnly": true }, "cospfLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement format.", "readOnly": true }, "cospfLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It is used to detect old and duplicate\n link state advertisements. The space of\n sequence numbers is linearly ordered. The\n larger the sequence number the more recent the\n advertisement.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cospfLsdbAge": { "type": "integer", "description": "This field is the age of the link state advertisement in\n seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cospfLsdbChecksum": { "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 connectionless\n datagrams; it is commonly referred to\n as the Fletcher checksum.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cospfLsdbAdvertisement": { "type": "string", "description": "The entire Link State Advertisement, including\n its header.", "format": "binary", "readOnly": true } } } }, "CISCO-OSPF-MIB_cospfShamLinkEntry": { "type": "array", "description": "Information about a single sham link", "items": { "type": "object", "properties": { "cospfShamLinkAreaId": { "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 }, "cospfShamLinkLocalIpAddress": { "type": "string", "description": "The Local IP address of the sham link.", "format": "inet:ipv4-address", "readOnly": true }, "cospfShamLinkNeighborId": { "type": "string", "description": "The Router ID of the other end router of the sham\n link.", "x-yang-type": "ospf-mib:RouterID", "readOnly": true }, "cospfShamLinkRetransInterval": { "type": "string", "description": "The number of seconds between link-state advertisement\n retransmissions, for adjacencies\n belonging to this link. This value is also\n used when retransmitting database description \n and link-state request packets. This value \n should be well over the expected round trip\n time.", "x-yang-type": "ospf-mib:UpToMaxAge", "readOnly": true }, "cospfShamLinkHelloInterval": { "type": "string", "description": "The length of time, in seconds, between the\n Hello packets that the router sends on the sham\n link.", "x-yang-type": "ospf-mib:HelloRange", "readOnly": true }, "cospfShamLinkRtrDeadInterval": { "type": "string", "description": "The number of seconds that a router's Hello\n packets have not been seen before it's neighbors\n declare the router down. This should be\n some multiple of the Hello interval.", "x-yang-type": "ospf-mib:PositiveInteger", "readOnly": true }, "cospfShamLinkState": { "type": "string", "description": "OSPF sham link states.", "readOnly": true }, "cospfShamLinkEvents": { "type": "integer", "description": "The number of state changes or error events on\n this sham link", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cospfShamLinkMetric": { "type": "string", "description": "The Metric to be advertised.", "x-yang-type": "ospf-mib:Metric", "readOnly": true } } } }, "CISCO-OSPF-MIB_cospfLocalLsdbEntry": { "type": "array", "description": "A single Link State Advertisement.", "items": { "type": "object", "properties": { "cospfLocalLsdbIpAddress": { "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 }, "cospfLocalLsdbAddressLessIf": { "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 }, "cospfLocalLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement format.", "readOnly": true }, "cospfLocalLsdbLsid": { "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 }, "cospfLocalLsdbRouterId": { "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 }, "cospfLocalLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It is used to detect old and duplicate link\n state advertisements. The space of\n sequence numbers is linearly ordered. The\n larger the sequence number the more recent the\n advertisement.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cospfLocalLsdbAge": { "type": "integer", "description": "This field is the age of the link state advertisement \n in seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cospfLocalLsdbChecksum": { "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 connectionless\n datagrams; it is commonly referred to\n as the Fletcher checksum.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cospfLocalLsdbAdvertisement": { "type": "string", "description": "The entire Link State Advertisement, including\n its header.", "format": "binary", "readOnly": true } } } }, "CISCO-OSPF-MIB_cospfVirtLocalLsdbEntry": { "type": "array", "description": "A single Link State Advertisement.", "items": { "type": "object", "properties": { "cospfVirtLocalLsdbTransitArea": { "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 }, "cospfVirtLocalLsdbNeighbor": { "type": "string", "description": "The Router ID of the Virtual Neighbor.", "x-yang-type": "ospf-mib:RouterID", "readOnly": true }, "cospfVirtLocalLsdbType": { "type": "string", "description": "The type of the link state advertisement.\n Each link state type has a separate advertisement format.", "readOnly": true }, "cospfVirtLocalLsdbLsid": { "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 }, "cospfVirtLocalLsdbRouterId": { "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 }, "cospfVirtLocalLsdbSequence": { "type": "integer", "description": "The sequence number field is a signed 32-bit\n integer. It is used to detect old and duplicate\n link state advertisements. The space of\n sequence numbers is linearly ordered. The\n larger the sequence number the more recent the\n advertisement.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cospfVirtLocalLsdbAge": { "type": "integer", "description": "This field is the age of the link state advertisement\n in seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cospfVirtLocalLsdbChecksum": { "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 connectionless\n datagrams; it is commonly referred to\n as the Fletcher checksum.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cospfVirtLocalLsdbAdvertisement": { "type": "string", "description": "The entire Link State Advertisement, including\n its header.", "format": "binary", "readOnly": true } } } }, "CISCO-OSPF-MIB_cospfShamLinkNbrEntry": { "type": "array", "description": "Sham link neighbor information.", "items": { "type": "object", "properties": { "cospfShamLinksLocalIpAddrType": { "type": "string", "description": "cospfShamLinksLocalIpAddrType", "x-yang-type": "leafref", "readOnly": true }, "cospfShamLinksLocalIpAddr": { "type": "string", "description": "cospfShamLinksLocalIpAddr", "x-yang-type": "leafref", "readOnly": true }, "cospfShamLinkNbrArea": { "type": "string", "description": "The area to which the sham link is part of.", "x-yang-type": "ospf-mib:AreaID", "readOnly": true }, "cospfShamLinkNbrIpAddrType": { "type": "string", "description": "The type of internet address of this sham link neighbor's\n IP address.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cospfShamLinkNbrIpAddr": { "type": "string", "description": "The IP address this sham link neighbor is using.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cospfShamLinkNbrRtrId": { "type": "string", "description": "A 32-bit integer uniquely identifying the neighboring\n router.", "x-yang-type": "ospf-mib:RouterID", "readOnly": true }, "cospfShamLinkNbrOptions": { "type": "integer", "description": "A Bit Mask corresponding to the neighbor's options\n 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; ie, that it implements \n OSPF Multicast Routing.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cospfShamLinkNbrState": { "type": "string", "description": "The state of this sham link neighbor relation-\n ship.", "readOnly": true }, "cospfShamLinkNbrEvents": { "type": "integer", "description": "The number of times this sham link has changed\n state or an error has occurred.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cospfShamLinkNbrLsRetransQLen": { "type": "integer", "description": "The current length of the retransmission\n queue. The retransmission queue is maintained for\n LSAs that have been flooded but not acknowledged\n on this adjacency.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cospfShamLinkNbrHelloSuppressed": { "type": "boolean", "description": "Indicates whether Hellos are being suppressed\n to the neighbor.", "readOnly": true } } } }, "CISCO-OSPF-MIB_cospfShamLinksEntry": { "type": "array", "description": "Information about a single sham link.", "items": { "type": "object", "properties": { "cospfShamLinksAreaId": { "type": "string", "description": "The area that this sham link is part of.", "x-yang-type": "ospf-mib:AreaID", "readOnly": true }, "cospfShamLinksLocalIpAddrType": { "type": "string", "description": "The type of internet address of this sham link's local IP\n address.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cospfShamLinksLocalIpAddr": { "type": "string", "description": "The Local IP address of the sham link.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cospfShamLinksRemoteIpAddrType": { "type": "string", "description": "The type of internet address of this sham link's remote IP\n address.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cospfShamLinksRemoteIpAddr": { "type": "string", "description": "The IP address of the other end router of the sham link.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cospfShamLinksRetransInterval": { "type": "string", "description": "The number of seconds between link-state advertisement\n retransmissions, for adjacencies belonging to this link.\n This value is also used when retransmitting database \n description and link-state request packets. This value\n should be well over the expected round trip time.", "x-yang-type": "ospf-mib:UpToMaxAge", "readOnly": true }, "cospfShamLinksHelloInterval": { "type": "string", "description": "The length of time, in seconds, between the\n Hello packets that the router sends on the sham\n link.", "x-yang-type": "ospf-mib:HelloRange", "readOnly": true }, "cospfShamLinksRtrDeadInterval": { "type": "string", "description": "The number of seconds that a router's Hello\n packets have not been seen before it's neighbors\n declare the router down. This should be\n some multiple of the Hello interval.", "x-yang-type": "ospf-mib:PositiveInteger", "readOnly": true }, "cospfShamLinksState": { "type": "string", "description": "OSPF sham link states.", "readOnly": true }, "cospfShamLinksEvents": { "type": "integer", "description": "The number of state changes or error events on\n this sham link", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cospfShamLinksMetric": { "type": "string", "description": "The Metric to be advertised.", "x-yang-type": "ospf-mib:Metric", "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": "CISCO-OSPF-MIB", "description": "MIB operations for CISCO-OSPF-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }