{ "openapi": "3.0.0", "info": { "title": "CISCO-IPMROUTE-MIB MIB API", "version": "1.0.0", "description": "The MIB module for management of IP Multicast routing,\n but independent of the specific multicast routing protocol\n in use.\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-IPMROUTE-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/CISCO-IPMROUTE-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "CISCO-IPMROUTE-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-IPMROUTE-MIB:ciscoIpMRoute": { "get": { "summary": "Get ciscoIpMRoute data", "description": "Retrieve ciscoIpMRoute operational data from MIB", "tags": [ "CISCO-IPMROUTE-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "Maintains a count of the number of entries in the\n ipMRouteTable.", "properties": { "ciscoIpMRouteNumberOfEntries": { "type": "integer", "description": "Maintains a count of the number of entries in the\n ipMRouteTable.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-IPMROUTE-MIB:ciscoIpMRoute": { "ciscoIpMRouteNumberOfEntries": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoIpMRoute", "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": "/ciscoIpMRoute", "x-restconf-kind": "container" }, "/data/CISCO-IPMROUTE-MIB:ciscoIpMRouteHeartBeatTable": { "get": { "summary": "Get ciscoIpMRouteHeartBeatTable data", "description": "Retrieve ciscoIpMRouteHeartBeatTable operational data from MIB", "tags": [ "CISCO-IPMROUTE-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The (conceptual) table listing sets of IP Multicast\n heartbeat parameters. If no IP Multicast heartbeat is\n configured, this table would be empty.", "properties": { "ciscoIpMRouteHeartBeatEntry": { "type": "array", "description": "An entry (conceptual row) representing a set of IP\n Multicast heartbeat parameters.", "items": { "type": "object", "properties": { "ciscoIpMRouteHeartBeatGroupAddr": { "type": "string", "description": "Multicast group address used to receive heartbeat\n packets.", "format": "inet:ipv4-address" }, "ciscoIpMRouteHeartBeatSourceAddr": { "type": "string", "description": "Source address of the last multicast heartbeat packet\n received.", "format": "inet:ipv4-address" }, "ciscoIpMRouteHeartBeatInterval": { "type": "integer", "description": "Number of seconds in which a Cisco multicast router\n expects a valid heartBeat packet from a source. This\n value must be a multiple of 10.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoIpMRouteHeartBeatWindowSize": { "type": "integer", "description": "Number of ciscoIpMRouteHeartBeatInterval intervals a\n Cisco multicast router waits before checking if expected\n number of heartbeat packets are received or not.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoIpMRouteHeartBeatCount": { "type": "integer", "description": "Number of time intervals where multicast packets were\n received in the last ciscoIpMRouteHeartBeatWindowSize\n intervals.", "minimum": 0, "maximum": 4294967295 }, "ciscoIpMRouteHeartBeatMinimum": { "type": "integer", "description": "The minimal number of heartbeat packets expected in the\n last ciscoIpMRouteHeartBeatWindowSize intervals. If\n ciscoIpMRouteHeartBeatCount falls below this value, an\n SNMP trap/notification, if configured, will be sent to the\n NMS.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoIpMRouteHeartBeatAlertTime": { "type": "string", "description": "The value of sysUpTime on the most recent occasion at\n which a missing IP multicast heartbeat condition occured\n for the group address specified in this entry. If no such\n condition have occurred since the last re-initialization\n of the local management subsystem, then this object\n contains a zero value.", "x-yang-type": "yang:timestamp" }, "ciscoIpMRouteHeartBeatStatus": { "type": "string", "description": "This object is used to create a new row or delete an\n existing row in this table.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "CISCO-IPMROUTE-MIB:ciscoIpMRouteHeartBeatTable": { "ciscoIpMRouteHeartBeatEntry": [ { "ciscoIpMRouteHeartBeatGroupAddr": "192.168.1.1", "ciscoIpMRouteHeartBeatSourceAddr": "192.168.1.1", "ciscoIpMRouteHeartBeatInterval": -2147483648, "ciscoIpMRouteHeartBeatWindowSize": -2147483648, "ciscoIpMRouteHeartBeatCount": 0, "ciscoIpMRouteHeartBeatMinimum": -2147483648, "ciscoIpMRouteHeartBeatAlertTime": "192.168.1.1", "ciscoIpMRouteHeartBeatStatus": "192.168.1.1" }, { "ciscoIpMRouteHeartBeatGroupAddr": "192.168.1.1", "ciscoIpMRouteHeartBeatSourceAddr": "192.168.1.1", "ciscoIpMRouteHeartBeatInterval": -2147483648, "ciscoIpMRouteHeartBeatWindowSize": -2147483648, "ciscoIpMRouteHeartBeatCount": 0, "ciscoIpMRouteHeartBeatMinimum": -2147483648, "ciscoIpMRouteHeartBeatAlertTime": "192.168.1.1", "ciscoIpMRouteHeartBeatStatus": "192.168.1.1" }, { "ciscoIpMRouteHeartBeatGroupAddr": "192.168.1.1", "ciscoIpMRouteHeartBeatSourceAddr": "192.168.1.1", "ciscoIpMRouteHeartBeatInterval": -2147483648, "ciscoIpMRouteHeartBeatWindowSize": -2147483648, "ciscoIpMRouteHeartBeatCount": 0, "ciscoIpMRouteHeartBeatMinimum": -2147483648, "ciscoIpMRouteHeartBeatAlertTime": "192.168.1.1", "ciscoIpMRouteHeartBeatStatus": "192.168.1.1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoIpMRouteHeartBeatTable", "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": "/ciscoIpMRouteHeartBeatTable", "x-restconf-kind": "container" }, "/data/CISCO-IPMROUTE-MIB:ciscoIpMRouteHeartBeatTable/ciscoIpMRouteHeartBeatEntry": { "get": { "summary": "Get ciscoIpMRouteHeartBeatEntry list", "description": "Retrieve list of ciscoIpMRouteHeartBeatEntry entries from MIB", "tags": [ "CISCO-IPMROUTE-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) representing a set of IP\n Multicast heartbeat parameters.", "items": { "type": "object", "properties": { "ciscoIpMRouteHeartBeatGroupAddr": { "type": "string", "description": "Multicast group address used to receive heartbeat\n packets.", "format": "inet:ipv4-address" }, "ciscoIpMRouteHeartBeatSourceAddr": { "type": "string", "description": "Source address of the last multicast heartbeat packet\n received.", "format": "inet:ipv4-address" }, "ciscoIpMRouteHeartBeatInterval": { "type": "integer", "description": "Number of seconds in which a Cisco multicast router\n expects a valid heartBeat packet from a source. This\n value must be a multiple of 10.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoIpMRouteHeartBeatWindowSize": { "type": "integer", "description": "Number of ciscoIpMRouteHeartBeatInterval intervals a\n Cisco multicast router waits before checking if expected\n number of heartbeat packets are received or not.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoIpMRouteHeartBeatCount": { "type": "integer", "description": "Number of time intervals where multicast packets were\n received in the last ciscoIpMRouteHeartBeatWindowSize\n intervals.", "minimum": 0, "maximum": 4294967295 }, "ciscoIpMRouteHeartBeatMinimum": { "type": "integer", "description": "The minimal number of heartbeat packets expected in the\n last ciscoIpMRouteHeartBeatWindowSize intervals. If\n ciscoIpMRouteHeartBeatCount falls below this value, an\n SNMP trap/notification, if configured, will be sent to the\n NMS.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoIpMRouteHeartBeatAlertTime": { "type": "string", "description": "The value of sysUpTime on the most recent occasion at\n which a missing IP multicast heartbeat condition occured\n for the group address specified in this entry. If no such\n condition have occurred since the last re-initialization\n of the local management subsystem, then this object\n contains a zero value.", "x-yang-type": "yang:timestamp" }, "ciscoIpMRouteHeartBeatStatus": { "type": "string", "description": "This object is used to create a new row or delete an\n existing row in this table.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-IPMROUTE-MIB:ciscoIpMRouteHeartBeatEntry": [ { "ciscoIpMRouteHeartBeatGroupAddr": "192.168.1.1", "ciscoIpMRouteHeartBeatSourceAddr": "192.168.1.1", "ciscoIpMRouteHeartBeatInterval": -2147483648, "ciscoIpMRouteHeartBeatWindowSize": -2147483648, "ciscoIpMRouteHeartBeatCount": 0, "ciscoIpMRouteHeartBeatMinimum": -2147483648, "ciscoIpMRouteHeartBeatAlertTime": "192.168.1.1", "ciscoIpMRouteHeartBeatStatus": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoIpMRouteHeartBeatEntry", "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": "/ciscoIpMRouteHeartBeatTable/ciscoIpMRouteHeartBeatEntry", "x-restconf-kind": "container" }, "/data/CISCO-IPMROUTE-MIB:ciscoIpMRouteHeartBeatTable/ciscoIpMRouteHeartBeatEntry={ciscoIpMRouteHeartBeatGroupAddr}": { "get": { "summary": "Get ciscoIpMRouteHeartBeatEntry entry", "description": "Retrieve specific ciscoIpMRouteHeartBeatEntry entry by key from MIB", "tags": [ "CISCO-IPMROUTE-MIB" ], "parameters": [ { "name": "ciscoIpMRouteHeartBeatGroupAddr", "in": "path", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "ciscoIpMRouteHeartBeatGroupAddr": { "type": "string", "description": "Multicast group address used to receive heartbeat\n packets.", "format": "inet:ipv4-address" }, "ciscoIpMRouteHeartBeatSourceAddr": { "type": "string", "description": "Source address of the last multicast heartbeat packet\n received.", "format": "inet:ipv4-address" }, "ciscoIpMRouteHeartBeatInterval": { "type": "integer", "description": "Number of seconds in which a Cisco multicast router\n expects a valid heartBeat packet from a source. This\n value must be a multiple of 10.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoIpMRouteHeartBeatWindowSize": { "type": "integer", "description": "Number of ciscoIpMRouteHeartBeatInterval intervals a\n Cisco multicast router waits before checking if expected\n number of heartbeat packets are received or not.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoIpMRouteHeartBeatCount": { "type": "integer", "description": "Number of time intervals where multicast packets were\n received in the last ciscoIpMRouteHeartBeatWindowSize\n intervals.", "minimum": 0, "maximum": 4294967295 }, "ciscoIpMRouteHeartBeatMinimum": { "type": "integer", "description": "The minimal number of heartbeat packets expected in the\n last ciscoIpMRouteHeartBeatWindowSize intervals. If\n ciscoIpMRouteHeartBeatCount falls below this value, an\n SNMP trap/notification, if configured, will be sent to the\n NMS.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoIpMRouteHeartBeatAlertTime": { "type": "string", "description": "The value of sysUpTime on the most recent occasion at\n which a missing IP multicast heartbeat condition occured\n for the group address specified in this entry. If no such\n condition have occurred since the last re-initialization\n of the local management subsystem, then this object\n contains a zero value.", "x-yang-type": "yang:timestamp" }, "ciscoIpMRouteHeartBeatStatus": { "type": "string", "description": "This object is used to create a new row or delete an\n existing row in this table.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-IPMROUTE-MIB:ciscoIpMRouteHeartBeatEntry": { "ciscoIpMRouteHeartBeatGroupAddr": "192.168.1.1", "ciscoIpMRouteHeartBeatSourceAddr": "192.168.1.1", "ciscoIpMRouteHeartBeatInterval": -2147483648, "ciscoIpMRouteHeartBeatWindowSize": -2147483648, "ciscoIpMRouteHeartBeatCount": 0, "ciscoIpMRouteHeartBeatMinimum": -2147483648, "ciscoIpMRouteHeartBeatAlertTime": "192.168.1.1", "ciscoIpMRouteHeartBeatStatus": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoIpMRouteHeartBeatEntry-2" }, "x-yang-path": "/ciscoIpMRouteHeartBeatTable/ciscoIpMRouteHeartBeatEntry={ciscoIpMRouteHeartBeatGroupAddr}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ciscoIpMRouteHeartBeatGroupAddr" ] }, "/data/CISCO-IPMROUTE-MIB:ciscoIpMRouteHeartBeatEntry": { "get": { "summary": "Get ciscoIpMRouteHeartBeatEntry list", "description": "Retrieve list of ciscoIpMRouteHeartBeatEntry entries from MIB", "tags": [ "CISCO-IPMROUTE-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) representing a set of IP\n Multicast heartbeat parameters.", "items": { "type": "object", "properties": { "ciscoIpMRouteHeartBeatGroupAddr": { "type": "string", "description": "Multicast group address used to receive heartbeat\n packets.", "format": "inet:ipv4-address" }, "ciscoIpMRouteHeartBeatSourceAddr": { "type": "string", "description": "Source address of the last multicast heartbeat packet\n received.", "format": "inet:ipv4-address" }, "ciscoIpMRouteHeartBeatInterval": { "type": "integer", "description": "Number of seconds in which a Cisco multicast router\n expects a valid heartBeat packet from a source. This\n value must be a multiple of 10.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoIpMRouteHeartBeatWindowSize": { "type": "integer", "description": "Number of ciscoIpMRouteHeartBeatInterval intervals a\n Cisco multicast router waits before checking if expected\n number of heartbeat packets are received or not.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoIpMRouteHeartBeatCount": { "type": "integer", "description": "Number of time intervals where multicast packets were\n received in the last ciscoIpMRouteHeartBeatWindowSize\n intervals.", "minimum": 0, "maximum": 4294967295 }, "ciscoIpMRouteHeartBeatMinimum": { "type": "integer", "description": "The minimal number of heartbeat packets expected in the\n last ciscoIpMRouteHeartBeatWindowSize intervals. If\n ciscoIpMRouteHeartBeatCount falls below this value, an\n SNMP trap/notification, if configured, will be sent to the\n NMS.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoIpMRouteHeartBeatAlertTime": { "type": "string", "description": "The value of sysUpTime on the most recent occasion at\n which a missing IP multicast heartbeat condition occured\n for the group address specified in this entry. If no such\n condition have occurred since the last re-initialization\n of the local management subsystem, then this object\n contains a zero value.", "x-yang-type": "yang:timestamp" }, "ciscoIpMRouteHeartBeatStatus": { "type": "string", "description": "This object is used to create a new row or delete an\n existing row in this table.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-IPMROUTE-MIB:ciscoIpMRouteHeartBeatEntry": [ { "ciscoIpMRouteHeartBeatGroupAddr": "192.168.1.1", "ciscoIpMRouteHeartBeatSourceAddr": "192.168.1.1", "ciscoIpMRouteHeartBeatInterval": -2147483648, "ciscoIpMRouteHeartBeatWindowSize": -2147483648, "ciscoIpMRouteHeartBeatCount": 0, "ciscoIpMRouteHeartBeatMinimum": -2147483648, "ciscoIpMRouteHeartBeatAlertTime": "192.168.1.1", "ciscoIpMRouteHeartBeatStatus": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoIpMRouteHeartBeatEntry-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": "/ciscoIpMRouteHeartBeatEntry", "x-restconf-kind": "container" }, "/data/CISCO-IPMROUTE-MIB:ciscoIpMRouteHeartBeatEntry={ciscoIpMRouteHeartBeatGroupAddr}": { "get": { "summary": "Get ciscoIpMRouteHeartBeatEntry entry", "description": "Retrieve specific ciscoIpMRouteHeartBeatEntry entry by key from MIB", "tags": [ "CISCO-IPMROUTE-MIB" ], "parameters": [ { "name": "ciscoIpMRouteHeartBeatGroupAddr", "in": "path", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "ciscoIpMRouteHeartBeatGroupAddr": { "type": "string", "description": "Multicast group address used to receive heartbeat\n packets.", "format": "inet:ipv4-address" }, "ciscoIpMRouteHeartBeatSourceAddr": { "type": "string", "description": "Source address of the last multicast heartbeat packet\n received.", "format": "inet:ipv4-address" }, "ciscoIpMRouteHeartBeatInterval": { "type": "integer", "description": "Number of seconds in which a Cisco multicast router\n expects a valid heartBeat packet from a source. This\n value must be a multiple of 10.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoIpMRouteHeartBeatWindowSize": { "type": "integer", "description": "Number of ciscoIpMRouteHeartBeatInterval intervals a\n Cisco multicast router waits before checking if expected\n number of heartbeat packets are received or not.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoIpMRouteHeartBeatCount": { "type": "integer", "description": "Number of time intervals where multicast packets were\n received in the last ciscoIpMRouteHeartBeatWindowSize\n intervals.", "minimum": 0, "maximum": 4294967295 }, "ciscoIpMRouteHeartBeatMinimum": { "type": "integer", "description": "The minimal number of heartbeat packets expected in the\n last ciscoIpMRouteHeartBeatWindowSize intervals. If\n ciscoIpMRouteHeartBeatCount falls below this value, an\n SNMP trap/notification, if configured, will be sent to the\n NMS.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoIpMRouteHeartBeatAlertTime": { "type": "string", "description": "The value of sysUpTime on the most recent occasion at\n which a missing IP multicast heartbeat condition occured\n for the group address specified in this entry. If no such\n condition have occurred since the last re-initialization\n of the local management subsystem, then this object\n contains a zero value.", "x-yang-type": "yang:timestamp" }, "ciscoIpMRouteHeartBeatStatus": { "type": "string", "description": "This object is used to create a new row or delete an\n existing row in this table.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-IPMROUTE-MIB:ciscoIpMRouteHeartBeatEntry": { "ciscoIpMRouteHeartBeatGroupAddr": "192.168.1.1", "ciscoIpMRouteHeartBeatSourceAddr": "192.168.1.1", "ciscoIpMRouteHeartBeatInterval": -2147483648, "ciscoIpMRouteHeartBeatWindowSize": -2147483648, "ciscoIpMRouteHeartBeatCount": 0, "ciscoIpMRouteHeartBeatMinimum": -2147483648, "ciscoIpMRouteHeartBeatAlertTime": "192.168.1.1", "ciscoIpMRouteHeartBeatStatus": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoIpMRouteHeartBeatEntry-4" }, "x-yang-path": "/ciscoIpMRouteHeartBeatEntry={ciscoIpMRouteHeartBeatGroupAddr}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ciscoIpMRouteHeartBeatGroupAddr" ] } }, "components": { "schemas": { "CISCO-IPMROUTE-MIB_CISCO-IPMROUTE-MIB": { "type": "object", "description": "Maintains a count of the number of entries in the\n ipMRouteTable.", "properties": { "ciscoIpMRouteHeartBeatEntry": { "type": "array", "description": "An entry (conceptual row) representing a set of IP\n Multicast heartbeat parameters.", "items": { "type": "object", "properties": { "ciscoIpMRouteHeartBeatGroupAddr": { "type": "string", "description": "Multicast group address used to receive heartbeat\n packets.", "format": "inet:ipv4-address", "readOnly": true }, "ciscoIpMRouteHeartBeatSourceAddr": { "type": "string", "description": "Source address of the last multicast heartbeat packet\n received.", "format": "inet:ipv4-address", "readOnly": true }, "ciscoIpMRouteHeartBeatInterval": { "type": "integer", "description": "Number of seconds in which a Cisco multicast router\n expects a valid heartBeat packet from a source. This\n value must be a multiple of 10.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoIpMRouteHeartBeatWindowSize": { "type": "integer", "description": "Number of ciscoIpMRouteHeartBeatInterval intervals a\n Cisco multicast router waits before checking if expected\n number of heartbeat packets are received or not.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoIpMRouteHeartBeatCount": { "type": "integer", "description": "Number of time intervals where multicast packets were\n received in the last ciscoIpMRouteHeartBeatWindowSize\n intervals.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoIpMRouteHeartBeatMinimum": { "type": "integer", "description": "The minimal number of heartbeat packets expected in the\n last ciscoIpMRouteHeartBeatWindowSize intervals. If\n ciscoIpMRouteHeartBeatCount falls below this value, an\n SNMP trap/notification, if configured, will be sent to the\n NMS.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoIpMRouteHeartBeatAlertTime": { "type": "string", "description": "The value of sysUpTime on the most recent occasion at\n which a missing IP multicast heartbeat condition occured\n for the group address specified in this entry. If no such\n condition have occurred since the last re-initialization\n of the local management subsystem, then this object\n contains a zero value.", "x-yang-type": "yang:timestamp", "readOnly": true }, "ciscoIpMRouteHeartBeatStatus": { "type": "string", "description": "This object is used to create a new row or delete an\n existing row in this table.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "ciscoIpMRoute": { "type": "object", "description": "Maintains a count of the number of entries in the\n ipMRouteTable.", "properties": { "ciscoIpMRouteNumberOfEntries": { "type": "integer", "description": "Maintains a count of the number of entries in the\n ipMRouteTable.", "minimum": 0, "maximum": 4294967295, "readOnly": true } }, "readOnly": true }, "ciscoIpMRouteHeartBeatTable": { "type": "object", "description": "The (conceptual) table listing sets of IP Multicast\n heartbeat parameters. If no IP Multicast heartbeat is\n configured, this table would be empty.", "properties": { "ciscoIpMRouteHeartBeatEntry": { "type": "array", "description": "An entry (conceptual row) representing a set of IP\n Multicast heartbeat parameters.", "items": { "type": "object", "properties": { "ciscoIpMRouteHeartBeatGroupAddr": { "type": "string", "description": "Multicast group address used to receive heartbeat\n packets.", "format": "inet:ipv4-address", "readOnly": true }, "ciscoIpMRouteHeartBeatSourceAddr": { "type": "string", "description": "Source address of the last multicast heartbeat packet\n received.", "format": "inet:ipv4-address", "readOnly": true }, "ciscoIpMRouteHeartBeatInterval": { "type": "integer", "description": "Number of seconds in which a Cisco multicast router\n expects a valid heartBeat packet from a source. This\n value must be a multiple of 10.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoIpMRouteHeartBeatWindowSize": { "type": "integer", "description": "Number of ciscoIpMRouteHeartBeatInterval intervals a\n Cisco multicast router waits before checking if expected\n number of heartbeat packets are received or not.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoIpMRouteHeartBeatCount": { "type": "integer", "description": "Number of time intervals where multicast packets were\n received in the last ciscoIpMRouteHeartBeatWindowSize\n intervals.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoIpMRouteHeartBeatMinimum": { "type": "integer", "description": "The minimal number of heartbeat packets expected in the\n last ciscoIpMRouteHeartBeatWindowSize intervals. If\n ciscoIpMRouteHeartBeatCount falls below this value, an\n SNMP trap/notification, if configured, will be sent to the\n NMS.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoIpMRouteHeartBeatAlertTime": { "type": "string", "description": "The value of sysUpTime on the most recent occasion at\n which a missing IP multicast heartbeat condition occured\n for the group address specified in this entry. If no such\n condition have occurred since the last re-initialization\n of the local management subsystem, then this object\n contains a zero value.", "x-yang-type": "yang:timestamp", "readOnly": true }, "ciscoIpMRouteHeartBeatStatus": { "type": "string", "description": "This object is used to create a new row or delete an\n existing row in this table.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "CISCO-IPMROUTE-MIB_object-1": { "type": "object", "description": "object-1", "properties": { "ciscoIpMRouteHeartBeatGroupAddr": { "type": "string", "description": "ciscoIpMRouteHeartBeatGroupAddr", "x-yang-type": "leafref", "readOnly": true }, "ciscoIpMRouteHeartBeatSourceAddr": { "type": "string", "description": "ciscoIpMRouteHeartBeatSourceAddr", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-IPMROUTE-MIB_object-2": { "type": "object", "description": "object-2", "properties": { "ciscoIpMRouteHeartBeatGroupAddr": { "type": "string", "description": "ciscoIpMRouteHeartBeatGroupAddr", "x-yang-type": "leafref", "readOnly": true }, "ciscoIpMRouteHeartBeatInterval": { "type": "string", "description": "ciscoIpMRouteHeartBeatInterval", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-IPMROUTE-MIB_object-3": { "type": "object", "description": "object-3", "properties": { "ciscoIpMRouteHeartBeatGroupAddr": { "type": "string", "description": "ciscoIpMRouteHeartBeatGroupAddr", "x-yang-type": "leafref", "readOnly": true }, "ciscoIpMRouteHeartBeatWindowSize": { "type": "string", "description": "ciscoIpMRouteHeartBeatWindowSize", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-IPMROUTE-MIB_object-4": { "type": "object", "description": "object-4", "properties": { "ciscoIpMRouteHeartBeatGroupAddr": { "type": "string", "description": "ciscoIpMRouteHeartBeatGroupAddr", "x-yang-type": "leafref", "readOnly": true }, "ciscoIpMRouteHeartBeatCount": { "type": "string", "description": "ciscoIpMRouteHeartBeatCount", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-IPMROUTE-MIB_ciscoIpMRouteHeartBeatEntry": { "type": "array", "description": "An entry (conceptual row) representing a set of IP\n Multicast heartbeat parameters.", "items": { "type": "object", "properties": { "ciscoIpMRouteHeartBeatGroupAddr": { "type": "string", "description": "Multicast group address used to receive heartbeat\n packets.", "format": "inet:ipv4-address", "readOnly": true }, "ciscoIpMRouteHeartBeatSourceAddr": { "type": "string", "description": "Source address of the last multicast heartbeat packet\n received.", "format": "inet:ipv4-address", "readOnly": true }, "ciscoIpMRouteHeartBeatInterval": { "type": "integer", "description": "Number of seconds in which a Cisco multicast router\n expects a valid heartBeat packet from a source. This\n value must be a multiple of 10.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoIpMRouteHeartBeatWindowSize": { "type": "integer", "description": "Number of ciscoIpMRouteHeartBeatInterval intervals a\n Cisco multicast router waits before checking if expected\n number of heartbeat packets are received or not.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoIpMRouteHeartBeatCount": { "type": "integer", "description": "Number of time intervals where multicast packets were\n received in the last ciscoIpMRouteHeartBeatWindowSize\n intervals.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoIpMRouteHeartBeatMinimum": { "type": "integer", "description": "The minimal number of heartbeat packets expected in the\n last ciscoIpMRouteHeartBeatWindowSize intervals. If\n ciscoIpMRouteHeartBeatCount falls below this value, an\n SNMP trap/notification, if configured, will be sent to the\n NMS.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoIpMRouteHeartBeatAlertTime": { "type": "string", "description": "The value of sysUpTime on the most recent occasion at\n which a missing IP multicast heartbeat condition occured\n for the group address specified in this entry. If no such\n condition have occurred since the last re-initialization\n of the local management subsystem, then this object\n contains a zero value.", "x-yang-type": "yang:timestamp", "readOnly": true }, "ciscoIpMRouteHeartBeatStatus": { "type": "string", "description": "This object is used to create a new row or delete an\n existing row in this table.", "x-yang-type": "snmpv2-tc:RowStatus", "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-IPMROUTE-MIB", "description": "MIB operations for CISCO-IPMROUTE-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }