{ "openapi": "3.0.0", "info": { "title": "CISCO-IP-URPF-MIB MIB API", "version": "1.0.0", "description": "Unicast Reverse Path Forwarding (URPF) is a function that\n checks the validity of the source address of IP packets\n received on an interface. This in an attempt to prevent\n Denial of Service attacks based on IP address spoofing.\n \n URPF checks validity of a source address by determining\n whether the packet would be successfully routed as a\n destination address. \n Based on configuration, the check made\n can be for existence of any route for the address, or more\n strictly for a route out the interface on which the packet\n was received by the device. When a violating packet is\n detected, it can be dropped. \n This MIB allows detection of\n spoofingevents.\n\nāš ļø **IMPORTANT - MIB DATA ACCESS**:\nThis YANG model exists for SMIv2-to-YANG translation purposes, but MIB data on IOS-XE devices is primarily accessed via **SNMP protocol**, not RESTCONF.\n\n**RESTCONF Limitation**: Many MIB paths may return 404 errors via RESTCONF `/data` endpoints because the device exposes MIB data through SNMP, not the YANG datastore.\n\n**Recommended Access Methods**:\n- Use SNMP (v2c/v3) to query MIB data directly\n- Use NETCONF `` operations for devices supporting YANG-modeled MIB access\n- Check device capabilities: some newer IOS-XE versions may support limited RESTCONF access to specific MIBs\n\n**YANG Model Purpose**: These YANG models define the structure of SNMP MIBs in YANG format for tooling compatibility, but do not guarantee RESTCONF data availability.\n\n\n**šŸ“Š YANG Tree:** [View CISCO-IP-URPF-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/CISCO-IP-URPF-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "CISCO-IP-URPF-MIB", "x-model-type": "mib" }, "servers": [ { "url": "https://{device}/restconf", "description": "RESTCONF server", "variables": { "device": { "default": "10.1.1.1", "description": "Device hostname or IP address" } } } ], "paths": { "/data/CISCO-IP-URPF-MIB:cipUrpfScalar": { "get": { "summary": "Get cipUrpfScalar data", "description": "Retrieve cipUrpfScalar operational data from MIB", "tags": [ "CISCO-IP-URPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "cipUrpfScalar", "properties": { "cipUrpfDropRateWindow": { "type": "integer", "description": "The window of time in the recent past over which the drop\n count used in the drop rate computation is collected. \n This global value applies for the computation of all URPF \n rates, global and per-interface. \n \n Once the period over which computations have been \n performed exceeds cipUrpfDropRateWindow, every time a \n computation is performed, the window slides up to end \n at the current time and start at cipUrpfDropRateWindow \n seconds before. \n \n The cipUrpfDropRateWindow must be greater than\n or equal to the interval between computations \n (cipUrpfComputeInterval).\n \n Since the agent must save the drop count values\n for each compute interval in order to slide the window,\n the number of counts saved is the quotient of\n cipUrpfDropRateWindow divided by cipUrpfComputeInterval.", "minimum": -2147483648, "maximum": 2147483647 }, "cipUrpfComputeInterval": { "type": "integer", "description": "The time between rate computations. This global value\n applies for the computation of all URPF rates, global\n and per-interface.\n \n When the value of cipUrpfComputeInterval is changed,\n the interval in-progress proceeds as though the value\n had not changed. The change will apply to the length\n of subsequent intervals.\n \n The cipUrpfComputeInterval must be less than or equal \n to the cipUrpfDropRateWindow.", "minimum": -2147483648, "maximum": 2147483647 }, "cipUrpfDropNotifyHoldDownTime": { "type": "integer", "description": "The minimum time between issuance of\n cipUrpfIfDropRateNotify notifications for a \n particular interface and packet forwarding type.\n \n Notifications are generated for each interface and\n packet forwarding type that exceeds the drop-rate. \n When a Notify is sent because the drop-rate is \n exceeded for a particular interface and forwarding\n type, the time specified by this object is used to \n specify the minimum time that must elapse before \n another Notify can be sent for that interface and\n forwarding type. The time is specified globally but \n used individually.", "minimum": -2147483648, "maximum": 2147483647 } } }, "example": { "CISCO-IP-URPF-MIB:cipUrpfScalar": { "cipUrpfDropRateWindow": -2147483648, "cipUrpfComputeInterval": -2147483648, "cipUrpfDropNotifyHoldDownTime": -2147483648 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipUrpfScalar", "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": "/cipUrpfScalar", "x-restconf-kind": "container" }, "/data/CISCO-IP-URPF-MIB:cipUrpfTable": { "get": { "summary": "Get cipUrpfTable data", "description": "Retrieve cipUrpfTable operational data from MIB", "tags": [ "CISCO-IP-URPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains summary information for the\n managed device on URPF dropping.", "properties": { "cipUrpfEntry": { "type": "array", "description": "If the managed device supports URPF dropping,\n a row exists for each IP version type (v4 and v6).\n A row contains summary information on URPF\n dropping over the entire managed device.", "items": { "type": "object", "properties": { "cipUrpfIpVersion": { "type": "string", "description": "Specifies the version of IP forwarding on an interface\n to which the table row URPF counts, rates, and\n configuration apply." }, "cipUrpfDrops": { "type": "integer", "description": "Sum of dropped IP version cipUrpfIpVersion packets failing\n a URPF check. This value is the sum of drops of packets \n received on all interfaces of the managed device.", "minimum": 0, "maximum": 4294967295 }, "cipUrpfDropRate": { "type": "integer", "description": "The rate of packet drops of IP version cipUrpfIpVersion\n packets due to URPF for the managed device. The\n per-interface drop rate notification is issued on rates\n exceeding a limit (rising rate). This dropping may indicate\n an security attack on the network. To determine whether the\n attack/event is over, the NMS must consult the managed\n device. This object can be polled to determine the recent\n drop rate for the managed device as a whole, in addition to\n querying particular interface objects. \n This object is the\n average rate of dropping over the most recent window of\n time. The rate is computed by dividing the number of packets\n dropped over a window by the window time in seconds. The\n window time is specified by cipUrpfDropRateWindow. Each time\n the drop rate is computed, and at system startup, a snapshot\n is taken of the latest value of cipUrpfDrops. Subtracting\n from this the snapshot of cipUrpfDrops at the start of the\n current window of time gives the number of packets dropped.\n The drop rate is computed every cipUrpfComputeInterval\n seconds. As an example, let cipUrpfDropRateWindow be 300\n seconds, and cipUrpfComputeInterval 30 seconds. Every 30\n seconds, the drop count five minutes previous is subtracted\n from the current drop count, and the result is divided by\n 300 to arrive at the drop rate. \n At device start-up, until\n the device has been up more than cipUrpfDropRateWindow, when\n drop rate is computed, the value of cipUrpfDrops is divided\n by the time the device has been up. \n After the device has\n been up for cipUrpfDropRateWindow, when drop rate is\n computed, the number of packet drops counted from interval\n start time to the computation time is divided by\n cipUrpfDropRateWindow. \n Changes to cipUrpfDropRateWindow are\n not reflected in this object until the next computation\n time. \n The rate from the most recent computation is the\n value fetched until the subsequent computation is\n performed.", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "CISCO-IP-URPF-MIB:cipUrpfTable": { "cipUrpfEntry": [ { "cipUrpfIpVersion": "192.168.1.1", "cipUrpfDrops": 0, "cipUrpfDropRate": 0 }, { "cipUrpfIpVersion": "192.168.1.1", "cipUrpfDrops": 0, "cipUrpfDropRate": 0 }, { "cipUrpfIpVersion": "192.168.1.1", "cipUrpfDrops": 0, "cipUrpfDropRate": 0 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipUrpfTable", "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": "/cipUrpfTable", "x-restconf-kind": "container" }, "/data/CISCO-IP-URPF-MIB:cipUrpfTable/cipUrpfEntry": { "get": { "summary": "Get cipUrpfEntry list", "description": "Retrieve list of cipUrpfEntry entries from MIB", "tags": [ "CISCO-IP-URPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "If the managed device supports URPF dropping,\n a row exists for each IP version type (v4 and v6).\n A row contains summary information on URPF\n dropping over the entire managed device.", "items": { "type": "object", "properties": { "cipUrpfIpVersion": { "type": "string", "description": "Specifies the version of IP forwarding on an interface\n to which the table row URPF counts, rates, and\n configuration apply." }, "cipUrpfDrops": { "type": "integer", "description": "Sum of dropped IP version cipUrpfIpVersion packets failing\n a URPF check. This value is the sum of drops of packets \n received on all interfaces of the managed device.", "minimum": 0, "maximum": 4294967295 }, "cipUrpfDropRate": { "type": "integer", "description": "The rate of packet drops of IP version cipUrpfIpVersion\n packets due to URPF for the managed device. The\n per-interface drop rate notification is issued on rates\n exceeding a limit (rising rate). This dropping may indicate\n an security attack on the network. To determine whether the\n attack/event is over, the NMS must consult the managed\n device. This object can be polled to determine the recent\n drop rate for the managed device as a whole, in addition to\n querying particular interface objects. \n This object is the\n average rate of dropping over the most recent window of\n time. The rate is computed by dividing the number of packets\n dropped over a window by the window time in seconds. The\n window time is specified by cipUrpfDropRateWindow. Each time\n the drop rate is computed, and at system startup, a snapshot\n is taken of the latest value of cipUrpfDrops. Subtracting\n from this the snapshot of cipUrpfDrops at the start of the\n current window of time gives the number of packets dropped.\n The drop rate is computed every cipUrpfComputeInterval\n seconds. As an example, let cipUrpfDropRateWindow be 300\n seconds, and cipUrpfComputeInterval 30 seconds. Every 30\n seconds, the drop count five minutes previous is subtracted\n from the current drop count, and the result is divided by\n 300 to arrive at the drop rate. \n At device start-up, until\n the device has been up more than cipUrpfDropRateWindow, when\n drop rate is computed, the value of cipUrpfDrops is divided\n by the time the device has been up. \n After the device has\n been up for cipUrpfDropRateWindow, when drop rate is\n computed, the number of packet drops counted from interval\n start time to the computation time is divided by\n cipUrpfDropRateWindow. \n Changes to cipUrpfDropRateWindow are\n not reflected in this object until the next computation\n time. \n The rate from the most recent computation is the\n value fetched until the subsequent computation is\n performed.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-IP-URPF-MIB:cipUrpfEntry": [ { "cipUrpfIpVersion": "192.168.1.1", "cipUrpfDrops": 0, "cipUrpfDropRate": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipUrpfEntry", "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": "/cipUrpfTable/cipUrpfEntry", "x-restconf-kind": "container" }, "/data/CISCO-IP-URPF-MIB:cipUrpfTable/cipUrpfEntry={cipUrpfIpVersion}": { "get": { "summary": "Get cipUrpfEntry entry", "description": "Retrieve specific cipUrpfEntry entry by key from MIB", "tags": [ "CISCO-IP-URPF-MIB" ], "parameters": [ { "name": "cipUrpfIpVersion", "in": "path", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "cipUrpfIpVersion": { "type": "string", "description": "Specifies the version of IP forwarding on an interface\n to which the table row URPF counts, rates, and\n configuration apply." }, "cipUrpfDrops": { "type": "integer", "description": "Sum of dropped IP version cipUrpfIpVersion packets failing\n a URPF check. This value is the sum of drops of packets \n received on all interfaces of the managed device.", "minimum": 0, "maximum": 4294967295 }, "cipUrpfDropRate": { "type": "integer", "description": "The rate of packet drops of IP version cipUrpfIpVersion\n packets due to URPF for the managed device. The\n per-interface drop rate notification is issued on rates\n exceeding a limit (rising rate). This dropping may indicate\n an security attack on the network. To determine whether the\n attack/event is over, the NMS must consult the managed\n device. This object can be polled to determine the recent\n drop rate for the managed device as a whole, in addition to\n querying particular interface objects. \n This object is the\n average rate of dropping over the most recent window of\n time. The rate is computed by dividing the number of packets\n dropped over a window by the window time in seconds. The\n window time is specified by cipUrpfDropRateWindow. Each time\n the drop rate is computed, and at system startup, a snapshot\n is taken of the latest value of cipUrpfDrops. Subtracting\n from this the snapshot of cipUrpfDrops at the start of the\n current window of time gives the number of packets dropped.\n The drop rate is computed every cipUrpfComputeInterval\n seconds. As an example, let cipUrpfDropRateWindow be 300\n seconds, and cipUrpfComputeInterval 30 seconds. Every 30\n seconds, the drop count five minutes previous is subtracted\n from the current drop count, and the result is divided by\n 300 to arrive at the drop rate. \n At device start-up, until\n the device has been up more than cipUrpfDropRateWindow, when\n drop rate is computed, the value of cipUrpfDrops is divided\n by the time the device has been up. \n After the device has\n been up for cipUrpfDropRateWindow, when drop rate is\n computed, the number of packet drops counted from interval\n start time to the computation time is divided by\n cipUrpfDropRateWindow. \n Changes to cipUrpfDropRateWindow are\n not reflected in this object until the next computation\n time. \n The rate from the most recent computation is the\n value fetched until the subsequent computation is\n performed.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-IP-URPF-MIB:cipUrpfEntry": { "cipUrpfIpVersion": "192.168.1.1", "cipUrpfDrops": 0, "cipUrpfDropRate": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipUrpfEntry-2" }, "x-yang-path": "/cipUrpfTable/cipUrpfEntry={cipUrpfIpVersion}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cipUrpfIpVersion" ] }, "/data/CISCO-IP-URPF-MIB:cipUrpfIfMonTable": { "get": { "summary": "Get cipUrpfIfMonTable data", "description": "Retrieve cipUrpfIfMonTable operational data from MIB", "tags": [ "CISCO-IP-URPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains information on URPF dropping on\n an interface.", "properties": { "cipUrpfIfMonEntry": { "type": "array", "description": "cipUrpfIfMonEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cipUrpfIfIpVersion": { "type": "string", "description": "Specifies the version of IP forwarding on an interface\n to which the table row URPF counts, rates, and \n configuration apply." }, "cipUrpfIfDrops": { "type": "integer", "description": "The number of IP packets of version cipUrpfIfIpVersion\n failing the URPF check and dropped by the managed device\n on a particular interface.\n \n Discontinuities in the value of this variable can occur \n at re-initialization of the management system, and at \n other times as indicated by the values of \n cipUrpfIfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cipUrpfIfSuppressedDrops": { "type": "integer", "description": "The number of IP packets of version cipUrpfIfIpVersion\n failing the URPF check but given a reprieve and not \n dropped by the managed device. Depending on the \n device configuration and capabilities, the following \n cases may cause incrementing of the counter: \n - if the managed device is configured to allow self-pings \n and the managed device pings itself.\n - if the managed device is configured for loose URPF (if any\n interface has a route to the source), and the strict\n case fails while the loose case passes.\n - DHCP Request packets (src 0.0.0.0 dst 255.255.255.255) \n will pass after initially being marked for drop.\n - RIP routing on unnumbered interfaces will pass after \n initially being marked for drop.\n - multicast packets will pass after initially being marked \n for drop\n - ACL's can be applied to permit packets after initially \n being marked for drop.\n \n Discontinuities in the value of this variable can occur \n at re-initialization of the management system, and at \n other times as indicated by the values of \n cipUrpfIfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cipUrpfIfDropRate": { "type": "integer", "description": "The rate of packet drops of IP version cipUrpfIfIpVersion\n packets due to URPF on the interface. \n \n This object is the average rate of dropping over the most \n recent interval of time. The rate is computed by dividing\n the number of packets dropped over an interval by the \n interval time in seconds. Each time the drop rate\n is computed, and at system startup, a snapshot is taken\n of the latest value of cipUrpfIfDrops. Subtracting from this\n the snapshot of cipUrpfIfDrops at the start of the current\n interval of time gives the number of packets dropped.\n The drop rate is computed every cipUrpfComputeInterval\n seconds.\n \n When drop rate is computed, if time since the creation of \n a row in cipUrpfIfMonTable is less than \n cipUrpfDropRateWindow, the value of cipUrpfIfDrops is \n divided by the time since row was created.\n \n After the row has been in existence for \n cipUrpfDropRateWindow, when drop rate is computed, the \n number of packet drops counted on the interface from \n interval start time to the computation time is divided \n by cipUrpfDropRateWindow.\n \n Changes to cipUrpfDropRateWindow are not reflected in this\n object until the next computation time.\n \n The rate from the most recent computation is the value \n fetched until the subsequent computation is performed.", "minimum": 0, "maximum": 4294967295 }, "cipUrpfIfDiscontinuityTime": { "type": "string", "description": "The value of sysUpTime on the most recent\n occasion at which this interface's counters\n suffered a discontinuity.\n If no such discontinuities have occurred\n since the last re-initialization of the\n local management subsystem, then this\n object contains a value of zero.", "x-yang-type": "yang:timestamp" } } } } } }, "example": { "CISCO-IP-URPF-MIB:cipUrpfIfMonTable": { "cipUrpfIfMonEntry": [ { "ifIndex": "1", "cipUrpfIfIpVersion": "192.168.1.1", "cipUrpfIfDrops": 0, "cipUrpfIfSuppressedDrops": 0, "cipUrpfIfDropRate": 0, "cipUrpfIfDiscontinuityTime": "192.168.1.1" }, { "ifIndex": "2", "cipUrpfIfIpVersion": "192.168.1.1", "cipUrpfIfDrops": 0, "cipUrpfIfSuppressedDrops": 0, "cipUrpfIfDropRate": 0, "cipUrpfIfDiscontinuityTime": "192.168.1.1" }, { "ifIndex": "3", "cipUrpfIfIpVersion": "192.168.1.1", "cipUrpfIfDrops": 0, "cipUrpfIfSuppressedDrops": 0, "cipUrpfIfDropRate": 0, "cipUrpfIfDiscontinuityTime": "192.168.1.1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipUrpfIfMonTable", "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": "/cipUrpfIfMonTable", "x-restconf-kind": "container" }, "/data/CISCO-IP-URPF-MIB:cipUrpfIfMonTable/cipUrpfIfMonEntry": { "get": { "summary": "Get cipUrpfIfMonEntry list", "description": "Retrieve list of cipUrpfIfMonEntry entries from MIB", "tags": [ "CISCO-IP-URPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cipUrpfIfMonEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cipUrpfIfIpVersion": { "type": "string", "description": "Specifies the version of IP forwarding on an interface\n to which the table row URPF counts, rates, and \n configuration apply." }, "cipUrpfIfDrops": { "type": "integer", "description": "The number of IP packets of version cipUrpfIfIpVersion\n failing the URPF check and dropped by the managed device\n on a particular interface.\n \n Discontinuities in the value of this variable can occur \n at re-initialization of the management system, and at \n other times as indicated by the values of \n cipUrpfIfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cipUrpfIfSuppressedDrops": { "type": "integer", "description": "The number of IP packets of version cipUrpfIfIpVersion\n failing the URPF check but given a reprieve and not \n dropped by the managed device. Depending on the \n device configuration and capabilities, the following \n cases may cause incrementing of the counter: \n - if the managed device is configured to allow self-pings \n and the managed device pings itself.\n - if the managed device is configured for loose URPF (if any\n interface has a route to the source), and the strict\n case fails while the loose case passes.\n - DHCP Request packets (src 0.0.0.0 dst 255.255.255.255) \n will pass after initially being marked for drop.\n - RIP routing on unnumbered interfaces will pass after \n initially being marked for drop.\n - multicast packets will pass after initially being marked \n for drop\n - ACL's can be applied to permit packets after initially \n being marked for drop.\n \n Discontinuities in the value of this variable can occur \n at re-initialization of the management system, and at \n other times as indicated by the values of \n cipUrpfIfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cipUrpfIfDropRate": { "type": "integer", "description": "The rate of packet drops of IP version cipUrpfIfIpVersion\n packets due to URPF on the interface. \n \n This object is the average rate of dropping over the most \n recent interval of time. The rate is computed by dividing\n the number of packets dropped over an interval by the \n interval time in seconds. Each time the drop rate\n is computed, and at system startup, a snapshot is taken\n of the latest value of cipUrpfIfDrops. Subtracting from this\n the snapshot of cipUrpfIfDrops at the start of the current\n interval of time gives the number of packets dropped.\n The drop rate is computed every cipUrpfComputeInterval\n seconds.\n \n When drop rate is computed, if time since the creation of \n a row in cipUrpfIfMonTable is less than \n cipUrpfDropRateWindow, the value of cipUrpfIfDrops is \n divided by the time since row was created.\n \n After the row has been in existence for \n cipUrpfDropRateWindow, when drop rate is computed, the \n number of packet drops counted on the interface from \n interval start time to the computation time is divided \n by cipUrpfDropRateWindow.\n \n Changes to cipUrpfDropRateWindow are not reflected in this\n object until the next computation time.\n \n The rate from the most recent computation is the value \n fetched until the subsequent computation is performed.", "minimum": 0, "maximum": 4294967295 }, "cipUrpfIfDiscontinuityTime": { "type": "string", "description": "The value of sysUpTime on the most recent\n occasion at which this interface's counters\n suffered a discontinuity.\n If no such discontinuities have occurred\n since the last re-initialization of the\n local management subsystem, then this\n object contains a value of zero.", "x-yang-type": "yang:timestamp" } } } }, "example": { "CISCO-IP-URPF-MIB:cipUrpfIfMonEntry": [ { "ifIndex": "example-string", "cipUrpfIfIpVersion": "192.168.1.1", "cipUrpfIfDrops": 0, "cipUrpfIfSuppressedDrops": 0, "cipUrpfIfDropRate": 0, "cipUrpfIfDiscontinuityTime": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipUrpfIfMonEntry", "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": "/cipUrpfIfMonTable/cipUrpfIfMonEntry", "x-restconf-kind": "container" }, "/data/CISCO-IP-URPF-MIB:cipUrpfVrfIfTable": { "get": { "summary": "Get cipUrpfVrfIfTable data", "description": "Retrieve cipUrpfVrfIfTable operational data from MIB", "tags": [ "CISCO-IP-URPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains statistics information for interfaces\n performing URPF using VRF table to determine reachability.", "properties": { "cipUrpfVrfIfEntry": { "type": "array", "description": "An entry exists for a VRF and interface if and only\n if the VRF associated with the interface is configured \n to perform IP URPF checking using the routing \n table for the VRF.", "items": { "type": "object", "properties": { "cipUrpfVrfName": { "type": "string", "description": "cipUrpfVrfName", "x-yang-type": "leafref" }, "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cipUrpfVrfIfDrops": { "type": "integer", "description": "The number of packets failing the URPF check for a VRF on\n the interface and dropped by the managed device.\n \n Discontinuities in the value of this variable can occur \n at re-initialization of the management system, and at \n other times as indicated by the values of \n cipUrpfVrfIfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cipUrpfVrfIfDiscontinuityTime": { "type": "string", "description": "The value of sysUpTime on the most recent occasion at\n which the URPF counters for this VRF on this interface \n suffered a discontinuity. If no such discontinuities \n have occurred since the last re-initialization of the\n local management subsystem, then this object contains a \n value of zero.", "x-yang-type": "yang:timestamp" } } } } } }, "example": { "CISCO-IP-URPF-MIB:cipUrpfVrfIfTable": { "cipUrpfVrfIfEntry": [ { "cipUrpfVrfName": "192.168.1.1", "ifIndex": "1", "cipUrpfVrfIfDrops": 0, "cipUrpfVrfIfDiscontinuityTime": "192.168.1.1" }, { "cipUrpfVrfName": "192.168.1.1", "ifIndex": "2", "cipUrpfVrfIfDrops": 0, "cipUrpfVrfIfDiscontinuityTime": "192.168.1.1" }, { "cipUrpfVrfName": "192.168.1.1", "ifIndex": "3", "cipUrpfVrfIfDrops": 0, "cipUrpfVrfIfDiscontinuityTime": "192.168.1.1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipUrpfVrfIfTable", "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": "/cipUrpfVrfIfTable", "x-restconf-kind": "container" }, "/data/CISCO-IP-URPF-MIB:cipUrpfVrfIfTable/cipUrpfVrfIfEntry": { "get": { "summary": "Get cipUrpfVrfIfEntry list", "description": "Retrieve list of cipUrpfVrfIfEntry entries from MIB", "tags": [ "CISCO-IP-URPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry exists for a VRF and interface if and only\n if the VRF associated with the interface is configured \n to perform IP URPF checking using the routing \n table for the VRF.", "items": { "type": "object", "properties": { "cipUrpfVrfName": { "type": "string", "description": "cipUrpfVrfName", "x-yang-type": "leafref" }, "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cipUrpfVrfIfDrops": { "type": "integer", "description": "The number of packets failing the URPF check for a VRF on\n the interface and dropped by the managed device.\n \n Discontinuities in the value of this variable can occur \n at re-initialization of the management system, and at \n other times as indicated by the values of \n cipUrpfVrfIfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cipUrpfVrfIfDiscontinuityTime": { "type": "string", "description": "The value of sysUpTime on the most recent occasion at\n which the URPF counters for this VRF on this interface \n suffered a discontinuity. If no such discontinuities \n have occurred since the last re-initialization of the\n local management subsystem, then this object contains a \n value of zero.", "x-yang-type": "yang:timestamp" } } } }, "example": { "CISCO-IP-URPF-MIB:cipUrpfVrfIfEntry": [ { "cipUrpfVrfName": "192.168.1.1", "ifIndex": "example-string", "cipUrpfVrfIfDrops": 0, "cipUrpfVrfIfDiscontinuityTime": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipUrpfVrfIfEntry", "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": "/cipUrpfVrfIfTable/cipUrpfVrfIfEntry", "x-restconf-kind": "container" }, "/data/CISCO-IP-URPF-MIB:cipUrpfVrfTable": { "get": { "summary": "Get cipUrpfVrfTable data", "description": "Retrieve cipUrpfVrfTable operational data from MIB", "tags": [ "CISCO-IP-URPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table enables indexing URPF drop statistics\n by Virtual Routing and Forwarding instances.", "properties": { "cipUrpfVrfEntry": { "type": "array", "description": "An entry exists for a VRF if and only if the VRF\n is associated with an interface that is configured\n to perform IP URPF checking using the routing table \n for that VRF.", "items": { "type": "object", "properties": { "cipUrpfVrfName": { "type": "string", "description": "This field is used to specify the VRF Table\n name.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } } } }, "example": { "CISCO-IP-URPF-MIB:cipUrpfVrfTable": { "cipUrpfVrfEntry": [ { "cipUrpfVrfName": "192.168.1.1" }, { "cipUrpfVrfName": "192.168.1.1" }, { "cipUrpfVrfName": "192.168.1.1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipUrpfVrfTable", "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": "/cipUrpfVrfTable", "x-restconf-kind": "container" }, "/data/CISCO-IP-URPF-MIB:cipUrpfVrfTable/cipUrpfVrfEntry": { "get": { "summary": "Get cipUrpfVrfEntry list", "description": "Retrieve list of cipUrpfVrfEntry entries from MIB", "tags": [ "CISCO-IP-URPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry exists for a VRF if and only if the VRF\n is associated with an interface that is configured\n to perform IP URPF checking using the routing table \n for that VRF.", "items": { "type": "object", "properties": { "cipUrpfVrfName": { "type": "string", "description": "This field is used to specify the VRF Table\n name.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } }, "example": { "CISCO-IP-URPF-MIB:cipUrpfVrfEntry": [ { "cipUrpfVrfName": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipUrpfVrfEntry", "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": "/cipUrpfVrfTable/cipUrpfVrfEntry", "x-restconf-kind": "container" }, "/data/CISCO-IP-URPF-MIB:cipUrpfVrfTable/cipUrpfVrfEntry={cipUrpfVrfName}": { "get": { "summary": "Get cipUrpfVrfEntry entry", "description": "Retrieve specific cipUrpfVrfEntry entry by key from MIB", "tags": [ "CISCO-IP-URPF-MIB" ], "parameters": [ { "name": "cipUrpfVrfName", "in": "path", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "cipUrpfVrfName": { "type": "string", "description": "This field is used to specify the VRF Table\n name.", "x-yang-type": "snmp-framework:SnmpAdminString" } } }, "example": { "CISCO-IP-URPF-MIB:cipUrpfVrfEntry": { "cipUrpfVrfName": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipUrpfVrfEntry-2" }, "x-yang-path": "/cipUrpfVrfTable/cipUrpfVrfEntry={cipUrpfVrfName}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cipUrpfVrfName" ] }, "/data/CISCO-IP-URPF-MIB:cipUrpfEntry": { "get": { "summary": "Get cipUrpfEntry list", "description": "Retrieve list of cipUrpfEntry entries from MIB", "tags": [ "CISCO-IP-URPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "If the managed device supports URPF dropping,\n a row exists for each IP version type (v4 and v6).\n A row contains summary information on URPF\n dropping over the entire managed device.", "items": { "type": "object", "properties": { "cipUrpfIpVersion": { "type": "string", "description": "Specifies the version of IP forwarding on an interface\n to which the table row URPF counts, rates, and\n configuration apply." }, "cipUrpfDrops": { "type": "integer", "description": "Sum of dropped IP version cipUrpfIpVersion packets failing\n a URPF check. This value is the sum of drops of packets \n received on all interfaces of the managed device.", "minimum": 0, "maximum": 4294967295 }, "cipUrpfDropRate": { "type": "integer", "description": "The rate of packet drops of IP version cipUrpfIpVersion\n packets due to URPF for the managed device. The\n per-interface drop rate notification is issued on rates\n exceeding a limit (rising rate). This dropping may indicate\n an security attack on the network. To determine whether the\n attack/event is over, the NMS must consult the managed\n device. This object can be polled to determine the recent\n drop rate for the managed device as a whole, in addition to\n querying particular interface objects. \n This object is the\n average rate of dropping over the most recent window of\n time. The rate is computed by dividing the number of packets\n dropped over a window by the window time in seconds. The\n window time is specified by cipUrpfDropRateWindow. Each time\n the drop rate is computed, and at system startup, a snapshot\n is taken of the latest value of cipUrpfDrops. Subtracting\n from this the snapshot of cipUrpfDrops at the start of the\n current window of time gives the number of packets dropped.\n The drop rate is computed every cipUrpfComputeInterval\n seconds. As an example, let cipUrpfDropRateWindow be 300\n seconds, and cipUrpfComputeInterval 30 seconds. Every 30\n seconds, the drop count five minutes previous is subtracted\n from the current drop count, and the result is divided by\n 300 to arrive at the drop rate. \n At device start-up, until\n the device has been up more than cipUrpfDropRateWindow, when\n drop rate is computed, the value of cipUrpfDrops is divided\n by the time the device has been up. \n After the device has\n been up for cipUrpfDropRateWindow, when drop rate is\n computed, the number of packet drops counted from interval\n start time to the computation time is divided by\n cipUrpfDropRateWindow. \n Changes to cipUrpfDropRateWindow are\n not reflected in this object until the next computation\n time. \n The rate from the most recent computation is the\n value fetched until the subsequent computation is\n performed.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-IP-URPF-MIB:cipUrpfEntry": [ { "cipUrpfIpVersion": "192.168.1.1", "cipUrpfDrops": 0, "cipUrpfDropRate": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipUrpfEntry-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": "/cipUrpfEntry", "x-restconf-kind": "container" }, "/data/CISCO-IP-URPF-MIB:cipUrpfEntry={cipUrpfIpVersion}": { "get": { "summary": "Get cipUrpfEntry entry", "description": "Retrieve specific cipUrpfEntry entry by key from MIB", "tags": [ "CISCO-IP-URPF-MIB" ], "parameters": [ { "name": "cipUrpfIpVersion", "in": "path", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "cipUrpfIpVersion": { "type": "string", "description": "Specifies the version of IP forwarding on an interface\n to which the table row URPF counts, rates, and\n configuration apply." }, "cipUrpfDrops": { "type": "integer", "description": "Sum of dropped IP version cipUrpfIpVersion packets failing\n a URPF check. This value is the sum of drops of packets \n received on all interfaces of the managed device.", "minimum": 0, "maximum": 4294967295 }, "cipUrpfDropRate": { "type": "integer", "description": "The rate of packet drops of IP version cipUrpfIpVersion\n packets due to URPF for the managed device. The\n per-interface drop rate notification is issued on rates\n exceeding a limit (rising rate). This dropping may indicate\n an security attack on the network. To determine whether the\n attack/event is over, the NMS must consult the managed\n device. This object can be polled to determine the recent\n drop rate for the managed device as a whole, in addition to\n querying particular interface objects. \n This object is the\n average rate of dropping over the most recent window of\n time. The rate is computed by dividing the number of packets\n dropped over a window by the window time in seconds. The\n window time is specified by cipUrpfDropRateWindow. Each time\n the drop rate is computed, and at system startup, a snapshot\n is taken of the latest value of cipUrpfDrops. Subtracting\n from this the snapshot of cipUrpfDrops at the start of the\n current window of time gives the number of packets dropped.\n The drop rate is computed every cipUrpfComputeInterval\n seconds. As an example, let cipUrpfDropRateWindow be 300\n seconds, and cipUrpfComputeInterval 30 seconds. Every 30\n seconds, the drop count five minutes previous is subtracted\n from the current drop count, and the result is divided by\n 300 to arrive at the drop rate. \n At device start-up, until\n the device has been up more than cipUrpfDropRateWindow, when\n drop rate is computed, the value of cipUrpfDrops is divided\n by the time the device has been up. \n After the device has\n been up for cipUrpfDropRateWindow, when drop rate is\n computed, the number of packet drops counted from interval\n start time to the computation time is divided by\n cipUrpfDropRateWindow. \n Changes to cipUrpfDropRateWindow are\n not reflected in this object until the next computation\n time. \n The rate from the most recent computation is the\n value fetched until the subsequent computation is\n performed.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-IP-URPF-MIB:cipUrpfEntry": { "cipUrpfIpVersion": "192.168.1.1", "cipUrpfDrops": 0, "cipUrpfDropRate": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipUrpfEntry-4" }, "x-yang-path": "/cipUrpfEntry={cipUrpfIpVersion}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cipUrpfIpVersion" ] }, "/data/CISCO-IP-URPF-MIB:cipUrpfIfMonEntry": { "get": { "summary": "Get cipUrpfIfMonEntry list", "description": "Retrieve list of cipUrpfIfMonEntry entries from MIB", "tags": [ "CISCO-IP-URPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cipUrpfIfMonEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cipUrpfIfIpVersion": { "type": "string", "description": "Specifies the version of IP forwarding on an interface\n to which the table row URPF counts, rates, and \n configuration apply." }, "cipUrpfIfDrops": { "type": "integer", "description": "The number of IP packets of version cipUrpfIfIpVersion\n failing the URPF check and dropped by the managed device\n on a particular interface.\n \n Discontinuities in the value of this variable can occur \n at re-initialization of the management system, and at \n other times as indicated by the values of \n cipUrpfIfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cipUrpfIfSuppressedDrops": { "type": "integer", "description": "The number of IP packets of version cipUrpfIfIpVersion\n failing the URPF check but given a reprieve and not \n dropped by the managed device. Depending on the \n device configuration and capabilities, the following \n cases may cause incrementing of the counter: \n - if the managed device is configured to allow self-pings \n and the managed device pings itself.\n - if the managed device is configured for loose URPF (if any\n interface has a route to the source), and the strict\n case fails while the loose case passes.\n - DHCP Request packets (src 0.0.0.0 dst 255.255.255.255) \n will pass after initially being marked for drop.\n - RIP routing on unnumbered interfaces will pass after \n initially being marked for drop.\n - multicast packets will pass after initially being marked \n for drop\n - ACL's can be applied to permit packets after initially \n being marked for drop.\n \n Discontinuities in the value of this variable can occur \n at re-initialization of the management system, and at \n other times as indicated by the values of \n cipUrpfIfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cipUrpfIfDropRate": { "type": "integer", "description": "The rate of packet drops of IP version cipUrpfIfIpVersion\n packets due to URPF on the interface. \n \n This object is the average rate of dropping over the most \n recent interval of time. The rate is computed by dividing\n the number of packets dropped over an interval by the \n interval time in seconds. Each time the drop rate\n is computed, and at system startup, a snapshot is taken\n of the latest value of cipUrpfIfDrops. Subtracting from this\n the snapshot of cipUrpfIfDrops at the start of the current\n interval of time gives the number of packets dropped.\n The drop rate is computed every cipUrpfComputeInterval\n seconds.\n \n When drop rate is computed, if time since the creation of \n a row in cipUrpfIfMonTable is less than \n cipUrpfDropRateWindow, the value of cipUrpfIfDrops is \n divided by the time since row was created.\n \n After the row has been in existence for \n cipUrpfDropRateWindow, when drop rate is computed, the \n number of packet drops counted on the interface from \n interval start time to the computation time is divided \n by cipUrpfDropRateWindow.\n \n Changes to cipUrpfDropRateWindow are not reflected in this\n object until the next computation time.\n \n The rate from the most recent computation is the value \n fetched until the subsequent computation is performed.", "minimum": 0, "maximum": 4294967295 }, "cipUrpfIfDiscontinuityTime": { "type": "string", "description": "The value of sysUpTime on the most recent\n occasion at which this interface's counters\n suffered a discontinuity.\n If no such discontinuities have occurred\n since the last re-initialization of the\n local management subsystem, then this\n object contains a value of zero.", "x-yang-type": "yang:timestamp" } } } }, "example": { "CISCO-IP-URPF-MIB:cipUrpfIfMonEntry": [ { "ifIndex": "example-string", "cipUrpfIfIpVersion": "192.168.1.1", "cipUrpfIfDrops": 0, "cipUrpfIfSuppressedDrops": 0, "cipUrpfIfDropRate": 0, "cipUrpfIfDiscontinuityTime": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipUrpfIfMonEntry-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": "/cipUrpfIfMonEntry", "x-restconf-kind": "container" }, "/data/CISCO-IP-URPF-MIB:cipUrpfVrfIfEntry": { "get": { "summary": "Get cipUrpfVrfIfEntry list", "description": "Retrieve list of cipUrpfVrfIfEntry entries from MIB", "tags": [ "CISCO-IP-URPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry exists for a VRF and interface if and only\n if the VRF associated with the interface is configured \n to perform IP URPF checking using the routing \n table for the VRF.", "items": { "type": "object", "properties": { "cipUrpfVrfName": { "type": "string", "description": "cipUrpfVrfName", "x-yang-type": "leafref" }, "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cipUrpfVrfIfDrops": { "type": "integer", "description": "The number of packets failing the URPF check for a VRF on\n the interface and dropped by the managed device.\n \n Discontinuities in the value of this variable can occur \n at re-initialization of the management system, and at \n other times as indicated by the values of \n cipUrpfVrfIfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cipUrpfVrfIfDiscontinuityTime": { "type": "string", "description": "The value of sysUpTime on the most recent occasion at\n which the URPF counters for this VRF on this interface \n suffered a discontinuity. If no such discontinuities \n have occurred since the last re-initialization of the\n local management subsystem, then this object contains a \n value of zero.", "x-yang-type": "yang:timestamp" } } } }, "example": { "CISCO-IP-URPF-MIB:cipUrpfVrfIfEntry": [ { "cipUrpfVrfName": "192.168.1.1", "ifIndex": "example-string", "cipUrpfVrfIfDrops": 0, "cipUrpfVrfIfDiscontinuityTime": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipUrpfVrfIfEntry-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": "/cipUrpfVrfIfEntry", "x-restconf-kind": "container" }, "/data/CISCO-IP-URPF-MIB:cipUrpfVrfEntry": { "get": { "summary": "Get cipUrpfVrfEntry list", "description": "Retrieve list of cipUrpfVrfEntry entries from MIB", "tags": [ "CISCO-IP-URPF-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry exists for a VRF if and only if the VRF\n is associated with an interface that is configured\n to perform IP URPF checking using the routing table \n for that VRF.", "items": { "type": "object", "properties": { "cipUrpfVrfName": { "type": "string", "description": "This field is used to specify the VRF Table\n name.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } }, "example": { "CISCO-IP-URPF-MIB:cipUrpfVrfEntry": [ { "cipUrpfVrfName": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipUrpfVrfEntry-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": "/cipUrpfVrfEntry", "x-restconf-kind": "container" }, "/data/CISCO-IP-URPF-MIB:cipUrpfVrfEntry={cipUrpfVrfName}": { "get": { "summary": "Get cipUrpfVrfEntry entry", "description": "Retrieve specific cipUrpfVrfEntry entry by key from MIB", "tags": [ "CISCO-IP-URPF-MIB" ], "parameters": [ { "name": "cipUrpfVrfName", "in": "path", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "cipUrpfVrfName": { "type": "string", "description": "This field is used to specify the VRF Table\n name.", "x-yang-type": "snmp-framework:SnmpAdminString" } } }, "example": { "CISCO-IP-URPF-MIB:cipUrpfVrfEntry": { "cipUrpfVrfName": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipUrpfVrfEntry-4" }, "x-yang-path": "/cipUrpfVrfEntry={cipUrpfVrfName}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cipUrpfVrfName" ] }, "/data/CISCO-IP-URPF-MIB:cipUrpfIfMonTable/cipUrpfIfMonEntry={ifIndex},{cipUrpfIfIpVersion}": { "get": { "summary": "Get cipUrpfIfMonEntry entry", "description": "Retrieve specific cipUrpfIfMonEntry entry by key from MIB", "tags": [ "CISCO-IP-URPF-MIB" ], "parameters": [ { "name": "ifIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cipUrpfIfIpVersion", "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": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cipUrpfIfIpVersion": { "type": "string", "description": "Specifies the version of IP forwarding on an interface\n to which the table row URPF counts, rates, and \n configuration apply." }, "cipUrpfIfDrops": { "type": "integer", "description": "The number of IP packets of version cipUrpfIfIpVersion\n failing the URPF check and dropped by the managed device\n on a particular interface.\n \n Discontinuities in the value of this variable can occur \n at re-initialization of the management system, and at \n other times as indicated by the values of \n cipUrpfIfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cipUrpfIfSuppressedDrops": { "type": "integer", "description": "The number of IP packets of version cipUrpfIfIpVersion\n failing the URPF check but given a reprieve and not \n dropped by the managed device. Depending on the \n device configuration and capabilities, the following \n cases may cause incrementing of the counter: \n - if the managed device is configured to allow self-pings \n and the managed device pings itself.\n - if the managed device is configured for loose URPF (if any\n interface has a route to the source), and the strict\n case fails while the loose case passes.\n - DHCP Request packets (src 0.0.0.0 dst 255.255.255.255) \n will pass after initially being marked for drop.\n - RIP routing on unnumbered interfaces will pass after \n initially being marked for drop.\n - multicast packets will pass after initially being marked \n for drop\n - ACL's can be applied to permit packets after initially \n being marked for drop.\n \n Discontinuities in the value of this variable can occur \n at re-initialization of the management system, and at \n other times as indicated by the values of \n cipUrpfIfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cipUrpfIfDropRate": { "type": "integer", "description": "The rate of packet drops of IP version cipUrpfIfIpVersion\n packets due to URPF on the interface. \n \n This object is the average rate of dropping over the most \n recent interval of time. The rate is computed by dividing\n the number of packets dropped over an interval by the \n interval time in seconds. Each time the drop rate\n is computed, and at system startup, a snapshot is taken\n of the latest value of cipUrpfIfDrops. Subtracting from this\n the snapshot of cipUrpfIfDrops at the start of the current\n interval of time gives the number of packets dropped.\n The drop rate is computed every cipUrpfComputeInterval\n seconds.\n \n When drop rate is computed, if time since the creation of \n a row in cipUrpfIfMonTable is less than \n cipUrpfDropRateWindow, the value of cipUrpfIfDrops is \n divided by the time since row was created.\n \n After the row has been in existence for \n cipUrpfDropRateWindow, when drop rate is computed, the \n number of packet drops counted on the interface from \n interval start time to the computation time is divided \n by cipUrpfDropRateWindow.\n \n Changes to cipUrpfDropRateWindow are not reflected in this\n object until the next computation time.\n \n The rate from the most recent computation is the value \n fetched until the subsequent computation is performed.", "minimum": 0, "maximum": 4294967295 }, "cipUrpfIfDiscontinuityTime": { "type": "string", "description": "The value of sysUpTime on the most recent\n occasion at which this interface's counters\n suffered a discontinuity.\n If no such discontinuities have occurred\n since the last re-initialization of the\n local management subsystem, then this\n object contains a value of zero.", "x-yang-type": "yang:timestamp" } } }, "example": { "CISCO-IP-URPF-MIB:cipUrpfIfMonEntry": { "ifIndex": "example-string", "cipUrpfIfIpVersion": "192.168.1.1", "cipUrpfIfDrops": 0, "cipUrpfIfSuppressedDrops": 0, "cipUrpfIfDropRate": 0, "cipUrpfIfDiscontinuityTime": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipUrpfIfMonEntry-2" }, "x-yang-path": "/cipUrpfIfMonTable/cipUrpfIfMonEntry={ifIndex cipUrpfIfIpVersion}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex cipUrpfIfIpVersion" ] }, "/data/CISCO-IP-URPF-MIB:cipUrpfVrfIfTable/cipUrpfVrfIfEntry={cipUrpfVrfName},{ifIndex}": { "get": { "summary": "Get cipUrpfVrfIfEntry entry", "description": "Retrieve specific cipUrpfVrfIfEntry entry by key from MIB", "tags": [ "CISCO-IP-URPF-MIB" ], "parameters": [ { "name": "cipUrpfVrfName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ifIndex", "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": { "cipUrpfVrfName": { "type": "string", "description": "cipUrpfVrfName", "x-yang-type": "leafref" }, "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cipUrpfVrfIfDrops": { "type": "integer", "description": "The number of packets failing the URPF check for a VRF on\n the interface and dropped by the managed device.\n \n Discontinuities in the value of this variable can occur \n at re-initialization of the management system, and at \n other times as indicated by the values of \n cipUrpfVrfIfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cipUrpfVrfIfDiscontinuityTime": { "type": "string", "description": "The value of sysUpTime on the most recent occasion at\n which the URPF counters for this VRF on this interface \n suffered a discontinuity. If no such discontinuities \n have occurred since the last re-initialization of the\n local management subsystem, then this object contains a \n value of zero.", "x-yang-type": "yang:timestamp" } } }, "example": { "CISCO-IP-URPF-MIB:cipUrpfVrfIfEntry": { "cipUrpfVrfName": "192.168.1.1", "ifIndex": "example-string", "cipUrpfVrfIfDrops": 0, "cipUrpfVrfIfDiscontinuityTime": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipUrpfVrfIfEntry-2" }, "x-yang-path": "/cipUrpfVrfIfTable/cipUrpfVrfIfEntry={cipUrpfVrfName ifIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cipUrpfVrfName ifIndex" ] }, "/data/CISCO-IP-URPF-MIB:cipUrpfIfMonEntry={ifIndex},{cipUrpfIfIpVersion}": { "get": { "summary": "Get cipUrpfIfMonEntry entry", "description": "Retrieve specific cipUrpfIfMonEntry entry by key from MIB", "tags": [ "CISCO-IP-URPF-MIB" ], "parameters": [ { "name": "ifIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cipUrpfIfIpVersion", "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": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cipUrpfIfIpVersion": { "type": "string", "description": "Specifies the version of IP forwarding on an interface\n to which the table row URPF counts, rates, and \n configuration apply." }, "cipUrpfIfDrops": { "type": "integer", "description": "The number of IP packets of version cipUrpfIfIpVersion\n failing the URPF check and dropped by the managed device\n on a particular interface.\n \n Discontinuities in the value of this variable can occur \n at re-initialization of the management system, and at \n other times as indicated by the values of \n cipUrpfIfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cipUrpfIfSuppressedDrops": { "type": "integer", "description": "The number of IP packets of version cipUrpfIfIpVersion\n failing the URPF check but given a reprieve and not \n dropped by the managed device. Depending on the \n device configuration and capabilities, the following \n cases may cause incrementing of the counter: \n - if the managed device is configured to allow self-pings \n and the managed device pings itself.\n - if the managed device is configured for loose URPF (if any\n interface has a route to the source), and the strict\n case fails while the loose case passes.\n - DHCP Request packets (src 0.0.0.0 dst 255.255.255.255) \n will pass after initially being marked for drop.\n - RIP routing on unnumbered interfaces will pass after \n initially being marked for drop.\n - multicast packets will pass after initially being marked \n for drop\n - ACL's can be applied to permit packets after initially \n being marked for drop.\n \n Discontinuities in the value of this variable can occur \n at re-initialization of the management system, and at \n other times as indicated by the values of \n cipUrpfIfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cipUrpfIfDropRate": { "type": "integer", "description": "The rate of packet drops of IP version cipUrpfIfIpVersion\n packets due to URPF on the interface. \n \n This object is the average rate of dropping over the most \n recent interval of time. The rate is computed by dividing\n the number of packets dropped over an interval by the \n interval time in seconds. Each time the drop rate\n is computed, and at system startup, a snapshot is taken\n of the latest value of cipUrpfIfDrops. Subtracting from this\n the snapshot of cipUrpfIfDrops at the start of the current\n interval of time gives the number of packets dropped.\n The drop rate is computed every cipUrpfComputeInterval\n seconds.\n \n When drop rate is computed, if time since the creation of \n a row in cipUrpfIfMonTable is less than \n cipUrpfDropRateWindow, the value of cipUrpfIfDrops is \n divided by the time since row was created.\n \n After the row has been in existence for \n cipUrpfDropRateWindow, when drop rate is computed, the \n number of packet drops counted on the interface from \n interval start time to the computation time is divided \n by cipUrpfDropRateWindow.\n \n Changes to cipUrpfDropRateWindow are not reflected in this\n object until the next computation time.\n \n The rate from the most recent computation is the value \n fetched until the subsequent computation is performed.", "minimum": 0, "maximum": 4294967295 }, "cipUrpfIfDiscontinuityTime": { "type": "string", "description": "The value of sysUpTime on the most recent\n occasion at which this interface's counters\n suffered a discontinuity.\n If no such discontinuities have occurred\n since the last re-initialization of the\n local management subsystem, then this\n object contains a value of zero.", "x-yang-type": "yang:timestamp" } } }, "example": { "CISCO-IP-URPF-MIB:cipUrpfIfMonEntry": { "ifIndex": "example-string", "cipUrpfIfIpVersion": "192.168.1.1", "cipUrpfIfDrops": 0, "cipUrpfIfSuppressedDrops": 0, "cipUrpfIfDropRate": 0, "cipUrpfIfDiscontinuityTime": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipUrpfIfMonEntry-4" }, "x-yang-path": "/cipUrpfIfMonEntry={ifIndex cipUrpfIfIpVersion}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex cipUrpfIfIpVersion" ] }, "/data/CISCO-IP-URPF-MIB:cipUrpfVrfIfEntry={cipUrpfVrfName},{ifIndex}": { "get": { "summary": "Get cipUrpfVrfIfEntry entry", "description": "Retrieve specific cipUrpfVrfIfEntry entry by key from MIB", "tags": [ "CISCO-IP-URPF-MIB" ], "parameters": [ { "name": "cipUrpfVrfName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ifIndex", "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": { "cipUrpfVrfName": { "type": "string", "description": "cipUrpfVrfName", "x-yang-type": "leafref" }, "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cipUrpfVrfIfDrops": { "type": "integer", "description": "The number of packets failing the URPF check for a VRF on\n the interface and dropped by the managed device.\n \n Discontinuities in the value of this variable can occur \n at re-initialization of the management system, and at \n other times as indicated by the values of \n cipUrpfVrfIfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cipUrpfVrfIfDiscontinuityTime": { "type": "string", "description": "The value of sysUpTime on the most recent occasion at\n which the URPF counters for this VRF on this interface \n suffered a discontinuity. If no such discontinuities \n have occurred since the last re-initialization of the\n local management subsystem, then this object contains a \n value of zero.", "x-yang-type": "yang:timestamp" } } }, "example": { "CISCO-IP-URPF-MIB:cipUrpfVrfIfEntry": { "cipUrpfVrfName": "192.168.1.1", "ifIndex": "example-string", "cipUrpfVrfIfDrops": 0, "cipUrpfVrfIfDiscontinuityTime": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipUrpfVrfIfEntry-4" }, "x-yang-path": "/cipUrpfVrfIfEntry={cipUrpfVrfName ifIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cipUrpfVrfName ifIndex" ] } }, "components": { "schemas": { "CISCO-IP-URPF-MIB_CISCO-IP-URPF-MIB": { "type": "object", "description": "CISCO-IP-URPF-MIB", "properties": { "cipUrpfEntry": { "type": "array", "description": "If the managed device supports URPF dropping,\n a row exists for each IP version type (v4 and v6).\n A row contains summary information on URPF\n dropping over the entire managed device.", "items": { "type": "object", "properties": { "cipUrpfIpVersion": { "type": "string", "description": "Specifies the version of IP forwarding on an interface\n to which the table row URPF counts, rates, and\n configuration apply.", "readOnly": true }, "cipUrpfDrops": { "type": "integer", "description": "Sum of dropped IP version cipUrpfIpVersion packets failing\n a URPF check. This value is the sum of drops of packets \n received on all interfaces of the managed device.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipUrpfDropRate": { "type": "integer", "description": "The rate of packet drops of IP version cipUrpfIpVersion\n packets due to URPF for the managed device. The\n per-interface drop rate notification is issued on rates\n exceeding a limit (rising rate). This dropping may indicate\n an security attack on the network. To determine whether the\n attack/event is over, the NMS must consult the managed\n device. This object can be polled to determine the recent\n drop rate for the managed device as a whole, in addition to\n querying particular interface objects. \n This object is the\n average rate of dropping over the most recent window of\n time. The rate is computed by dividing the number of packets\n dropped over a window by the window time in seconds. The\n window time is specified by cipUrpfDropRateWindow. Each time\n the drop rate is computed, and at system startup, a snapshot\n is taken of the latest value of cipUrpfDrops. Subtracting\n from this the snapshot of cipUrpfDrops at the start of the\n current window of time gives the number of packets dropped.\n The drop rate is computed every cipUrpfComputeInterval\n seconds. As an example, let cipUrpfDropRateWindow be 300\n seconds, and cipUrpfComputeInterval 30 seconds. Every 30\n seconds, the drop count five minutes previous is subtracted\n from the current drop count, and the result is divided by\n 300 to arrive at the drop rate. \n At device start-up, until\n the device has been up more than cipUrpfDropRateWindow, when\n drop rate is computed, the value of cipUrpfDrops is divided\n by the time the device has been up. \n After the device has\n been up for cipUrpfDropRateWindow, when drop rate is\n computed, the number of packet drops counted from interval\n start time to the computation time is divided by\n cipUrpfDropRateWindow. \n Changes to cipUrpfDropRateWindow are\n not reflected in this object until the next computation\n time. \n The rate from the most recent computation is the\n value fetched until the subsequent computation is\n performed.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "cipUrpfIfMonEntry": { "type": "array", "description": "cipUrpfIfMonEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cipUrpfIfIpVersion": { "type": "string", "description": "Specifies the version of IP forwarding on an interface\n to which the table row URPF counts, rates, and \n configuration apply.", "readOnly": true }, "cipUrpfIfDrops": { "type": "integer", "description": "The number of IP packets of version cipUrpfIfIpVersion\n failing the URPF check and dropped by the managed device\n on a particular interface.\n \n Discontinuities in the value of this variable can occur \n at re-initialization of the management system, and at \n other times as indicated by the values of \n cipUrpfIfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipUrpfIfSuppressedDrops": { "type": "integer", "description": "The number of IP packets of version cipUrpfIfIpVersion\n failing the URPF check but given a reprieve and not \n dropped by the managed device. Depending on the \n device configuration and capabilities, the following \n cases may cause incrementing of the counter: \n - if the managed device is configured to allow self-pings \n and the managed device pings itself.\n - if the managed device is configured for loose URPF (if any\n interface has a route to the source), and the strict\n case fails while the loose case passes.\n - DHCP Request packets (src 0.0.0.0 dst 255.255.255.255) \n will pass after initially being marked for drop.\n - RIP routing on unnumbered interfaces will pass after \n initially being marked for drop.\n - multicast packets will pass after initially being marked \n for drop\n - ACL's can be applied to permit packets after initially \n being marked for drop.\n \n Discontinuities in the value of this variable can occur \n at re-initialization of the management system, and at \n other times as indicated by the values of \n cipUrpfIfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipUrpfIfDropRate": { "type": "integer", "description": "The rate of packet drops of IP version cipUrpfIfIpVersion\n packets due to URPF on the interface. \n \n This object is the average rate of dropping over the most \n recent interval of time. The rate is computed by dividing\n the number of packets dropped over an interval by the \n interval time in seconds. Each time the drop rate\n is computed, and at system startup, a snapshot is taken\n of the latest value of cipUrpfIfDrops. Subtracting from this\n the snapshot of cipUrpfIfDrops at the start of the current\n interval of time gives the number of packets dropped.\n The drop rate is computed every cipUrpfComputeInterval\n seconds.\n \n When drop rate is computed, if time since the creation of \n a row in cipUrpfIfMonTable is less than \n cipUrpfDropRateWindow, the value of cipUrpfIfDrops is \n divided by the time since row was created.\n \n After the row has been in existence for \n cipUrpfDropRateWindow, when drop rate is computed, the \n number of packet drops counted on the interface from \n interval start time to the computation time is divided \n by cipUrpfDropRateWindow.\n \n Changes to cipUrpfDropRateWindow are not reflected in this\n object until the next computation time.\n \n The rate from the most recent computation is the value \n fetched until the subsequent computation is performed.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipUrpfIfDiscontinuityTime": { "type": "string", "description": "The value of sysUpTime on the most recent\n occasion at which this interface's counters\n suffered a discontinuity.\n If no such discontinuities have occurred\n since the last re-initialization of the\n local management subsystem, then this\n object contains a value of zero.", "x-yang-type": "yang:timestamp", "readOnly": true } } }, "readOnly": true }, "cipUrpfVrfIfEntry": { "type": "array", "description": "An entry exists for a VRF and interface if and only\n if the VRF associated with the interface is configured \n to perform IP URPF checking using the routing \n table for the VRF.", "items": { "type": "object", "properties": { "cipUrpfVrfName": { "type": "string", "description": "cipUrpfVrfName", "x-yang-type": "leafref", "readOnly": true }, "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cipUrpfVrfIfDrops": { "type": "integer", "description": "The number of packets failing the URPF check for a VRF on\n the interface and dropped by the managed device.\n \n Discontinuities in the value of this variable can occur \n at re-initialization of the management system, and at \n other times as indicated by the values of \n cipUrpfVrfIfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipUrpfVrfIfDiscontinuityTime": { "type": "string", "description": "The value of sysUpTime on the most recent occasion at\n which the URPF counters for this VRF on this interface \n suffered a discontinuity. If no such discontinuities \n have occurred since the last re-initialization of the\n local management subsystem, then this object contains a \n value of zero.", "x-yang-type": "yang:timestamp", "readOnly": true } } }, "readOnly": true }, "cipUrpfVrfEntry": { "type": "array", "description": "An entry exists for a VRF if and only if the VRF\n is associated with an interface that is configured\n to perform IP URPF checking using the routing table \n for that VRF.", "items": { "type": "object", "properties": { "cipUrpfVrfName": { "type": "string", "description": "This field is used to specify the VRF Table\n name.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } }, "readOnly": true }, "cipUrpfScalar": { "type": "object", "description": "cipUrpfScalar", "properties": { "cipUrpfDropRateWindow": { "type": "integer", "description": "The window of time in the recent past over which the drop\n count used in the drop rate computation is collected. \n This global value applies for the computation of all URPF \n rates, global and per-interface. \n \n Once the period over which computations have been \n performed exceeds cipUrpfDropRateWindow, every time a \n computation is performed, the window slides up to end \n at the current time and start at cipUrpfDropRateWindow \n seconds before. \n \n The cipUrpfDropRateWindow must be greater than\n or equal to the interval between computations \n (cipUrpfComputeInterval).\n \n Since the agent must save the drop count values\n for each compute interval in order to slide the window,\n the number of counts saved is the quotient of\n cipUrpfDropRateWindow divided by cipUrpfComputeInterval.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cipUrpfComputeInterval": { "type": "integer", "description": "The time between rate computations. This global value\n applies for the computation of all URPF rates, global\n and per-interface.\n \n When the value of cipUrpfComputeInterval is changed,\n the interval in-progress proceeds as though the value\n had not changed. The change will apply to the length\n of subsequent intervals.\n \n The cipUrpfComputeInterval must be less than or equal \n to the cipUrpfDropRateWindow.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cipUrpfDropNotifyHoldDownTime": { "type": "integer", "description": "The minimum time between issuance of\n cipUrpfIfDropRateNotify notifications for a \n particular interface and packet forwarding type.\n \n Notifications are generated for each interface and\n packet forwarding type that exceeds the drop-rate. \n When a Notify is sent because the drop-rate is \n exceeded for a particular interface and forwarding\n type, the time specified by this object is used to \n specify the minimum time that must elapse before \n another Notify can be sent for that interface and\n forwarding type. The time is specified globally but \n used individually.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true } }, "readOnly": true }, "cipUrpfTable": { "type": "object", "description": "This table contains summary information for the\n managed device on URPF dropping.", "properties": { "cipUrpfEntry": { "type": "array", "description": "If the managed device supports URPF dropping,\n a row exists for each IP version type (v4 and v6).\n A row contains summary information on URPF\n dropping over the entire managed device.", "items": { "type": "object", "properties": { "cipUrpfIpVersion": { "type": "string", "description": "Specifies the version of IP forwarding on an interface\n to which the table row URPF counts, rates, and\n configuration apply.", "readOnly": true }, "cipUrpfDrops": { "type": "integer", "description": "Sum of dropped IP version cipUrpfIpVersion packets failing\n a URPF check. This value is the sum of drops of packets \n received on all interfaces of the managed device.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipUrpfDropRate": { "type": "integer", "description": "The rate of packet drops of IP version cipUrpfIpVersion\n packets due to URPF for the managed device. The\n per-interface drop rate notification is issued on rates\n exceeding a limit (rising rate). This dropping may indicate\n an security attack on the network. To determine whether the\n attack/event is over, the NMS must consult the managed\n device. This object can be polled to determine the recent\n drop rate for the managed device as a whole, in addition to\n querying particular interface objects. \n This object is the\n average rate of dropping over the most recent window of\n time. The rate is computed by dividing the number of packets\n dropped over a window by the window time in seconds. The\n window time is specified by cipUrpfDropRateWindow. Each time\n the drop rate is computed, and at system startup, a snapshot\n is taken of the latest value of cipUrpfDrops. Subtracting\n from this the snapshot of cipUrpfDrops at the start of the\n current window of time gives the number of packets dropped.\n The drop rate is computed every cipUrpfComputeInterval\n seconds. As an example, let cipUrpfDropRateWindow be 300\n seconds, and cipUrpfComputeInterval 30 seconds. Every 30\n seconds, the drop count five minutes previous is subtracted\n from the current drop count, and the result is divided by\n 300 to arrive at the drop rate. \n At device start-up, until\n the device has been up more than cipUrpfDropRateWindow, when\n drop rate is computed, the value of cipUrpfDrops is divided\n by the time the device has been up. \n After the device has\n been up for cipUrpfDropRateWindow, when drop rate is\n computed, the number of packet drops counted from interval\n start time to the computation time is divided by\n cipUrpfDropRateWindow. \n Changes to cipUrpfDropRateWindow are\n not reflected in this object until the next computation\n time. \n The rate from the most recent computation is the\n value fetched until the subsequent computation is\n performed.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cipUrpfIfMonTable": { "type": "object", "description": "This table contains information on URPF dropping on\n an interface.", "properties": { "cipUrpfIfMonEntry": { "type": "array", "description": "cipUrpfIfMonEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cipUrpfIfIpVersion": { "type": "string", "description": "Specifies the version of IP forwarding on an interface\n to which the table row URPF counts, rates, and \n configuration apply.", "readOnly": true }, "cipUrpfIfDrops": { "type": "integer", "description": "The number of IP packets of version cipUrpfIfIpVersion\n failing the URPF check and dropped by the managed device\n on a particular interface.\n \n Discontinuities in the value of this variable can occur \n at re-initialization of the management system, and at \n other times as indicated by the values of \n cipUrpfIfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipUrpfIfSuppressedDrops": { "type": "integer", "description": "The number of IP packets of version cipUrpfIfIpVersion\n failing the URPF check but given a reprieve and not \n dropped by the managed device. Depending on the \n device configuration and capabilities, the following \n cases may cause incrementing of the counter: \n - if the managed device is configured to allow self-pings \n and the managed device pings itself.\n - if the managed device is configured for loose URPF (if any\n interface has a route to the source), and the strict\n case fails while the loose case passes.\n - DHCP Request packets (src 0.0.0.0 dst 255.255.255.255) \n will pass after initially being marked for drop.\n - RIP routing on unnumbered interfaces will pass after \n initially being marked for drop.\n - multicast packets will pass after initially being marked \n for drop\n - ACL's can be applied to permit packets after initially \n being marked for drop.\n \n Discontinuities in the value of this variable can occur \n at re-initialization of the management system, and at \n other times as indicated by the values of \n cipUrpfIfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipUrpfIfDropRate": { "type": "integer", "description": "The rate of packet drops of IP version cipUrpfIfIpVersion\n packets due to URPF on the interface. \n \n This object is the average rate of dropping over the most \n recent interval of time. The rate is computed by dividing\n the number of packets dropped over an interval by the \n interval time in seconds. Each time the drop rate\n is computed, and at system startup, a snapshot is taken\n of the latest value of cipUrpfIfDrops. Subtracting from this\n the snapshot of cipUrpfIfDrops at the start of the current\n interval of time gives the number of packets dropped.\n The drop rate is computed every cipUrpfComputeInterval\n seconds.\n \n When drop rate is computed, if time since the creation of \n a row in cipUrpfIfMonTable is less than \n cipUrpfDropRateWindow, the value of cipUrpfIfDrops is \n divided by the time since row was created.\n \n After the row has been in existence for \n cipUrpfDropRateWindow, when drop rate is computed, the \n number of packet drops counted on the interface from \n interval start time to the computation time is divided \n by cipUrpfDropRateWindow.\n \n Changes to cipUrpfDropRateWindow are not reflected in this\n object until the next computation time.\n \n The rate from the most recent computation is the value \n fetched until the subsequent computation is performed.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipUrpfIfDiscontinuityTime": { "type": "string", "description": "The value of sysUpTime on the most recent\n occasion at which this interface's counters\n suffered a discontinuity.\n If no such discontinuities have occurred\n since the last re-initialization of the\n local management subsystem, then this\n object contains a value of zero.", "x-yang-type": "yang:timestamp", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cipUrpfVrfIfTable": { "type": "object", "description": "This table contains statistics information for interfaces\n performing URPF using VRF table to determine reachability.", "properties": { "cipUrpfVrfIfEntry": { "type": "array", "description": "An entry exists for a VRF and interface if and only\n if the VRF associated with the interface is configured \n to perform IP URPF checking using the routing \n table for the VRF.", "items": { "type": "object", "properties": { "cipUrpfVrfName": { "type": "string", "description": "cipUrpfVrfName", "x-yang-type": "leafref", "readOnly": true }, "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cipUrpfVrfIfDrops": { "type": "integer", "description": "The number of packets failing the URPF check for a VRF on\n the interface and dropped by the managed device.\n \n Discontinuities in the value of this variable can occur \n at re-initialization of the management system, and at \n other times as indicated by the values of \n cipUrpfVrfIfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipUrpfVrfIfDiscontinuityTime": { "type": "string", "description": "The value of sysUpTime on the most recent occasion at\n which the URPF counters for this VRF on this interface \n suffered a discontinuity. If no such discontinuities \n have occurred since the last re-initialization of the\n local management subsystem, then this object contains a \n value of zero.", "x-yang-type": "yang:timestamp", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cipUrpfVrfTable": { "type": "object", "description": "This table enables indexing URPF drop statistics\n by Virtual Routing and Forwarding instances.", "properties": { "cipUrpfVrfEntry": { "type": "array", "description": "An entry exists for a VRF if and only if the VRF\n is associated with an interface that is configured\n to perform IP URPF checking using the routing table \n for that VRF.", "items": { "type": "object", "properties": { "cipUrpfVrfName": { "type": "string", "description": "This field is used to specify the VRF Table\n name.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "CISCO-IP-URPF-MIB_object-1": { "type": "object", "description": "object-1", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cipUrpfIfIpVersion": { "type": "string", "description": "cipUrpfIfIpVersion", "x-yang-type": "leafref", "readOnly": true }, "cipUrpfIfDropRate": { "type": "string", "description": "cipUrpfIfDropRate", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-IP-URPF-MIB_cipUrpfEntry": { "type": "array", "description": "If the managed device supports URPF dropping,\n a row exists for each IP version type (v4 and v6).\n A row contains summary information on URPF\n dropping over the entire managed device.", "items": { "type": "object", "properties": { "cipUrpfIpVersion": { "type": "string", "description": "Specifies the version of IP forwarding on an interface\n to which the table row URPF counts, rates, and\n configuration apply.", "readOnly": true }, "cipUrpfDrops": { "type": "integer", "description": "Sum of dropped IP version cipUrpfIpVersion packets failing\n a URPF check. This value is the sum of drops of packets \n received on all interfaces of the managed device.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipUrpfDropRate": { "type": "integer", "description": "The rate of packet drops of IP version cipUrpfIpVersion\n packets due to URPF for the managed device. The\n per-interface drop rate notification is issued on rates\n exceeding a limit (rising rate). This dropping may indicate\n an security attack on the network. To determine whether the\n attack/event is over, the NMS must consult the managed\n device. This object can be polled to determine the recent\n drop rate for the managed device as a whole, in addition to\n querying particular interface objects. \n This object is the\n average rate of dropping over the most recent window of\n time. The rate is computed by dividing the number of packets\n dropped over a window by the window time in seconds. The\n window time is specified by cipUrpfDropRateWindow. Each time\n the drop rate is computed, and at system startup, a snapshot\n is taken of the latest value of cipUrpfDrops. Subtracting\n from this the snapshot of cipUrpfDrops at the start of the\n current window of time gives the number of packets dropped.\n The drop rate is computed every cipUrpfComputeInterval\n seconds. As an example, let cipUrpfDropRateWindow be 300\n seconds, and cipUrpfComputeInterval 30 seconds. Every 30\n seconds, the drop count five minutes previous is subtracted\n from the current drop count, and the result is divided by\n 300 to arrive at the drop rate. \n At device start-up, until\n the device has been up more than cipUrpfDropRateWindow, when\n drop rate is computed, the value of cipUrpfDrops is divided\n by the time the device has been up. \n After the device has\n been up for cipUrpfDropRateWindow, when drop rate is\n computed, the number of packet drops counted from interval\n start time to the computation time is divided by\n cipUrpfDropRateWindow. \n Changes to cipUrpfDropRateWindow are\n not reflected in this object until the next computation\n time. \n The rate from the most recent computation is the\n value fetched until the subsequent computation is\n performed.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } } }, "CISCO-IP-URPF-MIB_cipUrpfIfMonEntry": { "type": "array", "description": "cipUrpfIfMonEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cipUrpfIfIpVersion": { "type": "string", "description": "Specifies the version of IP forwarding on an interface\n to which the table row URPF counts, rates, and \n configuration apply.", "readOnly": true }, "cipUrpfIfDrops": { "type": "integer", "description": "The number of IP packets of version cipUrpfIfIpVersion\n failing the URPF check and dropped by the managed device\n on a particular interface.\n \n Discontinuities in the value of this variable can occur \n at re-initialization of the management system, and at \n other times as indicated by the values of \n cipUrpfIfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipUrpfIfSuppressedDrops": { "type": "integer", "description": "The number of IP packets of version cipUrpfIfIpVersion\n failing the URPF check but given a reprieve and not \n dropped by the managed device. Depending on the \n device configuration and capabilities, the following \n cases may cause incrementing of the counter: \n - if the managed device is configured to allow self-pings \n and the managed device pings itself.\n - if the managed device is configured for loose URPF (if any\n interface has a route to the source), and the strict\n case fails while the loose case passes.\n - DHCP Request packets (src 0.0.0.0 dst 255.255.255.255) \n will pass after initially being marked for drop.\n - RIP routing on unnumbered interfaces will pass after \n initially being marked for drop.\n - multicast packets will pass after initially being marked \n for drop\n - ACL's can be applied to permit packets after initially \n being marked for drop.\n \n Discontinuities in the value of this variable can occur \n at re-initialization of the management system, and at \n other times as indicated by the values of \n cipUrpfIfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipUrpfIfDropRate": { "type": "integer", "description": "The rate of packet drops of IP version cipUrpfIfIpVersion\n packets due to URPF on the interface. \n \n This object is the average rate of dropping over the most \n recent interval of time. The rate is computed by dividing\n the number of packets dropped over an interval by the \n interval time in seconds. Each time the drop rate\n is computed, and at system startup, a snapshot is taken\n of the latest value of cipUrpfIfDrops. Subtracting from this\n the snapshot of cipUrpfIfDrops at the start of the current\n interval of time gives the number of packets dropped.\n The drop rate is computed every cipUrpfComputeInterval\n seconds.\n \n When drop rate is computed, if time since the creation of \n a row in cipUrpfIfMonTable is less than \n cipUrpfDropRateWindow, the value of cipUrpfIfDrops is \n divided by the time since row was created.\n \n After the row has been in existence for \n cipUrpfDropRateWindow, when drop rate is computed, the \n number of packet drops counted on the interface from \n interval start time to the computation time is divided \n by cipUrpfDropRateWindow.\n \n Changes to cipUrpfDropRateWindow are not reflected in this\n object until the next computation time.\n \n The rate from the most recent computation is the value \n fetched until the subsequent computation is performed.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipUrpfIfDiscontinuityTime": { "type": "string", "description": "The value of sysUpTime on the most recent\n occasion at which this interface's counters\n suffered a discontinuity.\n If no such discontinuities have occurred\n since the last re-initialization of the\n local management subsystem, then this\n object contains a value of zero.", "x-yang-type": "yang:timestamp", "readOnly": true } } } }, "CISCO-IP-URPF-MIB_cipUrpfVrfIfEntry": { "type": "array", "description": "An entry exists for a VRF and interface if and only\n if the VRF associated with the interface is configured \n to perform IP URPF checking using the routing \n table for the VRF.", "items": { "type": "object", "properties": { "cipUrpfVrfName": { "type": "string", "description": "cipUrpfVrfName", "x-yang-type": "leafref", "readOnly": true }, "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cipUrpfVrfIfDrops": { "type": "integer", "description": "The number of packets failing the URPF check for a VRF on\n the interface and dropped by the managed device.\n \n Discontinuities in the value of this variable can occur \n at re-initialization of the management system, and at \n other times as indicated by the values of \n cipUrpfVrfIfDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipUrpfVrfIfDiscontinuityTime": { "type": "string", "description": "The value of sysUpTime on the most recent occasion at\n which the URPF counters for this VRF on this interface \n suffered a discontinuity. If no such discontinuities \n have occurred since the last re-initialization of the\n local management subsystem, then this object contains a \n value of zero.", "x-yang-type": "yang:timestamp", "readOnly": true } } } }, "CISCO-IP-URPF-MIB_cipUrpfVrfEntry": { "type": "array", "description": "An entry exists for a VRF if and only if the VRF\n is associated with an interface that is configured\n to perform IP URPF checking using the routing table \n for that VRF.", "items": { "type": "object", "properties": { "cipUrpfVrfName": { "type": "string", "description": "This field is used to specify the VRF Table\n name.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } } }, "restconf-error": { "type": "object", "description": "Standard RESTCONF error response (RFC 8040 Section 7.1)", "properties": { "ietf-restconf:errors": { "type": "object", "properties": { "error": { "type": "array", "items": { "type": "object", "properties": { "error-type": { "type": "string", "enum": [ "transport", "rpc", "protocol", "application" ], "description": "Layer where the error occurred" }, "error-tag": { "type": "string", "description": "Enumerated error tag (e.g. invalid-value, data-missing, access-denied)" }, "error-severity": { "type": "string", "enum": [ "error", "warning" ], "description": "Error severity" }, "error-app-tag": { "type": "string", "description": "Application-specific error tag" }, "error-path": { "type": "string", "description": "YANG instance-identifier of the error node" }, "error-message": { "type": "string", "description": "Human-readable error description" } }, "required": [ "error-type", "error-tag" ] } } } } }, "example": { "ietf-restconf:errors": { "error": [ { "error-type": "protocol", "error-tag": "invalid-value", "error-severity": "error", "error-message": "Invalid input parameter" } ] } } } }, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } } }, "security": [ { "basicAuth": [] } ], "tags": [ { "name": "CISCO-IP-URPF-MIB", "description": "MIB operations for CISCO-IP-URPF-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }