{ "openapi": "3.0.0", "info": { "title": "IPMROUTE-STD-MIB MIB API", "version": "1.0.0", "description": "The MIB module for management of IP Multicast routing, but\n independent of the specific multicast routing protocol in\n 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 IPMROUTE-STD-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/IPMROUTE-STD-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "IPMROUTE-STD-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/IPMROUTE-STD-MIB:ipMRoute": { "get": { "summary": "Get ipMRoute data", "description": "Retrieve ipMRoute operational data from MIB", "tags": [ "IPMROUTE-STD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The enabled status of IP Multicast routing on this router.", "properties": { "ipMRouteEnable": { "type": "string", "description": "The enabled status of IP Multicast routing on this router." }, "ipMRouteEntryCount": { "type": "integer", "description": "The number of rows in the ipMRouteTable. This can be used\n to monitor the multicast routing table size.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "IPMROUTE-STD-MIB:ipMRoute": { "ipMRouteEnable": "192.168.1.1", "ipMRouteEntryCount": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipMRoute", "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": "/ipMRoute", "x-restconf-kind": "container" }, "/data/IPMROUTE-STD-MIB:ipMRouteTable": { "get": { "summary": "Get ipMRouteTable data", "description": "Retrieve ipMRouteTable operational data from MIB", "tags": [ "IPMROUTE-STD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The (conceptual) table containing multicast routing\n information for IP datagrams sent by particular sources to\n the IP multicast groups known to this router.", "properties": { "ipMRouteEntry": { "type": "array", "description": "An entry (conceptual row) containing the multicast routing\n information for IP datagrams from a particular source and\n addressed to a particular IP multicast group address.\n Discontinuities in counters in this entry can be detected by\n observing the value of ipMRouteUpTime.", "items": { "type": "object", "properties": { "ipMRouteGroup": { "type": "string", "description": "The IP multicast group address for which this entry\n contains multicast routing information.", "format": "inet:ipv4-address" }, "ipMRouteSource": { "type": "string", "description": "The network address which when combined with the\n corresponding value of ipMRouteSourceMask identifies the\n sources for which this entry contains multicast routing\n information.", "format": "inet:ipv4-address" }, "ipMRouteSourceMask": { "type": "string", "description": "The network mask which when combined with the corresponding\n value of ipMRouteSource identifies the sources for which\n this entry contains multicast routing information.", "format": "inet:ipv4-address" }, "ipMRouteUpstreamNeighbor": { "type": "string", "description": "The address of the upstream neighbor (e.g., RPF neighbor)\n from which IP datagrams from these sources to this multicast\n address are received, or 0.0.0.0 if the upstream neighbor is\n unknown (e.g., in CBT).", "format": "inet:ipv4-address" }, "ipMRouteInIfIndex": { "type": "string", "description": "The value of ifIndex for the interface on which IP\n datagrams sent by these sources to this multicast address\n are received. A value of 0 indicates that datagrams are not\n subject to an incoming interface check, but may be accepted\n on multiple interfaces (e.g., in CBT).", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "ipMRouteUpTime": { "type": "string", "description": "The time since the multicast routing information\n represented by this entry was learned by the router.", "x-yang-type": "yang:timeticks" }, "ipMRouteExpiryTime": { "type": "string", "description": "The minimum amount of time remaining before this entry will\n be aged out. The value 0 indicates that the entry is not\n subject to aging.", "x-yang-type": "yang:timeticks" }, "ipMRoutePkts": { "type": "integer", "description": "The number of packets which this router has received from\n these sources and addressed to this multicast group\n address.", "minimum": 0, "maximum": 4294967295 }, "ipMRouteDifferentInIfPackets": { "type": "integer", "description": "The number of packets which this router has received from\n these sources and addressed to this multicast group address,\n which were dropped because they were not received on the\n interface indicated by ipMRouteInIfIndex. Packets which are\n not subject to an incoming interface check (e.g., using CBT)\n are not counted.", "minimum": 0, "maximum": 4294967295 }, "ipMRouteOctets": { "type": "integer", "description": "The number of octets contained in IP datagrams which were\n received from these sources and addressed to this multicast\n group address, and which were forwarded by this router.", "minimum": 0, "maximum": 4294967295 }, "ipMRouteProtocol": { "type": "string", "description": "The multicast routing protocol via which this multicast\n forwarding entry was learned.", "x-yang-type": "iana-rtproto:IANAipMRouteProtocol" }, "ipMRouteRtProto": { "type": "string", "description": "The routing mechanism via which the route used to find the\n upstream or parent interface for this multicast forwarding\n entry was learned. Inclusion of values for routing\n protocols is not intended to imply that those protocols need\n be supported.", "x-yang-type": "iana-rtproto:IANAipRouteProtocol" }, "ipMRouteRtAddress": { "type": "string", "description": "The address portion of the route used to find the upstream\n or parent interface for this multicast forwarding entry.", "format": "inet:ipv4-address" }, "ipMRouteRtMask": { "type": "string", "description": "The mask associated with the route used to find the upstream\n or parent interface for this multicast forwarding entry.", "format": "inet:ipv4-address" }, "ipMRouteRtType": { "type": "string", "description": "The reason the given route was placed in the (logical)\n multicast Routing Information Base (RIB). A value of\n unicast means that the route would normally be placed only\n in the unicast RIB, but was placed in the multicast RIB\n (instead or in addition) due to local configuration, such as\n when running PIM over RIP. A value of multicast means that\n \n \n \n \n \n the route was explicitly added to the multicast RIB by the\n routing protocol, such as DVMRP or Multiprotocol BGP." }, "ipMRouteHCOctets": { "type": "integer", "description": "The number of octets contained in IP datagrams which were\n received from these sources and addressed to this multicast\n group address, and which were forwarded by this router.\n This object is a 64-bit version of ipMRouteOctets.", "minimum": 0 } } } } } }, "example": { "IPMROUTE-STD-MIB:ipMRouteTable": { "ipMRouteEntry": [ { "ipMRouteGroup": "192.168.1.1", "ipMRouteSource": "192.168.1.1", "ipMRouteSourceMask": "192.168.1.1", "ipMRouteUpstreamNeighbor": "192.168.1.1", "ipMRouteInIfIndex": "1", "ipMRouteUpTime": "192.168.1.1", "ipMRouteExpiryTime": "192.168.1.1", "ipMRoutePkts": 0, "ipMRouteDifferentInIfPackets": 1234567890, "ipMRouteOctets": 1234567890, "ipMRouteProtocol": "192.168.1.1", "ipMRouteRtProto": "192.168.1.1", "ipMRouteRtAddress": "192.168.1.1", "ipMRouteRtMask": "192.168.1.1", "ipMRouteRtType": "192.168.1.1", "ipMRouteHCOctets": 1234567890 }, { "ipMRouteGroup": "192.168.1.1", "ipMRouteSource": "192.168.1.1", "ipMRouteSourceMask": "192.168.1.1", "ipMRouteUpstreamNeighbor": "192.168.1.1", "ipMRouteInIfIndex": "2", "ipMRouteUpTime": "192.168.1.1", "ipMRouteExpiryTime": "192.168.1.1", "ipMRoutePkts": 0, "ipMRouteDifferentInIfPackets": 1234567890, "ipMRouteOctets": 1234567890, "ipMRouteProtocol": "192.168.1.1", "ipMRouteRtProto": "192.168.1.1", "ipMRouteRtAddress": "192.168.1.1", "ipMRouteRtMask": "192.168.1.1", "ipMRouteRtType": "192.168.1.1", "ipMRouteHCOctets": 1234567890 }, { "ipMRouteGroup": "192.168.1.1", "ipMRouteSource": "192.168.1.1", "ipMRouteSourceMask": "192.168.1.1", "ipMRouteUpstreamNeighbor": "192.168.1.1", "ipMRouteInIfIndex": "3", "ipMRouteUpTime": "192.168.1.1", "ipMRouteExpiryTime": "192.168.1.1", "ipMRoutePkts": 0, "ipMRouteDifferentInIfPackets": 1234567890, "ipMRouteOctets": 1234567890, "ipMRouteProtocol": "192.168.1.1", "ipMRouteRtProto": "192.168.1.1", "ipMRouteRtAddress": "192.168.1.1", "ipMRouteRtMask": "192.168.1.1", "ipMRouteRtType": "192.168.1.1", "ipMRouteHCOctets": 1234567890 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipMRouteTable", "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": "/ipMRouteTable", "x-restconf-kind": "container" }, "/data/IPMROUTE-STD-MIB:ipMRouteTable/ipMRouteEntry": { "get": { "summary": "Get ipMRouteEntry list", "description": "Retrieve list of ipMRouteEntry entries from MIB", "tags": [ "IPMROUTE-STD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) containing the multicast routing\n information for IP datagrams from a particular source and\n addressed to a particular IP multicast group address.\n Discontinuities in counters in this entry can be detected by\n observing the value of ipMRouteUpTime.", "items": { "type": "object", "properties": { "ipMRouteGroup": { "type": "string", "description": "The IP multicast group address for which this entry\n contains multicast routing information.", "format": "inet:ipv4-address" }, "ipMRouteSource": { "type": "string", "description": "The network address which when combined with the\n corresponding value of ipMRouteSourceMask identifies the\n sources for which this entry contains multicast routing\n information.", "format": "inet:ipv4-address" }, "ipMRouteSourceMask": { "type": "string", "description": "The network mask which when combined with the corresponding\n value of ipMRouteSource identifies the sources for which\n this entry contains multicast routing information.", "format": "inet:ipv4-address" }, "ipMRouteUpstreamNeighbor": { "type": "string", "description": "The address of the upstream neighbor (e.g., RPF neighbor)\n from which IP datagrams from these sources to this multicast\n address are received, or 0.0.0.0 if the upstream neighbor is\n unknown (e.g., in CBT).", "format": "inet:ipv4-address" }, "ipMRouteInIfIndex": { "type": "string", "description": "The value of ifIndex for the interface on which IP\n datagrams sent by these sources to this multicast address\n are received. A value of 0 indicates that datagrams are not\n subject to an incoming interface check, but may be accepted\n on multiple interfaces (e.g., in CBT).", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "ipMRouteUpTime": { "type": "string", "description": "The time since the multicast routing information\n represented by this entry was learned by the router.", "x-yang-type": "yang:timeticks" }, "ipMRouteExpiryTime": { "type": "string", "description": "The minimum amount of time remaining before this entry will\n be aged out. The value 0 indicates that the entry is not\n subject to aging.", "x-yang-type": "yang:timeticks" }, "ipMRoutePkts": { "type": "integer", "description": "The number of packets which this router has received from\n these sources and addressed to this multicast group\n address.", "minimum": 0, "maximum": 4294967295 }, "ipMRouteDifferentInIfPackets": { "type": "integer", "description": "The number of packets which this router has received from\n these sources and addressed to this multicast group address,\n which were dropped because they were not received on the\n interface indicated by ipMRouteInIfIndex. Packets which are\n not subject to an incoming interface check (e.g., using CBT)\n are not counted.", "minimum": 0, "maximum": 4294967295 }, "ipMRouteOctets": { "type": "integer", "description": "The number of octets contained in IP datagrams which were\n received from these sources and addressed to this multicast\n group address, and which were forwarded by this router.", "minimum": 0, "maximum": 4294967295 }, "ipMRouteProtocol": { "type": "string", "description": "The multicast routing protocol via which this multicast\n forwarding entry was learned.", "x-yang-type": "iana-rtproto:IANAipMRouteProtocol" }, "ipMRouteRtProto": { "type": "string", "description": "The routing mechanism via which the route used to find the\n upstream or parent interface for this multicast forwarding\n entry was learned. Inclusion of values for routing\n protocols is not intended to imply that those protocols need\n be supported.", "x-yang-type": "iana-rtproto:IANAipRouteProtocol" }, "ipMRouteRtAddress": { "type": "string", "description": "The address portion of the route used to find the upstream\n or parent interface for this multicast forwarding entry.", "format": "inet:ipv4-address" }, "ipMRouteRtMask": { "type": "string", "description": "The mask associated with the route used to find the upstream\n or parent interface for this multicast forwarding entry.", "format": "inet:ipv4-address" }, "ipMRouteRtType": { "type": "string", "description": "The reason the given route was placed in the (logical)\n multicast Routing Information Base (RIB). A value of\n unicast means that the route would normally be placed only\n in the unicast RIB, but was placed in the multicast RIB\n (instead or in addition) due to local configuration, such as\n when running PIM over RIP. A value of multicast means that\n \n \n \n \n \n the route was explicitly added to the multicast RIB by the\n routing protocol, such as DVMRP or Multiprotocol BGP." }, "ipMRouteHCOctets": { "type": "integer", "description": "The number of octets contained in IP datagrams which were\n received from these sources and addressed to this multicast\n group address, and which were forwarded by this router.\n This object is a 64-bit version of ipMRouteOctets.", "minimum": 0 } } } }, "example": { "IPMROUTE-STD-MIB:ipMRouteEntry": [ { "ipMRouteGroup": "192.168.1.1", "ipMRouteSource": "192.168.1.1", "ipMRouteSourceMask": "192.168.1.1", "ipMRouteUpstreamNeighbor": "192.168.1.1", "ipMRouteInIfIndex": "192.168.1.1", "ipMRouteUpTime": "192.168.1.1", "ipMRouteExpiryTime": "192.168.1.1", "ipMRoutePkts": 0, "ipMRouteDifferentInIfPackets": 1234567890, "ipMRouteOctets": 1234567890, "ipMRouteProtocol": "192.168.1.1", "ipMRouteRtProto": "192.168.1.1", "ipMRouteRtAddress": "192.168.1.1", "ipMRouteRtMask": "192.168.1.1", "ipMRouteRtType": "192.168.1.1", "ipMRouteHCOctets": 1234567890 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipMRouteEntry", "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": "/ipMRouteTable/ipMRouteEntry", "x-restconf-kind": "container" }, "/data/IPMROUTE-STD-MIB:ipMRouteNextHopTable": { "get": { "summary": "Get ipMRouteNextHopTable data", "description": "Retrieve ipMRouteNextHopTable operational data from MIB", "tags": [ "IPMROUTE-STD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The (conceptual) table containing information on the next-\n hops on outgoing interfaces for routing IP multicast\n datagrams. Each entry is one of a list of next-hops on\n outgoing interfaces for particular sources sending to a\n particular multicast group address.", "properties": { "ipMRouteNextHopEntry": { "type": "array", "description": "An entry (conceptual row) in the list of next-hops on\n outgoing interfaces to which IP multicast datagrams from\n particular sources to a IP multicast group address are\n routed. Discontinuities in counters in this entry can be\n detected by observing the value of ipMRouteUpTime.", "items": { "type": "object", "properties": { "ipMRouteNextHopGroup": { "type": "string", "description": "The IP multicast group for which this entry specifies a\n next-hop on an outgoing interface.", "format": "inet:ipv4-address" }, "ipMRouteNextHopSource": { "type": "string", "description": "The network address which when combined with the\n corresponding value of ipMRouteNextHopSourceMask identifies\n the sources for which this entry specifies a next-hop on an\n outgoing interface.", "format": "inet:ipv4-address" }, "ipMRouteNextHopSourceMask": { "type": "string", "description": "The network mask which when combined with the corresponding\n value of ipMRouteNextHopSource identifies the sources for\n which this entry specifies a next-hop on an outgoing\n interface.", "format": "inet:ipv4-address" }, "ipMRouteNextHopIfIndex": { "type": "string", "description": "The ifIndex value of the interface for the outgoing\n interface for this next-hop.", "x-yang-type": "if-mib:InterfaceIndex" }, "ipMRouteNextHopAddress": { "type": "string", "description": "The address of the next-hop specific to this entry. For\n most interfaces, this is identical to ipMRouteNextHopGroup.\n NBMA interfaces, however, may have multiple next-hop\n addresses out a single outgoing interface.", "format": "inet:ipv4-address" }, "ipMRouteNextHopState": { "type": "string", "description": "An indication of whether the outgoing interface and next-\n hop represented by this entry is currently being used to\n forward IP datagrams. The value 'forwarding' indicates it\n is currently being used; the value 'pruned' indicates it is\n not." }, "ipMRouteNextHopUpTime": { "type": "string", "description": "The time since the multicast routing information\n represented by this entry was learned by the router.", "x-yang-type": "yang:timeticks" }, "ipMRouteNextHopExpiryTime": { "type": "string", "description": "The minimum amount of time remaining before this entry will\n be aged out. If ipMRouteNextHopState is pruned(1), the\n remaining time until the prune expires and the state reverts\n to forwarding(2). Otherwise, the remaining time until this\n entry is removed from the table. The time remaining may be\n copied from ipMRouteExpiryTime if the protocol in use for\n this entry does not specify next-hop timers. The value 0\n \n \n \n \n \n indicates that the entry is not subject to aging.", "x-yang-type": "yang:timeticks" }, "ipMRouteNextHopClosestMemberHops": { "type": "integer", "description": "The minimum number of hops between this router and any\n member of this IP multicast group reached via this next-hop\n on this outgoing interface. Any IP multicast datagrams for\n the group which have a TTL less than this number of hops\n will not be forwarded to this next-hop.", "minimum": -2147483648, "maximum": 2147483647 }, "ipMRouteNextHopProtocol": { "type": "string", "description": "The routing mechanism via which this next-hop was learned.", "x-yang-type": "iana-rtproto:IANAipMRouteProtocol" }, "ipMRouteNextHopPkts": { "type": "integer", "description": "The number of packets which have been forwarded using this\n route.", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "IPMROUTE-STD-MIB:ipMRouteNextHopTable": { "ipMRouteNextHopEntry": [ { "ipMRouteNextHopGroup": "192.168.1.1", "ipMRouteNextHopSource": "192.168.1.1", "ipMRouteNextHopSourceMask": "192.168.1.1", "ipMRouteNextHopIfIndex": "1", "ipMRouteNextHopAddress": "192.168.1.1", "ipMRouteNextHopState": "192.168.1.1", "ipMRouteNextHopUpTime": "192.168.1.1", "ipMRouteNextHopExpiryTime": "192.168.1.1", "ipMRouteNextHopClosestMemberHops": -2147483648, "ipMRouteNextHopProtocol": "192.168.1.1", "ipMRouteNextHopPkts": 0 }, { "ipMRouteNextHopGroup": "192.168.1.1", "ipMRouteNextHopSource": "192.168.1.1", "ipMRouteNextHopSourceMask": "192.168.1.1", "ipMRouteNextHopIfIndex": "2", "ipMRouteNextHopAddress": "192.168.1.1", "ipMRouteNextHopState": "192.168.1.1", "ipMRouteNextHopUpTime": "192.168.1.1", "ipMRouteNextHopExpiryTime": "192.168.1.1", "ipMRouteNextHopClosestMemberHops": -2147483648, "ipMRouteNextHopProtocol": "192.168.1.1", "ipMRouteNextHopPkts": 0 }, { "ipMRouteNextHopGroup": "192.168.1.1", "ipMRouteNextHopSource": "192.168.1.1", "ipMRouteNextHopSourceMask": "192.168.1.1", "ipMRouteNextHopIfIndex": "3", "ipMRouteNextHopAddress": "192.168.1.1", "ipMRouteNextHopState": "192.168.1.1", "ipMRouteNextHopUpTime": "192.168.1.1", "ipMRouteNextHopExpiryTime": "192.168.1.1", "ipMRouteNextHopClosestMemberHops": -2147483648, "ipMRouteNextHopProtocol": "192.168.1.1", "ipMRouteNextHopPkts": 0 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipMRouteNextHopTable", "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": "/ipMRouteNextHopTable", "x-restconf-kind": "container" }, "/data/IPMROUTE-STD-MIB:ipMRouteNextHopTable/ipMRouteNextHopEntry": { "get": { "summary": "Get ipMRouteNextHopEntry list", "description": "Retrieve list of ipMRouteNextHopEntry entries from MIB", "tags": [ "IPMROUTE-STD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) in the list of next-hops on\n outgoing interfaces to which IP multicast datagrams from\n particular sources to a IP multicast group address are\n routed. Discontinuities in counters in this entry can be\n detected by observing the value of ipMRouteUpTime.", "items": { "type": "object", "properties": { "ipMRouteNextHopGroup": { "type": "string", "description": "The IP multicast group for which this entry specifies a\n next-hop on an outgoing interface.", "format": "inet:ipv4-address" }, "ipMRouteNextHopSource": { "type": "string", "description": "The network address which when combined with the\n corresponding value of ipMRouteNextHopSourceMask identifies\n the sources for which this entry specifies a next-hop on an\n outgoing interface.", "format": "inet:ipv4-address" }, "ipMRouteNextHopSourceMask": { "type": "string", "description": "The network mask which when combined with the corresponding\n value of ipMRouteNextHopSource identifies the sources for\n which this entry specifies a next-hop on an outgoing\n interface.", "format": "inet:ipv4-address" }, "ipMRouteNextHopIfIndex": { "type": "string", "description": "The ifIndex value of the interface for the outgoing\n interface for this next-hop.", "x-yang-type": "if-mib:InterfaceIndex" }, "ipMRouteNextHopAddress": { "type": "string", "description": "The address of the next-hop specific to this entry. For\n most interfaces, this is identical to ipMRouteNextHopGroup.\n NBMA interfaces, however, may have multiple next-hop\n addresses out a single outgoing interface.", "format": "inet:ipv4-address" }, "ipMRouteNextHopState": { "type": "string", "description": "An indication of whether the outgoing interface and next-\n hop represented by this entry is currently being used to\n forward IP datagrams. The value 'forwarding' indicates it\n is currently being used; the value 'pruned' indicates it is\n not." }, "ipMRouteNextHopUpTime": { "type": "string", "description": "The time since the multicast routing information\n represented by this entry was learned by the router.", "x-yang-type": "yang:timeticks" }, "ipMRouteNextHopExpiryTime": { "type": "string", "description": "The minimum amount of time remaining before this entry will\n be aged out. If ipMRouteNextHopState is pruned(1), the\n remaining time until the prune expires and the state reverts\n to forwarding(2). Otherwise, the remaining time until this\n entry is removed from the table. The time remaining may be\n copied from ipMRouteExpiryTime if the protocol in use for\n this entry does not specify next-hop timers. The value 0\n \n \n \n \n \n indicates that the entry is not subject to aging.", "x-yang-type": "yang:timeticks" }, "ipMRouteNextHopClosestMemberHops": { "type": "integer", "description": "The minimum number of hops between this router and any\n member of this IP multicast group reached via this next-hop\n on this outgoing interface. Any IP multicast datagrams for\n the group which have a TTL less than this number of hops\n will not be forwarded to this next-hop.", "minimum": -2147483648, "maximum": 2147483647 }, "ipMRouteNextHopProtocol": { "type": "string", "description": "The routing mechanism via which this next-hop was learned.", "x-yang-type": "iana-rtproto:IANAipMRouteProtocol" }, "ipMRouteNextHopPkts": { "type": "integer", "description": "The number of packets which have been forwarded using this\n route.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "IPMROUTE-STD-MIB:ipMRouteNextHopEntry": [ { "ipMRouteNextHopGroup": "192.168.1.1", "ipMRouteNextHopSource": "192.168.1.1", "ipMRouteNextHopSourceMask": "192.168.1.1", "ipMRouteNextHopIfIndex": "192.168.1.1", "ipMRouteNextHopAddress": "192.168.1.1", "ipMRouteNextHopState": "192.168.1.1", "ipMRouteNextHopUpTime": "192.168.1.1", "ipMRouteNextHopExpiryTime": "192.168.1.1", "ipMRouteNextHopClosestMemberHops": -2147483648, "ipMRouteNextHopProtocol": "192.168.1.1", "ipMRouteNextHopPkts": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipMRouteNextHopEntry", "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": "/ipMRouteNextHopTable/ipMRouteNextHopEntry", "x-restconf-kind": "container" }, "/data/IPMROUTE-STD-MIB:ipMRouteInterfaceTable": { "get": { "summary": "Get ipMRouteInterfaceTable data", "description": "Retrieve ipMRouteInterfaceTable operational data from MIB", "tags": [ "IPMROUTE-STD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The (conceptual) table containing multicast routing\n information specific to interfaces.", "properties": { "ipMRouteInterfaceEntry": { "type": "array", "description": "An entry (conceptual row) containing the multicast routing\n information for a particular interface.", "items": { "type": "object", "properties": { "ipMRouteInterfaceIfIndex": { "type": "string", "description": "The ifIndex value of the interface for which this entry\n contains information.", "x-yang-type": "if-mib:InterfaceIndex" }, "ipMRouteInterfaceTtl": { "type": "integer", "description": "The datagram TTL threshold for the interface. Any IP\n multicast datagrams with a TTL less than this threshold will\n not be forwarded out the interface. The default value of 0\n means all multicast packets are forwarded out the\n interface.", "minimum": -2147483648, "maximum": 2147483647 }, "ipMRouteInterfaceProtocol": { "type": "string", "description": "The routing protocol running on this interface.", "x-yang-type": "iana-rtproto:IANAipMRouteProtocol" }, "ipMRouteInterfaceRateLimit": { "type": "integer", "description": "The rate-limit, in kilobits per second, of forwarded\n multicast traffic on the interface. A rate-limit of 0\n indicates that no rate limiting is done.", "minimum": -2147483648, "maximum": 2147483647 }, "ipMRouteInterfaceInMcastOctets": { "type": "integer", "description": "The number of octets of multicast packets that have arrived\n on the interface, including framing characters. This object\n is similar to ifInOctets in the Interfaces MIB, except that\n only multicast packets are counted.", "minimum": 0, "maximum": 4294967295 }, "ipMRouteInterfaceOutMcastOctets": { "type": "integer", "description": "The number of octets of multicast packets that have been\n sent on the interface.", "minimum": 0, "maximum": 4294967295 }, "ipMRouteInterfaceHCInMcastOctets": { "type": "integer", "description": "The number of octets of multicast packets that have arrived\n on the interface, including framing characters. This object\n is a 64-bit version of ipMRouteInterfaceInMcastOctets. It\n is similar to ifHCInOctets in the Interfaces MIB, except\n that only multicast packets are counted.", "minimum": 0 }, "ipMRouteInterfaceHCOutMcastOctets": { "type": "integer", "description": "The number of octets of multicast packets that have been\n \n \n \n \n \n sent on the interface. This object is a 64-bit version of\n ipMRouteInterfaceOutMcastOctets.", "minimum": 0 } } } } } }, "example": { "IPMROUTE-STD-MIB:ipMRouteInterfaceTable": { "ipMRouteInterfaceEntry": [ { "ipMRouteInterfaceIfIndex": "1", "ipMRouteInterfaceTtl": -2147483648, "ipMRouteInterfaceProtocol": "192.168.1.1", "ipMRouteInterfaceRateLimit": -2147483648, "ipMRouteInterfaceInMcastOctets": 1234567890, "ipMRouteInterfaceOutMcastOctets": 1234567890, "ipMRouteInterfaceHCInMcastOctets": 1234567890, "ipMRouteInterfaceHCOutMcastOctets": 1234567890 }, { "ipMRouteInterfaceIfIndex": "2", "ipMRouteInterfaceTtl": -2147483648, "ipMRouteInterfaceProtocol": "192.168.1.1", "ipMRouteInterfaceRateLimit": -2147483648, "ipMRouteInterfaceInMcastOctets": 1234567890, "ipMRouteInterfaceOutMcastOctets": 1234567890, "ipMRouteInterfaceHCInMcastOctets": 1234567890, "ipMRouteInterfaceHCOutMcastOctets": 1234567890 }, { "ipMRouteInterfaceIfIndex": "3", "ipMRouteInterfaceTtl": -2147483648, "ipMRouteInterfaceProtocol": "192.168.1.1", "ipMRouteInterfaceRateLimit": -2147483648, "ipMRouteInterfaceInMcastOctets": 1234567890, "ipMRouteInterfaceOutMcastOctets": 1234567890, "ipMRouteInterfaceHCInMcastOctets": 1234567890, "ipMRouteInterfaceHCOutMcastOctets": 1234567890 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipMRouteInterfaceTable", "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": "/ipMRouteInterfaceTable", "x-restconf-kind": "container" }, "/data/IPMROUTE-STD-MIB:ipMRouteInterfaceTable/ipMRouteInterfaceEntry": { "get": { "summary": "Get ipMRouteInterfaceEntry list", "description": "Retrieve list of ipMRouteInterfaceEntry entries from MIB", "tags": [ "IPMROUTE-STD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) containing the multicast routing\n information for a particular interface.", "items": { "type": "object", "properties": { "ipMRouteInterfaceIfIndex": { "type": "string", "description": "The ifIndex value of the interface for which this entry\n contains information.", "x-yang-type": "if-mib:InterfaceIndex" }, "ipMRouteInterfaceTtl": { "type": "integer", "description": "The datagram TTL threshold for the interface. Any IP\n multicast datagrams with a TTL less than this threshold will\n not be forwarded out the interface. The default value of 0\n means all multicast packets are forwarded out the\n interface.", "minimum": -2147483648, "maximum": 2147483647 }, "ipMRouteInterfaceProtocol": { "type": "string", "description": "The routing protocol running on this interface.", "x-yang-type": "iana-rtproto:IANAipMRouteProtocol" }, "ipMRouteInterfaceRateLimit": { "type": "integer", "description": "The rate-limit, in kilobits per second, of forwarded\n multicast traffic on the interface. A rate-limit of 0\n indicates that no rate limiting is done.", "minimum": -2147483648, "maximum": 2147483647 }, "ipMRouteInterfaceInMcastOctets": { "type": "integer", "description": "The number of octets of multicast packets that have arrived\n on the interface, including framing characters. This object\n is similar to ifInOctets in the Interfaces MIB, except that\n only multicast packets are counted.", "minimum": 0, "maximum": 4294967295 }, "ipMRouteInterfaceOutMcastOctets": { "type": "integer", "description": "The number of octets of multicast packets that have been\n sent on the interface.", "minimum": 0, "maximum": 4294967295 }, "ipMRouteInterfaceHCInMcastOctets": { "type": "integer", "description": "The number of octets of multicast packets that have arrived\n on the interface, including framing characters. This object\n is a 64-bit version of ipMRouteInterfaceInMcastOctets. It\n is similar to ifHCInOctets in the Interfaces MIB, except\n that only multicast packets are counted.", "minimum": 0 }, "ipMRouteInterfaceHCOutMcastOctets": { "type": "integer", "description": "The number of octets of multicast packets that have been\n \n \n \n \n \n sent on the interface. This object is a 64-bit version of\n ipMRouteInterfaceOutMcastOctets.", "minimum": 0 } } } }, "example": { "IPMROUTE-STD-MIB:ipMRouteInterfaceEntry": [ { "ipMRouteInterfaceIfIndex": "192.168.1.1", "ipMRouteInterfaceTtl": -2147483648, "ipMRouteInterfaceProtocol": "192.168.1.1", "ipMRouteInterfaceRateLimit": -2147483648, "ipMRouteInterfaceInMcastOctets": 1234567890, "ipMRouteInterfaceOutMcastOctets": 1234567890, "ipMRouteInterfaceHCInMcastOctets": 1234567890, "ipMRouteInterfaceHCOutMcastOctets": 1234567890 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipMRouteInterfaceEntry", "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": "/ipMRouteInterfaceTable/ipMRouteInterfaceEntry", "x-restconf-kind": "container" }, "/data/IPMROUTE-STD-MIB:ipMRouteInterfaceTable/ipMRouteInterfaceEntry={ipMRouteInterfaceIfIndex}": { "get": { "summary": "Get ipMRouteInterfaceEntry entry", "description": "Retrieve specific ipMRouteInterfaceEntry entry by key from MIB", "tags": [ "IPMROUTE-STD-MIB" ], "parameters": [ { "name": "ipMRouteInterfaceIfIndex", "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": { "ipMRouteInterfaceIfIndex": { "type": "string", "description": "The ifIndex value of the interface for which this entry\n contains information.", "x-yang-type": "if-mib:InterfaceIndex" }, "ipMRouteInterfaceTtl": { "type": "integer", "description": "The datagram TTL threshold for the interface. Any IP\n multicast datagrams with a TTL less than this threshold will\n not be forwarded out the interface. The default value of 0\n means all multicast packets are forwarded out the\n interface.", "minimum": -2147483648, "maximum": 2147483647 }, "ipMRouteInterfaceProtocol": { "type": "string", "description": "The routing protocol running on this interface.", "x-yang-type": "iana-rtproto:IANAipMRouteProtocol" }, "ipMRouteInterfaceRateLimit": { "type": "integer", "description": "The rate-limit, in kilobits per second, of forwarded\n multicast traffic on the interface. A rate-limit of 0\n indicates that no rate limiting is done.", "minimum": -2147483648, "maximum": 2147483647 }, "ipMRouteInterfaceInMcastOctets": { "type": "integer", "description": "The number of octets of multicast packets that have arrived\n on the interface, including framing characters. This object\n is similar to ifInOctets in the Interfaces MIB, except that\n only multicast packets are counted.", "minimum": 0, "maximum": 4294967295 }, "ipMRouteInterfaceOutMcastOctets": { "type": "integer", "description": "The number of octets of multicast packets that have been\n sent on the interface.", "minimum": 0, "maximum": 4294967295 }, "ipMRouteInterfaceHCInMcastOctets": { "type": "integer", "description": "The number of octets of multicast packets that have arrived\n on the interface, including framing characters. This object\n is a 64-bit version of ipMRouteInterfaceInMcastOctets. It\n is similar to ifHCInOctets in the Interfaces MIB, except\n that only multicast packets are counted.", "minimum": 0 }, "ipMRouteInterfaceHCOutMcastOctets": { "type": "integer", "description": "The number of octets of multicast packets that have been\n \n \n \n \n \n sent on the interface. This object is a 64-bit version of\n ipMRouteInterfaceOutMcastOctets.", "minimum": 0 } } }, "example": { "IPMROUTE-STD-MIB:ipMRouteInterfaceEntry": { "ipMRouteInterfaceIfIndex": "192.168.1.1", "ipMRouteInterfaceTtl": -2147483648, "ipMRouteInterfaceProtocol": "192.168.1.1", "ipMRouteInterfaceRateLimit": -2147483648, "ipMRouteInterfaceInMcastOctets": 1234567890, "ipMRouteInterfaceOutMcastOctets": 1234567890, "ipMRouteInterfaceHCInMcastOctets": 1234567890, "ipMRouteInterfaceHCOutMcastOctets": 1234567890 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipMRouteInterfaceEntry-2" }, "x-yang-path": "/ipMRouteInterfaceTable/ipMRouteInterfaceEntry={ipMRouteInterfaceIfIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ipMRouteInterfaceIfIndex" ] }, "/data/IPMROUTE-STD-MIB:ipMRouteBoundaryTable": { "get": { "summary": "Get ipMRouteBoundaryTable data", "description": "Retrieve ipMRouteBoundaryTable operational data from MIB", "tags": [ "IPMROUTE-STD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The (conceptual) table listing the router's scoped\n multicast address boundaries.", "properties": { "ipMRouteBoundaryEntry": { "type": "array", "description": "An entry (conceptual row) in the ipMRouteBoundaryTable\n representing a scoped boundary.", "items": { "type": "object", "properties": { "ipMRouteBoundaryIfIndex": { "type": "string", "description": "The IfIndex value for the interface to which this boundary\n applies. Packets with a destination address in the\n associated address/mask range will not be forwarded out this\n interface.", "x-yang-type": "if-mib:InterfaceIndex" }, "ipMRouteBoundaryAddress": { "type": "string", "description": "The group address which when combined with the\n corresponding value of ipMRouteBoundaryAddressMask\n identifies the group range for which the scoped boundary\n exists. Scoped addresses must come from the range 239.x.x.x\n as specified in RFC 2365.", "format": "inet:ipv4-address" }, "ipMRouteBoundaryAddressMask": { "type": "string", "description": "The group address mask which when combined with the\n corresponding value of ipMRouteBoundaryAddress identifies\n the group range for which the scoped boundary exists.", "format": "inet:ipv4-address" }, "ipMRouteBoundaryStatus": { "type": "string", "description": "The status of this row, by which new entries may be\n created, or old entries deleted from this table.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "IPMROUTE-STD-MIB:ipMRouteBoundaryTable": { "ipMRouteBoundaryEntry": [ { "ipMRouteBoundaryIfIndex": "1", "ipMRouteBoundaryAddress": "192.168.1.1", "ipMRouteBoundaryAddressMask": "192.168.1.1", "ipMRouteBoundaryStatus": "192.168.1.1" }, { "ipMRouteBoundaryIfIndex": "2", "ipMRouteBoundaryAddress": "192.168.1.1", "ipMRouteBoundaryAddressMask": "192.168.1.1", "ipMRouteBoundaryStatus": "192.168.1.1" }, { "ipMRouteBoundaryIfIndex": "3", "ipMRouteBoundaryAddress": "192.168.1.1", "ipMRouteBoundaryAddressMask": "192.168.1.1", "ipMRouteBoundaryStatus": "192.168.1.1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipMRouteBoundaryTable", "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": "/ipMRouteBoundaryTable", "x-restconf-kind": "container" }, "/data/IPMROUTE-STD-MIB:ipMRouteBoundaryTable/ipMRouteBoundaryEntry": { "get": { "summary": "Get ipMRouteBoundaryEntry list", "description": "Retrieve list of ipMRouteBoundaryEntry entries from MIB", "tags": [ "IPMROUTE-STD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) in the ipMRouteBoundaryTable\n representing a scoped boundary.", "items": { "type": "object", "properties": { "ipMRouteBoundaryIfIndex": { "type": "string", "description": "The IfIndex value for the interface to which this boundary\n applies. Packets with a destination address in the\n associated address/mask range will not be forwarded out this\n interface.", "x-yang-type": "if-mib:InterfaceIndex" }, "ipMRouteBoundaryAddress": { "type": "string", "description": "The group address which when combined with the\n corresponding value of ipMRouteBoundaryAddressMask\n identifies the group range for which the scoped boundary\n exists. Scoped addresses must come from the range 239.x.x.x\n as specified in RFC 2365.", "format": "inet:ipv4-address" }, "ipMRouteBoundaryAddressMask": { "type": "string", "description": "The group address mask which when combined with the\n corresponding value of ipMRouteBoundaryAddress identifies\n the group range for which the scoped boundary exists.", "format": "inet:ipv4-address" }, "ipMRouteBoundaryStatus": { "type": "string", "description": "The status of this row, by which new entries may be\n created, or old entries deleted from this table.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "IPMROUTE-STD-MIB:ipMRouteBoundaryEntry": [ { "ipMRouteBoundaryIfIndex": "192.168.1.1", "ipMRouteBoundaryAddress": "192.168.1.1", "ipMRouteBoundaryAddressMask": "192.168.1.1", "ipMRouteBoundaryStatus": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipMRouteBoundaryEntry", "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": "/ipMRouteBoundaryTable/ipMRouteBoundaryEntry", "x-restconf-kind": "container" }, "/data/IPMROUTE-STD-MIB:ipMRouteScopeNameTable": { "get": { "summary": "Get ipMRouteScopeNameTable data", "description": "Retrieve ipMRouteScopeNameTable operational data from MIB", "tags": [ "IPMROUTE-STD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The (conceptual) table listing the multicast scope names.", "properties": { "ipMRouteScopeNameEntry": { "type": "array", "description": "An entry (conceptual row) in the ipMRouteScopeNameTable\n representing a multicast scope name.", "items": { "type": "object", "properties": { "ipMRouteScopeNameAddress": { "type": "string", "description": "The group address which when combined with the\n corresponding value of ipMRouteScopeNameAddressMask\n identifies the group range associated with the multicast\n scope. Scoped addresses must come from the range\n 239.x.x.x.", "format": "inet:ipv4-address" }, "ipMRouteScopeNameAddressMask": { "type": "string", "description": "The group address mask which when combined with the\n corresponding value of ipMRouteScopeNameAddress identifies\n the group range associated with the multicast scope.", "format": "inet:ipv4-address" }, "ipMRouteScopeNameLanguage": { "type": "string", "description": "The RFC 1766-style language tag associated with the scope\n name.", "x-yang-type": "IPMROUTE-STD-MIB:LanguageTag" }, "ipMRouteScopeNameString": { "type": "string", "description": "The textual name associated with the multicast scope. The\n value of this object should be suitable for displaying to\n end-users, such as when allocating a multicast address in\n this scope. When no name is specified, the default value of\n this object should be the string 239.x.x.x/y with x and y\n replaced appropriately to describe the address and mask\n length associated with the scope.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "ipMRouteScopeNameDefault": { "type": "boolean", "description": "If true, indicates a preference that the name in the\n following language should be used by applications if no name\n is available in a desired language." }, "ipMRouteScopeNameStatus": { "type": "string", "description": "The status of this row, by which new entries may be\n created, or old entries deleted from this table.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "IPMROUTE-STD-MIB:ipMRouteScopeNameTable": { "ipMRouteScopeNameEntry": [ { "ipMRouteScopeNameAddress": "192.168.1.1", "ipMRouteScopeNameAddressMask": "192.168.1.1", "ipMRouteScopeNameLanguage": "192.168.1.1", "ipMRouteScopeNameString": "192.168.1.1", "ipMRouteScopeNameDefault": true, "ipMRouteScopeNameStatus": "192.168.1.1" }, { "ipMRouteScopeNameAddress": "192.168.1.1", "ipMRouteScopeNameAddressMask": "192.168.1.1", "ipMRouteScopeNameLanguage": "192.168.1.1", "ipMRouteScopeNameString": "192.168.1.1", "ipMRouteScopeNameDefault": true, "ipMRouteScopeNameStatus": "192.168.1.1" }, { "ipMRouteScopeNameAddress": "192.168.1.1", "ipMRouteScopeNameAddressMask": "192.168.1.1", "ipMRouteScopeNameLanguage": "192.168.1.1", "ipMRouteScopeNameString": "192.168.1.1", "ipMRouteScopeNameDefault": true, "ipMRouteScopeNameStatus": "192.168.1.1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipMRouteScopeNameTable", "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": "/ipMRouteScopeNameTable", "x-restconf-kind": "container" }, "/data/IPMROUTE-STD-MIB:ipMRouteScopeNameTable/ipMRouteScopeNameEntry": { "get": { "summary": "Get ipMRouteScopeNameEntry list", "description": "Retrieve list of ipMRouteScopeNameEntry entries from MIB", "tags": [ "IPMROUTE-STD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) in the ipMRouteScopeNameTable\n representing a multicast scope name.", "items": { "type": "object", "properties": { "ipMRouteScopeNameAddress": { "type": "string", "description": "The group address which when combined with the\n corresponding value of ipMRouteScopeNameAddressMask\n identifies the group range associated with the multicast\n scope. Scoped addresses must come from the range\n 239.x.x.x.", "format": "inet:ipv4-address" }, "ipMRouteScopeNameAddressMask": { "type": "string", "description": "The group address mask which when combined with the\n corresponding value of ipMRouteScopeNameAddress identifies\n the group range associated with the multicast scope.", "format": "inet:ipv4-address" }, "ipMRouteScopeNameLanguage": { "type": "string", "description": "The RFC 1766-style language tag associated with the scope\n name.", "x-yang-type": "IPMROUTE-STD-MIB:LanguageTag" }, "ipMRouteScopeNameString": { "type": "string", "description": "The textual name associated with the multicast scope. The\n value of this object should be suitable for displaying to\n end-users, such as when allocating a multicast address in\n this scope. When no name is specified, the default value of\n this object should be the string 239.x.x.x/y with x and y\n replaced appropriately to describe the address and mask\n length associated with the scope.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "ipMRouteScopeNameDefault": { "type": "boolean", "description": "If true, indicates a preference that the name in the\n following language should be used by applications if no name\n is available in a desired language." }, "ipMRouteScopeNameStatus": { "type": "string", "description": "The status of this row, by which new entries may be\n created, or old entries deleted from this table.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "IPMROUTE-STD-MIB:ipMRouteScopeNameEntry": [ { "ipMRouteScopeNameAddress": "192.168.1.1", "ipMRouteScopeNameAddressMask": "192.168.1.1", "ipMRouteScopeNameLanguage": "192.168.1.1", "ipMRouteScopeNameString": "192.168.1.1", "ipMRouteScopeNameDefault": true, "ipMRouteScopeNameStatus": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipMRouteScopeNameEntry", "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": "/ipMRouteScopeNameTable/ipMRouteScopeNameEntry", "x-restconf-kind": "container" }, "/data/IPMROUTE-STD-MIB:ipMRouteEntry": { "get": { "summary": "Get ipMRouteEntry list", "description": "Retrieve list of ipMRouteEntry entries from MIB", "tags": [ "IPMROUTE-STD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) containing the multicast routing\n information for IP datagrams from a particular source and\n addressed to a particular IP multicast group address.\n Discontinuities in counters in this entry can be detected by\n observing the value of ipMRouteUpTime.", "items": { "type": "object", "properties": { "ipMRouteGroup": { "type": "string", "description": "The IP multicast group address for which this entry\n contains multicast routing information.", "format": "inet:ipv4-address" }, "ipMRouteSource": { "type": "string", "description": "The network address which when combined with the\n corresponding value of ipMRouteSourceMask identifies the\n sources for which this entry contains multicast routing\n information.", "format": "inet:ipv4-address" }, "ipMRouteSourceMask": { "type": "string", "description": "The network mask which when combined with the corresponding\n value of ipMRouteSource identifies the sources for which\n this entry contains multicast routing information.", "format": "inet:ipv4-address" }, "ipMRouteUpstreamNeighbor": { "type": "string", "description": "The address of the upstream neighbor (e.g., RPF neighbor)\n from which IP datagrams from these sources to this multicast\n address are received, or 0.0.0.0 if the upstream neighbor is\n unknown (e.g., in CBT).", "format": "inet:ipv4-address" }, "ipMRouteInIfIndex": { "type": "string", "description": "The value of ifIndex for the interface on which IP\n datagrams sent by these sources to this multicast address\n are received. A value of 0 indicates that datagrams are not\n subject to an incoming interface check, but may be accepted\n on multiple interfaces (e.g., in CBT).", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "ipMRouteUpTime": { "type": "string", "description": "The time since the multicast routing information\n represented by this entry was learned by the router.", "x-yang-type": "yang:timeticks" }, "ipMRouteExpiryTime": { "type": "string", "description": "The minimum amount of time remaining before this entry will\n be aged out. The value 0 indicates that the entry is not\n subject to aging.", "x-yang-type": "yang:timeticks" }, "ipMRoutePkts": { "type": "integer", "description": "The number of packets which this router has received from\n these sources and addressed to this multicast group\n address.", "minimum": 0, "maximum": 4294967295 }, "ipMRouteDifferentInIfPackets": { "type": "integer", "description": "The number of packets which this router has received from\n these sources and addressed to this multicast group address,\n which were dropped because they were not received on the\n interface indicated by ipMRouteInIfIndex. Packets which are\n not subject to an incoming interface check (e.g., using CBT)\n are not counted.", "minimum": 0, "maximum": 4294967295 }, "ipMRouteOctets": { "type": "integer", "description": "The number of octets contained in IP datagrams which were\n received from these sources and addressed to this multicast\n group address, and which were forwarded by this router.", "minimum": 0, "maximum": 4294967295 }, "ipMRouteProtocol": { "type": "string", "description": "The multicast routing protocol via which this multicast\n forwarding entry was learned.", "x-yang-type": "iana-rtproto:IANAipMRouteProtocol" }, "ipMRouteRtProto": { "type": "string", "description": "The routing mechanism via which the route used to find the\n upstream or parent interface for this multicast forwarding\n entry was learned. Inclusion of values for routing\n protocols is not intended to imply that those protocols need\n be supported.", "x-yang-type": "iana-rtproto:IANAipRouteProtocol" }, "ipMRouteRtAddress": { "type": "string", "description": "The address portion of the route used to find the upstream\n or parent interface for this multicast forwarding entry.", "format": "inet:ipv4-address" }, "ipMRouteRtMask": { "type": "string", "description": "The mask associated with the route used to find the upstream\n or parent interface for this multicast forwarding entry.", "format": "inet:ipv4-address" }, "ipMRouteRtType": { "type": "string", "description": "The reason the given route was placed in the (logical)\n multicast Routing Information Base (RIB). A value of\n unicast means that the route would normally be placed only\n in the unicast RIB, but was placed in the multicast RIB\n (instead or in addition) due to local configuration, such as\n when running PIM over RIP. A value of multicast means that\n \n \n \n \n \n the route was explicitly added to the multicast RIB by the\n routing protocol, such as DVMRP or Multiprotocol BGP." }, "ipMRouteHCOctets": { "type": "integer", "description": "The number of octets contained in IP datagrams which were\n received from these sources and addressed to this multicast\n group address, and which were forwarded by this router.\n This object is a 64-bit version of ipMRouteOctets.", "minimum": 0 } } } }, "example": { "IPMROUTE-STD-MIB:ipMRouteEntry": [ { "ipMRouteGroup": "192.168.1.1", "ipMRouteSource": "192.168.1.1", "ipMRouteSourceMask": "192.168.1.1", "ipMRouteUpstreamNeighbor": "192.168.1.1", "ipMRouteInIfIndex": "192.168.1.1", "ipMRouteUpTime": "192.168.1.1", "ipMRouteExpiryTime": "192.168.1.1", "ipMRoutePkts": 0, "ipMRouteDifferentInIfPackets": 1234567890, "ipMRouteOctets": 1234567890, "ipMRouteProtocol": "192.168.1.1", "ipMRouteRtProto": "192.168.1.1", "ipMRouteRtAddress": "192.168.1.1", "ipMRouteRtMask": "192.168.1.1", "ipMRouteRtType": "192.168.1.1", "ipMRouteHCOctets": 1234567890 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipMRouteEntry-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": "/ipMRouteEntry", "x-restconf-kind": "container" }, "/data/IPMROUTE-STD-MIB:ipMRouteNextHopEntry": { "get": { "summary": "Get ipMRouteNextHopEntry list", "description": "Retrieve list of ipMRouteNextHopEntry entries from MIB", "tags": [ "IPMROUTE-STD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) in the list of next-hops on\n outgoing interfaces to which IP multicast datagrams from\n particular sources to a IP multicast group address are\n routed. Discontinuities in counters in this entry can be\n detected by observing the value of ipMRouteUpTime.", "items": { "type": "object", "properties": { "ipMRouteNextHopGroup": { "type": "string", "description": "The IP multicast group for which this entry specifies a\n next-hop on an outgoing interface.", "format": "inet:ipv4-address" }, "ipMRouteNextHopSource": { "type": "string", "description": "The network address which when combined with the\n corresponding value of ipMRouteNextHopSourceMask identifies\n the sources for which this entry specifies a next-hop on an\n outgoing interface.", "format": "inet:ipv4-address" }, "ipMRouteNextHopSourceMask": { "type": "string", "description": "The network mask which when combined with the corresponding\n value of ipMRouteNextHopSource identifies the sources for\n which this entry specifies a next-hop on an outgoing\n interface.", "format": "inet:ipv4-address" }, "ipMRouteNextHopIfIndex": { "type": "string", "description": "The ifIndex value of the interface for the outgoing\n interface for this next-hop.", "x-yang-type": "if-mib:InterfaceIndex" }, "ipMRouteNextHopAddress": { "type": "string", "description": "The address of the next-hop specific to this entry. For\n most interfaces, this is identical to ipMRouteNextHopGroup.\n NBMA interfaces, however, may have multiple next-hop\n addresses out a single outgoing interface.", "format": "inet:ipv4-address" }, "ipMRouteNextHopState": { "type": "string", "description": "An indication of whether the outgoing interface and next-\n hop represented by this entry is currently being used to\n forward IP datagrams. The value 'forwarding' indicates it\n is currently being used; the value 'pruned' indicates it is\n not." }, "ipMRouteNextHopUpTime": { "type": "string", "description": "The time since the multicast routing information\n represented by this entry was learned by the router.", "x-yang-type": "yang:timeticks" }, "ipMRouteNextHopExpiryTime": { "type": "string", "description": "The minimum amount of time remaining before this entry will\n be aged out. If ipMRouteNextHopState is pruned(1), the\n remaining time until the prune expires and the state reverts\n to forwarding(2). Otherwise, the remaining time until this\n entry is removed from the table. The time remaining may be\n copied from ipMRouteExpiryTime if the protocol in use for\n this entry does not specify next-hop timers. The value 0\n \n \n \n \n \n indicates that the entry is not subject to aging.", "x-yang-type": "yang:timeticks" }, "ipMRouteNextHopClosestMemberHops": { "type": "integer", "description": "The minimum number of hops between this router and any\n member of this IP multicast group reached via this next-hop\n on this outgoing interface. Any IP multicast datagrams for\n the group which have a TTL less than this number of hops\n will not be forwarded to this next-hop.", "minimum": -2147483648, "maximum": 2147483647 }, "ipMRouteNextHopProtocol": { "type": "string", "description": "The routing mechanism via which this next-hop was learned.", "x-yang-type": "iana-rtproto:IANAipMRouteProtocol" }, "ipMRouteNextHopPkts": { "type": "integer", "description": "The number of packets which have been forwarded using this\n route.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "IPMROUTE-STD-MIB:ipMRouteNextHopEntry": [ { "ipMRouteNextHopGroup": "192.168.1.1", "ipMRouteNextHopSource": "192.168.1.1", "ipMRouteNextHopSourceMask": "192.168.1.1", "ipMRouteNextHopIfIndex": "192.168.1.1", "ipMRouteNextHopAddress": "192.168.1.1", "ipMRouteNextHopState": "192.168.1.1", "ipMRouteNextHopUpTime": "192.168.1.1", "ipMRouteNextHopExpiryTime": "192.168.1.1", "ipMRouteNextHopClosestMemberHops": -2147483648, "ipMRouteNextHopProtocol": "192.168.1.1", "ipMRouteNextHopPkts": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipMRouteNextHopEntry-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": "/ipMRouteNextHopEntry", "x-restconf-kind": "container" }, "/data/IPMROUTE-STD-MIB:ipMRouteInterfaceEntry": { "get": { "summary": "Get ipMRouteInterfaceEntry list", "description": "Retrieve list of ipMRouteInterfaceEntry entries from MIB", "tags": [ "IPMROUTE-STD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) containing the multicast routing\n information for a particular interface.", "items": { "type": "object", "properties": { "ipMRouteInterfaceIfIndex": { "type": "string", "description": "The ifIndex value of the interface for which this entry\n contains information.", "x-yang-type": "if-mib:InterfaceIndex" }, "ipMRouteInterfaceTtl": { "type": "integer", "description": "The datagram TTL threshold for the interface. Any IP\n multicast datagrams with a TTL less than this threshold will\n not be forwarded out the interface. The default value of 0\n means all multicast packets are forwarded out the\n interface.", "minimum": -2147483648, "maximum": 2147483647 }, "ipMRouteInterfaceProtocol": { "type": "string", "description": "The routing protocol running on this interface.", "x-yang-type": "iana-rtproto:IANAipMRouteProtocol" }, "ipMRouteInterfaceRateLimit": { "type": "integer", "description": "The rate-limit, in kilobits per second, of forwarded\n multicast traffic on the interface. A rate-limit of 0\n indicates that no rate limiting is done.", "minimum": -2147483648, "maximum": 2147483647 }, "ipMRouteInterfaceInMcastOctets": { "type": "integer", "description": "The number of octets of multicast packets that have arrived\n on the interface, including framing characters. This object\n is similar to ifInOctets in the Interfaces MIB, except that\n only multicast packets are counted.", "minimum": 0, "maximum": 4294967295 }, "ipMRouteInterfaceOutMcastOctets": { "type": "integer", "description": "The number of octets of multicast packets that have been\n sent on the interface.", "minimum": 0, "maximum": 4294967295 }, "ipMRouteInterfaceHCInMcastOctets": { "type": "integer", "description": "The number of octets of multicast packets that have arrived\n on the interface, including framing characters. This object\n is a 64-bit version of ipMRouteInterfaceInMcastOctets. It\n is similar to ifHCInOctets in the Interfaces MIB, except\n that only multicast packets are counted.", "minimum": 0 }, "ipMRouteInterfaceHCOutMcastOctets": { "type": "integer", "description": "The number of octets of multicast packets that have been\n \n \n \n \n \n sent on the interface. This object is a 64-bit version of\n ipMRouteInterfaceOutMcastOctets.", "minimum": 0 } } } }, "example": { "IPMROUTE-STD-MIB:ipMRouteInterfaceEntry": [ { "ipMRouteInterfaceIfIndex": "192.168.1.1", "ipMRouteInterfaceTtl": -2147483648, "ipMRouteInterfaceProtocol": "192.168.1.1", "ipMRouteInterfaceRateLimit": -2147483648, "ipMRouteInterfaceInMcastOctets": 1234567890, "ipMRouteInterfaceOutMcastOctets": 1234567890, "ipMRouteInterfaceHCInMcastOctets": 1234567890, "ipMRouteInterfaceHCOutMcastOctets": 1234567890 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipMRouteInterfaceEntry-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": "/ipMRouteInterfaceEntry", "x-restconf-kind": "container" }, "/data/IPMROUTE-STD-MIB:ipMRouteInterfaceEntry={ipMRouteInterfaceIfIndex}": { "get": { "summary": "Get ipMRouteInterfaceEntry entry", "description": "Retrieve specific ipMRouteInterfaceEntry entry by key from MIB", "tags": [ "IPMROUTE-STD-MIB" ], "parameters": [ { "name": "ipMRouteInterfaceIfIndex", "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": { "ipMRouteInterfaceIfIndex": { "type": "string", "description": "The ifIndex value of the interface for which this entry\n contains information.", "x-yang-type": "if-mib:InterfaceIndex" }, "ipMRouteInterfaceTtl": { "type": "integer", "description": "The datagram TTL threshold for the interface. Any IP\n multicast datagrams with a TTL less than this threshold will\n not be forwarded out the interface. The default value of 0\n means all multicast packets are forwarded out the\n interface.", "minimum": -2147483648, "maximum": 2147483647 }, "ipMRouteInterfaceProtocol": { "type": "string", "description": "The routing protocol running on this interface.", "x-yang-type": "iana-rtproto:IANAipMRouteProtocol" }, "ipMRouteInterfaceRateLimit": { "type": "integer", "description": "The rate-limit, in kilobits per second, of forwarded\n multicast traffic on the interface. A rate-limit of 0\n indicates that no rate limiting is done.", "minimum": -2147483648, "maximum": 2147483647 }, "ipMRouteInterfaceInMcastOctets": { "type": "integer", "description": "The number of octets of multicast packets that have arrived\n on the interface, including framing characters. This object\n is similar to ifInOctets in the Interfaces MIB, except that\n only multicast packets are counted.", "minimum": 0, "maximum": 4294967295 }, "ipMRouteInterfaceOutMcastOctets": { "type": "integer", "description": "The number of octets of multicast packets that have been\n sent on the interface.", "minimum": 0, "maximum": 4294967295 }, "ipMRouteInterfaceHCInMcastOctets": { "type": "integer", "description": "The number of octets of multicast packets that have arrived\n on the interface, including framing characters. This object\n is a 64-bit version of ipMRouteInterfaceInMcastOctets. It\n is similar to ifHCInOctets in the Interfaces MIB, except\n that only multicast packets are counted.", "minimum": 0 }, "ipMRouteInterfaceHCOutMcastOctets": { "type": "integer", "description": "The number of octets of multicast packets that have been\n \n \n \n \n \n sent on the interface. This object is a 64-bit version of\n ipMRouteInterfaceOutMcastOctets.", "minimum": 0 } } }, "example": { "IPMROUTE-STD-MIB:ipMRouteInterfaceEntry": { "ipMRouteInterfaceIfIndex": "192.168.1.1", "ipMRouteInterfaceTtl": -2147483648, "ipMRouteInterfaceProtocol": "192.168.1.1", "ipMRouteInterfaceRateLimit": -2147483648, "ipMRouteInterfaceInMcastOctets": 1234567890, "ipMRouteInterfaceOutMcastOctets": 1234567890, "ipMRouteInterfaceHCInMcastOctets": 1234567890, "ipMRouteInterfaceHCOutMcastOctets": 1234567890 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipMRouteInterfaceEntry-4" }, "x-yang-path": "/ipMRouteInterfaceEntry={ipMRouteInterfaceIfIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ipMRouteInterfaceIfIndex" ] }, "/data/IPMROUTE-STD-MIB:ipMRouteBoundaryEntry": { "get": { "summary": "Get ipMRouteBoundaryEntry list", "description": "Retrieve list of ipMRouteBoundaryEntry entries from MIB", "tags": [ "IPMROUTE-STD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) in the ipMRouteBoundaryTable\n representing a scoped boundary.", "items": { "type": "object", "properties": { "ipMRouteBoundaryIfIndex": { "type": "string", "description": "The IfIndex value for the interface to which this boundary\n applies. Packets with a destination address in the\n associated address/mask range will not be forwarded out this\n interface.", "x-yang-type": "if-mib:InterfaceIndex" }, "ipMRouteBoundaryAddress": { "type": "string", "description": "The group address which when combined with the\n corresponding value of ipMRouteBoundaryAddressMask\n identifies the group range for which the scoped boundary\n exists. Scoped addresses must come from the range 239.x.x.x\n as specified in RFC 2365.", "format": "inet:ipv4-address" }, "ipMRouteBoundaryAddressMask": { "type": "string", "description": "The group address mask which when combined with the\n corresponding value of ipMRouteBoundaryAddress identifies\n the group range for which the scoped boundary exists.", "format": "inet:ipv4-address" }, "ipMRouteBoundaryStatus": { "type": "string", "description": "The status of this row, by which new entries may be\n created, or old entries deleted from this table.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "IPMROUTE-STD-MIB:ipMRouteBoundaryEntry": [ { "ipMRouteBoundaryIfIndex": "192.168.1.1", "ipMRouteBoundaryAddress": "192.168.1.1", "ipMRouteBoundaryAddressMask": "192.168.1.1", "ipMRouteBoundaryStatus": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipMRouteBoundaryEntry-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": "/ipMRouteBoundaryEntry", "x-restconf-kind": "container" }, "/data/IPMROUTE-STD-MIB:ipMRouteScopeNameEntry": { "get": { "summary": "Get ipMRouteScopeNameEntry list", "description": "Retrieve list of ipMRouteScopeNameEntry entries from MIB", "tags": [ "IPMROUTE-STD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) in the ipMRouteScopeNameTable\n representing a multicast scope name.", "items": { "type": "object", "properties": { "ipMRouteScopeNameAddress": { "type": "string", "description": "The group address which when combined with the\n corresponding value of ipMRouteScopeNameAddressMask\n identifies the group range associated with the multicast\n scope. Scoped addresses must come from the range\n 239.x.x.x.", "format": "inet:ipv4-address" }, "ipMRouteScopeNameAddressMask": { "type": "string", "description": "The group address mask which when combined with the\n corresponding value of ipMRouteScopeNameAddress identifies\n the group range associated with the multicast scope.", "format": "inet:ipv4-address" }, "ipMRouteScopeNameLanguage": { "type": "string", "description": "The RFC 1766-style language tag associated with the scope\n name.", "x-yang-type": "IPMROUTE-STD-MIB:LanguageTag" }, "ipMRouteScopeNameString": { "type": "string", "description": "The textual name associated with the multicast scope. The\n value of this object should be suitable for displaying to\n end-users, such as when allocating a multicast address in\n this scope. When no name is specified, the default value of\n this object should be the string 239.x.x.x/y with x and y\n replaced appropriately to describe the address and mask\n length associated with the scope.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "ipMRouteScopeNameDefault": { "type": "boolean", "description": "If true, indicates a preference that the name in the\n following language should be used by applications if no name\n is available in a desired language." }, "ipMRouteScopeNameStatus": { "type": "string", "description": "The status of this row, by which new entries may be\n created, or old entries deleted from this table.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "IPMROUTE-STD-MIB:ipMRouteScopeNameEntry": [ { "ipMRouteScopeNameAddress": "192.168.1.1", "ipMRouteScopeNameAddressMask": "192.168.1.1", "ipMRouteScopeNameLanguage": "192.168.1.1", "ipMRouteScopeNameString": "192.168.1.1", "ipMRouteScopeNameDefault": true, "ipMRouteScopeNameStatus": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipMRouteScopeNameEntry-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": "/ipMRouteScopeNameEntry", "x-restconf-kind": "container" }, "/data/IPMROUTE-STD-MIB:ipMRouteTable/ipMRouteEntry={ipMRouteGroup},{ipMRouteSource},{ipMRouteSourceMask}": { "get": { "summary": "Get ipMRouteEntry entry", "description": "Retrieve specific ipMRouteEntry entry by key from MIB", "tags": [ "IPMROUTE-STD-MIB" ], "parameters": [ { "name": "ipMRouteGroup", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipMRouteSource", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipMRouteSourceMask", "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": { "ipMRouteGroup": { "type": "string", "description": "The IP multicast group address for which this entry\n contains multicast routing information.", "format": "inet:ipv4-address" }, "ipMRouteSource": { "type": "string", "description": "The network address which when combined with the\n corresponding value of ipMRouteSourceMask identifies the\n sources for which this entry contains multicast routing\n information.", "format": "inet:ipv4-address" }, "ipMRouteSourceMask": { "type": "string", "description": "The network mask which when combined with the corresponding\n value of ipMRouteSource identifies the sources for which\n this entry contains multicast routing information.", "format": "inet:ipv4-address" }, "ipMRouteUpstreamNeighbor": { "type": "string", "description": "The address of the upstream neighbor (e.g., RPF neighbor)\n from which IP datagrams from these sources to this multicast\n address are received, or 0.0.0.0 if the upstream neighbor is\n unknown (e.g., in CBT).", "format": "inet:ipv4-address" }, "ipMRouteInIfIndex": { "type": "string", "description": "The value of ifIndex for the interface on which IP\n datagrams sent by these sources to this multicast address\n are received. A value of 0 indicates that datagrams are not\n subject to an incoming interface check, but may be accepted\n on multiple interfaces (e.g., in CBT).", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "ipMRouteUpTime": { "type": "string", "description": "The time since the multicast routing information\n represented by this entry was learned by the router.", "x-yang-type": "yang:timeticks" }, "ipMRouteExpiryTime": { "type": "string", "description": "The minimum amount of time remaining before this entry will\n be aged out. The value 0 indicates that the entry is not\n subject to aging.", "x-yang-type": "yang:timeticks" }, "ipMRoutePkts": { "type": "integer", "description": "The number of packets which this router has received from\n these sources and addressed to this multicast group\n address.", "minimum": 0, "maximum": 4294967295 }, "ipMRouteDifferentInIfPackets": { "type": "integer", "description": "The number of packets which this router has received from\n these sources and addressed to this multicast group address,\n which were dropped because they were not received on the\n interface indicated by ipMRouteInIfIndex. Packets which are\n not subject to an incoming interface check (e.g., using CBT)\n are not counted.", "minimum": 0, "maximum": 4294967295 }, "ipMRouteOctets": { "type": "integer", "description": "The number of octets contained in IP datagrams which were\n received from these sources and addressed to this multicast\n group address, and which were forwarded by this router.", "minimum": 0, "maximum": 4294967295 }, "ipMRouteProtocol": { "type": "string", "description": "The multicast routing protocol via which this multicast\n forwarding entry was learned.", "x-yang-type": "iana-rtproto:IANAipMRouteProtocol" }, "ipMRouteRtProto": { "type": "string", "description": "The routing mechanism via which the route used to find the\n upstream or parent interface for this multicast forwarding\n entry was learned. Inclusion of values for routing\n protocols is not intended to imply that those protocols need\n be supported.", "x-yang-type": "iana-rtproto:IANAipRouteProtocol" }, "ipMRouteRtAddress": { "type": "string", "description": "The address portion of the route used to find the upstream\n or parent interface for this multicast forwarding entry.", "format": "inet:ipv4-address" }, "ipMRouteRtMask": { "type": "string", "description": "The mask associated with the route used to find the upstream\n or parent interface for this multicast forwarding entry.", "format": "inet:ipv4-address" }, "ipMRouteRtType": { "type": "string", "description": "The reason the given route was placed in the (logical)\n multicast Routing Information Base (RIB). A value of\n unicast means that the route would normally be placed only\n in the unicast RIB, but was placed in the multicast RIB\n (instead or in addition) due to local configuration, such as\n when running PIM over RIP. A value of multicast means that\n \n \n \n \n \n the route was explicitly added to the multicast RIB by the\n routing protocol, such as DVMRP or Multiprotocol BGP." }, "ipMRouteHCOctets": { "type": "integer", "description": "The number of octets contained in IP datagrams which were\n received from these sources and addressed to this multicast\n group address, and which were forwarded by this router.\n This object is a 64-bit version of ipMRouteOctets.", "minimum": 0 } } }, "example": { "IPMROUTE-STD-MIB:ipMRouteEntry": { "ipMRouteGroup": "192.168.1.1", "ipMRouteSource": "192.168.1.1", "ipMRouteSourceMask": "192.168.1.1", "ipMRouteUpstreamNeighbor": "192.168.1.1", "ipMRouteInIfIndex": "192.168.1.1", "ipMRouteUpTime": "192.168.1.1", "ipMRouteExpiryTime": "192.168.1.1", "ipMRoutePkts": 0, "ipMRouteDifferentInIfPackets": 1234567890, "ipMRouteOctets": 1234567890, "ipMRouteProtocol": "192.168.1.1", "ipMRouteRtProto": "192.168.1.1", "ipMRouteRtAddress": "192.168.1.1", "ipMRouteRtMask": "192.168.1.1", "ipMRouteRtType": "192.168.1.1", "ipMRouteHCOctets": 1234567890 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipMRouteEntry-2" }, "x-yang-path": "/ipMRouteTable/ipMRouteEntry={ipMRouteGroup ipMRouteSource ipMRouteSourceMask}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ipMRouteGroup ipMRouteSource ipMRouteSourceMask" ] }, "/data/IPMROUTE-STD-MIB:ipMRouteNextHopTable/ipMRouteNextHopEntry={ipMRouteNextHopGroup},{ipMRouteNextHopSource},{ipMRouteNextHopSourceMask},{ipMRouteNextHopIfIndex},{ipMRouteNextHopAddress}": { "get": { "summary": "Get ipMRouteNextHopEntry entry", "description": "Retrieve specific ipMRouteNextHopEntry entry by key from MIB", "tags": [ "IPMROUTE-STD-MIB" ], "parameters": [ { "name": "ipMRouteNextHopGroup", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipMRouteNextHopSource", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipMRouteNextHopSourceMask", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipMRouteNextHopIfIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipMRouteNextHopAddress", "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": { "ipMRouteNextHopGroup": { "type": "string", "description": "The IP multicast group for which this entry specifies a\n next-hop on an outgoing interface.", "format": "inet:ipv4-address" }, "ipMRouteNextHopSource": { "type": "string", "description": "The network address which when combined with the\n corresponding value of ipMRouteNextHopSourceMask identifies\n the sources for which this entry specifies a next-hop on an\n outgoing interface.", "format": "inet:ipv4-address" }, "ipMRouteNextHopSourceMask": { "type": "string", "description": "The network mask which when combined with the corresponding\n value of ipMRouteNextHopSource identifies the sources for\n which this entry specifies a next-hop on an outgoing\n interface.", "format": "inet:ipv4-address" }, "ipMRouteNextHopIfIndex": { "type": "string", "description": "The ifIndex value of the interface for the outgoing\n interface for this next-hop.", "x-yang-type": "if-mib:InterfaceIndex" }, "ipMRouteNextHopAddress": { "type": "string", "description": "The address of the next-hop specific to this entry. For\n most interfaces, this is identical to ipMRouteNextHopGroup.\n NBMA interfaces, however, may have multiple next-hop\n addresses out a single outgoing interface.", "format": "inet:ipv4-address" }, "ipMRouteNextHopState": { "type": "string", "description": "An indication of whether the outgoing interface and next-\n hop represented by this entry is currently being used to\n forward IP datagrams. The value 'forwarding' indicates it\n is currently being used; the value 'pruned' indicates it is\n not." }, "ipMRouteNextHopUpTime": { "type": "string", "description": "The time since the multicast routing information\n represented by this entry was learned by the router.", "x-yang-type": "yang:timeticks" }, "ipMRouteNextHopExpiryTime": { "type": "string", "description": "The minimum amount of time remaining before this entry will\n be aged out. If ipMRouteNextHopState is pruned(1), the\n remaining time until the prune expires and the state reverts\n to forwarding(2). Otherwise, the remaining time until this\n entry is removed from the table. The time remaining may be\n copied from ipMRouteExpiryTime if the protocol in use for\n this entry does not specify next-hop timers. The value 0\n \n \n \n \n \n indicates that the entry is not subject to aging.", "x-yang-type": "yang:timeticks" }, "ipMRouteNextHopClosestMemberHops": { "type": "integer", "description": "The minimum number of hops between this router and any\n member of this IP multicast group reached via this next-hop\n on this outgoing interface. Any IP multicast datagrams for\n the group which have a TTL less than this number of hops\n will not be forwarded to this next-hop.", "minimum": -2147483648, "maximum": 2147483647 }, "ipMRouteNextHopProtocol": { "type": "string", "description": "The routing mechanism via which this next-hop was learned.", "x-yang-type": "iana-rtproto:IANAipMRouteProtocol" }, "ipMRouteNextHopPkts": { "type": "integer", "description": "The number of packets which have been forwarded using this\n route.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "IPMROUTE-STD-MIB:ipMRouteNextHopEntry": { "ipMRouteNextHopGroup": "192.168.1.1", "ipMRouteNextHopSource": "192.168.1.1", "ipMRouteNextHopSourceMask": "192.168.1.1", "ipMRouteNextHopIfIndex": "192.168.1.1", "ipMRouteNextHopAddress": "192.168.1.1", "ipMRouteNextHopState": "192.168.1.1", "ipMRouteNextHopUpTime": "192.168.1.1", "ipMRouteNextHopExpiryTime": "192.168.1.1", "ipMRouteNextHopClosestMemberHops": -2147483648, "ipMRouteNextHopProtocol": "192.168.1.1", "ipMRouteNextHopPkts": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipMRouteNextHopEntry-2" }, "x-yang-path": "/ipMRouteNextHopTable/ipMRouteNextHopEntry={ipMRouteNextHopGroup ipMRouteNextHopSource ipMRouteNextHopSourceMask ipMRouteNextHopIfIndex ipMRouteNextHopAddress}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ipMRouteNextHopGroup ipMRouteNextHopSource ipMRouteNextHopSourceMask ipMRouteNextHopIfIndex ipMRouteNextHopAddress" ] }, "/data/IPMROUTE-STD-MIB:ipMRouteBoundaryTable/ipMRouteBoundaryEntry={ipMRouteBoundaryIfIndex},{ipMRouteBoundaryAddress},{ipMRouteBoundaryAddressMask}": { "get": { "summary": "Get ipMRouteBoundaryEntry entry", "description": "Retrieve specific ipMRouteBoundaryEntry entry by key from MIB", "tags": [ "IPMROUTE-STD-MIB" ], "parameters": [ { "name": "ipMRouteBoundaryIfIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipMRouteBoundaryAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipMRouteBoundaryAddressMask", "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": { "ipMRouteBoundaryIfIndex": { "type": "string", "description": "The IfIndex value for the interface to which this boundary\n applies. Packets with a destination address in the\n associated address/mask range will not be forwarded out this\n interface.", "x-yang-type": "if-mib:InterfaceIndex" }, "ipMRouteBoundaryAddress": { "type": "string", "description": "The group address which when combined with the\n corresponding value of ipMRouteBoundaryAddressMask\n identifies the group range for which the scoped boundary\n exists. Scoped addresses must come from the range 239.x.x.x\n as specified in RFC 2365.", "format": "inet:ipv4-address" }, "ipMRouteBoundaryAddressMask": { "type": "string", "description": "The group address mask which when combined with the\n corresponding value of ipMRouteBoundaryAddress identifies\n the group range for which the scoped boundary exists.", "format": "inet:ipv4-address" }, "ipMRouteBoundaryStatus": { "type": "string", "description": "The status of this row, by which new entries may be\n created, or old entries deleted from this table.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "IPMROUTE-STD-MIB:ipMRouteBoundaryEntry": { "ipMRouteBoundaryIfIndex": "192.168.1.1", "ipMRouteBoundaryAddress": "192.168.1.1", "ipMRouteBoundaryAddressMask": "192.168.1.1", "ipMRouteBoundaryStatus": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipMRouteBoundaryEntry-2" }, "x-yang-path": "/ipMRouteBoundaryTable/ipMRouteBoundaryEntry={ipMRouteBoundaryIfIndex ipMRouteBoundaryAddress ipMRouteBoundaryAddressMask}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ipMRouteBoundaryIfIndex ipMRouteBoundaryAddress ipMRouteBoundaryAddressMask" ] }, "/data/IPMROUTE-STD-MIB:ipMRouteScopeNameTable/ipMRouteScopeNameEntry={ipMRouteScopeNameAddress},{ipMRouteScopeNameAddressMask},{ipMRouteScopeNameLanguage}": { "get": { "summary": "Get ipMRouteScopeNameEntry entry", "description": "Retrieve specific ipMRouteScopeNameEntry entry by key from MIB", "tags": [ "IPMROUTE-STD-MIB" ], "parameters": [ { "name": "ipMRouteScopeNameAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipMRouteScopeNameAddressMask", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipMRouteScopeNameLanguage", "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": { "ipMRouteScopeNameAddress": { "type": "string", "description": "The group address which when combined with the\n corresponding value of ipMRouteScopeNameAddressMask\n identifies the group range associated with the multicast\n scope. Scoped addresses must come from the range\n 239.x.x.x.", "format": "inet:ipv4-address" }, "ipMRouteScopeNameAddressMask": { "type": "string", "description": "The group address mask which when combined with the\n corresponding value of ipMRouteScopeNameAddress identifies\n the group range associated with the multicast scope.", "format": "inet:ipv4-address" }, "ipMRouteScopeNameLanguage": { "type": "string", "description": "The RFC 1766-style language tag associated with the scope\n name.", "x-yang-type": "IPMROUTE-STD-MIB:LanguageTag" }, "ipMRouteScopeNameString": { "type": "string", "description": "The textual name associated with the multicast scope. The\n value of this object should be suitable for displaying to\n end-users, such as when allocating a multicast address in\n this scope. When no name is specified, the default value of\n this object should be the string 239.x.x.x/y with x and y\n replaced appropriately to describe the address and mask\n length associated with the scope.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "ipMRouteScopeNameDefault": { "type": "boolean", "description": "If true, indicates a preference that the name in the\n following language should be used by applications if no name\n is available in a desired language." }, "ipMRouteScopeNameStatus": { "type": "string", "description": "The status of this row, by which new entries may be\n created, or old entries deleted from this table.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "IPMROUTE-STD-MIB:ipMRouteScopeNameEntry": { "ipMRouteScopeNameAddress": "192.168.1.1", "ipMRouteScopeNameAddressMask": "192.168.1.1", "ipMRouteScopeNameLanguage": "192.168.1.1", "ipMRouteScopeNameString": "192.168.1.1", "ipMRouteScopeNameDefault": true, "ipMRouteScopeNameStatus": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipMRouteScopeNameEntry-2" }, "x-yang-path": "/ipMRouteScopeNameTable/ipMRouteScopeNameEntry={ipMRouteScopeNameAddress ipMRouteScopeNameAddressMask ipMRouteScopeNameLanguage}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ipMRouteScopeNameAddress ipMRouteScopeNameAddressMask ipMRouteScopeNameLanguage" ] }, "/data/IPMROUTE-STD-MIB:ipMRouteEntry={ipMRouteGroup},{ipMRouteSource},{ipMRouteSourceMask}": { "get": { "summary": "Get ipMRouteEntry entry", "description": "Retrieve specific ipMRouteEntry entry by key from MIB", "tags": [ "IPMROUTE-STD-MIB" ], "parameters": [ { "name": "ipMRouteGroup", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipMRouteSource", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipMRouteSourceMask", "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": { "ipMRouteGroup": { "type": "string", "description": "The IP multicast group address for which this entry\n contains multicast routing information.", "format": "inet:ipv4-address" }, "ipMRouteSource": { "type": "string", "description": "The network address which when combined with the\n corresponding value of ipMRouteSourceMask identifies the\n sources for which this entry contains multicast routing\n information.", "format": "inet:ipv4-address" }, "ipMRouteSourceMask": { "type": "string", "description": "The network mask which when combined with the corresponding\n value of ipMRouteSource identifies the sources for which\n this entry contains multicast routing information.", "format": "inet:ipv4-address" }, "ipMRouteUpstreamNeighbor": { "type": "string", "description": "The address of the upstream neighbor (e.g., RPF neighbor)\n from which IP datagrams from these sources to this multicast\n address are received, or 0.0.0.0 if the upstream neighbor is\n unknown (e.g., in CBT).", "format": "inet:ipv4-address" }, "ipMRouteInIfIndex": { "type": "string", "description": "The value of ifIndex for the interface on which IP\n datagrams sent by these sources to this multicast address\n are received. A value of 0 indicates that datagrams are not\n subject to an incoming interface check, but may be accepted\n on multiple interfaces (e.g., in CBT).", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "ipMRouteUpTime": { "type": "string", "description": "The time since the multicast routing information\n represented by this entry was learned by the router.", "x-yang-type": "yang:timeticks" }, "ipMRouteExpiryTime": { "type": "string", "description": "The minimum amount of time remaining before this entry will\n be aged out. The value 0 indicates that the entry is not\n subject to aging.", "x-yang-type": "yang:timeticks" }, "ipMRoutePkts": { "type": "integer", "description": "The number of packets which this router has received from\n these sources and addressed to this multicast group\n address.", "minimum": 0, "maximum": 4294967295 }, "ipMRouteDifferentInIfPackets": { "type": "integer", "description": "The number of packets which this router has received from\n these sources and addressed to this multicast group address,\n which were dropped because they were not received on the\n interface indicated by ipMRouteInIfIndex. Packets which are\n not subject to an incoming interface check (e.g., using CBT)\n are not counted.", "minimum": 0, "maximum": 4294967295 }, "ipMRouteOctets": { "type": "integer", "description": "The number of octets contained in IP datagrams which were\n received from these sources and addressed to this multicast\n group address, and which were forwarded by this router.", "minimum": 0, "maximum": 4294967295 }, "ipMRouteProtocol": { "type": "string", "description": "The multicast routing protocol via which this multicast\n forwarding entry was learned.", "x-yang-type": "iana-rtproto:IANAipMRouteProtocol" }, "ipMRouteRtProto": { "type": "string", "description": "The routing mechanism via which the route used to find the\n upstream or parent interface for this multicast forwarding\n entry was learned. Inclusion of values for routing\n protocols is not intended to imply that those protocols need\n be supported.", "x-yang-type": "iana-rtproto:IANAipRouteProtocol" }, "ipMRouteRtAddress": { "type": "string", "description": "The address portion of the route used to find the upstream\n or parent interface for this multicast forwarding entry.", "format": "inet:ipv4-address" }, "ipMRouteRtMask": { "type": "string", "description": "The mask associated with the route used to find the upstream\n or parent interface for this multicast forwarding entry.", "format": "inet:ipv4-address" }, "ipMRouteRtType": { "type": "string", "description": "The reason the given route was placed in the (logical)\n multicast Routing Information Base (RIB). A value of\n unicast means that the route would normally be placed only\n in the unicast RIB, but was placed in the multicast RIB\n (instead or in addition) due to local configuration, such as\n when running PIM over RIP. A value of multicast means that\n \n \n \n \n \n the route was explicitly added to the multicast RIB by the\n routing protocol, such as DVMRP or Multiprotocol BGP." }, "ipMRouteHCOctets": { "type": "integer", "description": "The number of octets contained in IP datagrams which were\n received from these sources and addressed to this multicast\n group address, and which were forwarded by this router.\n This object is a 64-bit version of ipMRouteOctets.", "minimum": 0 } } }, "example": { "IPMROUTE-STD-MIB:ipMRouteEntry": { "ipMRouteGroup": "192.168.1.1", "ipMRouteSource": "192.168.1.1", "ipMRouteSourceMask": "192.168.1.1", "ipMRouteUpstreamNeighbor": "192.168.1.1", "ipMRouteInIfIndex": "192.168.1.1", "ipMRouteUpTime": "192.168.1.1", "ipMRouteExpiryTime": "192.168.1.1", "ipMRoutePkts": 0, "ipMRouteDifferentInIfPackets": 1234567890, "ipMRouteOctets": 1234567890, "ipMRouteProtocol": "192.168.1.1", "ipMRouteRtProto": "192.168.1.1", "ipMRouteRtAddress": "192.168.1.1", "ipMRouteRtMask": "192.168.1.1", "ipMRouteRtType": "192.168.1.1", "ipMRouteHCOctets": 1234567890 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipMRouteEntry-4" }, "x-yang-path": "/ipMRouteEntry={ipMRouteGroup ipMRouteSource ipMRouteSourceMask}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ipMRouteGroup ipMRouteSource ipMRouteSourceMask" ] }, "/data/IPMROUTE-STD-MIB:ipMRouteNextHopEntry={ipMRouteNextHopGroup},{ipMRouteNextHopSource},{ipMRouteNextHopSourceMask},{ipMRouteNextHopIfIndex},{ipMRouteNextHopAddress}": { "get": { "summary": "Get ipMRouteNextHopEntry entry", "description": "Retrieve specific ipMRouteNextHopEntry entry by key from MIB", "tags": [ "IPMROUTE-STD-MIB" ], "parameters": [ { "name": "ipMRouteNextHopGroup", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipMRouteNextHopSource", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipMRouteNextHopSourceMask", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipMRouteNextHopIfIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipMRouteNextHopAddress", "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": { "ipMRouteNextHopGroup": { "type": "string", "description": "The IP multicast group for which this entry specifies a\n next-hop on an outgoing interface.", "format": "inet:ipv4-address" }, "ipMRouteNextHopSource": { "type": "string", "description": "The network address which when combined with the\n corresponding value of ipMRouteNextHopSourceMask identifies\n the sources for which this entry specifies a next-hop on an\n outgoing interface.", "format": "inet:ipv4-address" }, "ipMRouteNextHopSourceMask": { "type": "string", "description": "The network mask which when combined with the corresponding\n value of ipMRouteNextHopSource identifies the sources for\n which this entry specifies a next-hop on an outgoing\n interface.", "format": "inet:ipv4-address" }, "ipMRouteNextHopIfIndex": { "type": "string", "description": "The ifIndex value of the interface for the outgoing\n interface for this next-hop.", "x-yang-type": "if-mib:InterfaceIndex" }, "ipMRouteNextHopAddress": { "type": "string", "description": "The address of the next-hop specific to this entry. For\n most interfaces, this is identical to ipMRouteNextHopGroup.\n NBMA interfaces, however, may have multiple next-hop\n addresses out a single outgoing interface.", "format": "inet:ipv4-address" }, "ipMRouteNextHopState": { "type": "string", "description": "An indication of whether the outgoing interface and next-\n hop represented by this entry is currently being used to\n forward IP datagrams. The value 'forwarding' indicates it\n is currently being used; the value 'pruned' indicates it is\n not." }, "ipMRouteNextHopUpTime": { "type": "string", "description": "The time since the multicast routing information\n represented by this entry was learned by the router.", "x-yang-type": "yang:timeticks" }, "ipMRouteNextHopExpiryTime": { "type": "string", "description": "The minimum amount of time remaining before this entry will\n be aged out. If ipMRouteNextHopState is pruned(1), the\n remaining time until the prune expires and the state reverts\n to forwarding(2). Otherwise, the remaining time until this\n entry is removed from the table. The time remaining may be\n copied from ipMRouteExpiryTime if the protocol in use for\n this entry does not specify next-hop timers. The value 0\n \n \n \n \n \n indicates that the entry is not subject to aging.", "x-yang-type": "yang:timeticks" }, "ipMRouteNextHopClosestMemberHops": { "type": "integer", "description": "The minimum number of hops between this router and any\n member of this IP multicast group reached via this next-hop\n on this outgoing interface. Any IP multicast datagrams for\n the group which have a TTL less than this number of hops\n will not be forwarded to this next-hop.", "minimum": -2147483648, "maximum": 2147483647 }, "ipMRouteNextHopProtocol": { "type": "string", "description": "The routing mechanism via which this next-hop was learned.", "x-yang-type": "iana-rtproto:IANAipMRouteProtocol" }, "ipMRouteNextHopPkts": { "type": "integer", "description": "The number of packets which have been forwarded using this\n route.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "IPMROUTE-STD-MIB:ipMRouteNextHopEntry": { "ipMRouteNextHopGroup": "192.168.1.1", "ipMRouteNextHopSource": "192.168.1.1", "ipMRouteNextHopSourceMask": "192.168.1.1", "ipMRouteNextHopIfIndex": "192.168.1.1", "ipMRouteNextHopAddress": "192.168.1.1", "ipMRouteNextHopState": "192.168.1.1", "ipMRouteNextHopUpTime": "192.168.1.1", "ipMRouteNextHopExpiryTime": "192.168.1.1", "ipMRouteNextHopClosestMemberHops": -2147483648, "ipMRouteNextHopProtocol": "192.168.1.1", "ipMRouteNextHopPkts": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipMRouteNextHopEntry-4" }, "x-yang-path": "/ipMRouteNextHopEntry={ipMRouteNextHopGroup ipMRouteNextHopSource ipMRouteNextHopSourceMask ipMRouteNextHopIfIndex ipMRouteNextHopAddress}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ipMRouteNextHopGroup ipMRouteNextHopSource ipMRouteNextHopSourceMask ipMRouteNextHopIfIndex ipMRouteNextHopAddress" ] }, "/data/IPMROUTE-STD-MIB:ipMRouteBoundaryEntry={ipMRouteBoundaryIfIndex},{ipMRouteBoundaryAddress},{ipMRouteBoundaryAddressMask}": { "get": { "summary": "Get ipMRouteBoundaryEntry entry", "description": "Retrieve specific ipMRouteBoundaryEntry entry by key from MIB", "tags": [ "IPMROUTE-STD-MIB" ], "parameters": [ { "name": "ipMRouteBoundaryIfIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipMRouteBoundaryAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipMRouteBoundaryAddressMask", "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": { "ipMRouteBoundaryIfIndex": { "type": "string", "description": "The IfIndex value for the interface to which this boundary\n applies. Packets with a destination address in the\n associated address/mask range will not be forwarded out this\n interface.", "x-yang-type": "if-mib:InterfaceIndex" }, "ipMRouteBoundaryAddress": { "type": "string", "description": "The group address which when combined with the\n corresponding value of ipMRouteBoundaryAddressMask\n identifies the group range for which the scoped boundary\n exists. Scoped addresses must come from the range 239.x.x.x\n as specified in RFC 2365.", "format": "inet:ipv4-address" }, "ipMRouteBoundaryAddressMask": { "type": "string", "description": "The group address mask which when combined with the\n corresponding value of ipMRouteBoundaryAddress identifies\n the group range for which the scoped boundary exists.", "format": "inet:ipv4-address" }, "ipMRouteBoundaryStatus": { "type": "string", "description": "The status of this row, by which new entries may be\n created, or old entries deleted from this table.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "IPMROUTE-STD-MIB:ipMRouteBoundaryEntry": { "ipMRouteBoundaryIfIndex": "192.168.1.1", "ipMRouteBoundaryAddress": "192.168.1.1", "ipMRouteBoundaryAddressMask": "192.168.1.1", "ipMRouteBoundaryStatus": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipMRouteBoundaryEntry-4" }, "x-yang-path": "/ipMRouteBoundaryEntry={ipMRouteBoundaryIfIndex ipMRouteBoundaryAddress ipMRouteBoundaryAddressMask}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ipMRouteBoundaryIfIndex ipMRouteBoundaryAddress ipMRouteBoundaryAddressMask" ] }, "/data/IPMROUTE-STD-MIB:ipMRouteScopeNameEntry={ipMRouteScopeNameAddress},{ipMRouteScopeNameAddressMask},{ipMRouteScopeNameLanguage}": { "get": { "summary": "Get ipMRouteScopeNameEntry entry", "description": "Retrieve specific ipMRouteScopeNameEntry entry by key from MIB", "tags": [ "IPMROUTE-STD-MIB" ], "parameters": [ { "name": "ipMRouteScopeNameAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipMRouteScopeNameAddressMask", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipMRouteScopeNameLanguage", "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": { "ipMRouteScopeNameAddress": { "type": "string", "description": "The group address which when combined with the\n corresponding value of ipMRouteScopeNameAddressMask\n identifies the group range associated with the multicast\n scope. Scoped addresses must come from the range\n 239.x.x.x.", "format": "inet:ipv4-address" }, "ipMRouteScopeNameAddressMask": { "type": "string", "description": "The group address mask which when combined with the\n corresponding value of ipMRouteScopeNameAddress identifies\n the group range associated with the multicast scope.", "format": "inet:ipv4-address" }, "ipMRouteScopeNameLanguage": { "type": "string", "description": "The RFC 1766-style language tag associated with the scope\n name.", "x-yang-type": "IPMROUTE-STD-MIB:LanguageTag" }, "ipMRouteScopeNameString": { "type": "string", "description": "The textual name associated with the multicast scope. The\n value of this object should be suitable for displaying to\n end-users, such as when allocating a multicast address in\n this scope. When no name is specified, the default value of\n this object should be the string 239.x.x.x/y with x and y\n replaced appropriately to describe the address and mask\n length associated with the scope.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "ipMRouteScopeNameDefault": { "type": "boolean", "description": "If true, indicates a preference that the name in the\n following language should be used by applications if no name\n is available in a desired language." }, "ipMRouteScopeNameStatus": { "type": "string", "description": "The status of this row, by which new entries may be\n created, or old entries deleted from this table.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "IPMROUTE-STD-MIB:ipMRouteScopeNameEntry": { "ipMRouteScopeNameAddress": "192.168.1.1", "ipMRouteScopeNameAddressMask": "192.168.1.1", "ipMRouteScopeNameLanguage": "192.168.1.1", "ipMRouteScopeNameString": "192.168.1.1", "ipMRouteScopeNameDefault": true, "ipMRouteScopeNameStatus": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipMRouteScopeNameEntry-4" }, "x-yang-path": "/ipMRouteScopeNameEntry={ipMRouteScopeNameAddress ipMRouteScopeNameAddressMask ipMRouteScopeNameLanguage}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ipMRouteScopeNameAddress ipMRouteScopeNameAddressMask ipMRouteScopeNameLanguage" ] } }, "components": { "schemas": { "IPMROUTE-STD-MIB_IPMROUTE-STD-MIB": { "type": "object", "description": "The enabled status of IP Multicast routing on this router.", "properties": { "ipMRouteEntry": { "type": "array", "description": "An entry (conceptual row) containing the multicast routing\n information for IP datagrams from a particular source and\n addressed to a particular IP multicast group address.\n Discontinuities in counters in this entry can be detected by\n observing the value of ipMRouteUpTime.", "items": { "type": "object", "properties": { "ipMRouteGroup": { "type": "string", "description": "The IP multicast group address for which this entry\n contains multicast routing information.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteSource": { "type": "string", "description": "The network address which when combined with the\n corresponding value of ipMRouteSourceMask identifies the\n sources for which this entry contains multicast routing\n information.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteSourceMask": { "type": "string", "description": "The network mask which when combined with the corresponding\n value of ipMRouteSource identifies the sources for which\n this entry contains multicast routing information.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteUpstreamNeighbor": { "type": "string", "description": "The address of the upstream neighbor (e.g., RPF neighbor)\n from which IP datagrams from these sources to this multicast\n address are received, or 0.0.0.0 if the upstream neighbor is\n unknown (e.g., in CBT).", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteInIfIndex": { "type": "string", "description": "The value of ifIndex for the interface on which IP\n datagrams sent by these sources to this multicast address\n are received. A value of 0 indicates that datagrams are not\n subject to an incoming interface check, but may be accepted\n on multiple interfaces (e.g., in CBT).", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "ipMRouteUpTime": { "type": "string", "description": "The time since the multicast routing information\n represented by this entry was learned by the router.", "x-yang-type": "yang:timeticks", "readOnly": true }, "ipMRouteExpiryTime": { "type": "string", "description": "The minimum amount of time remaining before this entry will\n be aged out. The value 0 indicates that the entry is not\n subject to aging.", "x-yang-type": "yang:timeticks", "readOnly": true }, "ipMRoutePkts": { "type": "integer", "description": "The number of packets which this router has received from\n these sources and addressed to this multicast group\n address.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ipMRouteDifferentInIfPackets": { "type": "integer", "description": "The number of packets which this router has received from\n these sources and addressed to this multicast group address,\n which were dropped because they were not received on the\n interface indicated by ipMRouteInIfIndex. Packets which are\n not subject to an incoming interface check (e.g., using CBT)\n are not counted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ipMRouteOctets": { "type": "integer", "description": "The number of octets contained in IP datagrams which were\n received from these sources and addressed to this multicast\n group address, and which were forwarded by this router.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ipMRouteProtocol": { "type": "string", "description": "The multicast routing protocol via which this multicast\n forwarding entry was learned.", "x-yang-type": "iana-rtproto:IANAipMRouteProtocol", "readOnly": true }, "ipMRouteRtProto": { "type": "string", "description": "The routing mechanism via which the route used to find the\n upstream or parent interface for this multicast forwarding\n entry was learned. Inclusion of values for routing\n protocols is not intended to imply that those protocols need\n be supported.", "x-yang-type": "iana-rtproto:IANAipRouteProtocol", "readOnly": true }, "ipMRouteRtAddress": { "type": "string", "description": "The address portion of the route used to find the upstream\n or parent interface for this multicast forwarding entry.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteRtMask": { "type": "string", "description": "The mask associated with the route used to find the upstream\n or parent interface for this multicast forwarding entry.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteRtType": { "type": "string", "description": "The reason the given route was placed in the (logical)\n multicast Routing Information Base (RIB). A value of\n unicast means that the route would normally be placed only\n in the unicast RIB, but was placed in the multicast RIB\n (instead or in addition) due to local configuration, such as\n when running PIM over RIP. A value of multicast means that\n \n \n \n \n \n the route was explicitly added to the multicast RIB by the\n routing protocol, such as DVMRP or Multiprotocol BGP.", "readOnly": true }, "ipMRouteHCOctets": { "type": "integer", "description": "The number of octets contained in IP datagrams which were\n received from these sources and addressed to this multicast\n group address, and which were forwarded by this router.\n This object is a 64-bit version of ipMRouteOctets.", "minimum": 0, "readOnly": true } } }, "readOnly": true }, "ipMRouteNextHopEntry": { "type": "array", "description": "An entry (conceptual row) in the list of next-hops on\n outgoing interfaces to which IP multicast datagrams from\n particular sources to a IP multicast group address are\n routed. Discontinuities in counters in this entry can be\n detected by observing the value of ipMRouteUpTime.", "items": { "type": "object", "properties": { "ipMRouteNextHopGroup": { "type": "string", "description": "The IP multicast group for which this entry specifies a\n next-hop on an outgoing interface.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteNextHopSource": { "type": "string", "description": "The network address which when combined with the\n corresponding value of ipMRouteNextHopSourceMask identifies\n the sources for which this entry specifies a next-hop on an\n outgoing interface.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteNextHopSourceMask": { "type": "string", "description": "The network mask which when combined with the corresponding\n value of ipMRouteNextHopSource identifies the sources for\n which this entry specifies a next-hop on an outgoing\n interface.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteNextHopIfIndex": { "type": "string", "description": "The ifIndex value of the interface for the outgoing\n interface for this next-hop.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "ipMRouteNextHopAddress": { "type": "string", "description": "The address of the next-hop specific to this entry. For\n most interfaces, this is identical to ipMRouteNextHopGroup.\n NBMA interfaces, however, may have multiple next-hop\n addresses out a single outgoing interface.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteNextHopState": { "type": "string", "description": "An indication of whether the outgoing interface and next-\n hop represented by this entry is currently being used to\n forward IP datagrams. The value 'forwarding' indicates it\n is currently being used; the value 'pruned' indicates it is\n not.", "readOnly": true }, "ipMRouteNextHopUpTime": { "type": "string", "description": "The time since the multicast routing information\n represented by this entry was learned by the router.", "x-yang-type": "yang:timeticks", "readOnly": true }, "ipMRouteNextHopExpiryTime": { "type": "string", "description": "The minimum amount of time remaining before this entry will\n be aged out. If ipMRouteNextHopState is pruned(1), the\n remaining time until the prune expires and the state reverts\n to forwarding(2). Otherwise, the remaining time until this\n entry is removed from the table. The time remaining may be\n copied from ipMRouteExpiryTime if the protocol in use for\n this entry does not specify next-hop timers. The value 0\n \n \n \n \n \n indicates that the entry is not subject to aging.", "x-yang-type": "yang:timeticks", "readOnly": true }, "ipMRouteNextHopClosestMemberHops": { "type": "integer", "description": "The minimum number of hops between this router and any\n member of this IP multicast group reached via this next-hop\n on this outgoing interface. Any IP multicast datagrams for\n the group which have a TTL less than this number of hops\n will not be forwarded to this next-hop.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipMRouteNextHopProtocol": { "type": "string", "description": "The routing mechanism via which this next-hop was learned.", "x-yang-type": "iana-rtproto:IANAipMRouteProtocol", "readOnly": true }, "ipMRouteNextHopPkts": { "type": "integer", "description": "The number of packets which have been forwarded using this\n route.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "ipMRouteInterfaceEntry": { "type": "array", "description": "An entry (conceptual row) containing the multicast routing\n information for a particular interface.", "items": { "type": "object", "properties": { "ipMRouteInterfaceIfIndex": { "type": "string", "description": "The ifIndex value of the interface for which this entry\n contains information.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "ipMRouteInterfaceTtl": { "type": "integer", "description": "The datagram TTL threshold for the interface. Any IP\n multicast datagrams with a TTL less than this threshold will\n not be forwarded out the interface. The default value of 0\n means all multicast packets are forwarded out the\n interface.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipMRouteInterfaceProtocol": { "type": "string", "description": "The routing protocol running on this interface.", "x-yang-type": "iana-rtproto:IANAipMRouteProtocol", "readOnly": true }, "ipMRouteInterfaceRateLimit": { "type": "integer", "description": "The rate-limit, in kilobits per second, of forwarded\n multicast traffic on the interface. A rate-limit of 0\n indicates that no rate limiting is done.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipMRouteInterfaceInMcastOctets": { "type": "integer", "description": "The number of octets of multicast packets that have arrived\n on the interface, including framing characters. This object\n is similar to ifInOctets in the Interfaces MIB, except that\n only multicast packets are counted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ipMRouteInterfaceOutMcastOctets": { "type": "integer", "description": "The number of octets of multicast packets that have been\n sent on the interface.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ipMRouteInterfaceHCInMcastOctets": { "type": "integer", "description": "The number of octets of multicast packets that have arrived\n on the interface, including framing characters. This object\n is a 64-bit version of ipMRouteInterfaceInMcastOctets. It\n is similar to ifHCInOctets in the Interfaces MIB, except\n that only multicast packets are counted.", "minimum": 0, "readOnly": true }, "ipMRouteInterfaceHCOutMcastOctets": { "type": "integer", "description": "The number of octets of multicast packets that have been\n \n \n \n \n \n sent on the interface. This object is a 64-bit version of\n ipMRouteInterfaceOutMcastOctets.", "minimum": 0, "readOnly": true } } }, "readOnly": true }, "ipMRouteBoundaryEntry": { "type": "array", "description": "An entry (conceptual row) in the ipMRouteBoundaryTable\n representing a scoped boundary.", "items": { "type": "object", "properties": { "ipMRouteBoundaryIfIndex": { "type": "string", "description": "The IfIndex value for the interface to which this boundary\n applies. Packets with a destination address in the\n associated address/mask range will not be forwarded out this\n interface.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "ipMRouteBoundaryAddress": { "type": "string", "description": "The group address which when combined with the\n corresponding value of ipMRouteBoundaryAddressMask\n identifies the group range for which the scoped boundary\n exists. Scoped addresses must come from the range 239.x.x.x\n as specified in RFC 2365.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteBoundaryAddressMask": { "type": "string", "description": "The group address mask which when combined with the\n corresponding value of ipMRouteBoundaryAddress identifies\n the group range for which the scoped boundary exists.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteBoundaryStatus": { "type": "string", "description": "The status of this row, by which new entries may be\n created, or old entries deleted from this table.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "ipMRouteScopeNameEntry": { "type": "array", "description": "An entry (conceptual row) in the ipMRouteScopeNameTable\n representing a multicast scope name.", "items": { "type": "object", "properties": { "ipMRouteScopeNameAddress": { "type": "string", "description": "The group address which when combined with the\n corresponding value of ipMRouteScopeNameAddressMask\n identifies the group range associated with the multicast\n scope. Scoped addresses must come from the range\n 239.x.x.x.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteScopeNameAddressMask": { "type": "string", "description": "The group address mask which when combined with the\n corresponding value of ipMRouteScopeNameAddress identifies\n the group range associated with the multicast scope.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteScopeNameLanguage": { "type": "string", "description": "The RFC 1766-style language tag associated with the scope\n name.", "x-yang-type": "IPMROUTE-STD-MIB:LanguageTag", "readOnly": true }, "ipMRouteScopeNameString": { "type": "string", "description": "The textual name associated with the multicast scope. The\n value of this object should be suitable for displaying to\n end-users, such as when allocating a multicast address in\n this scope. When no name is specified, the default value of\n this object should be the string 239.x.x.x/y with x and y\n replaced appropriately to describe the address and mask\n length associated with the scope.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "ipMRouteScopeNameDefault": { "type": "boolean", "description": "If true, indicates a preference that the name in the\n following language should be used by applications if no name\n is available in a desired language.", "readOnly": true }, "ipMRouteScopeNameStatus": { "type": "string", "description": "The status of this row, by which new entries may be\n created, or old entries deleted from this table.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "ipMRoute": { "type": "object", "description": "The enabled status of IP Multicast routing on this router.", "properties": { "ipMRouteEnable": { "type": "string", "description": "The enabled status of IP Multicast routing on this router.", "readOnly": true }, "ipMRouteEntryCount": { "type": "integer", "description": "The number of rows in the ipMRouteTable. This can be used\n to monitor the multicast routing table size.", "minimum": 0, "maximum": 4294967295, "readOnly": true } }, "readOnly": true }, "ipMRouteTable": { "type": "object", "description": "The (conceptual) table containing multicast routing\n information for IP datagrams sent by particular sources to\n the IP multicast groups known to this router.", "properties": { "ipMRouteEntry": { "type": "array", "description": "An entry (conceptual row) containing the multicast routing\n information for IP datagrams from a particular source and\n addressed to a particular IP multicast group address.\n Discontinuities in counters in this entry can be detected by\n observing the value of ipMRouteUpTime.", "items": { "type": "object", "properties": { "ipMRouteGroup": { "type": "string", "description": "The IP multicast group address for which this entry\n contains multicast routing information.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteSource": { "type": "string", "description": "The network address which when combined with the\n corresponding value of ipMRouteSourceMask identifies the\n sources for which this entry contains multicast routing\n information.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteSourceMask": { "type": "string", "description": "The network mask which when combined with the corresponding\n value of ipMRouteSource identifies the sources for which\n this entry contains multicast routing information.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteUpstreamNeighbor": { "type": "string", "description": "The address of the upstream neighbor (e.g., RPF neighbor)\n from which IP datagrams from these sources to this multicast\n address are received, or 0.0.0.0 if the upstream neighbor is\n unknown (e.g., in CBT).", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteInIfIndex": { "type": "string", "description": "The value of ifIndex for the interface on which IP\n datagrams sent by these sources to this multicast address\n are received. A value of 0 indicates that datagrams are not\n subject to an incoming interface check, but may be accepted\n on multiple interfaces (e.g., in CBT).", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "ipMRouteUpTime": { "type": "string", "description": "The time since the multicast routing information\n represented by this entry was learned by the router.", "x-yang-type": "yang:timeticks", "readOnly": true }, "ipMRouteExpiryTime": { "type": "string", "description": "The minimum amount of time remaining before this entry will\n be aged out. The value 0 indicates that the entry is not\n subject to aging.", "x-yang-type": "yang:timeticks", "readOnly": true }, "ipMRoutePkts": { "type": "integer", "description": "The number of packets which this router has received from\n these sources and addressed to this multicast group\n address.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ipMRouteDifferentInIfPackets": { "type": "integer", "description": "The number of packets which this router has received from\n these sources and addressed to this multicast group address,\n which were dropped because they were not received on the\n interface indicated by ipMRouteInIfIndex. Packets which are\n not subject to an incoming interface check (e.g., using CBT)\n are not counted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ipMRouteOctets": { "type": "integer", "description": "The number of octets contained in IP datagrams which were\n received from these sources and addressed to this multicast\n group address, and which were forwarded by this router.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ipMRouteProtocol": { "type": "string", "description": "The multicast routing protocol via which this multicast\n forwarding entry was learned.", "x-yang-type": "iana-rtproto:IANAipMRouteProtocol", "readOnly": true }, "ipMRouteRtProto": { "type": "string", "description": "The routing mechanism via which the route used to find the\n upstream or parent interface for this multicast forwarding\n entry was learned. Inclusion of values for routing\n protocols is not intended to imply that those protocols need\n be supported.", "x-yang-type": "iana-rtproto:IANAipRouteProtocol", "readOnly": true }, "ipMRouteRtAddress": { "type": "string", "description": "The address portion of the route used to find the upstream\n or parent interface for this multicast forwarding entry.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteRtMask": { "type": "string", "description": "The mask associated with the route used to find the upstream\n or parent interface for this multicast forwarding entry.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteRtType": { "type": "string", "description": "The reason the given route was placed in the (logical)\n multicast Routing Information Base (RIB). A value of\n unicast means that the route would normally be placed only\n in the unicast RIB, but was placed in the multicast RIB\n (instead or in addition) due to local configuration, such as\n when running PIM over RIP. A value of multicast means that\n \n \n \n \n \n the route was explicitly added to the multicast RIB by the\n routing protocol, such as DVMRP or Multiprotocol BGP.", "readOnly": true }, "ipMRouteHCOctets": { "type": "integer", "description": "The number of octets contained in IP datagrams which were\n received from these sources and addressed to this multicast\n group address, and which were forwarded by this router.\n This object is a 64-bit version of ipMRouteOctets.", "minimum": 0, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ipMRouteNextHopTable": { "type": "object", "description": "The (conceptual) table containing information on the next-\n hops on outgoing interfaces for routing IP multicast\n datagrams. Each entry is one of a list of next-hops on\n outgoing interfaces for particular sources sending to a\n particular multicast group address.", "properties": { "ipMRouteNextHopEntry": { "type": "array", "description": "An entry (conceptual row) in the list of next-hops on\n outgoing interfaces to which IP multicast datagrams from\n particular sources to a IP multicast group address are\n routed. Discontinuities in counters in this entry can be\n detected by observing the value of ipMRouteUpTime.", "items": { "type": "object", "properties": { "ipMRouteNextHopGroup": { "type": "string", "description": "The IP multicast group for which this entry specifies a\n next-hop on an outgoing interface.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteNextHopSource": { "type": "string", "description": "The network address which when combined with the\n corresponding value of ipMRouteNextHopSourceMask identifies\n the sources for which this entry specifies a next-hop on an\n outgoing interface.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteNextHopSourceMask": { "type": "string", "description": "The network mask which when combined with the corresponding\n value of ipMRouteNextHopSource identifies the sources for\n which this entry specifies a next-hop on an outgoing\n interface.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteNextHopIfIndex": { "type": "string", "description": "The ifIndex value of the interface for the outgoing\n interface for this next-hop.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "ipMRouteNextHopAddress": { "type": "string", "description": "The address of the next-hop specific to this entry. For\n most interfaces, this is identical to ipMRouteNextHopGroup.\n NBMA interfaces, however, may have multiple next-hop\n addresses out a single outgoing interface.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteNextHopState": { "type": "string", "description": "An indication of whether the outgoing interface and next-\n hop represented by this entry is currently being used to\n forward IP datagrams. The value 'forwarding' indicates it\n is currently being used; the value 'pruned' indicates it is\n not.", "readOnly": true }, "ipMRouteNextHopUpTime": { "type": "string", "description": "The time since the multicast routing information\n represented by this entry was learned by the router.", "x-yang-type": "yang:timeticks", "readOnly": true }, "ipMRouteNextHopExpiryTime": { "type": "string", "description": "The minimum amount of time remaining before this entry will\n be aged out. If ipMRouteNextHopState is pruned(1), the\n remaining time until the prune expires and the state reverts\n to forwarding(2). Otherwise, the remaining time until this\n entry is removed from the table. The time remaining may be\n copied from ipMRouteExpiryTime if the protocol in use for\n this entry does not specify next-hop timers. The value 0\n \n \n \n \n \n indicates that the entry is not subject to aging.", "x-yang-type": "yang:timeticks", "readOnly": true }, "ipMRouteNextHopClosestMemberHops": { "type": "integer", "description": "The minimum number of hops between this router and any\n member of this IP multicast group reached via this next-hop\n on this outgoing interface. Any IP multicast datagrams for\n the group which have a TTL less than this number of hops\n will not be forwarded to this next-hop.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipMRouteNextHopProtocol": { "type": "string", "description": "The routing mechanism via which this next-hop was learned.", "x-yang-type": "iana-rtproto:IANAipMRouteProtocol", "readOnly": true }, "ipMRouteNextHopPkts": { "type": "integer", "description": "The number of packets which have been forwarded using this\n route.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ipMRouteInterfaceTable": { "type": "object", "description": "The (conceptual) table containing multicast routing\n information specific to interfaces.", "properties": { "ipMRouteInterfaceEntry": { "type": "array", "description": "An entry (conceptual row) containing the multicast routing\n information for a particular interface.", "items": { "type": "object", "properties": { "ipMRouteInterfaceIfIndex": { "type": "string", "description": "The ifIndex value of the interface for which this entry\n contains information.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "ipMRouteInterfaceTtl": { "type": "integer", "description": "The datagram TTL threshold for the interface. Any IP\n multicast datagrams with a TTL less than this threshold will\n not be forwarded out the interface. The default value of 0\n means all multicast packets are forwarded out the\n interface.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipMRouteInterfaceProtocol": { "type": "string", "description": "The routing protocol running on this interface.", "x-yang-type": "iana-rtproto:IANAipMRouteProtocol", "readOnly": true }, "ipMRouteInterfaceRateLimit": { "type": "integer", "description": "The rate-limit, in kilobits per second, of forwarded\n multicast traffic on the interface. A rate-limit of 0\n indicates that no rate limiting is done.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipMRouteInterfaceInMcastOctets": { "type": "integer", "description": "The number of octets of multicast packets that have arrived\n on the interface, including framing characters. This object\n is similar to ifInOctets in the Interfaces MIB, except that\n only multicast packets are counted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ipMRouteInterfaceOutMcastOctets": { "type": "integer", "description": "The number of octets of multicast packets that have been\n sent on the interface.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ipMRouteInterfaceHCInMcastOctets": { "type": "integer", "description": "The number of octets of multicast packets that have arrived\n on the interface, including framing characters. This object\n is a 64-bit version of ipMRouteInterfaceInMcastOctets. It\n is similar to ifHCInOctets in the Interfaces MIB, except\n that only multicast packets are counted.", "minimum": 0, "readOnly": true }, "ipMRouteInterfaceHCOutMcastOctets": { "type": "integer", "description": "The number of octets of multicast packets that have been\n \n \n \n \n \n sent on the interface. This object is a 64-bit version of\n ipMRouteInterfaceOutMcastOctets.", "minimum": 0, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ipMRouteBoundaryTable": { "type": "object", "description": "The (conceptual) table listing the router's scoped\n multicast address boundaries.", "properties": { "ipMRouteBoundaryEntry": { "type": "array", "description": "An entry (conceptual row) in the ipMRouteBoundaryTable\n representing a scoped boundary.", "items": { "type": "object", "properties": { "ipMRouteBoundaryIfIndex": { "type": "string", "description": "The IfIndex value for the interface to which this boundary\n applies. Packets with a destination address in the\n associated address/mask range will not be forwarded out this\n interface.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "ipMRouteBoundaryAddress": { "type": "string", "description": "The group address which when combined with the\n corresponding value of ipMRouteBoundaryAddressMask\n identifies the group range for which the scoped boundary\n exists. Scoped addresses must come from the range 239.x.x.x\n as specified in RFC 2365.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteBoundaryAddressMask": { "type": "string", "description": "The group address mask which when combined with the\n corresponding value of ipMRouteBoundaryAddress identifies\n the group range for which the scoped boundary exists.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteBoundaryStatus": { "type": "string", "description": "The status of this row, by which new entries may be\n created, or old entries deleted from this table.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ipMRouteScopeNameTable": { "type": "object", "description": "The (conceptual) table listing the multicast scope names.", "properties": { "ipMRouteScopeNameEntry": { "type": "array", "description": "An entry (conceptual row) in the ipMRouteScopeNameTable\n representing a multicast scope name.", "items": { "type": "object", "properties": { "ipMRouteScopeNameAddress": { "type": "string", "description": "The group address which when combined with the\n corresponding value of ipMRouteScopeNameAddressMask\n identifies the group range associated with the multicast\n scope. Scoped addresses must come from the range\n 239.x.x.x.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteScopeNameAddressMask": { "type": "string", "description": "The group address mask which when combined with the\n corresponding value of ipMRouteScopeNameAddress identifies\n the group range associated with the multicast scope.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteScopeNameLanguage": { "type": "string", "description": "The RFC 1766-style language tag associated with the scope\n name.", "x-yang-type": "IPMROUTE-STD-MIB:LanguageTag", "readOnly": true }, "ipMRouteScopeNameString": { "type": "string", "description": "The textual name associated with the multicast scope. The\n value of this object should be suitable for displaying to\n end-users, such as when allocating a multicast address in\n this scope. When no name is specified, the default value of\n this object should be the string 239.x.x.x/y with x and y\n replaced appropriately to describe the address and mask\n length associated with the scope.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "ipMRouteScopeNameDefault": { "type": "boolean", "description": "If true, indicates a preference that the name in the\n following language should be used by applications if no name\n is available in a desired language.", "readOnly": true }, "ipMRouteScopeNameStatus": { "type": "string", "description": "The status of this row, by which new entries may be\n created, or old entries deleted from this table.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "IPMROUTE-STD-MIB_ipMRouteEntry": { "type": "array", "description": "An entry (conceptual row) containing the multicast routing\n information for IP datagrams from a particular source and\n addressed to a particular IP multicast group address.\n Discontinuities in counters in this entry can be detected by\n observing the value of ipMRouteUpTime.", "items": { "type": "object", "properties": { "ipMRouteGroup": { "type": "string", "description": "The IP multicast group address for which this entry\n contains multicast routing information.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteSource": { "type": "string", "description": "The network address which when combined with the\n corresponding value of ipMRouteSourceMask identifies the\n sources for which this entry contains multicast routing\n information.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteSourceMask": { "type": "string", "description": "The network mask which when combined with the corresponding\n value of ipMRouteSource identifies the sources for which\n this entry contains multicast routing information.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteUpstreamNeighbor": { "type": "string", "description": "The address of the upstream neighbor (e.g., RPF neighbor)\n from which IP datagrams from these sources to this multicast\n address are received, or 0.0.0.0 if the upstream neighbor is\n unknown (e.g., in CBT).", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteInIfIndex": { "type": "string", "description": "The value of ifIndex for the interface on which IP\n datagrams sent by these sources to this multicast address\n are received. A value of 0 indicates that datagrams are not\n subject to an incoming interface check, but may be accepted\n on multiple interfaces (e.g., in CBT).", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "ipMRouteUpTime": { "type": "string", "description": "The time since the multicast routing information\n represented by this entry was learned by the router.", "x-yang-type": "yang:timeticks", "readOnly": true }, "ipMRouteExpiryTime": { "type": "string", "description": "The minimum amount of time remaining before this entry will\n be aged out. The value 0 indicates that the entry is not\n subject to aging.", "x-yang-type": "yang:timeticks", "readOnly": true }, "ipMRoutePkts": { "type": "integer", "description": "The number of packets which this router has received from\n these sources and addressed to this multicast group\n address.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ipMRouteDifferentInIfPackets": { "type": "integer", "description": "The number of packets which this router has received from\n these sources and addressed to this multicast group address,\n which were dropped because they were not received on the\n interface indicated by ipMRouteInIfIndex. Packets which are\n not subject to an incoming interface check (e.g., using CBT)\n are not counted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ipMRouteOctets": { "type": "integer", "description": "The number of octets contained in IP datagrams which were\n received from these sources and addressed to this multicast\n group address, and which were forwarded by this router.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ipMRouteProtocol": { "type": "string", "description": "The multicast routing protocol via which this multicast\n forwarding entry was learned.", "x-yang-type": "iana-rtproto:IANAipMRouteProtocol", "readOnly": true }, "ipMRouteRtProto": { "type": "string", "description": "The routing mechanism via which the route used to find the\n upstream or parent interface for this multicast forwarding\n entry was learned. Inclusion of values for routing\n protocols is not intended to imply that those protocols need\n be supported.", "x-yang-type": "iana-rtproto:IANAipRouteProtocol", "readOnly": true }, "ipMRouteRtAddress": { "type": "string", "description": "The address portion of the route used to find the upstream\n or parent interface for this multicast forwarding entry.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteRtMask": { "type": "string", "description": "The mask associated with the route used to find the upstream\n or parent interface for this multicast forwarding entry.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteRtType": { "type": "string", "description": "The reason the given route was placed in the (logical)\n multicast Routing Information Base (RIB). A value of\n unicast means that the route would normally be placed only\n in the unicast RIB, but was placed in the multicast RIB\n (instead or in addition) due to local configuration, such as\n when running PIM over RIP. A value of multicast means that\n \n \n \n \n \n the route was explicitly added to the multicast RIB by the\n routing protocol, such as DVMRP or Multiprotocol BGP.", "readOnly": true }, "ipMRouteHCOctets": { "type": "integer", "description": "The number of octets contained in IP datagrams which were\n received from these sources and addressed to this multicast\n group address, and which were forwarded by this router.\n This object is a 64-bit version of ipMRouteOctets.", "minimum": 0, "readOnly": true } } } }, "IPMROUTE-STD-MIB_ipMRouteNextHopEntry": { "type": "array", "description": "An entry (conceptual row) in the list of next-hops on\n outgoing interfaces to which IP multicast datagrams from\n particular sources to a IP multicast group address are\n routed. Discontinuities in counters in this entry can be\n detected by observing the value of ipMRouteUpTime.", "items": { "type": "object", "properties": { "ipMRouteNextHopGroup": { "type": "string", "description": "The IP multicast group for which this entry specifies a\n next-hop on an outgoing interface.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteNextHopSource": { "type": "string", "description": "The network address which when combined with the\n corresponding value of ipMRouteNextHopSourceMask identifies\n the sources for which this entry specifies a next-hop on an\n outgoing interface.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteNextHopSourceMask": { "type": "string", "description": "The network mask which when combined with the corresponding\n value of ipMRouteNextHopSource identifies the sources for\n which this entry specifies a next-hop on an outgoing\n interface.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteNextHopIfIndex": { "type": "string", "description": "The ifIndex value of the interface for the outgoing\n interface for this next-hop.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "ipMRouteNextHopAddress": { "type": "string", "description": "The address of the next-hop specific to this entry. For\n most interfaces, this is identical to ipMRouteNextHopGroup.\n NBMA interfaces, however, may have multiple next-hop\n addresses out a single outgoing interface.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteNextHopState": { "type": "string", "description": "An indication of whether the outgoing interface and next-\n hop represented by this entry is currently being used to\n forward IP datagrams. The value 'forwarding' indicates it\n is currently being used; the value 'pruned' indicates it is\n not.", "readOnly": true }, "ipMRouteNextHopUpTime": { "type": "string", "description": "The time since the multicast routing information\n represented by this entry was learned by the router.", "x-yang-type": "yang:timeticks", "readOnly": true }, "ipMRouteNextHopExpiryTime": { "type": "string", "description": "The minimum amount of time remaining before this entry will\n be aged out. If ipMRouteNextHopState is pruned(1), the\n remaining time until the prune expires and the state reverts\n to forwarding(2). Otherwise, the remaining time until this\n entry is removed from the table. The time remaining may be\n copied from ipMRouteExpiryTime if the protocol in use for\n this entry does not specify next-hop timers. The value 0\n \n \n \n \n \n indicates that the entry is not subject to aging.", "x-yang-type": "yang:timeticks", "readOnly": true }, "ipMRouteNextHopClosestMemberHops": { "type": "integer", "description": "The minimum number of hops between this router and any\n member of this IP multicast group reached via this next-hop\n on this outgoing interface. Any IP multicast datagrams for\n the group which have a TTL less than this number of hops\n will not be forwarded to this next-hop.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipMRouteNextHopProtocol": { "type": "string", "description": "The routing mechanism via which this next-hop was learned.", "x-yang-type": "iana-rtproto:IANAipMRouteProtocol", "readOnly": true }, "ipMRouteNextHopPkts": { "type": "integer", "description": "The number of packets which have been forwarded using this\n route.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } } }, "IPMROUTE-STD-MIB_ipMRouteInterfaceEntry": { "type": "array", "description": "An entry (conceptual row) containing the multicast routing\n information for a particular interface.", "items": { "type": "object", "properties": { "ipMRouteInterfaceIfIndex": { "type": "string", "description": "The ifIndex value of the interface for which this entry\n contains information.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "ipMRouteInterfaceTtl": { "type": "integer", "description": "The datagram TTL threshold for the interface. Any IP\n multicast datagrams with a TTL less than this threshold will\n not be forwarded out the interface. The default value of 0\n means all multicast packets are forwarded out the\n interface.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipMRouteInterfaceProtocol": { "type": "string", "description": "The routing protocol running on this interface.", "x-yang-type": "iana-rtproto:IANAipMRouteProtocol", "readOnly": true }, "ipMRouteInterfaceRateLimit": { "type": "integer", "description": "The rate-limit, in kilobits per second, of forwarded\n multicast traffic on the interface. A rate-limit of 0\n indicates that no rate limiting is done.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipMRouteInterfaceInMcastOctets": { "type": "integer", "description": "The number of octets of multicast packets that have arrived\n on the interface, including framing characters. This object\n is similar to ifInOctets in the Interfaces MIB, except that\n only multicast packets are counted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ipMRouteInterfaceOutMcastOctets": { "type": "integer", "description": "The number of octets of multicast packets that have been\n sent on the interface.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ipMRouteInterfaceHCInMcastOctets": { "type": "integer", "description": "The number of octets of multicast packets that have arrived\n on the interface, including framing characters. This object\n is a 64-bit version of ipMRouteInterfaceInMcastOctets. It\n is similar to ifHCInOctets in the Interfaces MIB, except\n that only multicast packets are counted.", "minimum": 0, "readOnly": true }, "ipMRouteInterfaceHCOutMcastOctets": { "type": "integer", "description": "The number of octets of multicast packets that have been\n \n \n \n \n \n sent on the interface. This object is a 64-bit version of\n ipMRouteInterfaceOutMcastOctets.", "minimum": 0, "readOnly": true } } } }, "IPMROUTE-STD-MIB_ipMRouteBoundaryEntry": { "type": "array", "description": "An entry (conceptual row) in the ipMRouteBoundaryTable\n representing a scoped boundary.", "items": { "type": "object", "properties": { "ipMRouteBoundaryIfIndex": { "type": "string", "description": "The IfIndex value for the interface to which this boundary\n applies. Packets with a destination address in the\n associated address/mask range will not be forwarded out this\n interface.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "ipMRouteBoundaryAddress": { "type": "string", "description": "The group address which when combined with the\n corresponding value of ipMRouteBoundaryAddressMask\n identifies the group range for which the scoped boundary\n exists. Scoped addresses must come from the range 239.x.x.x\n as specified in RFC 2365.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteBoundaryAddressMask": { "type": "string", "description": "The group address mask which when combined with the\n corresponding value of ipMRouteBoundaryAddress identifies\n the group range for which the scoped boundary exists.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteBoundaryStatus": { "type": "string", "description": "The status of this row, by which new entries may be\n created, or old entries deleted from this table.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } } }, "IPMROUTE-STD-MIB_ipMRouteScopeNameEntry": { "type": "array", "description": "An entry (conceptual row) in the ipMRouteScopeNameTable\n representing a multicast scope name.", "items": { "type": "object", "properties": { "ipMRouteScopeNameAddress": { "type": "string", "description": "The group address which when combined with the\n corresponding value of ipMRouteScopeNameAddressMask\n identifies the group range associated with the multicast\n scope. Scoped addresses must come from the range\n 239.x.x.x.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteScopeNameAddressMask": { "type": "string", "description": "The group address mask which when combined with the\n corresponding value of ipMRouteScopeNameAddress identifies\n the group range associated with the multicast scope.", "format": "inet:ipv4-address", "readOnly": true }, "ipMRouteScopeNameLanguage": { "type": "string", "description": "The RFC 1766-style language tag associated with the scope\n name.", "x-yang-type": "IPMROUTE-STD-MIB:LanguageTag", "readOnly": true }, "ipMRouteScopeNameString": { "type": "string", "description": "The textual name associated with the multicast scope. The\n value of this object should be suitable for displaying to\n end-users, such as when allocating a multicast address in\n this scope. When no name is specified, the default value of\n this object should be the string 239.x.x.x/y with x and y\n replaced appropriately to describe the address and mask\n length associated with the scope.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "ipMRouteScopeNameDefault": { "type": "boolean", "description": "If true, indicates a preference that the name in the\n following language should be used by applications if no name\n is available in a desired language.", "readOnly": true }, "ipMRouteScopeNameStatus": { "type": "string", "description": "The status of this row, by which new entries may be\n created, or old entries deleted from 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": "IPMROUTE-STD-MIB", "description": "MIB operations for IPMROUTE-STD-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }