{ "openapi": "3.0.0", "info": { "title": "IP-FORWARD-MIB MIB API", "version": "1.0.0", "description": "The MIB module for the display of CIDR multipath IP Routes.\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 IP-FORWARD-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/IP-FORWARD-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "IP-FORWARD-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/IP-FORWARD-MIB:ipForward": { "get": { "summary": "Get ipForward data", "description": "Retrieve ipForward operational data from MIB", "tags": [ "IP-FORWARD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The number of current ipForwardTable entries\n that are not invalid.", "properties": { "ipForwardNumber": { "type": "integer", "description": "The number of current ipForwardTable entries\n that are not invalid.", "minimum": 0, "maximum": 4294967295 }, "ipCidrRouteNumber": { "type": "integer", "description": "The number of current ipCidrRouteTable entries\n that are not invalid.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "IP-FORWARD-MIB:ipForward": { "ipForwardNumber": 0, "ipCidrRouteNumber": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipForward", "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": "/ipForward", "x-restconf-kind": "container" }, "/data/IP-FORWARD-MIB:ipForwardTable": { "get": { "summary": "Get ipForwardTable data", "description": "Retrieve ipForwardTable operational data from MIB", "tags": [ "IP-FORWARD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This entity's IP Routing table.", "properties": { "ipForwardEntry": { "type": "array", "description": "A particular route to a particular destina-\n tion, under a particular policy.", "items": { "type": "object", "properties": { "ipForwardDest": { "type": "string", "description": "The destination IP address of this route. An\n entry with a value of 0.0.0.0 is considered a\n default route.\n \n This object may not take a Multicast (Class D)\n address value.\n \n Any assignment (implicit or otherwise) of an\n instance of this object to a value x must be\n rejected if the bitwise logical-AND of x with\n the value of the corresponding instance of the\n ipForwardMask object is not equal to x.", "format": "inet:ipv4-address" }, "ipForwardMask": { "type": "string", "description": "Indicate the mask to be logical-ANDed with the\n destination address before being compared to\n the value in the ipForwardDest field. For\n those systems that do not support arbitrary\n subnet masks, an agent constructs the value of\n the ipForwardMask by reference to the IP Ad-\n dress Class.\n \n Any assignment (implicit or otherwise) of an\n instance of this object to a value x must be\n rejected if the bitwise logical-AND of x with\n the value of the corresponding instance of the\n ipForwardDest object is not equal to ipForward-\n Dest.", "format": "inet:ipv4-address" }, "ipForwardPolicy": { "type": "integer", "description": "The general set of conditions that would cause\n the selection of one multipath route (set of\n next hops for a given destination) is referred\n to as 'policy'.\n \n Unless the mechanism indicated by ipForwardPro-\n to specifies otherwise, the policy specifier is\n the IP TOS Field. The encoding of IP TOS is as\n specified by the following convention. Zero\n indicates the default path if no more specific\n policy applies.\n \n +-----+-----+-----+-----+-----+-----+-----+-----+\n | | | |\n | PRECEDENCE | TYPE OF SERVICE | 0 |\n | | | |\n +-----+-----+-----+-----+-----+-----+-----+-----+\n \n IP TOS IP TOS\n Field Policy Field Policy\n Contents Code Contents Code\n 0 0 0 0 ==> 0 0 0 0 1 ==> 2\n 0 0 1 0 ==> 4 0 0 1 1 ==> 6\n 0 1 0 0 ==> 8 0 1 0 1 ==> 10\n 0 1 1 0 ==> 12 0 1 1 1 ==> 14\n 1 0 0 0 ==> 16 1 0 0 1 ==> 18\n 1 0 1 0 ==> 20 1 0 1 1 ==> 22\n 1 1 0 0 ==> 24 1 1 0 1 ==> 26\n 1 1 1 0 ==> 28 1 1 1 1 ==> 30\n \n Protocols defining 'policy' otherwise must ei-\n ther define a set of values which are valid for\n this object or must implement an integer-\n instanced policy table for which this object's\n value acts as an index.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardNextHop": { "type": "string", "description": "On remote routes, the address of the next sys-\n tem en route; Otherwise, 0.0.0.0.", "format": "inet:ipv4-address" }, "ipForwardIfIndex": { "type": "integer", "description": "The ifIndex value which identifies the local\n interface through which the next hop of this\n route should be reached.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardType": { "type": "string", "description": "The type of route. Note that local(3) refers\n to a route for which the next hop is the final\n destination; remote(4) refers to a route for\n which the next hop is not the final destina-\n tion.\n \n Setting this object to the value invalid(2) has\n the effect of invalidating the corresponding\n entry in the ipForwardTable object. That is,\n it effectively disassociates the destination\n identified with said entry from the route iden-\n tified with said entry. It is an\n implementation-specific matter as to whether\n the agent removes an invalidated entry from the\n table. Accordingly, management stations must\n be prepared to receive tabular information from\n agents that corresponds to entries not current-\n ly in use. Proper interpretation of such en-\n tries requires examination of the relevant ip-\n ForwardType object." }, "ipForwardProto": { "type": "string", "description": "The routing mechanism via which this route was\n learned. Inclusion of values for gateway rout-\n ing protocols is not intended to imply that\n hosts should support those protocols." }, "ipForwardAge": { "type": "integer", "description": "The number of seconds since this route was\n last updated or otherwise determined to be\n correct. Note that no semantics of `too old'\n can be implied except through knowledge of the\n routing protocol by which the route was\n learned.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardInfo": { "type": "string", "description": "A reference to MIB definitions specific to the\n particular routing protocol which is responsi-\n ble for this route, as determined by the value\n specified in the route's ipForwardProto value.\n If this information is not present, its value\n should be set to the OBJECT IDENTIFIER { 0 0 },\n which is a syntactically valid object identif-\n ier, and any implementation conforming to ASN.1\n and the Basic Encoding Rules must be able to\n generate and recognize this value.", "x-yang-type": "yang:object-identifier-128" }, "ipForwardNextHopAS": { "type": "integer", "description": "The Autonomous System Number of the Next Hop.\n When this is unknown or not relevant to the\n protocol indicated by ipForwardProto, zero.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardMetric1": { "type": "integer", "description": "The primary routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardMetric2": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardMetric3": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardMetric4": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardMetric5": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 } } } } } }, "example": { "IP-FORWARD-MIB:ipForwardTable": { "ipForwardEntry": [ { "ipForwardDest": "192.168.1.1", "ipForwardMask": "192.168.1.1", "ipForwardPolicy": -2147483648, "ipForwardNextHop": "192.168.1.1", "ipForwardIfIndex": 1, "ipForwardType": "192.168.1.1", "ipForwardProto": "192.168.1.1", "ipForwardAge": -2147483648, "ipForwardInfo": "192.168.1.1", "ipForwardNextHopAS": -2147483648, "ipForwardMetric1": -2147483648, "ipForwardMetric2": -2147483648, "ipForwardMetric3": -2147483648, "ipForwardMetric4": -2147483648, "ipForwardMetric5": -2147483648 }, { "ipForwardDest": "192.168.1.1", "ipForwardMask": "192.168.1.1", "ipForwardPolicy": -2147483648, "ipForwardNextHop": "192.168.1.1", "ipForwardIfIndex": 2, "ipForwardType": "192.168.1.1", "ipForwardProto": "192.168.1.1", "ipForwardAge": -2147483648, "ipForwardInfo": "192.168.1.1", "ipForwardNextHopAS": -2147483648, "ipForwardMetric1": -2147483648, "ipForwardMetric2": -2147483648, "ipForwardMetric3": -2147483648, "ipForwardMetric4": -2147483648, "ipForwardMetric5": -2147483648 }, { "ipForwardDest": "192.168.1.1", "ipForwardMask": "192.168.1.1", "ipForwardPolicy": -2147483648, "ipForwardNextHop": "192.168.1.1", "ipForwardIfIndex": 3, "ipForwardType": "192.168.1.1", "ipForwardProto": "192.168.1.1", "ipForwardAge": -2147483648, "ipForwardInfo": "192.168.1.1", "ipForwardNextHopAS": -2147483648, "ipForwardMetric1": -2147483648, "ipForwardMetric2": -2147483648, "ipForwardMetric3": -2147483648, "ipForwardMetric4": -2147483648, "ipForwardMetric5": -2147483648 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipForwardTable", "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": "/ipForwardTable", "x-restconf-kind": "container" }, "/data/IP-FORWARD-MIB:ipForwardTable/ipForwardEntry": { "get": { "summary": "Get ipForwardEntry list", "description": "Retrieve list of ipForwardEntry entries from MIB", "tags": [ "IP-FORWARD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A particular route to a particular destina-\n tion, under a particular policy.", "items": { "type": "object", "properties": { "ipForwardDest": { "type": "string", "description": "The destination IP address of this route. An\n entry with a value of 0.0.0.0 is considered a\n default route.\n \n This object may not take a Multicast (Class D)\n address value.\n \n Any assignment (implicit or otherwise) of an\n instance of this object to a value x must be\n rejected if the bitwise logical-AND of x with\n the value of the corresponding instance of the\n ipForwardMask object is not equal to x.", "format": "inet:ipv4-address" }, "ipForwardMask": { "type": "string", "description": "Indicate the mask to be logical-ANDed with the\n destination address before being compared to\n the value in the ipForwardDest field. For\n those systems that do not support arbitrary\n subnet masks, an agent constructs the value of\n the ipForwardMask by reference to the IP Ad-\n dress Class.\n \n Any assignment (implicit or otherwise) of an\n instance of this object to a value x must be\n rejected if the bitwise logical-AND of x with\n the value of the corresponding instance of the\n ipForwardDest object is not equal to ipForward-\n Dest.", "format": "inet:ipv4-address" }, "ipForwardPolicy": { "type": "integer", "description": "The general set of conditions that would cause\n the selection of one multipath route (set of\n next hops for a given destination) is referred\n to as 'policy'.\n \n Unless the mechanism indicated by ipForwardPro-\n to specifies otherwise, the policy specifier is\n the IP TOS Field. The encoding of IP TOS is as\n specified by the following convention. Zero\n indicates the default path if no more specific\n policy applies.\n \n +-----+-----+-----+-----+-----+-----+-----+-----+\n | | | |\n | PRECEDENCE | TYPE OF SERVICE | 0 |\n | | | |\n +-----+-----+-----+-----+-----+-----+-----+-----+\n \n IP TOS IP TOS\n Field Policy Field Policy\n Contents Code Contents Code\n 0 0 0 0 ==> 0 0 0 0 1 ==> 2\n 0 0 1 0 ==> 4 0 0 1 1 ==> 6\n 0 1 0 0 ==> 8 0 1 0 1 ==> 10\n 0 1 1 0 ==> 12 0 1 1 1 ==> 14\n 1 0 0 0 ==> 16 1 0 0 1 ==> 18\n 1 0 1 0 ==> 20 1 0 1 1 ==> 22\n 1 1 0 0 ==> 24 1 1 0 1 ==> 26\n 1 1 1 0 ==> 28 1 1 1 1 ==> 30\n \n Protocols defining 'policy' otherwise must ei-\n ther define a set of values which are valid for\n this object or must implement an integer-\n instanced policy table for which this object's\n value acts as an index.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardNextHop": { "type": "string", "description": "On remote routes, the address of the next sys-\n tem en route; Otherwise, 0.0.0.0.", "format": "inet:ipv4-address" }, "ipForwardIfIndex": { "type": "integer", "description": "The ifIndex value which identifies the local\n interface through which the next hop of this\n route should be reached.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardType": { "type": "string", "description": "The type of route. Note that local(3) refers\n to a route for which the next hop is the final\n destination; remote(4) refers to a route for\n which the next hop is not the final destina-\n tion.\n \n Setting this object to the value invalid(2) has\n the effect of invalidating the corresponding\n entry in the ipForwardTable object. That is,\n it effectively disassociates the destination\n identified with said entry from the route iden-\n tified with said entry. It is an\n implementation-specific matter as to whether\n the agent removes an invalidated entry from the\n table. Accordingly, management stations must\n be prepared to receive tabular information from\n agents that corresponds to entries not current-\n ly in use. Proper interpretation of such en-\n tries requires examination of the relevant ip-\n ForwardType object." }, "ipForwardProto": { "type": "string", "description": "The routing mechanism via which this route was\n learned. Inclusion of values for gateway rout-\n ing protocols is not intended to imply that\n hosts should support those protocols." }, "ipForwardAge": { "type": "integer", "description": "The number of seconds since this route was\n last updated or otherwise determined to be\n correct. Note that no semantics of `too old'\n can be implied except through knowledge of the\n routing protocol by which the route was\n learned.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardInfo": { "type": "string", "description": "A reference to MIB definitions specific to the\n particular routing protocol which is responsi-\n ble for this route, as determined by the value\n specified in the route's ipForwardProto value.\n If this information is not present, its value\n should be set to the OBJECT IDENTIFIER { 0 0 },\n which is a syntactically valid object identif-\n ier, and any implementation conforming to ASN.1\n and the Basic Encoding Rules must be able to\n generate and recognize this value.", "x-yang-type": "yang:object-identifier-128" }, "ipForwardNextHopAS": { "type": "integer", "description": "The Autonomous System Number of the Next Hop.\n When this is unknown or not relevant to the\n protocol indicated by ipForwardProto, zero.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardMetric1": { "type": "integer", "description": "The primary routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardMetric2": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardMetric3": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardMetric4": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardMetric5": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 } } } }, "example": { "IP-FORWARD-MIB:ipForwardEntry": [ { "ipForwardDest": "192.168.1.1", "ipForwardMask": "192.168.1.1", "ipForwardPolicy": -2147483648, "ipForwardNextHop": "192.168.1.1", "ipForwardIfIndex": 1, "ipForwardType": "192.168.1.1", "ipForwardProto": "192.168.1.1", "ipForwardAge": -2147483648, "ipForwardInfo": "192.168.1.1", "ipForwardNextHopAS": -2147483648, "ipForwardMetric1": -2147483648, "ipForwardMetric2": -2147483648, "ipForwardMetric3": -2147483648, "ipForwardMetric4": -2147483648, "ipForwardMetric5": -2147483648 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipForwardEntry", "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": "/ipForwardTable/ipForwardEntry", "x-restconf-kind": "container" }, "/data/IP-FORWARD-MIB:ipCidrRouteTable": { "get": { "summary": "Get ipCidrRouteTable data", "description": "Retrieve ipCidrRouteTable operational data from MIB", "tags": [ "IP-FORWARD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This entity's IP Routing table.", "properties": { "ipCidrRouteEntry": { "type": "array", "description": "A particular route to a particular destina-\n tion, under a particular policy.", "items": { "type": "object", "properties": { "ipCidrRouteDest": { "type": "string", "description": "The destination IP address of this route.\n \n This object may not take a Multicast (Class D)\n address value.\n \n Any assignment (implicit or otherwise) of an\n instance of this object to a value x must be\n rejected if the bitwise logical-AND of x with\n the value of the corresponding instance of the\n ipCidrRouteMask object is not equal to x.", "format": "inet:ipv4-address" }, "ipCidrRouteMask": { "type": "string", "description": "Indicate the mask to be logical-ANDed with the\n destination address before being compared to\n the value in the ipCidrRouteDest field. For\n those systems that do not support arbitrary\n subnet masks, an agent constructs the value of\n the ipCidrRouteMask by reference to the IP Ad-\n dress Class.\n \n Any assignment (implicit or otherwise) of an\n instance of this object to a value x must be\n rejected if the bitwise logical-AND of x with\n the value of the corresponding instance of the\n ipCidrRouteDest object is not equal to ipCidrRoute-\n Dest.", "format": "inet:ipv4-address" }, "ipCidrRouteTos": { "type": "integer", "description": "The policy specifier is the IP TOS Field. The encoding\n of IP TOS is as specified by the following convention.\n Zero indicates the default path if no more specific\n policy applies.\n \n +-----+-----+-----+-----+-----+-----+-----+-----+\n | | | |\n | PRECEDENCE | TYPE OF SERVICE | 0 |\n | | | |\n +-----+-----+-----+-----+-----+-----+-----+-----+\n \n IP TOS IP TOS\n Field Policy Field Policy\n Contents Code Contents Code\n 0 0 0 0 ==> 0 0 0 0 1 ==> 2\n 0 0 1 0 ==> 4 0 0 1 1 ==> 6\n 0 1 0 0 ==> 8 0 1 0 1 ==> 10\n 0 1 1 0 ==> 12 0 1 1 1 ==> 14\n 1 0 0 0 ==> 16 1 0 0 1 ==> 18\n 1 0 1 0 ==> 20 1 0 1 1 ==> 22\n 1 1 0 0 ==> 24 1 1 0 1 ==> 26\n 1 1 1 0 ==> 28 1 1 1 1 ==> 30", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteNextHop": { "type": "string", "description": "On remote routes, the address of the next sys-\n tem en route; Otherwise, 0.0.0.0.", "format": "inet:ipv4-address" }, "ipCidrRouteIfIndex": { "type": "integer", "description": "The ifIndex value which identifies the local\n interface through which the next hop of this\n route should be reached.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteType": { "type": "string", "description": "The type of route. Note that local(3) refers\n to a route for which the next hop is the final\n destination; remote(4) refers to a route for\n which the next hop is not the final destina-\n tion.\n \n Routes which do not result in traffic forwarding or\n rejection should not be displayed even if the\n implementation keeps them stored internally.\n \n \n reject (2) refers to a route which, if matched, discards\n the message as unreachable. This is used in some\n protocols as a means of correctly aggregating routes." }, "ipCidrRouteProto": { "type": "string", "description": "The routing mechanism via which this route was\n learned. Inclusion of values for gateway rout-\n ing protocols is not intended to imply that\n hosts should support those protocols." }, "ipCidrRouteAge": { "type": "integer", "description": "The number of seconds since this route was\n last updated or otherwise determined to be\n correct. Note that no semantics of `too old'\n can be implied except through knowledge of the\n routing protocol by which the route was\n learned.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteInfo": { "type": "string", "description": "A reference to MIB definitions specific to the\n particular routing protocol which is responsi-\n ble for this route, as determined by the value\n specified in the route's ipCidrRouteProto value.\n If this information is not present, its value\n should be set to the OBJECT IDENTIFIER { 0 0 },\n which is a syntactically valid object identif-\n ier, and any implementation conforming to ASN.1\n and the Basic Encoding Rules must be able to\n generate and recognize this value.", "x-yang-type": "yang:object-identifier-128" }, "ipCidrRouteNextHopAS": { "type": "integer", "description": "The Autonomous System Number of the Next Hop.\n The semantics of this object are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. When this object is\n unknown or not relevant its value should be set\n to zero.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteMetric1": { "type": "integer", "description": "The primary routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteMetric2": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteMetric3": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteMetric4": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteMetric5": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteStatus": { "type": "string", "description": "The row status variable, used according to\n row installation and removal conventions.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "IP-FORWARD-MIB:ipCidrRouteTable": { "ipCidrRouteEntry": [ { "ipCidrRouteDest": "192.168.1.1", "ipCidrRouteMask": "192.168.1.1", "ipCidrRouteTos": -2147483648, "ipCidrRouteNextHop": "192.168.1.1", "ipCidrRouteIfIndex": 1, "ipCidrRouteType": "192.168.1.1", "ipCidrRouteProto": "192.168.1.1", "ipCidrRouteAge": -2147483648, "ipCidrRouteInfo": "192.168.1.1", "ipCidrRouteNextHopAS": -2147483648, "ipCidrRouteMetric1": -2147483648, "ipCidrRouteMetric2": -2147483648, "ipCidrRouteMetric3": -2147483648, "ipCidrRouteMetric4": -2147483648, "ipCidrRouteMetric5": -2147483648, "ipCidrRouteStatus": "192.168.1.1" }, { "ipCidrRouteDest": "192.168.1.1", "ipCidrRouteMask": "192.168.1.1", "ipCidrRouteTos": -2147483648, "ipCidrRouteNextHop": "192.168.1.1", "ipCidrRouteIfIndex": 2, "ipCidrRouteType": "192.168.1.1", "ipCidrRouteProto": "192.168.1.1", "ipCidrRouteAge": -2147483648, "ipCidrRouteInfo": "192.168.1.1", "ipCidrRouteNextHopAS": -2147483648, "ipCidrRouteMetric1": -2147483648, "ipCidrRouteMetric2": -2147483648, "ipCidrRouteMetric3": -2147483648, "ipCidrRouteMetric4": -2147483648, "ipCidrRouteMetric5": -2147483648, "ipCidrRouteStatus": "192.168.1.1" }, { "ipCidrRouteDest": "192.168.1.1", "ipCidrRouteMask": "192.168.1.1", "ipCidrRouteTos": -2147483648, "ipCidrRouteNextHop": "192.168.1.1", "ipCidrRouteIfIndex": 3, "ipCidrRouteType": "192.168.1.1", "ipCidrRouteProto": "192.168.1.1", "ipCidrRouteAge": -2147483648, "ipCidrRouteInfo": "192.168.1.1", "ipCidrRouteNextHopAS": -2147483648, "ipCidrRouteMetric1": -2147483648, "ipCidrRouteMetric2": -2147483648, "ipCidrRouteMetric3": -2147483648, "ipCidrRouteMetric4": -2147483648, "ipCidrRouteMetric5": -2147483648, "ipCidrRouteStatus": "192.168.1.1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipCidrRouteTable", "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": "/ipCidrRouteTable", "x-restconf-kind": "container" }, "/data/IP-FORWARD-MIB:ipCidrRouteTable/ipCidrRouteEntry": { "get": { "summary": "Get ipCidrRouteEntry list", "description": "Retrieve list of ipCidrRouteEntry entries from MIB", "tags": [ "IP-FORWARD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A particular route to a particular destina-\n tion, under a particular policy.", "items": { "type": "object", "properties": { "ipCidrRouteDest": { "type": "string", "description": "The destination IP address of this route.\n \n This object may not take a Multicast (Class D)\n address value.\n \n Any assignment (implicit or otherwise) of an\n instance of this object to a value x must be\n rejected if the bitwise logical-AND of x with\n the value of the corresponding instance of the\n ipCidrRouteMask object is not equal to x.", "format": "inet:ipv4-address" }, "ipCidrRouteMask": { "type": "string", "description": "Indicate the mask to be logical-ANDed with the\n destination address before being compared to\n the value in the ipCidrRouteDest field. For\n those systems that do not support arbitrary\n subnet masks, an agent constructs the value of\n the ipCidrRouteMask by reference to the IP Ad-\n dress Class.\n \n Any assignment (implicit or otherwise) of an\n instance of this object to a value x must be\n rejected if the bitwise logical-AND of x with\n the value of the corresponding instance of the\n ipCidrRouteDest object is not equal to ipCidrRoute-\n Dest.", "format": "inet:ipv4-address" }, "ipCidrRouteTos": { "type": "integer", "description": "The policy specifier is the IP TOS Field. The encoding\n of IP TOS is as specified by the following convention.\n Zero indicates the default path if no more specific\n policy applies.\n \n +-----+-----+-----+-----+-----+-----+-----+-----+\n | | | |\n | PRECEDENCE | TYPE OF SERVICE | 0 |\n | | | |\n +-----+-----+-----+-----+-----+-----+-----+-----+\n \n IP TOS IP TOS\n Field Policy Field Policy\n Contents Code Contents Code\n 0 0 0 0 ==> 0 0 0 0 1 ==> 2\n 0 0 1 0 ==> 4 0 0 1 1 ==> 6\n 0 1 0 0 ==> 8 0 1 0 1 ==> 10\n 0 1 1 0 ==> 12 0 1 1 1 ==> 14\n 1 0 0 0 ==> 16 1 0 0 1 ==> 18\n 1 0 1 0 ==> 20 1 0 1 1 ==> 22\n 1 1 0 0 ==> 24 1 1 0 1 ==> 26\n 1 1 1 0 ==> 28 1 1 1 1 ==> 30", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteNextHop": { "type": "string", "description": "On remote routes, the address of the next sys-\n tem en route; Otherwise, 0.0.0.0.", "format": "inet:ipv4-address" }, "ipCidrRouteIfIndex": { "type": "integer", "description": "The ifIndex value which identifies the local\n interface through which the next hop of this\n route should be reached.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteType": { "type": "string", "description": "The type of route. Note that local(3) refers\n to a route for which the next hop is the final\n destination; remote(4) refers to a route for\n which the next hop is not the final destina-\n tion.\n \n Routes which do not result in traffic forwarding or\n rejection should not be displayed even if the\n implementation keeps them stored internally.\n \n \n reject (2) refers to a route which, if matched, discards\n the message as unreachable. This is used in some\n protocols as a means of correctly aggregating routes." }, "ipCidrRouteProto": { "type": "string", "description": "The routing mechanism via which this route was\n learned. Inclusion of values for gateway rout-\n ing protocols is not intended to imply that\n hosts should support those protocols." }, "ipCidrRouteAge": { "type": "integer", "description": "The number of seconds since this route was\n last updated or otherwise determined to be\n correct. Note that no semantics of `too old'\n can be implied except through knowledge of the\n routing protocol by which the route was\n learned.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteInfo": { "type": "string", "description": "A reference to MIB definitions specific to the\n particular routing protocol which is responsi-\n ble for this route, as determined by the value\n specified in the route's ipCidrRouteProto value.\n If this information is not present, its value\n should be set to the OBJECT IDENTIFIER { 0 0 },\n which is a syntactically valid object identif-\n ier, and any implementation conforming to ASN.1\n and the Basic Encoding Rules must be able to\n generate and recognize this value.", "x-yang-type": "yang:object-identifier-128" }, "ipCidrRouteNextHopAS": { "type": "integer", "description": "The Autonomous System Number of the Next Hop.\n The semantics of this object are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. When this object is\n unknown or not relevant its value should be set\n to zero.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteMetric1": { "type": "integer", "description": "The primary routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteMetric2": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteMetric3": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteMetric4": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteMetric5": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteStatus": { "type": "string", "description": "The row status variable, used according to\n row installation and removal conventions.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "IP-FORWARD-MIB:ipCidrRouteEntry": [ { "ipCidrRouteDest": "192.168.1.1", "ipCidrRouteMask": "192.168.1.1", "ipCidrRouteTos": -2147483648, "ipCidrRouteNextHop": "192.168.1.1", "ipCidrRouteIfIndex": 1, "ipCidrRouteType": "192.168.1.1", "ipCidrRouteProto": "192.168.1.1", "ipCidrRouteAge": -2147483648, "ipCidrRouteInfo": "192.168.1.1", "ipCidrRouteNextHopAS": -2147483648, "ipCidrRouteMetric1": -2147483648, "ipCidrRouteMetric2": -2147483648, "ipCidrRouteMetric3": -2147483648, "ipCidrRouteMetric4": -2147483648, "ipCidrRouteMetric5": -2147483648, "ipCidrRouteStatus": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipCidrRouteEntry", "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": "/ipCidrRouteTable/ipCidrRouteEntry", "x-restconf-kind": "container" }, "/data/IP-FORWARD-MIB:ipForwardEntry": { "get": { "summary": "Get ipForwardEntry list", "description": "Retrieve list of ipForwardEntry entries from MIB", "tags": [ "IP-FORWARD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A particular route to a particular destina-\n tion, under a particular policy.", "items": { "type": "object", "properties": { "ipForwardDest": { "type": "string", "description": "The destination IP address of this route. An\n entry with a value of 0.0.0.0 is considered a\n default route.\n \n This object may not take a Multicast (Class D)\n address value.\n \n Any assignment (implicit or otherwise) of an\n instance of this object to a value x must be\n rejected if the bitwise logical-AND of x with\n the value of the corresponding instance of the\n ipForwardMask object is not equal to x.", "format": "inet:ipv4-address" }, "ipForwardMask": { "type": "string", "description": "Indicate the mask to be logical-ANDed with the\n destination address before being compared to\n the value in the ipForwardDest field. For\n those systems that do not support arbitrary\n subnet masks, an agent constructs the value of\n the ipForwardMask by reference to the IP Ad-\n dress Class.\n \n Any assignment (implicit or otherwise) of an\n instance of this object to a value x must be\n rejected if the bitwise logical-AND of x with\n the value of the corresponding instance of the\n ipForwardDest object is not equal to ipForward-\n Dest.", "format": "inet:ipv4-address" }, "ipForwardPolicy": { "type": "integer", "description": "The general set of conditions that would cause\n the selection of one multipath route (set of\n next hops for a given destination) is referred\n to as 'policy'.\n \n Unless the mechanism indicated by ipForwardPro-\n to specifies otherwise, the policy specifier is\n the IP TOS Field. The encoding of IP TOS is as\n specified by the following convention. Zero\n indicates the default path if no more specific\n policy applies.\n \n +-----+-----+-----+-----+-----+-----+-----+-----+\n | | | |\n | PRECEDENCE | TYPE OF SERVICE | 0 |\n | | | |\n +-----+-----+-----+-----+-----+-----+-----+-----+\n \n IP TOS IP TOS\n Field Policy Field Policy\n Contents Code Contents Code\n 0 0 0 0 ==> 0 0 0 0 1 ==> 2\n 0 0 1 0 ==> 4 0 0 1 1 ==> 6\n 0 1 0 0 ==> 8 0 1 0 1 ==> 10\n 0 1 1 0 ==> 12 0 1 1 1 ==> 14\n 1 0 0 0 ==> 16 1 0 0 1 ==> 18\n 1 0 1 0 ==> 20 1 0 1 1 ==> 22\n 1 1 0 0 ==> 24 1 1 0 1 ==> 26\n 1 1 1 0 ==> 28 1 1 1 1 ==> 30\n \n Protocols defining 'policy' otherwise must ei-\n ther define a set of values which are valid for\n this object or must implement an integer-\n instanced policy table for which this object's\n value acts as an index.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardNextHop": { "type": "string", "description": "On remote routes, the address of the next sys-\n tem en route; Otherwise, 0.0.0.0.", "format": "inet:ipv4-address" }, "ipForwardIfIndex": { "type": "integer", "description": "The ifIndex value which identifies the local\n interface through which the next hop of this\n route should be reached.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardType": { "type": "string", "description": "The type of route. Note that local(3) refers\n to a route for which the next hop is the final\n destination; remote(4) refers to a route for\n which the next hop is not the final destina-\n tion.\n \n Setting this object to the value invalid(2) has\n the effect of invalidating the corresponding\n entry in the ipForwardTable object. That is,\n it effectively disassociates the destination\n identified with said entry from the route iden-\n tified with said entry. It is an\n implementation-specific matter as to whether\n the agent removes an invalidated entry from the\n table. Accordingly, management stations must\n be prepared to receive tabular information from\n agents that corresponds to entries not current-\n ly in use. Proper interpretation of such en-\n tries requires examination of the relevant ip-\n ForwardType object." }, "ipForwardProto": { "type": "string", "description": "The routing mechanism via which this route was\n learned. Inclusion of values for gateway rout-\n ing protocols is not intended to imply that\n hosts should support those protocols." }, "ipForwardAge": { "type": "integer", "description": "The number of seconds since this route was\n last updated or otherwise determined to be\n correct. Note that no semantics of `too old'\n can be implied except through knowledge of the\n routing protocol by which the route was\n learned.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardInfo": { "type": "string", "description": "A reference to MIB definitions specific to the\n particular routing protocol which is responsi-\n ble for this route, as determined by the value\n specified in the route's ipForwardProto value.\n If this information is not present, its value\n should be set to the OBJECT IDENTIFIER { 0 0 },\n which is a syntactically valid object identif-\n ier, and any implementation conforming to ASN.1\n and the Basic Encoding Rules must be able to\n generate and recognize this value.", "x-yang-type": "yang:object-identifier-128" }, "ipForwardNextHopAS": { "type": "integer", "description": "The Autonomous System Number of the Next Hop.\n When this is unknown or not relevant to the\n protocol indicated by ipForwardProto, zero.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardMetric1": { "type": "integer", "description": "The primary routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardMetric2": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardMetric3": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardMetric4": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardMetric5": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 } } } }, "example": { "IP-FORWARD-MIB:ipForwardEntry": [ { "ipForwardDest": "192.168.1.1", "ipForwardMask": "192.168.1.1", "ipForwardPolicy": -2147483648, "ipForwardNextHop": "192.168.1.1", "ipForwardIfIndex": 1, "ipForwardType": "192.168.1.1", "ipForwardProto": "192.168.1.1", "ipForwardAge": -2147483648, "ipForwardInfo": "192.168.1.1", "ipForwardNextHopAS": -2147483648, "ipForwardMetric1": -2147483648, "ipForwardMetric2": -2147483648, "ipForwardMetric3": -2147483648, "ipForwardMetric4": -2147483648, "ipForwardMetric5": -2147483648 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipForwardEntry-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": "/ipForwardEntry", "x-restconf-kind": "container" }, "/data/IP-FORWARD-MIB:ipCidrRouteEntry": { "get": { "summary": "Get ipCidrRouteEntry list", "description": "Retrieve list of ipCidrRouteEntry entries from MIB", "tags": [ "IP-FORWARD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A particular route to a particular destina-\n tion, under a particular policy.", "items": { "type": "object", "properties": { "ipCidrRouteDest": { "type": "string", "description": "The destination IP address of this route.\n \n This object may not take a Multicast (Class D)\n address value.\n \n Any assignment (implicit or otherwise) of an\n instance of this object to a value x must be\n rejected if the bitwise logical-AND of x with\n the value of the corresponding instance of the\n ipCidrRouteMask object is not equal to x.", "format": "inet:ipv4-address" }, "ipCidrRouteMask": { "type": "string", "description": "Indicate the mask to be logical-ANDed with the\n destination address before being compared to\n the value in the ipCidrRouteDest field. For\n those systems that do not support arbitrary\n subnet masks, an agent constructs the value of\n the ipCidrRouteMask by reference to the IP Ad-\n dress Class.\n \n Any assignment (implicit or otherwise) of an\n instance of this object to a value x must be\n rejected if the bitwise logical-AND of x with\n the value of the corresponding instance of the\n ipCidrRouteDest object is not equal to ipCidrRoute-\n Dest.", "format": "inet:ipv4-address" }, "ipCidrRouteTos": { "type": "integer", "description": "The policy specifier is the IP TOS Field. The encoding\n of IP TOS is as specified by the following convention.\n Zero indicates the default path if no more specific\n policy applies.\n \n +-----+-----+-----+-----+-----+-----+-----+-----+\n | | | |\n | PRECEDENCE | TYPE OF SERVICE | 0 |\n | | | |\n +-----+-----+-----+-----+-----+-----+-----+-----+\n \n IP TOS IP TOS\n Field Policy Field Policy\n Contents Code Contents Code\n 0 0 0 0 ==> 0 0 0 0 1 ==> 2\n 0 0 1 0 ==> 4 0 0 1 1 ==> 6\n 0 1 0 0 ==> 8 0 1 0 1 ==> 10\n 0 1 1 0 ==> 12 0 1 1 1 ==> 14\n 1 0 0 0 ==> 16 1 0 0 1 ==> 18\n 1 0 1 0 ==> 20 1 0 1 1 ==> 22\n 1 1 0 0 ==> 24 1 1 0 1 ==> 26\n 1 1 1 0 ==> 28 1 1 1 1 ==> 30", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteNextHop": { "type": "string", "description": "On remote routes, the address of the next sys-\n tem en route; Otherwise, 0.0.0.0.", "format": "inet:ipv4-address" }, "ipCidrRouteIfIndex": { "type": "integer", "description": "The ifIndex value which identifies the local\n interface through which the next hop of this\n route should be reached.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteType": { "type": "string", "description": "The type of route. Note that local(3) refers\n to a route for which the next hop is the final\n destination; remote(4) refers to a route for\n which the next hop is not the final destina-\n tion.\n \n Routes which do not result in traffic forwarding or\n rejection should not be displayed even if the\n implementation keeps them stored internally.\n \n \n reject (2) refers to a route which, if matched, discards\n the message as unreachable. This is used in some\n protocols as a means of correctly aggregating routes." }, "ipCidrRouteProto": { "type": "string", "description": "The routing mechanism via which this route was\n learned. Inclusion of values for gateway rout-\n ing protocols is not intended to imply that\n hosts should support those protocols." }, "ipCidrRouteAge": { "type": "integer", "description": "The number of seconds since this route was\n last updated or otherwise determined to be\n correct. Note that no semantics of `too old'\n can be implied except through knowledge of the\n routing protocol by which the route was\n learned.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteInfo": { "type": "string", "description": "A reference to MIB definitions specific to the\n particular routing protocol which is responsi-\n ble for this route, as determined by the value\n specified in the route's ipCidrRouteProto value.\n If this information is not present, its value\n should be set to the OBJECT IDENTIFIER { 0 0 },\n which is a syntactically valid object identif-\n ier, and any implementation conforming to ASN.1\n and the Basic Encoding Rules must be able to\n generate and recognize this value.", "x-yang-type": "yang:object-identifier-128" }, "ipCidrRouteNextHopAS": { "type": "integer", "description": "The Autonomous System Number of the Next Hop.\n The semantics of this object are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. When this object is\n unknown or not relevant its value should be set\n to zero.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteMetric1": { "type": "integer", "description": "The primary routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteMetric2": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteMetric3": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteMetric4": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteMetric5": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteStatus": { "type": "string", "description": "The row status variable, used according to\n row installation and removal conventions.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "IP-FORWARD-MIB:ipCidrRouteEntry": [ { "ipCidrRouteDest": "192.168.1.1", "ipCidrRouteMask": "192.168.1.1", "ipCidrRouteTos": -2147483648, "ipCidrRouteNextHop": "192.168.1.1", "ipCidrRouteIfIndex": 1, "ipCidrRouteType": "192.168.1.1", "ipCidrRouteProto": "192.168.1.1", "ipCidrRouteAge": -2147483648, "ipCidrRouteInfo": "192.168.1.1", "ipCidrRouteNextHopAS": -2147483648, "ipCidrRouteMetric1": -2147483648, "ipCidrRouteMetric2": -2147483648, "ipCidrRouteMetric3": -2147483648, "ipCidrRouteMetric4": -2147483648, "ipCidrRouteMetric5": -2147483648, "ipCidrRouteStatus": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipCidrRouteEntry-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": "/ipCidrRouteEntry", "x-restconf-kind": "container" }, "/data/IP-FORWARD-MIB:ipForwardTable/ipForwardEntry={ipForwardDest},{ipForwardProto},{ipForwardPolicy},{ipForwardNextHop}": { "get": { "summary": "Get ipForwardEntry entry", "description": "Retrieve specific ipForwardEntry entry by key from MIB", "tags": [ "IP-FORWARD-MIB" ], "parameters": [ { "name": "ipForwardDest", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipForwardProto", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipForwardPolicy", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipForwardNextHop", "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": { "ipForwardDest": { "type": "string", "description": "The destination IP address of this route. An\n entry with a value of 0.0.0.0 is considered a\n default route.\n \n This object may not take a Multicast (Class D)\n address value.\n \n Any assignment (implicit or otherwise) of an\n instance of this object to a value x must be\n rejected if the bitwise logical-AND of x with\n the value of the corresponding instance of the\n ipForwardMask object is not equal to x.", "format": "inet:ipv4-address" }, "ipForwardMask": { "type": "string", "description": "Indicate the mask to be logical-ANDed with the\n destination address before being compared to\n the value in the ipForwardDest field. For\n those systems that do not support arbitrary\n subnet masks, an agent constructs the value of\n the ipForwardMask by reference to the IP Ad-\n dress Class.\n \n Any assignment (implicit or otherwise) of an\n instance of this object to a value x must be\n rejected if the bitwise logical-AND of x with\n the value of the corresponding instance of the\n ipForwardDest object is not equal to ipForward-\n Dest.", "format": "inet:ipv4-address" }, "ipForwardPolicy": { "type": "integer", "description": "The general set of conditions that would cause\n the selection of one multipath route (set of\n next hops for a given destination) is referred\n to as 'policy'.\n \n Unless the mechanism indicated by ipForwardPro-\n to specifies otherwise, the policy specifier is\n the IP TOS Field. The encoding of IP TOS is as\n specified by the following convention. Zero\n indicates the default path if no more specific\n policy applies.\n \n +-----+-----+-----+-----+-----+-----+-----+-----+\n | | | |\n | PRECEDENCE | TYPE OF SERVICE | 0 |\n | | | |\n +-----+-----+-----+-----+-----+-----+-----+-----+\n \n IP TOS IP TOS\n Field Policy Field Policy\n Contents Code Contents Code\n 0 0 0 0 ==> 0 0 0 0 1 ==> 2\n 0 0 1 0 ==> 4 0 0 1 1 ==> 6\n 0 1 0 0 ==> 8 0 1 0 1 ==> 10\n 0 1 1 0 ==> 12 0 1 1 1 ==> 14\n 1 0 0 0 ==> 16 1 0 0 1 ==> 18\n 1 0 1 0 ==> 20 1 0 1 1 ==> 22\n 1 1 0 0 ==> 24 1 1 0 1 ==> 26\n 1 1 1 0 ==> 28 1 1 1 1 ==> 30\n \n Protocols defining 'policy' otherwise must ei-\n ther define a set of values which are valid for\n this object or must implement an integer-\n instanced policy table for which this object's\n value acts as an index.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardNextHop": { "type": "string", "description": "On remote routes, the address of the next sys-\n tem en route; Otherwise, 0.0.0.0.", "format": "inet:ipv4-address" }, "ipForwardIfIndex": { "type": "integer", "description": "The ifIndex value which identifies the local\n interface through which the next hop of this\n route should be reached.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardType": { "type": "string", "description": "The type of route. Note that local(3) refers\n to a route for which the next hop is the final\n destination; remote(4) refers to a route for\n which the next hop is not the final destina-\n tion.\n \n Setting this object to the value invalid(2) has\n the effect of invalidating the corresponding\n entry in the ipForwardTable object. That is,\n it effectively disassociates the destination\n identified with said entry from the route iden-\n tified with said entry. It is an\n implementation-specific matter as to whether\n the agent removes an invalidated entry from the\n table. Accordingly, management stations must\n be prepared to receive tabular information from\n agents that corresponds to entries not current-\n ly in use. Proper interpretation of such en-\n tries requires examination of the relevant ip-\n ForwardType object." }, "ipForwardProto": { "type": "string", "description": "The routing mechanism via which this route was\n learned. Inclusion of values for gateway rout-\n ing protocols is not intended to imply that\n hosts should support those protocols." }, "ipForwardAge": { "type": "integer", "description": "The number of seconds since this route was\n last updated or otherwise determined to be\n correct. Note that no semantics of `too old'\n can be implied except through knowledge of the\n routing protocol by which the route was\n learned.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardInfo": { "type": "string", "description": "A reference to MIB definitions specific to the\n particular routing protocol which is responsi-\n ble for this route, as determined by the value\n specified in the route's ipForwardProto value.\n If this information is not present, its value\n should be set to the OBJECT IDENTIFIER { 0 0 },\n which is a syntactically valid object identif-\n ier, and any implementation conforming to ASN.1\n and the Basic Encoding Rules must be able to\n generate and recognize this value.", "x-yang-type": "yang:object-identifier-128" }, "ipForwardNextHopAS": { "type": "integer", "description": "The Autonomous System Number of the Next Hop.\n When this is unknown or not relevant to the\n protocol indicated by ipForwardProto, zero.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardMetric1": { "type": "integer", "description": "The primary routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardMetric2": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardMetric3": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardMetric4": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardMetric5": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 } } }, "example": { "IP-FORWARD-MIB:ipForwardEntry": { "ipForwardDest": "192.168.1.1", "ipForwardMask": "192.168.1.1", "ipForwardPolicy": -2147483648, "ipForwardNextHop": "192.168.1.1", "ipForwardIfIndex": 1, "ipForwardType": "192.168.1.1", "ipForwardProto": "192.168.1.1", "ipForwardAge": -2147483648, "ipForwardInfo": "192.168.1.1", "ipForwardNextHopAS": -2147483648, "ipForwardMetric1": -2147483648, "ipForwardMetric2": -2147483648, "ipForwardMetric3": -2147483648, "ipForwardMetric4": -2147483648, "ipForwardMetric5": -2147483648 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipForwardEntry-2" }, "x-yang-path": "/ipForwardTable/ipForwardEntry={ipForwardDest ipForwardProto ipForwardPolicy ipForwardNextHop}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ipForwardDest ipForwardProto ipForwardPolicy ipForwardNextHop" ] }, "/data/IP-FORWARD-MIB:ipCidrRouteTable/ipCidrRouteEntry={ipCidrRouteDest},{ipCidrRouteMask},{ipCidrRouteTos},{ipCidrRouteNextHop}": { "get": { "summary": "Get ipCidrRouteEntry entry", "description": "Retrieve specific ipCidrRouteEntry entry by key from MIB", "tags": [ "IP-FORWARD-MIB" ], "parameters": [ { "name": "ipCidrRouteDest", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipCidrRouteMask", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipCidrRouteTos", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipCidrRouteNextHop", "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": { "ipCidrRouteDest": { "type": "string", "description": "The destination IP address of this route.\n \n This object may not take a Multicast (Class D)\n address value.\n \n Any assignment (implicit or otherwise) of an\n instance of this object to a value x must be\n rejected if the bitwise logical-AND of x with\n the value of the corresponding instance of the\n ipCidrRouteMask object is not equal to x.", "format": "inet:ipv4-address" }, "ipCidrRouteMask": { "type": "string", "description": "Indicate the mask to be logical-ANDed with the\n destination address before being compared to\n the value in the ipCidrRouteDest field. For\n those systems that do not support arbitrary\n subnet masks, an agent constructs the value of\n the ipCidrRouteMask by reference to the IP Ad-\n dress Class.\n \n Any assignment (implicit or otherwise) of an\n instance of this object to a value x must be\n rejected if the bitwise logical-AND of x with\n the value of the corresponding instance of the\n ipCidrRouteDest object is not equal to ipCidrRoute-\n Dest.", "format": "inet:ipv4-address" }, "ipCidrRouteTos": { "type": "integer", "description": "The policy specifier is the IP TOS Field. The encoding\n of IP TOS is as specified by the following convention.\n Zero indicates the default path if no more specific\n policy applies.\n \n +-----+-----+-----+-----+-----+-----+-----+-----+\n | | | |\n | PRECEDENCE | TYPE OF SERVICE | 0 |\n | | | |\n +-----+-----+-----+-----+-----+-----+-----+-----+\n \n IP TOS IP TOS\n Field Policy Field Policy\n Contents Code Contents Code\n 0 0 0 0 ==> 0 0 0 0 1 ==> 2\n 0 0 1 0 ==> 4 0 0 1 1 ==> 6\n 0 1 0 0 ==> 8 0 1 0 1 ==> 10\n 0 1 1 0 ==> 12 0 1 1 1 ==> 14\n 1 0 0 0 ==> 16 1 0 0 1 ==> 18\n 1 0 1 0 ==> 20 1 0 1 1 ==> 22\n 1 1 0 0 ==> 24 1 1 0 1 ==> 26\n 1 1 1 0 ==> 28 1 1 1 1 ==> 30", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteNextHop": { "type": "string", "description": "On remote routes, the address of the next sys-\n tem en route; Otherwise, 0.0.0.0.", "format": "inet:ipv4-address" }, "ipCidrRouteIfIndex": { "type": "integer", "description": "The ifIndex value which identifies the local\n interface through which the next hop of this\n route should be reached.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteType": { "type": "string", "description": "The type of route. Note that local(3) refers\n to a route for which the next hop is the final\n destination; remote(4) refers to a route for\n which the next hop is not the final destina-\n tion.\n \n Routes which do not result in traffic forwarding or\n rejection should not be displayed even if the\n implementation keeps them stored internally.\n \n \n reject (2) refers to a route which, if matched, discards\n the message as unreachable. This is used in some\n protocols as a means of correctly aggregating routes." }, "ipCidrRouteProto": { "type": "string", "description": "The routing mechanism via which this route was\n learned. Inclusion of values for gateway rout-\n ing protocols is not intended to imply that\n hosts should support those protocols." }, "ipCidrRouteAge": { "type": "integer", "description": "The number of seconds since this route was\n last updated or otherwise determined to be\n correct. Note that no semantics of `too old'\n can be implied except through knowledge of the\n routing protocol by which the route was\n learned.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteInfo": { "type": "string", "description": "A reference to MIB definitions specific to the\n particular routing protocol which is responsi-\n ble for this route, as determined by the value\n specified in the route's ipCidrRouteProto value.\n If this information is not present, its value\n should be set to the OBJECT IDENTIFIER { 0 0 },\n which is a syntactically valid object identif-\n ier, and any implementation conforming to ASN.1\n and the Basic Encoding Rules must be able to\n generate and recognize this value.", "x-yang-type": "yang:object-identifier-128" }, "ipCidrRouteNextHopAS": { "type": "integer", "description": "The Autonomous System Number of the Next Hop.\n The semantics of this object are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. When this object is\n unknown or not relevant its value should be set\n to zero.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteMetric1": { "type": "integer", "description": "The primary routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteMetric2": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteMetric3": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteMetric4": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteMetric5": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteStatus": { "type": "string", "description": "The row status variable, used according to\n row installation and removal conventions.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "IP-FORWARD-MIB:ipCidrRouteEntry": { "ipCidrRouteDest": "192.168.1.1", "ipCidrRouteMask": "192.168.1.1", "ipCidrRouteTos": -2147483648, "ipCidrRouteNextHop": "192.168.1.1", "ipCidrRouteIfIndex": 1, "ipCidrRouteType": "192.168.1.1", "ipCidrRouteProto": "192.168.1.1", "ipCidrRouteAge": -2147483648, "ipCidrRouteInfo": "192.168.1.1", "ipCidrRouteNextHopAS": -2147483648, "ipCidrRouteMetric1": -2147483648, "ipCidrRouteMetric2": -2147483648, "ipCidrRouteMetric3": -2147483648, "ipCidrRouteMetric4": -2147483648, "ipCidrRouteMetric5": -2147483648, "ipCidrRouteStatus": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipCidrRouteEntry-2" }, "x-yang-path": "/ipCidrRouteTable/ipCidrRouteEntry={ipCidrRouteDest ipCidrRouteMask ipCidrRouteTos ipCidrRouteNextHop}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ipCidrRouteDest ipCidrRouteMask ipCidrRouteTos ipCidrRouteNextHop" ] }, "/data/IP-FORWARD-MIB:ipForwardEntry={ipForwardDest},{ipForwardProto},{ipForwardPolicy},{ipForwardNextHop}": { "get": { "summary": "Get ipForwardEntry entry", "description": "Retrieve specific ipForwardEntry entry by key from MIB", "tags": [ "IP-FORWARD-MIB" ], "parameters": [ { "name": "ipForwardDest", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipForwardProto", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipForwardPolicy", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipForwardNextHop", "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": { "ipForwardDest": { "type": "string", "description": "The destination IP address of this route. An\n entry with a value of 0.0.0.0 is considered a\n default route.\n \n This object may not take a Multicast (Class D)\n address value.\n \n Any assignment (implicit or otherwise) of an\n instance of this object to a value x must be\n rejected if the bitwise logical-AND of x with\n the value of the corresponding instance of the\n ipForwardMask object is not equal to x.", "format": "inet:ipv4-address" }, "ipForwardMask": { "type": "string", "description": "Indicate the mask to be logical-ANDed with the\n destination address before being compared to\n the value in the ipForwardDest field. For\n those systems that do not support arbitrary\n subnet masks, an agent constructs the value of\n the ipForwardMask by reference to the IP Ad-\n dress Class.\n \n Any assignment (implicit or otherwise) of an\n instance of this object to a value x must be\n rejected if the bitwise logical-AND of x with\n the value of the corresponding instance of the\n ipForwardDest object is not equal to ipForward-\n Dest.", "format": "inet:ipv4-address" }, "ipForwardPolicy": { "type": "integer", "description": "The general set of conditions that would cause\n the selection of one multipath route (set of\n next hops for a given destination) is referred\n to as 'policy'.\n \n Unless the mechanism indicated by ipForwardPro-\n to specifies otherwise, the policy specifier is\n the IP TOS Field. The encoding of IP TOS is as\n specified by the following convention. Zero\n indicates the default path if no more specific\n policy applies.\n \n +-----+-----+-----+-----+-----+-----+-----+-----+\n | | | |\n | PRECEDENCE | TYPE OF SERVICE | 0 |\n | | | |\n +-----+-----+-----+-----+-----+-----+-----+-----+\n \n IP TOS IP TOS\n Field Policy Field Policy\n Contents Code Contents Code\n 0 0 0 0 ==> 0 0 0 0 1 ==> 2\n 0 0 1 0 ==> 4 0 0 1 1 ==> 6\n 0 1 0 0 ==> 8 0 1 0 1 ==> 10\n 0 1 1 0 ==> 12 0 1 1 1 ==> 14\n 1 0 0 0 ==> 16 1 0 0 1 ==> 18\n 1 0 1 0 ==> 20 1 0 1 1 ==> 22\n 1 1 0 0 ==> 24 1 1 0 1 ==> 26\n 1 1 1 0 ==> 28 1 1 1 1 ==> 30\n \n Protocols defining 'policy' otherwise must ei-\n ther define a set of values which are valid for\n this object or must implement an integer-\n instanced policy table for which this object's\n value acts as an index.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardNextHop": { "type": "string", "description": "On remote routes, the address of the next sys-\n tem en route; Otherwise, 0.0.0.0.", "format": "inet:ipv4-address" }, "ipForwardIfIndex": { "type": "integer", "description": "The ifIndex value which identifies the local\n interface through which the next hop of this\n route should be reached.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardType": { "type": "string", "description": "The type of route. Note that local(3) refers\n to a route for which the next hop is the final\n destination; remote(4) refers to a route for\n which the next hop is not the final destina-\n tion.\n \n Setting this object to the value invalid(2) has\n the effect of invalidating the corresponding\n entry in the ipForwardTable object. That is,\n it effectively disassociates the destination\n identified with said entry from the route iden-\n tified with said entry. It is an\n implementation-specific matter as to whether\n the agent removes an invalidated entry from the\n table. Accordingly, management stations must\n be prepared to receive tabular information from\n agents that corresponds to entries not current-\n ly in use. Proper interpretation of such en-\n tries requires examination of the relevant ip-\n ForwardType object." }, "ipForwardProto": { "type": "string", "description": "The routing mechanism via which this route was\n learned. Inclusion of values for gateway rout-\n ing protocols is not intended to imply that\n hosts should support those protocols." }, "ipForwardAge": { "type": "integer", "description": "The number of seconds since this route was\n last updated or otherwise determined to be\n correct. Note that no semantics of `too old'\n can be implied except through knowledge of the\n routing protocol by which the route was\n learned.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardInfo": { "type": "string", "description": "A reference to MIB definitions specific to the\n particular routing protocol which is responsi-\n ble for this route, as determined by the value\n specified in the route's ipForwardProto value.\n If this information is not present, its value\n should be set to the OBJECT IDENTIFIER { 0 0 },\n which is a syntactically valid object identif-\n ier, and any implementation conforming to ASN.1\n and the Basic Encoding Rules must be able to\n generate and recognize this value.", "x-yang-type": "yang:object-identifier-128" }, "ipForwardNextHopAS": { "type": "integer", "description": "The Autonomous System Number of the Next Hop.\n When this is unknown or not relevant to the\n protocol indicated by ipForwardProto, zero.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardMetric1": { "type": "integer", "description": "The primary routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardMetric2": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardMetric3": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardMetric4": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipForwardMetric5": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 } } }, "example": { "IP-FORWARD-MIB:ipForwardEntry": { "ipForwardDest": "192.168.1.1", "ipForwardMask": "192.168.1.1", "ipForwardPolicy": -2147483648, "ipForwardNextHop": "192.168.1.1", "ipForwardIfIndex": 1, "ipForwardType": "192.168.1.1", "ipForwardProto": "192.168.1.1", "ipForwardAge": -2147483648, "ipForwardInfo": "192.168.1.1", "ipForwardNextHopAS": -2147483648, "ipForwardMetric1": -2147483648, "ipForwardMetric2": -2147483648, "ipForwardMetric3": -2147483648, "ipForwardMetric4": -2147483648, "ipForwardMetric5": -2147483648 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipForwardEntry-4" }, "x-yang-path": "/ipForwardEntry={ipForwardDest ipForwardProto ipForwardPolicy ipForwardNextHop}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ipForwardDest ipForwardProto ipForwardPolicy ipForwardNextHop" ] }, "/data/IP-FORWARD-MIB:ipCidrRouteEntry={ipCidrRouteDest},{ipCidrRouteMask},{ipCidrRouteTos},{ipCidrRouteNextHop}": { "get": { "summary": "Get ipCidrRouteEntry entry", "description": "Retrieve specific ipCidrRouteEntry entry by key from MIB", "tags": [ "IP-FORWARD-MIB" ], "parameters": [ { "name": "ipCidrRouteDest", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipCidrRouteMask", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipCidrRouteTos", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipCidrRouteNextHop", "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": { "ipCidrRouteDest": { "type": "string", "description": "The destination IP address of this route.\n \n This object may not take a Multicast (Class D)\n address value.\n \n Any assignment (implicit or otherwise) of an\n instance of this object to a value x must be\n rejected if the bitwise logical-AND of x with\n the value of the corresponding instance of the\n ipCidrRouteMask object is not equal to x.", "format": "inet:ipv4-address" }, "ipCidrRouteMask": { "type": "string", "description": "Indicate the mask to be logical-ANDed with the\n destination address before being compared to\n the value in the ipCidrRouteDest field. For\n those systems that do not support arbitrary\n subnet masks, an agent constructs the value of\n the ipCidrRouteMask by reference to the IP Ad-\n dress Class.\n \n Any assignment (implicit or otherwise) of an\n instance of this object to a value x must be\n rejected if the bitwise logical-AND of x with\n the value of the corresponding instance of the\n ipCidrRouteDest object is not equal to ipCidrRoute-\n Dest.", "format": "inet:ipv4-address" }, "ipCidrRouteTos": { "type": "integer", "description": "The policy specifier is the IP TOS Field. The encoding\n of IP TOS is as specified by the following convention.\n Zero indicates the default path if no more specific\n policy applies.\n \n +-----+-----+-----+-----+-----+-----+-----+-----+\n | | | |\n | PRECEDENCE | TYPE OF SERVICE | 0 |\n | | | |\n +-----+-----+-----+-----+-----+-----+-----+-----+\n \n IP TOS IP TOS\n Field Policy Field Policy\n Contents Code Contents Code\n 0 0 0 0 ==> 0 0 0 0 1 ==> 2\n 0 0 1 0 ==> 4 0 0 1 1 ==> 6\n 0 1 0 0 ==> 8 0 1 0 1 ==> 10\n 0 1 1 0 ==> 12 0 1 1 1 ==> 14\n 1 0 0 0 ==> 16 1 0 0 1 ==> 18\n 1 0 1 0 ==> 20 1 0 1 1 ==> 22\n 1 1 0 0 ==> 24 1 1 0 1 ==> 26\n 1 1 1 0 ==> 28 1 1 1 1 ==> 30", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteNextHop": { "type": "string", "description": "On remote routes, the address of the next sys-\n tem en route; Otherwise, 0.0.0.0.", "format": "inet:ipv4-address" }, "ipCidrRouteIfIndex": { "type": "integer", "description": "The ifIndex value which identifies the local\n interface through which the next hop of this\n route should be reached.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteType": { "type": "string", "description": "The type of route. Note that local(3) refers\n to a route for which the next hop is the final\n destination; remote(4) refers to a route for\n which the next hop is not the final destina-\n tion.\n \n Routes which do not result in traffic forwarding or\n rejection should not be displayed even if the\n implementation keeps them stored internally.\n \n \n reject (2) refers to a route which, if matched, discards\n the message as unreachable. This is used in some\n protocols as a means of correctly aggregating routes." }, "ipCidrRouteProto": { "type": "string", "description": "The routing mechanism via which this route was\n learned. Inclusion of values for gateway rout-\n ing protocols is not intended to imply that\n hosts should support those protocols." }, "ipCidrRouteAge": { "type": "integer", "description": "The number of seconds since this route was\n last updated or otherwise determined to be\n correct. Note that no semantics of `too old'\n can be implied except through knowledge of the\n routing protocol by which the route was\n learned.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteInfo": { "type": "string", "description": "A reference to MIB definitions specific to the\n particular routing protocol which is responsi-\n ble for this route, as determined by the value\n specified in the route's ipCidrRouteProto value.\n If this information is not present, its value\n should be set to the OBJECT IDENTIFIER { 0 0 },\n which is a syntactically valid object identif-\n ier, and any implementation conforming to ASN.1\n and the Basic Encoding Rules must be able to\n generate and recognize this value.", "x-yang-type": "yang:object-identifier-128" }, "ipCidrRouteNextHopAS": { "type": "integer", "description": "The Autonomous System Number of the Next Hop.\n The semantics of this object are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. When this object is\n unknown or not relevant its value should be set\n to zero.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteMetric1": { "type": "integer", "description": "The primary routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteMetric2": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteMetric3": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteMetric4": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteMetric5": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647 }, "ipCidrRouteStatus": { "type": "string", "description": "The row status variable, used according to\n row installation and removal conventions.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "IP-FORWARD-MIB:ipCidrRouteEntry": { "ipCidrRouteDest": "192.168.1.1", "ipCidrRouteMask": "192.168.1.1", "ipCidrRouteTos": -2147483648, "ipCidrRouteNextHop": "192.168.1.1", "ipCidrRouteIfIndex": 1, "ipCidrRouteType": "192.168.1.1", "ipCidrRouteProto": "192.168.1.1", "ipCidrRouteAge": -2147483648, "ipCidrRouteInfo": "192.168.1.1", "ipCidrRouteNextHopAS": -2147483648, "ipCidrRouteMetric1": -2147483648, "ipCidrRouteMetric2": -2147483648, "ipCidrRouteMetric3": -2147483648, "ipCidrRouteMetric4": -2147483648, "ipCidrRouteMetric5": -2147483648, "ipCidrRouteStatus": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ipCidrRouteEntry-4" }, "x-yang-path": "/ipCidrRouteEntry={ipCidrRouteDest ipCidrRouteMask ipCidrRouteTos ipCidrRouteNextHop}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ipCidrRouteDest ipCidrRouteMask ipCidrRouteTos ipCidrRouteNextHop" ] } }, "components": { "schemas": { "IP-FORWARD-MIB_IP-FORWARD-MIB": { "type": "object", "description": "The number of current ipForwardTable entries\n that are not invalid.", "properties": { "ipForwardEntry": { "type": "array", "description": "A particular route to a particular destina-\n tion, under a particular policy.", "items": { "type": "object", "properties": { "ipForwardDest": { "type": "string", "description": "The destination IP address of this route. An\n entry with a value of 0.0.0.0 is considered a\n default route.\n \n This object may not take a Multicast (Class D)\n address value.\n \n Any assignment (implicit or otherwise) of an\n instance of this object to a value x must be\n rejected if the bitwise logical-AND of x with\n the value of the corresponding instance of the\n ipForwardMask object is not equal to x.", "format": "inet:ipv4-address", "readOnly": true }, "ipForwardMask": { "type": "string", "description": "Indicate the mask to be logical-ANDed with the\n destination address before being compared to\n the value in the ipForwardDest field. For\n those systems that do not support arbitrary\n subnet masks, an agent constructs the value of\n the ipForwardMask by reference to the IP Ad-\n dress Class.\n \n Any assignment (implicit or otherwise) of an\n instance of this object to a value x must be\n rejected if the bitwise logical-AND of x with\n the value of the corresponding instance of the\n ipForwardDest object is not equal to ipForward-\n Dest.", "format": "inet:ipv4-address", "readOnly": true }, "ipForwardPolicy": { "type": "integer", "description": "The general set of conditions that would cause\n the selection of one multipath route (set of\n next hops for a given destination) is referred\n to as 'policy'.\n \n Unless the mechanism indicated by ipForwardPro-\n to specifies otherwise, the policy specifier is\n the IP TOS Field. The encoding of IP TOS is as\n specified by the following convention. Zero\n indicates the default path if no more specific\n policy applies.\n \n +-----+-----+-----+-----+-----+-----+-----+-----+\n | | | |\n | PRECEDENCE | TYPE OF SERVICE | 0 |\n | | | |\n +-----+-----+-----+-----+-----+-----+-----+-----+\n \n IP TOS IP TOS\n Field Policy Field Policy\n Contents Code Contents Code\n 0 0 0 0 ==> 0 0 0 0 1 ==> 2\n 0 0 1 0 ==> 4 0 0 1 1 ==> 6\n 0 1 0 0 ==> 8 0 1 0 1 ==> 10\n 0 1 1 0 ==> 12 0 1 1 1 ==> 14\n 1 0 0 0 ==> 16 1 0 0 1 ==> 18\n 1 0 1 0 ==> 20 1 0 1 1 ==> 22\n 1 1 0 0 ==> 24 1 1 0 1 ==> 26\n 1 1 1 0 ==> 28 1 1 1 1 ==> 30\n \n Protocols defining 'policy' otherwise must ei-\n ther define a set of values which are valid for\n this object or must implement an integer-\n instanced policy table for which this object's\n value acts as an index.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipForwardNextHop": { "type": "string", "description": "On remote routes, the address of the next sys-\n tem en route; Otherwise, 0.0.0.0.", "format": "inet:ipv4-address", "readOnly": true }, "ipForwardIfIndex": { "type": "integer", "description": "The ifIndex value which identifies the local\n interface through which the next hop of this\n route should be reached.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipForwardType": { "type": "string", "description": "The type of route. Note that local(3) refers\n to a route for which the next hop is the final\n destination; remote(4) refers to a route for\n which the next hop is not the final destina-\n tion.\n \n Setting this object to the value invalid(2) has\n the effect of invalidating the corresponding\n entry in the ipForwardTable object. That is,\n it effectively disassociates the destination\n identified with said entry from the route iden-\n tified with said entry. It is an\n implementation-specific matter as to whether\n the agent removes an invalidated entry from the\n table. Accordingly, management stations must\n be prepared to receive tabular information from\n agents that corresponds to entries not current-\n ly in use. Proper interpretation of such en-\n tries requires examination of the relevant ip-\n ForwardType object.", "readOnly": true }, "ipForwardProto": { "type": "string", "description": "The routing mechanism via which this route was\n learned. Inclusion of values for gateway rout-\n ing protocols is not intended to imply that\n hosts should support those protocols.", "readOnly": true }, "ipForwardAge": { "type": "integer", "description": "The number of seconds since this route was\n last updated or otherwise determined to be\n correct. Note that no semantics of `too old'\n can be implied except through knowledge of the\n routing protocol by which the route was\n learned.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipForwardInfo": { "type": "string", "description": "A reference to MIB definitions specific to the\n particular routing protocol which is responsi-\n ble for this route, as determined by the value\n specified in the route's ipForwardProto value.\n If this information is not present, its value\n should be set to the OBJECT IDENTIFIER { 0 0 },\n which is a syntactically valid object identif-\n ier, and any implementation conforming to ASN.1\n and the Basic Encoding Rules must be able to\n generate and recognize this value.", "x-yang-type": "yang:object-identifier-128", "readOnly": true }, "ipForwardNextHopAS": { "type": "integer", "description": "The Autonomous System Number of the Next Hop.\n When this is unknown or not relevant to the\n protocol indicated by ipForwardProto, zero.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipForwardMetric1": { "type": "integer", "description": "The primary routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipForwardMetric2": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipForwardMetric3": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipForwardMetric4": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipForwardMetric5": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true } } }, "readOnly": true }, "ipCidrRouteEntry": { "type": "array", "description": "A particular route to a particular destina-\n tion, under a particular policy.", "items": { "type": "object", "properties": { "ipCidrRouteDest": { "type": "string", "description": "The destination IP address of this route.\n \n This object may not take a Multicast (Class D)\n address value.\n \n Any assignment (implicit or otherwise) of an\n instance of this object to a value x must be\n rejected if the bitwise logical-AND of x with\n the value of the corresponding instance of the\n ipCidrRouteMask object is not equal to x.", "format": "inet:ipv4-address", "readOnly": true }, "ipCidrRouteMask": { "type": "string", "description": "Indicate the mask to be logical-ANDed with the\n destination address before being compared to\n the value in the ipCidrRouteDest field. For\n those systems that do not support arbitrary\n subnet masks, an agent constructs the value of\n the ipCidrRouteMask by reference to the IP Ad-\n dress Class.\n \n Any assignment (implicit or otherwise) of an\n instance of this object to a value x must be\n rejected if the bitwise logical-AND of x with\n the value of the corresponding instance of the\n ipCidrRouteDest object is not equal to ipCidrRoute-\n Dest.", "format": "inet:ipv4-address", "readOnly": true }, "ipCidrRouteTos": { "type": "integer", "description": "The policy specifier is the IP TOS Field. The encoding\n of IP TOS is as specified by the following convention.\n Zero indicates the default path if no more specific\n policy applies.\n \n +-----+-----+-----+-----+-----+-----+-----+-----+\n | | | |\n | PRECEDENCE | TYPE OF SERVICE | 0 |\n | | | |\n +-----+-----+-----+-----+-----+-----+-----+-----+\n \n IP TOS IP TOS\n Field Policy Field Policy\n Contents Code Contents Code\n 0 0 0 0 ==> 0 0 0 0 1 ==> 2\n 0 0 1 0 ==> 4 0 0 1 1 ==> 6\n 0 1 0 0 ==> 8 0 1 0 1 ==> 10\n 0 1 1 0 ==> 12 0 1 1 1 ==> 14\n 1 0 0 0 ==> 16 1 0 0 1 ==> 18\n 1 0 1 0 ==> 20 1 0 1 1 ==> 22\n 1 1 0 0 ==> 24 1 1 0 1 ==> 26\n 1 1 1 0 ==> 28 1 1 1 1 ==> 30", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipCidrRouteNextHop": { "type": "string", "description": "On remote routes, the address of the next sys-\n tem en route; Otherwise, 0.0.0.0.", "format": "inet:ipv4-address", "readOnly": true }, "ipCidrRouteIfIndex": { "type": "integer", "description": "The ifIndex value which identifies the local\n interface through which the next hop of this\n route should be reached.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipCidrRouteType": { "type": "string", "description": "The type of route. Note that local(3) refers\n to a route for which the next hop is the final\n destination; remote(4) refers to a route for\n which the next hop is not the final destina-\n tion.\n \n Routes which do not result in traffic forwarding or\n rejection should not be displayed even if the\n implementation keeps them stored internally.\n \n \n reject (2) refers to a route which, if matched, discards\n the message as unreachable. This is used in some\n protocols as a means of correctly aggregating routes.", "readOnly": true }, "ipCidrRouteProto": { "type": "string", "description": "The routing mechanism via which this route was\n learned. Inclusion of values for gateway rout-\n ing protocols is not intended to imply that\n hosts should support those protocols.", "readOnly": true }, "ipCidrRouteAge": { "type": "integer", "description": "The number of seconds since this route was\n last updated or otherwise determined to be\n correct. Note that no semantics of `too old'\n can be implied except through knowledge of the\n routing protocol by which the route was\n learned.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipCidrRouteInfo": { "type": "string", "description": "A reference to MIB definitions specific to the\n particular routing protocol which is responsi-\n ble for this route, as determined by the value\n specified in the route's ipCidrRouteProto value.\n If this information is not present, its value\n should be set to the OBJECT IDENTIFIER { 0 0 },\n which is a syntactically valid object identif-\n ier, and any implementation conforming to ASN.1\n and the Basic Encoding Rules must be able to\n generate and recognize this value.", "x-yang-type": "yang:object-identifier-128", "readOnly": true }, "ipCidrRouteNextHopAS": { "type": "integer", "description": "The Autonomous System Number of the Next Hop.\n The semantics of this object are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. When this object is\n unknown or not relevant its value should be set\n to zero.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipCidrRouteMetric1": { "type": "integer", "description": "The primary routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipCidrRouteMetric2": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipCidrRouteMetric3": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipCidrRouteMetric4": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipCidrRouteMetric5": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipCidrRouteStatus": { "type": "string", "description": "The row status variable, used according to\n row installation and removal conventions.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "ipForward": { "type": "object", "description": "The number of current ipForwardTable entries\n that are not invalid.", "properties": { "ipForwardNumber": { "type": "integer", "description": "The number of current ipForwardTable entries\n that are not invalid.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ipCidrRouteNumber": { "type": "integer", "description": "The number of current ipCidrRouteTable entries\n that are not invalid.", "minimum": 0, "maximum": 4294967295, "readOnly": true } }, "readOnly": true }, "ipForwardTable": { "type": "object", "description": "This entity's IP Routing table.", "properties": { "ipForwardEntry": { "type": "array", "description": "A particular route to a particular destina-\n tion, under a particular policy.", "items": { "type": "object", "properties": { "ipForwardDest": { "type": "string", "description": "The destination IP address of this route. An\n entry with a value of 0.0.0.0 is considered a\n default route.\n \n This object may not take a Multicast (Class D)\n address value.\n \n Any assignment (implicit or otherwise) of an\n instance of this object to a value x must be\n rejected if the bitwise logical-AND of x with\n the value of the corresponding instance of the\n ipForwardMask object is not equal to x.", "format": "inet:ipv4-address", "readOnly": true }, "ipForwardMask": { "type": "string", "description": "Indicate the mask to be logical-ANDed with the\n destination address before being compared to\n the value in the ipForwardDest field. For\n those systems that do not support arbitrary\n subnet masks, an agent constructs the value of\n the ipForwardMask by reference to the IP Ad-\n dress Class.\n \n Any assignment (implicit or otherwise) of an\n instance of this object to a value x must be\n rejected if the bitwise logical-AND of x with\n the value of the corresponding instance of the\n ipForwardDest object is not equal to ipForward-\n Dest.", "format": "inet:ipv4-address", "readOnly": true }, "ipForwardPolicy": { "type": "integer", "description": "The general set of conditions that would cause\n the selection of one multipath route (set of\n next hops for a given destination) is referred\n to as 'policy'.\n \n Unless the mechanism indicated by ipForwardPro-\n to specifies otherwise, the policy specifier is\n the IP TOS Field. The encoding of IP TOS is as\n specified by the following convention. Zero\n indicates the default path if no more specific\n policy applies.\n \n +-----+-----+-----+-----+-----+-----+-----+-----+\n | | | |\n | PRECEDENCE | TYPE OF SERVICE | 0 |\n | | | |\n +-----+-----+-----+-----+-----+-----+-----+-----+\n \n IP TOS IP TOS\n Field Policy Field Policy\n Contents Code Contents Code\n 0 0 0 0 ==> 0 0 0 0 1 ==> 2\n 0 0 1 0 ==> 4 0 0 1 1 ==> 6\n 0 1 0 0 ==> 8 0 1 0 1 ==> 10\n 0 1 1 0 ==> 12 0 1 1 1 ==> 14\n 1 0 0 0 ==> 16 1 0 0 1 ==> 18\n 1 0 1 0 ==> 20 1 0 1 1 ==> 22\n 1 1 0 0 ==> 24 1 1 0 1 ==> 26\n 1 1 1 0 ==> 28 1 1 1 1 ==> 30\n \n Protocols defining 'policy' otherwise must ei-\n ther define a set of values which are valid for\n this object or must implement an integer-\n instanced policy table for which this object's\n value acts as an index.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipForwardNextHop": { "type": "string", "description": "On remote routes, the address of the next sys-\n tem en route; Otherwise, 0.0.0.0.", "format": "inet:ipv4-address", "readOnly": true }, "ipForwardIfIndex": { "type": "integer", "description": "The ifIndex value which identifies the local\n interface through which the next hop of this\n route should be reached.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipForwardType": { "type": "string", "description": "The type of route. Note that local(3) refers\n to a route for which the next hop is the final\n destination; remote(4) refers to a route for\n which the next hop is not the final destina-\n tion.\n \n Setting this object to the value invalid(2) has\n the effect of invalidating the corresponding\n entry in the ipForwardTable object. That is,\n it effectively disassociates the destination\n identified with said entry from the route iden-\n tified with said entry. It is an\n implementation-specific matter as to whether\n the agent removes an invalidated entry from the\n table. Accordingly, management stations must\n be prepared to receive tabular information from\n agents that corresponds to entries not current-\n ly in use. Proper interpretation of such en-\n tries requires examination of the relevant ip-\n ForwardType object.", "readOnly": true }, "ipForwardProto": { "type": "string", "description": "The routing mechanism via which this route was\n learned. Inclusion of values for gateway rout-\n ing protocols is not intended to imply that\n hosts should support those protocols.", "readOnly": true }, "ipForwardAge": { "type": "integer", "description": "The number of seconds since this route was\n last updated or otherwise determined to be\n correct. Note that no semantics of `too old'\n can be implied except through knowledge of the\n routing protocol by which the route was\n learned.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipForwardInfo": { "type": "string", "description": "A reference to MIB definitions specific to the\n particular routing protocol which is responsi-\n ble for this route, as determined by the value\n specified in the route's ipForwardProto value.\n If this information is not present, its value\n should be set to the OBJECT IDENTIFIER { 0 0 },\n which is a syntactically valid object identif-\n ier, and any implementation conforming to ASN.1\n and the Basic Encoding Rules must be able to\n generate and recognize this value.", "x-yang-type": "yang:object-identifier-128", "readOnly": true }, "ipForwardNextHopAS": { "type": "integer", "description": "The Autonomous System Number of the Next Hop.\n When this is unknown or not relevant to the\n protocol indicated by ipForwardProto, zero.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipForwardMetric1": { "type": "integer", "description": "The primary routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipForwardMetric2": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipForwardMetric3": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipForwardMetric4": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipForwardMetric5": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ipCidrRouteTable": { "type": "object", "description": "This entity's IP Routing table.", "properties": { "ipCidrRouteEntry": { "type": "array", "description": "A particular route to a particular destina-\n tion, under a particular policy.", "items": { "type": "object", "properties": { "ipCidrRouteDest": { "type": "string", "description": "The destination IP address of this route.\n \n This object may not take a Multicast (Class D)\n address value.\n \n Any assignment (implicit or otherwise) of an\n instance of this object to a value x must be\n rejected if the bitwise logical-AND of x with\n the value of the corresponding instance of the\n ipCidrRouteMask object is not equal to x.", "format": "inet:ipv4-address", "readOnly": true }, "ipCidrRouteMask": { "type": "string", "description": "Indicate the mask to be logical-ANDed with the\n destination address before being compared to\n the value in the ipCidrRouteDest field. For\n those systems that do not support arbitrary\n subnet masks, an agent constructs the value of\n the ipCidrRouteMask by reference to the IP Ad-\n dress Class.\n \n Any assignment (implicit or otherwise) of an\n instance of this object to a value x must be\n rejected if the bitwise logical-AND of x with\n the value of the corresponding instance of the\n ipCidrRouteDest object is not equal to ipCidrRoute-\n Dest.", "format": "inet:ipv4-address", "readOnly": true }, "ipCidrRouteTos": { "type": "integer", "description": "The policy specifier is the IP TOS Field. The encoding\n of IP TOS is as specified by the following convention.\n Zero indicates the default path if no more specific\n policy applies.\n \n +-----+-----+-----+-----+-----+-----+-----+-----+\n | | | |\n | PRECEDENCE | TYPE OF SERVICE | 0 |\n | | | |\n +-----+-----+-----+-----+-----+-----+-----+-----+\n \n IP TOS IP TOS\n Field Policy Field Policy\n Contents Code Contents Code\n 0 0 0 0 ==> 0 0 0 0 1 ==> 2\n 0 0 1 0 ==> 4 0 0 1 1 ==> 6\n 0 1 0 0 ==> 8 0 1 0 1 ==> 10\n 0 1 1 0 ==> 12 0 1 1 1 ==> 14\n 1 0 0 0 ==> 16 1 0 0 1 ==> 18\n 1 0 1 0 ==> 20 1 0 1 1 ==> 22\n 1 1 0 0 ==> 24 1 1 0 1 ==> 26\n 1 1 1 0 ==> 28 1 1 1 1 ==> 30", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipCidrRouteNextHop": { "type": "string", "description": "On remote routes, the address of the next sys-\n tem en route; Otherwise, 0.0.0.0.", "format": "inet:ipv4-address", "readOnly": true }, "ipCidrRouteIfIndex": { "type": "integer", "description": "The ifIndex value which identifies the local\n interface through which the next hop of this\n route should be reached.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipCidrRouteType": { "type": "string", "description": "The type of route. Note that local(3) refers\n to a route for which the next hop is the final\n destination; remote(4) refers to a route for\n which the next hop is not the final destina-\n tion.\n \n Routes which do not result in traffic forwarding or\n rejection should not be displayed even if the\n implementation keeps them stored internally.\n \n \n reject (2) refers to a route which, if matched, discards\n the message as unreachable. This is used in some\n protocols as a means of correctly aggregating routes.", "readOnly": true }, "ipCidrRouteProto": { "type": "string", "description": "The routing mechanism via which this route was\n learned. Inclusion of values for gateway rout-\n ing protocols is not intended to imply that\n hosts should support those protocols.", "readOnly": true }, "ipCidrRouteAge": { "type": "integer", "description": "The number of seconds since this route was\n last updated or otherwise determined to be\n correct. Note that no semantics of `too old'\n can be implied except through knowledge of the\n routing protocol by which the route was\n learned.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipCidrRouteInfo": { "type": "string", "description": "A reference to MIB definitions specific to the\n particular routing protocol which is responsi-\n ble for this route, as determined by the value\n specified in the route's ipCidrRouteProto value.\n If this information is not present, its value\n should be set to the OBJECT IDENTIFIER { 0 0 },\n which is a syntactically valid object identif-\n ier, and any implementation conforming to ASN.1\n and the Basic Encoding Rules must be able to\n generate and recognize this value.", "x-yang-type": "yang:object-identifier-128", "readOnly": true }, "ipCidrRouteNextHopAS": { "type": "integer", "description": "The Autonomous System Number of the Next Hop.\n The semantics of this object are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. When this object is\n unknown or not relevant its value should be set\n to zero.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipCidrRouteMetric1": { "type": "integer", "description": "The primary routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipCidrRouteMetric2": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipCidrRouteMetric3": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipCidrRouteMetric4": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipCidrRouteMetric5": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipCidrRouteStatus": { "type": "string", "description": "The row status variable, used according to\n row installation and removal conventions.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "IP-FORWARD-MIB_ipForwardEntry": { "type": "array", "description": "A particular route to a particular destina-\n tion, under a particular policy.", "items": { "type": "object", "properties": { "ipForwardDest": { "type": "string", "description": "The destination IP address of this route. An\n entry with a value of 0.0.0.0 is considered a\n default route.\n \n This object may not take a Multicast (Class D)\n address value.\n \n Any assignment (implicit or otherwise) of an\n instance of this object to a value x must be\n rejected if the bitwise logical-AND of x with\n the value of the corresponding instance of the\n ipForwardMask object is not equal to x.", "format": "inet:ipv4-address", "readOnly": true }, "ipForwardMask": { "type": "string", "description": "Indicate the mask to be logical-ANDed with the\n destination address before being compared to\n the value in the ipForwardDest field. For\n those systems that do not support arbitrary\n subnet masks, an agent constructs the value of\n the ipForwardMask by reference to the IP Ad-\n dress Class.\n \n Any assignment (implicit or otherwise) of an\n instance of this object to a value x must be\n rejected if the bitwise logical-AND of x with\n the value of the corresponding instance of the\n ipForwardDest object is not equal to ipForward-\n Dest.", "format": "inet:ipv4-address", "readOnly": true }, "ipForwardPolicy": { "type": "integer", "description": "The general set of conditions that would cause\n the selection of one multipath route (set of\n next hops for a given destination) is referred\n to as 'policy'.\n \n Unless the mechanism indicated by ipForwardPro-\n to specifies otherwise, the policy specifier is\n the IP TOS Field. The encoding of IP TOS is as\n specified by the following convention. Zero\n indicates the default path if no more specific\n policy applies.\n \n +-----+-----+-----+-----+-----+-----+-----+-----+\n | | | |\n | PRECEDENCE | TYPE OF SERVICE | 0 |\n | | | |\n +-----+-----+-----+-----+-----+-----+-----+-----+\n \n IP TOS IP TOS\n Field Policy Field Policy\n Contents Code Contents Code\n 0 0 0 0 ==> 0 0 0 0 1 ==> 2\n 0 0 1 0 ==> 4 0 0 1 1 ==> 6\n 0 1 0 0 ==> 8 0 1 0 1 ==> 10\n 0 1 1 0 ==> 12 0 1 1 1 ==> 14\n 1 0 0 0 ==> 16 1 0 0 1 ==> 18\n 1 0 1 0 ==> 20 1 0 1 1 ==> 22\n 1 1 0 0 ==> 24 1 1 0 1 ==> 26\n 1 1 1 0 ==> 28 1 1 1 1 ==> 30\n \n Protocols defining 'policy' otherwise must ei-\n ther define a set of values which are valid for\n this object or must implement an integer-\n instanced policy table for which this object's\n value acts as an index.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipForwardNextHop": { "type": "string", "description": "On remote routes, the address of the next sys-\n tem en route; Otherwise, 0.0.0.0.", "format": "inet:ipv4-address", "readOnly": true }, "ipForwardIfIndex": { "type": "integer", "description": "The ifIndex value which identifies the local\n interface through which the next hop of this\n route should be reached.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipForwardType": { "type": "string", "description": "The type of route. Note that local(3) refers\n to a route for which the next hop is the final\n destination; remote(4) refers to a route for\n which the next hop is not the final destina-\n tion.\n \n Setting this object to the value invalid(2) has\n the effect of invalidating the corresponding\n entry in the ipForwardTable object. That is,\n it effectively disassociates the destination\n identified with said entry from the route iden-\n tified with said entry. It is an\n implementation-specific matter as to whether\n the agent removes an invalidated entry from the\n table. Accordingly, management stations must\n be prepared to receive tabular information from\n agents that corresponds to entries not current-\n ly in use. Proper interpretation of such en-\n tries requires examination of the relevant ip-\n ForwardType object.", "readOnly": true }, "ipForwardProto": { "type": "string", "description": "The routing mechanism via which this route was\n learned. Inclusion of values for gateway rout-\n ing protocols is not intended to imply that\n hosts should support those protocols.", "readOnly": true }, "ipForwardAge": { "type": "integer", "description": "The number of seconds since this route was\n last updated or otherwise determined to be\n correct. Note that no semantics of `too old'\n can be implied except through knowledge of the\n routing protocol by which the route was\n learned.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipForwardInfo": { "type": "string", "description": "A reference to MIB definitions specific to the\n particular routing protocol which is responsi-\n ble for this route, as determined by the value\n specified in the route's ipForwardProto value.\n If this information is not present, its value\n should be set to the OBJECT IDENTIFIER { 0 0 },\n which is a syntactically valid object identif-\n ier, and any implementation conforming to ASN.1\n and the Basic Encoding Rules must be able to\n generate and recognize this value.", "x-yang-type": "yang:object-identifier-128", "readOnly": true }, "ipForwardNextHopAS": { "type": "integer", "description": "The Autonomous System Number of the Next Hop.\n When this is unknown or not relevant to the\n protocol indicated by ipForwardProto, zero.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipForwardMetric1": { "type": "integer", "description": "The primary routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipForwardMetric2": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipForwardMetric3": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipForwardMetric4": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipForwardMetric5": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipForwardProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true } } } }, "IP-FORWARD-MIB_ipCidrRouteEntry": { "type": "array", "description": "A particular route to a particular destina-\n tion, under a particular policy.", "items": { "type": "object", "properties": { "ipCidrRouteDest": { "type": "string", "description": "The destination IP address of this route.\n \n This object may not take a Multicast (Class D)\n address value.\n \n Any assignment (implicit or otherwise) of an\n instance of this object to a value x must be\n rejected if the bitwise logical-AND of x with\n the value of the corresponding instance of the\n ipCidrRouteMask object is not equal to x.", "format": "inet:ipv4-address", "readOnly": true }, "ipCidrRouteMask": { "type": "string", "description": "Indicate the mask to be logical-ANDed with the\n destination address before being compared to\n the value in the ipCidrRouteDest field. For\n those systems that do not support arbitrary\n subnet masks, an agent constructs the value of\n the ipCidrRouteMask by reference to the IP Ad-\n dress Class.\n \n Any assignment (implicit or otherwise) of an\n instance of this object to a value x must be\n rejected if the bitwise logical-AND of x with\n the value of the corresponding instance of the\n ipCidrRouteDest object is not equal to ipCidrRoute-\n Dest.", "format": "inet:ipv4-address", "readOnly": true }, "ipCidrRouteTos": { "type": "integer", "description": "The policy specifier is the IP TOS Field. The encoding\n of IP TOS is as specified by the following convention.\n Zero indicates the default path if no more specific\n policy applies.\n \n +-----+-----+-----+-----+-----+-----+-----+-----+\n | | | |\n | PRECEDENCE | TYPE OF SERVICE | 0 |\n | | | |\n +-----+-----+-----+-----+-----+-----+-----+-----+\n \n IP TOS IP TOS\n Field Policy Field Policy\n Contents Code Contents Code\n 0 0 0 0 ==> 0 0 0 0 1 ==> 2\n 0 0 1 0 ==> 4 0 0 1 1 ==> 6\n 0 1 0 0 ==> 8 0 1 0 1 ==> 10\n 0 1 1 0 ==> 12 0 1 1 1 ==> 14\n 1 0 0 0 ==> 16 1 0 0 1 ==> 18\n 1 0 1 0 ==> 20 1 0 1 1 ==> 22\n 1 1 0 0 ==> 24 1 1 0 1 ==> 26\n 1 1 1 0 ==> 28 1 1 1 1 ==> 30", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipCidrRouteNextHop": { "type": "string", "description": "On remote routes, the address of the next sys-\n tem en route; Otherwise, 0.0.0.0.", "format": "inet:ipv4-address", "readOnly": true }, "ipCidrRouteIfIndex": { "type": "integer", "description": "The ifIndex value which identifies the local\n interface through which the next hop of this\n route should be reached.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipCidrRouteType": { "type": "string", "description": "The type of route. Note that local(3) refers\n to a route for which the next hop is the final\n destination; remote(4) refers to a route for\n which the next hop is not the final destina-\n tion.\n \n Routes which do not result in traffic forwarding or\n rejection should not be displayed even if the\n implementation keeps them stored internally.\n \n \n reject (2) refers to a route which, if matched, discards\n the message as unreachable. This is used in some\n protocols as a means of correctly aggregating routes.", "readOnly": true }, "ipCidrRouteProto": { "type": "string", "description": "The routing mechanism via which this route was\n learned. Inclusion of values for gateway rout-\n ing protocols is not intended to imply that\n hosts should support those protocols.", "readOnly": true }, "ipCidrRouteAge": { "type": "integer", "description": "The number of seconds since this route was\n last updated or otherwise determined to be\n correct. Note that no semantics of `too old'\n can be implied except through knowledge of the\n routing protocol by which the route was\n learned.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipCidrRouteInfo": { "type": "string", "description": "A reference to MIB definitions specific to the\n particular routing protocol which is responsi-\n ble for this route, as determined by the value\n specified in the route's ipCidrRouteProto value.\n If this information is not present, its value\n should be set to the OBJECT IDENTIFIER { 0 0 },\n which is a syntactically valid object identif-\n ier, and any implementation conforming to ASN.1\n and the Basic Encoding Rules must be able to\n generate and recognize this value.", "x-yang-type": "yang:object-identifier-128", "readOnly": true }, "ipCidrRouteNextHopAS": { "type": "integer", "description": "The Autonomous System Number of the Next Hop.\n The semantics of this object are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. When this object is\n unknown or not relevant its value should be set\n to zero.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipCidrRouteMetric1": { "type": "integer", "description": "The primary routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipCidrRouteMetric2": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipCidrRouteMetric3": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipCidrRouteMetric4": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipCidrRouteMetric5": { "type": "integer", "description": "An alternate routing metric for this route.\n The semantics of this metric are determined by\n the routing-protocol specified in the route's\n ipCidrRouteProto value. If this metric is not\n used, its value should be set to -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ipCidrRouteStatus": { "type": "string", "description": "The row status variable, used according to\n row installation and removal conventions.", "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": "IP-FORWARD-MIB", "description": "MIB operations for IP-FORWARD-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }