{ "openapi": "3.0.0", "info": { "title": "CISCO-IETF-FRR-MIB MIB API", "version": "1.0.0", "description": "This MIB module contains managed object definitions for MPLS\n Fast Reroute (FRR) as defined in:Pan, P., Gan, D., Swallow, G.,\n Vasseur, J.Ph., Cooper, D., Atlas, A., Jork, M., Fast Reroute\n Techniques in RSVP-TE, draft-ietf-mpls-rsvp-lsp-fastreroute-\n 00.txt, January 2002.\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-IETF-FRR-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/CISCO-IETF-FRR-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "CISCO-IETF-FRR-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-IETF-FRR-MIB:cmplsFrrScalars": { "get": { "summary": "Get cmplsFrrScalars data", "description": "Retrieve cmplsFrrScalars operational data from MIB", "tags": [ "CISCO-IETF-FRR-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The number of detour LSPs entering the device if\n mplsFrrConstProtectionMethod is set to oneToOneBackup(0), or\n or 0 if mplsFrrConstProtectionMethod is set to\n facilityBackup(1).", "properties": { "cmplsFrrDetourIncoming": { "type": "integer", "description": "The number of detour LSPs entering the device if\n mplsFrrConstProtectionMethod is set to oneToOneBackup(0), or\n or 0 if mplsFrrConstProtectionMethod is set to\n facilityBackup(1).", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrDetourOutgoing": { "type": "integer", "description": "The number of detour LSPs leaving the device if\n mplsFrrConstProtectionMethod is set to oneToOneBackup(0),\n or 0 if mplsFrrConstProtectionMethod is set to \n to facilityBackup(1).", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrDetourOriginating": { "type": "integer", "description": "The number of detour LSPs originating at this PLR if\n mplsFrrConstProtectionMethod is set to oneToOneBackup(0).\n This object MUST return 0 if the mplsFrrConstProtectionMethod \n is set to facilityBackup(1).", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrSwitchover": { "type": "integer", "description": "The number of tunnel instances that are switched over to their\n corresponding detour LSP if mplsFrrConstProtectionMethod is set\n to oneToOneBackup(0), or tunnels being switched over if\n mplsFrrConstProtectionMethod is set to facilityBackup(1).", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrNumOfConfIfs": { "type": "integer", "description": "Indicates the number of MPLS interfaces configured for \n protection by the FRR feature, otherwise this value\n MUST return 0 to indicate that LSPs traversing any \n interface may be protected.", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrActProtectedIfs": { "type": "integer", "description": "Indicates the number of interfaces currently being protected \n by the FRR feature if mplsFrrConstProtectionMethod is set to\n facilityBackup(1), otherwise this value should return 0 to\n indicate that LSPs traversing any interface may be protected.\n This value MUST be less than or equal to mplsFrrConfIfs.", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrConfProtectingTuns": { "type": "integer", "description": "Indicates the number of bypass tunnels configured to \n protect facilities on this LSR using the FRR feature \n if mplsFrrConstProtectionMethod is set to \n facilityBackup(1), otherwise this value MUST return \n 0.", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrActProtectedTuns": { "type": "integer", "description": "Indicates the number of bypass tunnels indicated in\n mplsFrrConfProtectingTuns whose operStatus\n is up(1) indicating that they are currently protecting\n facilities on this LSR using the FRR feature. This\n object MUST return 0 if mplsFrrConstProtectionMethod \n is set to facilityBackup(1).", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrActProtectedLSPs": { "type": "integer", "description": "Indicates the number of LSPs currently protected by \n the FRR feature. If mplsFrrConstProtectionMethod is set \n to facilityBackup(1)this object MUST return 0.", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrConstProtectionMethod": { "type": "string", "description": "Indicates which protection method is to be used for fast\n reroute. Some devices may require a reboot of their routing\n processors if this variable is changed. An agent which\n does not wish to reboot or modify its FRR mode \n MUST return an inconsistentValue error. Please \n consult the device's agent capability statement \n for more details." }, "cmplsFrrNotifsEnabled": { "type": "boolean", "description": "Enables or disables FRR notifications defined in this MIB\n module. Notifications are disabled by default." }, "cmplsFrrLogTableMaxEntries": { "type": "integer", "description": "Indicates the maximum number of entries allowed in the FRR\n Log table. Agents receiving SETs for values that cannot be\n used must return an inconsistent value error. If a manager\n sets this value to 0, this indicates that no logging should\n take place by the agent. \n \n If this value is returned as 0, this indicates\n that no additional log entries will be added to the current\n table either because the table has been completely\n filled or logging has been disabled. However, agents\n may wish to not delete existing entries in the log table\n so that managers may review them in the future. \n \n It is implied that when mplsFrrLogTableCurrEntries \n has reached the value of this variable, that logging \n entries may not continue to be added to the table, \n although existing ones may remain. Furthermore, an\n agent may begin to delete existing (perhaps the\n oldest entries) entries to make room for new ones.", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrLogTableCurrEntries": { "type": "integer", "description": "Indicates the current number of entries in the FRR log\n table.", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrNotifMaxRate": { "type": "integer", "description": "This variable indicates the number of milliseconds\n that must elapse between notification emissions. If\n events occur more rapidly, the implementation may\n simply fail to emit these notifications during that\n period, or may queue them until an appropriate\n time in the future. A value of 0 means no minimum \n elapsed period is specified.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-IETF-FRR-MIB:cmplsFrrScalars": { "cmplsFrrDetourIncoming": 0, "cmplsFrrDetourOutgoing": 0, "cmplsFrrDetourOriginating": 0, "cmplsFrrSwitchover": 0, "cmplsFrrNumOfConfIfs": 0, "cmplsFrrActProtectedIfs": 0, "cmplsFrrConfProtectingTuns": 0, "cmplsFrrActProtectedTuns": 0, "cmplsFrrActProtectedLSPs": 0, "cmplsFrrConstProtectionMethod": "example-string", "cmplsFrrNotifsEnabled": true, "cmplsFrrLogTableMaxEntries": 0, "cmplsFrrLogTableCurrEntries": 0, "cmplsFrrNotifMaxRate": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cmplsFrrScalars", "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": "/cmplsFrrScalars", "x-restconf-kind": "container" }, "/data/CISCO-IETF-FRR-MIB:cmplsFrrConstTable": { "get": { "summary": "Get cmplsFrrConstTable data", "description": "Retrieve cmplsFrrConstTable operational data from MIB", "tags": [ "CISCO-IETF-FRR-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table shows detour setup constraints.", "properties": { "cmplsFrrConstEntry": { "type": "array", "description": "cmplsFrrConstEntry", "items": { "type": "object", "properties": { "cmplsFrrConstIfIndex": { "type": "string", "description": "Uniquely identifies an interface for which fast reroute is\n configured. Tabular entries indexed with a 0 value apply to all\n interfaces on this device for which the FRR feature can operate\n on.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cmplsFrrConstTunnelIndex": { "type": "string", "description": "Uniquely identifies a tunnel for which fast reroute is\n requested.", "x-yang-type": "mpls-tc:MplsTunnelIndex" }, "cmplsFrrConstTunnelInstance": { "type": "string", "description": "Uniquely identifies an instance of this tunnel for which fast\n reroute is requested.", "x-yang-type": "mpls-tc:MplsTunnelInstanceIndex" }, "cmplsFrrConstSetupPrio": { "type": "integer", "description": "Indicates the setup priority of detour LSP.", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrConstHoldingPrio": { "type": "integer", "description": "Indicates the holding priority for detour LSP.", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrConstInclAnyAffinity": { "type": "string", "description": "A link satisfies the include-any constraint if and only if the\n constraint is zero, or the link and the constraint have a\n resource class in common.", "x-yang-type": "mpls-tc:MplsTunnelAffinity" }, "cmplsFrrConstInclAllAffinity": { "type": "string", "description": "A link satisfies the include-all constraint if and only if the\n link contains all of the administrative groups specified in the\n constraint.", "x-yang-type": "mpls-tc:MplsTunnelAffinity" }, "cmplsFrrConstExclAllAffinity": { "type": "string", "description": "A link satisfies the exclude-all constraint if and only if the\n link contains none of the administrative groups specified in the\n constraint.", "x-yang-type": "mpls-tc:MplsTunnelAffinity" }, "cmplsFrrConstHopLimit": { "type": "integer", "description": "The maximum number of hops that the detour LSP may traverse.", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrConstBandwidth": { "type": "string", "description": "This variable represents the bandwidth for detour LSPs of this\n tunnel, in units of thousands of bits per second (Kbps).", "x-yang-type": "mpls-tc:MplsBitRate" }, "cmplsFrrConstRowStatus": { "type": "string", "description": "This object is used to create, modify, and/or delete a row in\n this table.", "x-yang-type": "snmpv2-tc:RowStatus" }, "cmplsFrrConstNumProtectingTunOnIf": { "type": "integer", "description": "The number of backup tunnels protecting the specified\n interface.", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrConstNumProtectedTunOnIf": { "type": "integer", "description": "The number of tunnels protected on this interface.", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "CISCO-IETF-FRR-MIB:cmplsFrrConstTable": { "cmplsFrrConstEntry": [ { "cmplsFrrConstIfIndex": "1", "cmplsFrrConstTunnelIndex": "1", "cmplsFrrConstTunnelInstance": "example-string", "cmplsFrrConstSetupPrio": 0, "cmplsFrrConstHoldingPrio": 0, "cmplsFrrConstInclAnyAffinity": "example-string", "cmplsFrrConstInclAllAffinity": "example-string", "cmplsFrrConstExclAllAffinity": "example-string", "cmplsFrrConstHopLimit": 0, "cmplsFrrConstBandwidth": "example-string", "cmplsFrrConstRowStatus": "up(1)", "cmplsFrrConstNumProtectingTunOnIf": 0, "cmplsFrrConstNumProtectedTunOnIf": 0 }, { "cmplsFrrConstIfIndex": "2", "cmplsFrrConstTunnelIndex": "2", "cmplsFrrConstTunnelInstance": "example-string", "cmplsFrrConstSetupPrio": 0, "cmplsFrrConstHoldingPrio": 0, "cmplsFrrConstInclAnyAffinity": "example-string", "cmplsFrrConstInclAllAffinity": "example-string", "cmplsFrrConstExclAllAffinity": "example-string", "cmplsFrrConstHopLimit": 0, "cmplsFrrConstBandwidth": "example-string", "cmplsFrrConstRowStatus": "up(1)", "cmplsFrrConstNumProtectingTunOnIf": 0, "cmplsFrrConstNumProtectedTunOnIf": 0 }, { "cmplsFrrConstIfIndex": "3", "cmplsFrrConstTunnelIndex": "3", "cmplsFrrConstTunnelInstance": "example-string", "cmplsFrrConstSetupPrio": 0, "cmplsFrrConstHoldingPrio": 0, "cmplsFrrConstInclAnyAffinity": "example-string", "cmplsFrrConstInclAllAffinity": "example-string", "cmplsFrrConstExclAllAffinity": "example-string", "cmplsFrrConstHopLimit": 0, "cmplsFrrConstBandwidth": "example-string", "cmplsFrrConstRowStatus": "up(1)", "cmplsFrrConstNumProtectingTunOnIf": 0, "cmplsFrrConstNumProtectedTunOnIf": 0 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cmplsFrrConstTable", "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": "/cmplsFrrConstTable", "x-restconf-kind": "container" }, "/data/CISCO-IETF-FRR-MIB:cmplsFrrConstTable/cmplsFrrConstEntry": { "get": { "summary": "Get cmplsFrrConstEntry list", "description": "Retrieve list of cmplsFrrConstEntry entries from MIB", "tags": [ "CISCO-IETF-FRR-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cmplsFrrConstEntry", "items": { "type": "object", "properties": { "cmplsFrrConstIfIndex": { "type": "string", "description": "Uniquely identifies an interface for which fast reroute is\n configured. Tabular entries indexed with a 0 value apply to all\n interfaces on this device for which the FRR feature can operate\n on.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cmplsFrrConstTunnelIndex": { "type": "string", "description": "Uniquely identifies a tunnel for which fast reroute is\n requested.", "x-yang-type": "mpls-tc:MplsTunnelIndex" }, "cmplsFrrConstTunnelInstance": { "type": "string", "description": "Uniquely identifies an instance of this tunnel for which fast\n reroute is requested.", "x-yang-type": "mpls-tc:MplsTunnelInstanceIndex" }, "cmplsFrrConstSetupPrio": { "type": "integer", "description": "Indicates the setup priority of detour LSP.", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrConstHoldingPrio": { "type": "integer", "description": "Indicates the holding priority for detour LSP.", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrConstInclAnyAffinity": { "type": "string", "description": "A link satisfies the include-any constraint if and only if the\n constraint is zero, or the link and the constraint have a\n resource class in common.", "x-yang-type": "mpls-tc:MplsTunnelAffinity" }, "cmplsFrrConstInclAllAffinity": { "type": "string", "description": "A link satisfies the include-all constraint if and only if the\n link contains all of the administrative groups specified in the\n constraint.", "x-yang-type": "mpls-tc:MplsTunnelAffinity" }, "cmplsFrrConstExclAllAffinity": { "type": "string", "description": "A link satisfies the exclude-all constraint if and only if the\n link contains none of the administrative groups specified in the\n constraint.", "x-yang-type": "mpls-tc:MplsTunnelAffinity" }, "cmplsFrrConstHopLimit": { "type": "integer", "description": "The maximum number of hops that the detour LSP may traverse.", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrConstBandwidth": { "type": "string", "description": "This variable represents the bandwidth for detour LSPs of this\n tunnel, in units of thousands of bits per second (Kbps).", "x-yang-type": "mpls-tc:MplsBitRate" }, "cmplsFrrConstRowStatus": { "type": "string", "description": "This object is used to create, modify, and/or delete a row in\n this table.", "x-yang-type": "snmpv2-tc:RowStatus" }, "cmplsFrrConstNumProtectingTunOnIf": { "type": "integer", "description": "The number of backup tunnels protecting the specified\n interface.", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrConstNumProtectedTunOnIf": { "type": "integer", "description": "The number of tunnels protected on this interface.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-IETF-FRR-MIB:cmplsFrrConstEntry": [ { "cmplsFrrConstIfIndex": "example-string", "cmplsFrrConstTunnelIndex": "example-string", "cmplsFrrConstTunnelInstance": "example-string", "cmplsFrrConstSetupPrio": 0, "cmplsFrrConstHoldingPrio": 0, "cmplsFrrConstInclAnyAffinity": "example-string", "cmplsFrrConstInclAllAffinity": "example-string", "cmplsFrrConstExclAllAffinity": "example-string", "cmplsFrrConstHopLimit": 0, "cmplsFrrConstBandwidth": "example-string", "cmplsFrrConstRowStatus": "up(1)", "cmplsFrrConstNumProtectingTunOnIf": 0, "cmplsFrrConstNumProtectedTunOnIf": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cmplsFrrConstEntry", "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": "/cmplsFrrConstTable/cmplsFrrConstEntry", "x-restconf-kind": "container" }, "/data/CISCO-IETF-FRR-MIB:cmplsFrrLogTable": { "get": { "summary": "Get cmplsFrrLogTable data", "description": "Retrieve cmplsFrrLogTable operational data from MIB", "tags": [ "CISCO-IETF-FRR-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The fast reroute log table records fast reroute events such\n as protected links going up or down or the FRR feature\n kicking in.", "properties": { "cmplsFrrLogEntry": { "type": "array", "description": "An entry in this table is created to describe one fast\n reroute event. Entries in this table are only created and\n destroyed by the agent implementation. The maximum number \n of entries in this log is governed by the scalar.", "items": { "type": "object", "properties": { "cmplsFrrLogIndex": { "type": "integer", "description": "Uniquely identifies a fast reroute event entry.", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrLogEventTime": { "type": "string", "description": "This object provides the amount of time ticks since this\n event occured.", "x-yang-type": "yang:timestamp" }, "cmplsFrrLogInterface": { "type": "string", "description": "This object indicates which interface was affected by this\n FRR event. This value may be set to 0 if\n mplsFrrConstProtectionMethod is set to oneToOneBackup(0).", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cmplsFrrLogEventType": { "type": "string", "description": "This object describes what type of fast reroute event\n occured." }, "cmplsFrrLogEventDuration": { "type": "string", "description": "This object describes the duration of this event.", "x-yang-type": "yang:timeticks" }, "cmplsFrrLogEventReasonString": { "type": "string", "description": "This object contains an implementation-specific explanation\n of the event.", "format": "binary" } } } } } }, "example": { "CISCO-IETF-FRR-MIB:cmplsFrrLogTable": { "cmplsFrrLogEntry": [ { "cmplsFrrLogIndex": 1, "cmplsFrrLogEventTime": "example-string", "cmplsFrrLogInterface": "GigabitEthernet1/0/1", "cmplsFrrLogEventType": "ethernetCsmacd(6)", "cmplsFrrLogEventDuration": "example-string", "cmplsFrrLogEventReasonString": "example-string" }, { "cmplsFrrLogIndex": 2, "cmplsFrrLogEventTime": "example-string", "cmplsFrrLogInterface": "GigabitEthernet1/0/1", "cmplsFrrLogEventType": "ethernetCsmacd(6)", "cmplsFrrLogEventDuration": "example-string", "cmplsFrrLogEventReasonString": "example-string" }, { "cmplsFrrLogIndex": 3, "cmplsFrrLogEventTime": "example-string", "cmplsFrrLogInterface": "GigabitEthernet1/0/1", "cmplsFrrLogEventType": "ethernetCsmacd(6)", "cmplsFrrLogEventDuration": "example-string", "cmplsFrrLogEventReasonString": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cmplsFrrLogTable", "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": "/cmplsFrrLogTable", "x-restconf-kind": "container" }, "/data/CISCO-IETF-FRR-MIB:cmplsFrrLogTable/cmplsFrrLogEntry": { "get": { "summary": "Get cmplsFrrLogEntry list", "description": "Retrieve list of cmplsFrrLogEntry entries from MIB", "tags": [ "CISCO-IETF-FRR-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in this table is created to describe one fast\n reroute event. Entries in this table are only created and\n destroyed by the agent implementation. The maximum number \n of entries in this log is governed by the scalar.", "items": { "type": "object", "properties": { "cmplsFrrLogIndex": { "type": "integer", "description": "Uniquely identifies a fast reroute event entry.", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrLogEventTime": { "type": "string", "description": "This object provides the amount of time ticks since this\n event occured.", "x-yang-type": "yang:timestamp" }, "cmplsFrrLogInterface": { "type": "string", "description": "This object indicates which interface was affected by this\n FRR event. This value may be set to 0 if\n mplsFrrConstProtectionMethod is set to oneToOneBackup(0).", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cmplsFrrLogEventType": { "type": "string", "description": "This object describes what type of fast reroute event\n occured." }, "cmplsFrrLogEventDuration": { "type": "string", "description": "This object describes the duration of this event.", "x-yang-type": "yang:timeticks" }, "cmplsFrrLogEventReasonString": { "type": "string", "description": "This object contains an implementation-specific explanation\n of the event.", "format": "binary" } } } }, "example": { "CISCO-IETF-FRR-MIB:cmplsFrrLogEntry": [ { "cmplsFrrLogIndex": 1, "cmplsFrrLogEventTime": "example-string", "cmplsFrrLogInterface": "GigabitEthernet1/0/1", "cmplsFrrLogEventType": "ethernetCsmacd(6)", "cmplsFrrLogEventDuration": "example-string", "cmplsFrrLogEventReasonString": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cmplsFrrLogEntry", "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": "/cmplsFrrLogTable/cmplsFrrLogEntry", "x-restconf-kind": "container" }, "/data/CISCO-IETF-FRR-MIB:cmplsFrrLogTable/cmplsFrrLogEntry={cmplsFrrLogIndex}": { "get": { "summary": "Get cmplsFrrLogEntry entry", "description": "Retrieve specific cmplsFrrLogEntry entry by key from MIB", "tags": [ "CISCO-IETF-FRR-MIB" ], "parameters": [ { "name": "cmplsFrrLogIndex", "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": { "cmplsFrrLogIndex": { "type": "integer", "description": "Uniquely identifies a fast reroute event entry.", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrLogEventTime": { "type": "string", "description": "This object provides the amount of time ticks since this\n event occured.", "x-yang-type": "yang:timestamp" }, "cmplsFrrLogInterface": { "type": "string", "description": "This object indicates which interface was affected by this\n FRR event. This value may be set to 0 if\n mplsFrrConstProtectionMethod is set to oneToOneBackup(0).", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cmplsFrrLogEventType": { "type": "string", "description": "This object describes what type of fast reroute event\n occured." }, "cmplsFrrLogEventDuration": { "type": "string", "description": "This object describes the duration of this event.", "x-yang-type": "yang:timeticks" }, "cmplsFrrLogEventReasonString": { "type": "string", "description": "This object contains an implementation-specific explanation\n of the event.", "format": "binary" } } }, "example": { "CISCO-IETF-FRR-MIB:cmplsFrrLogEntry": { "cmplsFrrLogIndex": 1, "cmplsFrrLogEventTime": "example-string", "cmplsFrrLogInterface": "GigabitEthernet1/0/1", "cmplsFrrLogEventType": "ethernetCsmacd(6)", "cmplsFrrLogEventDuration": "example-string", "cmplsFrrLogEventReasonString": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cmplsFrrLogEntry-2" }, "x-yang-path": "/cmplsFrrLogTable/cmplsFrrLogEntry={cmplsFrrLogIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cmplsFrrLogIndex" ] }, "/data/CISCO-IETF-FRR-MIB:cmplsFrrFacRouteDBTable": { "get": { "summary": "Get cmplsFrrFacRouteDBTable data", "description": "Retrieve cmplsFrrFacRouteDBTable operational data from MIB", "tags": [ "CISCO-IETF-FRR-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "cmplsFrrFacRouteDBTable", "properties": { "cmplsFrrFacRouteDBEntry": { "type": "array", "description": "cmplsFrrFacRouteDBEntry", "items": { "type": "object", "properties": { "cmplsFrrFacRouteProtectedIfIndex": { "type": "string", "description": "Uniquely identifies the interface configured for FRR protection.", "x-yang-type": "if-mib:InterfaceIndex" }, "cmplsFrrFacRouteProtectingTunIndex": { "type": "string", "description": "Uniquely identifies the mplsTunnelEntry primary index for\n the tunnel head interface designated to protect the \n interface as specified in the mplsFrrFacRouteIfProtectedIndex\n (and all of the tunnels using this interface).", "x-yang-type": "mpls-tc:MplsTunnelIndex" }, "cmplsFrrFacRouteProtectedTunIndex": { "type": "string", "description": "Uniquely identifies an mplsTunnelEntry that is\n being protected by FRR.", "x-yang-type": "mpls-tc:MplsTunnelIndex" }, "cmplsFrrFacRouteProtectedTunInstance": { "type": "string", "description": "Uniquely identifies an mplsTunnelEntry that is\n being protected by FRR.", "x-yang-type": "mpls-tc:MplsTunnelInstanceIndex" }, "cmplsFrrFacRouteProtectedTunIngressLSRId": { "type": "string", "description": "Uniquely identifies an mplsTunnelEntry that is\n being protected by FRR.", "x-yang-type": "mpls-tc:MplsLsrIdentifier" }, "cmplsFrrFacRouteProtectedTunEgressLSRId": { "type": "string", "description": "Uniquely identifies an mplsTunnelEntry that is\n being protected by FRR.", "x-yang-type": "mpls-tc:MplsLsrIdentifier" }, "cmplsFrrFacRouteProtectedTunStatus": { "type": "string", "description": "Specifies the state of the protected tunnel.\n \n active This tunnel's label has been placed in the\n LFIB and is ready to be applied to incoming\n packets.\n \n ready - This tunnel's label entry has been created but is\n not yet in the LFIB.\n \n partial - This tunnel's label entry as not been fully\n created." }, "cmplsFrrFacRouteProtectingTunResvBw": { "type": "string", "description": "Specifies the amount of bandwidth in megabytes per second\n that is actually reserved by the backup tunnel for\n facility backup. This value is repeated here from the MPLS-\n TE MIB because the tunnel entry will reveal the bandwidth\n reserved by the signaling protocol, which is typically 0\n for backup tunnels so as to not over-book bandwidth.\n However, internal reservations are typically made on the\n PLR, thus this value should be revealed here.", "x-yang-type": "mpls-tc:MplsBitRate" }, "cmplsFrrFacRouteProtectingTunProtectionType": { "type": "string", "description": "Indicates type of the resource protection." } } } } } }, "example": { "CISCO-IETF-FRR-MIB:cmplsFrrFacRouteDBTable": { "cmplsFrrFacRouteDBEntry": [ { "cmplsFrrFacRouteProtectedIfIndex": "1", "cmplsFrrFacRouteProtectingTunIndex": "1", "cmplsFrrFacRouteProtectedTunIndex": "1", "cmplsFrrFacRouteProtectedTunInstance": "example-string", "cmplsFrrFacRouteProtectedTunIngressLSRId": "example-string", "cmplsFrrFacRouteProtectedTunEgressLSRId": "example-string", "cmplsFrrFacRouteProtectedTunStatus": "up(1)", "cmplsFrrFacRouteProtectingTunResvBw": "example-string", "cmplsFrrFacRouteProtectingTunProtectionType": "ethernetCsmacd(6)" }, { "cmplsFrrFacRouteProtectedIfIndex": "2", "cmplsFrrFacRouteProtectingTunIndex": "2", "cmplsFrrFacRouteProtectedTunIndex": "2", "cmplsFrrFacRouteProtectedTunInstance": "example-string", "cmplsFrrFacRouteProtectedTunIngressLSRId": "example-string", "cmplsFrrFacRouteProtectedTunEgressLSRId": "example-string", "cmplsFrrFacRouteProtectedTunStatus": "up(1)", "cmplsFrrFacRouteProtectingTunResvBw": "example-string", "cmplsFrrFacRouteProtectingTunProtectionType": "ethernetCsmacd(6)" }, { "cmplsFrrFacRouteProtectedIfIndex": "3", "cmplsFrrFacRouteProtectingTunIndex": "3", "cmplsFrrFacRouteProtectedTunIndex": "3", "cmplsFrrFacRouteProtectedTunInstance": "example-string", "cmplsFrrFacRouteProtectedTunIngressLSRId": "example-string", "cmplsFrrFacRouteProtectedTunEgressLSRId": "example-string", "cmplsFrrFacRouteProtectedTunStatus": "up(1)", "cmplsFrrFacRouteProtectingTunResvBw": "example-string", "cmplsFrrFacRouteProtectingTunProtectionType": "ethernetCsmacd(6)" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cmplsFrrFacRouteDBTable", "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": "/cmplsFrrFacRouteDBTable", "x-restconf-kind": "container" }, "/data/CISCO-IETF-FRR-MIB:cmplsFrrFacRouteDBTable/cmplsFrrFacRouteDBEntry": { "get": { "summary": "Get cmplsFrrFacRouteDBEntry list", "description": "Retrieve list of cmplsFrrFacRouteDBEntry entries from MIB", "tags": [ "CISCO-IETF-FRR-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cmplsFrrFacRouteDBEntry", "items": { "type": "object", "properties": { "cmplsFrrFacRouteProtectedIfIndex": { "type": "string", "description": "Uniquely identifies the interface configured for FRR protection.", "x-yang-type": "if-mib:InterfaceIndex" }, "cmplsFrrFacRouteProtectingTunIndex": { "type": "string", "description": "Uniquely identifies the mplsTunnelEntry primary index for\n the tunnel head interface designated to protect the \n interface as specified in the mplsFrrFacRouteIfProtectedIndex\n (and all of the tunnels using this interface).", "x-yang-type": "mpls-tc:MplsTunnelIndex" }, "cmplsFrrFacRouteProtectedTunIndex": { "type": "string", "description": "Uniquely identifies an mplsTunnelEntry that is\n being protected by FRR.", "x-yang-type": "mpls-tc:MplsTunnelIndex" }, "cmplsFrrFacRouteProtectedTunInstance": { "type": "string", "description": "Uniquely identifies an mplsTunnelEntry that is\n being protected by FRR.", "x-yang-type": "mpls-tc:MplsTunnelInstanceIndex" }, "cmplsFrrFacRouteProtectedTunIngressLSRId": { "type": "string", "description": "Uniquely identifies an mplsTunnelEntry that is\n being protected by FRR.", "x-yang-type": "mpls-tc:MplsLsrIdentifier" }, "cmplsFrrFacRouteProtectedTunEgressLSRId": { "type": "string", "description": "Uniquely identifies an mplsTunnelEntry that is\n being protected by FRR.", "x-yang-type": "mpls-tc:MplsLsrIdentifier" }, "cmplsFrrFacRouteProtectedTunStatus": { "type": "string", "description": "Specifies the state of the protected tunnel.\n \n active This tunnel's label has been placed in the\n LFIB and is ready to be applied to incoming\n packets.\n \n ready - This tunnel's label entry has been created but is\n not yet in the LFIB.\n \n partial - This tunnel's label entry as not been fully\n created." }, "cmplsFrrFacRouteProtectingTunResvBw": { "type": "string", "description": "Specifies the amount of bandwidth in megabytes per second\n that is actually reserved by the backup tunnel for\n facility backup. This value is repeated here from the MPLS-\n TE MIB because the tunnel entry will reveal the bandwidth\n reserved by the signaling protocol, which is typically 0\n for backup tunnels so as to not over-book bandwidth.\n However, internal reservations are typically made on the\n PLR, thus this value should be revealed here.", "x-yang-type": "mpls-tc:MplsBitRate" }, "cmplsFrrFacRouteProtectingTunProtectionType": { "type": "string", "description": "Indicates type of the resource protection." } } } }, "example": { "CISCO-IETF-FRR-MIB:cmplsFrrFacRouteDBEntry": [ { "cmplsFrrFacRouteProtectedIfIndex": "example-string", "cmplsFrrFacRouteProtectingTunIndex": "example-string", "cmplsFrrFacRouteProtectedTunIndex": "example-string", "cmplsFrrFacRouteProtectedTunInstance": "example-string", "cmplsFrrFacRouteProtectedTunIngressLSRId": "example-string", "cmplsFrrFacRouteProtectedTunEgressLSRId": "example-string", "cmplsFrrFacRouteProtectedTunStatus": "up(1)", "cmplsFrrFacRouteProtectingTunResvBw": "example-string", "cmplsFrrFacRouteProtectingTunProtectionType": "ethernetCsmacd(6)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cmplsFrrFacRouteDBEntry", "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": "/cmplsFrrFacRouteDBTable/cmplsFrrFacRouteDBEntry", "x-restconf-kind": "container" }, "/data/CISCO-IETF-FRR-MIB:cmplsFrrConstEntry": { "get": { "summary": "Get cmplsFrrConstEntry list", "description": "Retrieve list of cmplsFrrConstEntry entries from MIB", "tags": [ "CISCO-IETF-FRR-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cmplsFrrConstEntry", "items": { "type": "object", "properties": { "cmplsFrrConstIfIndex": { "type": "string", "description": "Uniquely identifies an interface for which fast reroute is\n configured. Tabular entries indexed with a 0 value apply to all\n interfaces on this device for which the FRR feature can operate\n on.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cmplsFrrConstTunnelIndex": { "type": "string", "description": "Uniquely identifies a tunnel for which fast reroute is\n requested.", "x-yang-type": "mpls-tc:MplsTunnelIndex" }, "cmplsFrrConstTunnelInstance": { "type": "string", "description": "Uniquely identifies an instance of this tunnel for which fast\n reroute is requested.", "x-yang-type": "mpls-tc:MplsTunnelInstanceIndex" }, "cmplsFrrConstSetupPrio": { "type": "integer", "description": "Indicates the setup priority of detour LSP.", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrConstHoldingPrio": { "type": "integer", "description": "Indicates the holding priority for detour LSP.", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrConstInclAnyAffinity": { "type": "string", "description": "A link satisfies the include-any constraint if and only if the\n constraint is zero, or the link and the constraint have a\n resource class in common.", "x-yang-type": "mpls-tc:MplsTunnelAffinity" }, "cmplsFrrConstInclAllAffinity": { "type": "string", "description": "A link satisfies the include-all constraint if and only if the\n link contains all of the administrative groups specified in the\n constraint.", "x-yang-type": "mpls-tc:MplsTunnelAffinity" }, "cmplsFrrConstExclAllAffinity": { "type": "string", "description": "A link satisfies the exclude-all constraint if and only if the\n link contains none of the administrative groups specified in the\n constraint.", "x-yang-type": "mpls-tc:MplsTunnelAffinity" }, "cmplsFrrConstHopLimit": { "type": "integer", "description": "The maximum number of hops that the detour LSP may traverse.", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrConstBandwidth": { "type": "string", "description": "This variable represents the bandwidth for detour LSPs of this\n tunnel, in units of thousands of bits per second (Kbps).", "x-yang-type": "mpls-tc:MplsBitRate" }, "cmplsFrrConstRowStatus": { "type": "string", "description": "This object is used to create, modify, and/or delete a row in\n this table.", "x-yang-type": "snmpv2-tc:RowStatus" }, "cmplsFrrConstNumProtectingTunOnIf": { "type": "integer", "description": "The number of backup tunnels protecting the specified\n interface.", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrConstNumProtectedTunOnIf": { "type": "integer", "description": "The number of tunnels protected on this interface.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-IETF-FRR-MIB:cmplsFrrConstEntry": [ { "cmplsFrrConstIfIndex": "example-string", "cmplsFrrConstTunnelIndex": "example-string", "cmplsFrrConstTunnelInstance": "example-string", "cmplsFrrConstSetupPrio": 0, "cmplsFrrConstHoldingPrio": 0, "cmplsFrrConstInclAnyAffinity": "example-string", "cmplsFrrConstInclAllAffinity": "example-string", "cmplsFrrConstExclAllAffinity": "example-string", "cmplsFrrConstHopLimit": 0, "cmplsFrrConstBandwidth": "example-string", "cmplsFrrConstRowStatus": "up(1)", "cmplsFrrConstNumProtectingTunOnIf": 0, "cmplsFrrConstNumProtectedTunOnIf": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cmplsFrrConstEntry-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": "/cmplsFrrConstEntry", "x-restconf-kind": "container" }, "/data/CISCO-IETF-FRR-MIB:cmplsFrrLogEntry": { "get": { "summary": "Get cmplsFrrLogEntry list", "description": "Retrieve list of cmplsFrrLogEntry entries from MIB", "tags": [ "CISCO-IETF-FRR-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in this table is created to describe one fast\n reroute event. Entries in this table are only created and\n destroyed by the agent implementation. The maximum number \n of entries in this log is governed by the scalar.", "items": { "type": "object", "properties": { "cmplsFrrLogIndex": { "type": "integer", "description": "Uniquely identifies a fast reroute event entry.", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrLogEventTime": { "type": "string", "description": "This object provides the amount of time ticks since this\n event occured.", "x-yang-type": "yang:timestamp" }, "cmplsFrrLogInterface": { "type": "string", "description": "This object indicates which interface was affected by this\n FRR event. This value may be set to 0 if\n mplsFrrConstProtectionMethod is set to oneToOneBackup(0).", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cmplsFrrLogEventType": { "type": "string", "description": "This object describes what type of fast reroute event\n occured." }, "cmplsFrrLogEventDuration": { "type": "string", "description": "This object describes the duration of this event.", "x-yang-type": "yang:timeticks" }, "cmplsFrrLogEventReasonString": { "type": "string", "description": "This object contains an implementation-specific explanation\n of the event.", "format": "binary" } } } }, "example": { "CISCO-IETF-FRR-MIB:cmplsFrrLogEntry": [ { "cmplsFrrLogIndex": 1, "cmplsFrrLogEventTime": "example-string", "cmplsFrrLogInterface": "GigabitEthernet1/0/1", "cmplsFrrLogEventType": "ethernetCsmacd(6)", "cmplsFrrLogEventDuration": "example-string", "cmplsFrrLogEventReasonString": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cmplsFrrLogEntry-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": "/cmplsFrrLogEntry", "x-restconf-kind": "container" }, "/data/CISCO-IETF-FRR-MIB:cmplsFrrLogEntry={cmplsFrrLogIndex}": { "get": { "summary": "Get cmplsFrrLogEntry entry", "description": "Retrieve specific cmplsFrrLogEntry entry by key from MIB", "tags": [ "CISCO-IETF-FRR-MIB" ], "parameters": [ { "name": "cmplsFrrLogIndex", "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": { "cmplsFrrLogIndex": { "type": "integer", "description": "Uniquely identifies a fast reroute event entry.", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrLogEventTime": { "type": "string", "description": "This object provides the amount of time ticks since this\n event occured.", "x-yang-type": "yang:timestamp" }, "cmplsFrrLogInterface": { "type": "string", "description": "This object indicates which interface was affected by this\n FRR event. This value may be set to 0 if\n mplsFrrConstProtectionMethod is set to oneToOneBackup(0).", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cmplsFrrLogEventType": { "type": "string", "description": "This object describes what type of fast reroute event\n occured." }, "cmplsFrrLogEventDuration": { "type": "string", "description": "This object describes the duration of this event.", "x-yang-type": "yang:timeticks" }, "cmplsFrrLogEventReasonString": { "type": "string", "description": "This object contains an implementation-specific explanation\n of the event.", "format": "binary" } } }, "example": { "CISCO-IETF-FRR-MIB:cmplsFrrLogEntry": { "cmplsFrrLogIndex": 1, "cmplsFrrLogEventTime": "example-string", "cmplsFrrLogInterface": "GigabitEthernet1/0/1", "cmplsFrrLogEventType": "ethernetCsmacd(6)", "cmplsFrrLogEventDuration": "example-string", "cmplsFrrLogEventReasonString": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cmplsFrrLogEntry-4" }, "x-yang-path": "/cmplsFrrLogEntry={cmplsFrrLogIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cmplsFrrLogIndex" ] }, "/data/CISCO-IETF-FRR-MIB:cmplsFrrFacRouteDBEntry": { "get": { "summary": "Get cmplsFrrFacRouteDBEntry list", "description": "Retrieve list of cmplsFrrFacRouteDBEntry entries from MIB", "tags": [ "CISCO-IETF-FRR-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cmplsFrrFacRouteDBEntry", "items": { "type": "object", "properties": { "cmplsFrrFacRouteProtectedIfIndex": { "type": "string", "description": "Uniquely identifies the interface configured for FRR protection.", "x-yang-type": "if-mib:InterfaceIndex" }, "cmplsFrrFacRouteProtectingTunIndex": { "type": "string", "description": "Uniquely identifies the mplsTunnelEntry primary index for\n the tunnel head interface designated to protect the \n interface as specified in the mplsFrrFacRouteIfProtectedIndex\n (and all of the tunnels using this interface).", "x-yang-type": "mpls-tc:MplsTunnelIndex" }, "cmplsFrrFacRouteProtectedTunIndex": { "type": "string", "description": "Uniquely identifies an mplsTunnelEntry that is\n being protected by FRR.", "x-yang-type": "mpls-tc:MplsTunnelIndex" }, "cmplsFrrFacRouteProtectedTunInstance": { "type": "string", "description": "Uniquely identifies an mplsTunnelEntry that is\n being protected by FRR.", "x-yang-type": "mpls-tc:MplsTunnelInstanceIndex" }, "cmplsFrrFacRouteProtectedTunIngressLSRId": { "type": "string", "description": "Uniquely identifies an mplsTunnelEntry that is\n being protected by FRR.", "x-yang-type": "mpls-tc:MplsLsrIdentifier" }, "cmplsFrrFacRouteProtectedTunEgressLSRId": { "type": "string", "description": "Uniquely identifies an mplsTunnelEntry that is\n being protected by FRR.", "x-yang-type": "mpls-tc:MplsLsrIdentifier" }, "cmplsFrrFacRouteProtectedTunStatus": { "type": "string", "description": "Specifies the state of the protected tunnel.\n \n active This tunnel's label has been placed in the\n LFIB and is ready to be applied to incoming\n packets.\n \n ready - This tunnel's label entry has been created but is\n not yet in the LFIB.\n \n partial - This tunnel's label entry as not been fully\n created." }, "cmplsFrrFacRouteProtectingTunResvBw": { "type": "string", "description": "Specifies the amount of bandwidth in megabytes per second\n that is actually reserved by the backup tunnel for\n facility backup. This value is repeated here from the MPLS-\n TE MIB because the tunnel entry will reveal the bandwidth\n reserved by the signaling protocol, which is typically 0\n for backup tunnels so as to not over-book bandwidth.\n However, internal reservations are typically made on the\n PLR, thus this value should be revealed here.", "x-yang-type": "mpls-tc:MplsBitRate" }, "cmplsFrrFacRouteProtectingTunProtectionType": { "type": "string", "description": "Indicates type of the resource protection." } } } }, "example": { "CISCO-IETF-FRR-MIB:cmplsFrrFacRouteDBEntry": [ { "cmplsFrrFacRouteProtectedIfIndex": "example-string", "cmplsFrrFacRouteProtectingTunIndex": "example-string", "cmplsFrrFacRouteProtectedTunIndex": "example-string", "cmplsFrrFacRouteProtectedTunInstance": "example-string", "cmplsFrrFacRouteProtectedTunIngressLSRId": "example-string", "cmplsFrrFacRouteProtectedTunEgressLSRId": "example-string", "cmplsFrrFacRouteProtectedTunStatus": "up(1)", "cmplsFrrFacRouteProtectingTunResvBw": "example-string", "cmplsFrrFacRouteProtectingTunProtectionType": "ethernetCsmacd(6)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cmplsFrrFacRouteDBEntry-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": "/cmplsFrrFacRouteDBEntry", "x-restconf-kind": "container" }, "/data/CISCO-IETF-FRR-MIB:cmplsFrrConstTable/cmplsFrrConstEntry={cmplsFrrConstIfIndex},{cmplsFrrConstTunnelIndex},{cmplsFrrConstTunnelInstance}": { "get": { "summary": "Get cmplsFrrConstEntry entry", "description": "Retrieve specific cmplsFrrConstEntry entry by key from MIB", "tags": [ "CISCO-IETF-FRR-MIB" ], "parameters": [ { "name": "cmplsFrrConstIfIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cmplsFrrConstTunnelIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cmplsFrrConstTunnelInstance", "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": { "cmplsFrrConstIfIndex": { "type": "string", "description": "Uniquely identifies an interface for which fast reroute is\n configured. Tabular entries indexed with a 0 value apply to all\n interfaces on this device for which the FRR feature can operate\n on.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cmplsFrrConstTunnelIndex": { "type": "string", "description": "Uniquely identifies a tunnel for which fast reroute is\n requested.", "x-yang-type": "mpls-tc:MplsTunnelIndex" }, "cmplsFrrConstTunnelInstance": { "type": "string", "description": "Uniquely identifies an instance of this tunnel for which fast\n reroute is requested.", "x-yang-type": "mpls-tc:MplsTunnelInstanceIndex" }, "cmplsFrrConstSetupPrio": { "type": "integer", "description": "Indicates the setup priority of detour LSP.", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrConstHoldingPrio": { "type": "integer", "description": "Indicates the holding priority for detour LSP.", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrConstInclAnyAffinity": { "type": "string", "description": "A link satisfies the include-any constraint if and only if the\n constraint is zero, or the link and the constraint have a\n resource class in common.", "x-yang-type": "mpls-tc:MplsTunnelAffinity" }, "cmplsFrrConstInclAllAffinity": { "type": "string", "description": "A link satisfies the include-all constraint if and only if the\n link contains all of the administrative groups specified in the\n constraint.", "x-yang-type": "mpls-tc:MplsTunnelAffinity" }, "cmplsFrrConstExclAllAffinity": { "type": "string", "description": "A link satisfies the exclude-all constraint if and only if the\n link contains none of the administrative groups specified in the\n constraint.", "x-yang-type": "mpls-tc:MplsTunnelAffinity" }, "cmplsFrrConstHopLimit": { "type": "integer", "description": "The maximum number of hops that the detour LSP may traverse.", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrConstBandwidth": { "type": "string", "description": "This variable represents the bandwidth for detour LSPs of this\n tunnel, in units of thousands of bits per second (Kbps).", "x-yang-type": "mpls-tc:MplsBitRate" }, "cmplsFrrConstRowStatus": { "type": "string", "description": "This object is used to create, modify, and/or delete a row in\n this table.", "x-yang-type": "snmpv2-tc:RowStatus" }, "cmplsFrrConstNumProtectingTunOnIf": { "type": "integer", "description": "The number of backup tunnels protecting the specified\n interface.", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrConstNumProtectedTunOnIf": { "type": "integer", "description": "The number of tunnels protected on this interface.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-IETF-FRR-MIB:cmplsFrrConstEntry": { "cmplsFrrConstIfIndex": "example-string", "cmplsFrrConstTunnelIndex": "example-string", "cmplsFrrConstTunnelInstance": "example-string", "cmplsFrrConstSetupPrio": 0, "cmplsFrrConstHoldingPrio": 0, "cmplsFrrConstInclAnyAffinity": "example-string", "cmplsFrrConstInclAllAffinity": "example-string", "cmplsFrrConstExclAllAffinity": "example-string", "cmplsFrrConstHopLimit": 0, "cmplsFrrConstBandwidth": "example-string", "cmplsFrrConstRowStatus": "up(1)", "cmplsFrrConstNumProtectingTunOnIf": 0, "cmplsFrrConstNumProtectedTunOnIf": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cmplsFrrConstEntry-2" }, "x-yang-path": "/cmplsFrrConstTable/cmplsFrrConstEntry={cmplsFrrConstIfIndex cmplsFrrConstTunnelIndex cmplsFrrConstTunnelInstance}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cmplsFrrConstIfIndex cmplsFrrConstTunnelIndex cmplsFrrConstTunnelInstance" ] }, "/data/CISCO-IETF-FRR-MIB:cmplsFrrFacRouteDBTable/cmplsFrrFacRouteDBEntry={cmplsFrrFacRouteProtectedIfIndex},{cmplsFrrFacRouteProtectingTunIndex},{cmplsFrrFacRouteProtectedTunIndex},{cmplsFrrFacRouteProtectedTunInstance},{cmplsFrrFacRouteProtectedTunIngressLSRId},{cmplsFrrFacRouteProtectedTunEgressLSRId}": { "get": { "summary": "Get cmplsFrrFacRouteDBEntry entry", "description": "Retrieve specific cmplsFrrFacRouteDBEntry entry by key from MIB", "tags": [ "CISCO-IETF-FRR-MIB" ], "parameters": [ { "name": "cmplsFrrFacRouteProtectedIfIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cmplsFrrFacRouteProtectingTunIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cmplsFrrFacRouteProtectedTunIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cmplsFrrFacRouteProtectedTunInstance", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cmplsFrrFacRouteProtectedTunIngressLSRId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cmplsFrrFacRouteProtectedTunEgressLSRId", "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": { "cmplsFrrFacRouteProtectedIfIndex": { "type": "string", "description": "Uniquely identifies the interface configured for FRR protection.", "x-yang-type": "if-mib:InterfaceIndex" }, "cmplsFrrFacRouteProtectingTunIndex": { "type": "string", "description": "Uniquely identifies the mplsTunnelEntry primary index for\n the tunnel head interface designated to protect the \n interface as specified in the mplsFrrFacRouteIfProtectedIndex\n (and all of the tunnels using this interface).", "x-yang-type": "mpls-tc:MplsTunnelIndex" }, "cmplsFrrFacRouteProtectedTunIndex": { "type": "string", "description": "Uniquely identifies an mplsTunnelEntry that is\n being protected by FRR.", "x-yang-type": "mpls-tc:MplsTunnelIndex" }, "cmplsFrrFacRouteProtectedTunInstance": { "type": "string", "description": "Uniquely identifies an mplsTunnelEntry that is\n being protected by FRR.", "x-yang-type": "mpls-tc:MplsTunnelInstanceIndex" }, "cmplsFrrFacRouteProtectedTunIngressLSRId": { "type": "string", "description": "Uniquely identifies an mplsTunnelEntry that is\n being protected by FRR.", "x-yang-type": "mpls-tc:MplsLsrIdentifier" }, "cmplsFrrFacRouteProtectedTunEgressLSRId": { "type": "string", "description": "Uniquely identifies an mplsTunnelEntry that is\n being protected by FRR.", "x-yang-type": "mpls-tc:MplsLsrIdentifier" }, "cmplsFrrFacRouteProtectedTunStatus": { "type": "string", "description": "Specifies the state of the protected tunnel.\n \n active This tunnel's label has been placed in the\n LFIB and is ready to be applied to incoming\n packets.\n \n ready - This tunnel's label entry has been created but is\n not yet in the LFIB.\n \n partial - This tunnel's label entry as not been fully\n created." }, "cmplsFrrFacRouteProtectingTunResvBw": { "type": "string", "description": "Specifies the amount of bandwidth in megabytes per second\n that is actually reserved by the backup tunnel for\n facility backup. This value is repeated here from the MPLS-\n TE MIB because the tunnel entry will reveal the bandwidth\n reserved by the signaling protocol, which is typically 0\n for backup tunnels so as to not over-book bandwidth.\n However, internal reservations are typically made on the\n PLR, thus this value should be revealed here.", "x-yang-type": "mpls-tc:MplsBitRate" }, "cmplsFrrFacRouteProtectingTunProtectionType": { "type": "string", "description": "Indicates type of the resource protection." } } }, "example": { "CISCO-IETF-FRR-MIB:cmplsFrrFacRouteDBEntry": { "cmplsFrrFacRouteProtectedIfIndex": "example-string", "cmplsFrrFacRouteProtectingTunIndex": "example-string", "cmplsFrrFacRouteProtectedTunIndex": "example-string", "cmplsFrrFacRouteProtectedTunInstance": "example-string", "cmplsFrrFacRouteProtectedTunIngressLSRId": "example-string", "cmplsFrrFacRouteProtectedTunEgressLSRId": "example-string", "cmplsFrrFacRouteProtectedTunStatus": "up(1)", "cmplsFrrFacRouteProtectingTunResvBw": "example-string", "cmplsFrrFacRouteProtectingTunProtectionType": "ethernetCsmacd(6)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cmplsFrrFacRouteDBEntry-2" }, "x-yang-path": "/cmplsFrrFacRouteDBTable/cmplsFrrFacRouteDBEntry={cmplsFrrFacRouteProtectedIfIndex cmplsFrrFacRouteProtectingTunIndex cmplsFrrFacRouteProtectedTunIndex cmplsFrrFacRouteProtectedTunInstance cmplsFrrFacRouteProtectedTunIngressLSRId cmplsFrrFacRouteProtectedTunEgressLSRId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cmplsFrrFacRouteProtectedIfIndex cmplsFrrFacRouteProtectingTunIndex cmplsFrrFacRouteProtectedTunIndex cmplsFrrFacRouteProtectedTunInstance cmplsFrrFacRouteProtectedTunIngressLSRId cmplsFrrFacRouteProtectedTunEgressLSRId" ] }, "/data/CISCO-IETF-FRR-MIB:cmplsFrrConstEntry={cmplsFrrConstIfIndex},{cmplsFrrConstTunnelIndex},{cmplsFrrConstTunnelInstance}": { "get": { "summary": "Get cmplsFrrConstEntry entry", "description": "Retrieve specific cmplsFrrConstEntry entry by key from MIB", "tags": [ "CISCO-IETF-FRR-MIB" ], "parameters": [ { "name": "cmplsFrrConstIfIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cmplsFrrConstTunnelIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cmplsFrrConstTunnelInstance", "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": { "cmplsFrrConstIfIndex": { "type": "string", "description": "Uniquely identifies an interface for which fast reroute is\n configured. Tabular entries indexed with a 0 value apply to all\n interfaces on this device for which the FRR feature can operate\n on.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cmplsFrrConstTunnelIndex": { "type": "string", "description": "Uniquely identifies a tunnel for which fast reroute is\n requested.", "x-yang-type": "mpls-tc:MplsTunnelIndex" }, "cmplsFrrConstTunnelInstance": { "type": "string", "description": "Uniquely identifies an instance of this tunnel for which fast\n reroute is requested.", "x-yang-type": "mpls-tc:MplsTunnelInstanceIndex" }, "cmplsFrrConstSetupPrio": { "type": "integer", "description": "Indicates the setup priority of detour LSP.", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrConstHoldingPrio": { "type": "integer", "description": "Indicates the holding priority for detour LSP.", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrConstInclAnyAffinity": { "type": "string", "description": "A link satisfies the include-any constraint if and only if the\n constraint is zero, or the link and the constraint have a\n resource class in common.", "x-yang-type": "mpls-tc:MplsTunnelAffinity" }, "cmplsFrrConstInclAllAffinity": { "type": "string", "description": "A link satisfies the include-all constraint if and only if the\n link contains all of the administrative groups specified in the\n constraint.", "x-yang-type": "mpls-tc:MplsTunnelAffinity" }, "cmplsFrrConstExclAllAffinity": { "type": "string", "description": "A link satisfies the exclude-all constraint if and only if the\n link contains none of the administrative groups specified in the\n constraint.", "x-yang-type": "mpls-tc:MplsTunnelAffinity" }, "cmplsFrrConstHopLimit": { "type": "integer", "description": "The maximum number of hops that the detour LSP may traverse.", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrConstBandwidth": { "type": "string", "description": "This variable represents the bandwidth for detour LSPs of this\n tunnel, in units of thousands of bits per second (Kbps).", "x-yang-type": "mpls-tc:MplsBitRate" }, "cmplsFrrConstRowStatus": { "type": "string", "description": "This object is used to create, modify, and/or delete a row in\n this table.", "x-yang-type": "snmpv2-tc:RowStatus" }, "cmplsFrrConstNumProtectingTunOnIf": { "type": "integer", "description": "The number of backup tunnels protecting the specified\n interface.", "minimum": 0, "maximum": 4294967295 }, "cmplsFrrConstNumProtectedTunOnIf": { "type": "integer", "description": "The number of tunnels protected on this interface.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-IETF-FRR-MIB:cmplsFrrConstEntry": { "cmplsFrrConstIfIndex": "example-string", "cmplsFrrConstTunnelIndex": "example-string", "cmplsFrrConstTunnelInstance": "example-string", "cmplsFrrConstSetupPrio": 0, "cmplsFrrConstHoldingPrio": 0, "cmplsFrrConstInclAnyAffinity": "example-string", "cmplsFrrConstInclAllAffinity": "example-string", "cmplsFrrConstExclAllAffinity": "example-string", "cmplsFrrConstHopLimit": 0, "cmplsFrrConstBandwidth": "example-string", "cmplsFrrConstRowStatus": "up(1)", "cmplsFrrConstNumProtectingTunOnIf": 0, "cmplsFrrConstNumProtectedTunOnIf": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cmplsFrrConstEntry-4" }, "x-yang-path": "/cmplsFrrConstEntry={cmplsFrrConstIfIndex cmplsFrrConstTunnelIndex cmplsFrrConstTunnelInstance}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cmplsFrrConstIfIndex cmplsFrrConstTunnelIndex cmplsFrrConstTunnelInstance" ] }, "/data/CISCO-IETF-FRR-MIB:cmplsFrrFacRouteDBEntry={cmplsFrrFacRouteProtectedIfIndex},{cmplsFrrFacRouteProtectingTunIndex},{cmplsFrrFacRouteProtectedTunIndex},{cmplsFrrFacRouteProtectedTunInstance},{cmplsFrrFacRouteProtectedTunIngressLSRId},{cmplsFrrFacRouteProtectedTunEgressLSRId}": { "get": { "summary": "Get cmplsFrrFacRouteDBEntry entry", "description": "Retrieve specific cmplsFrrFacRouteDBEntry entry by key from MIB", "tags": [ "CISCO-IETF-FRR-MIB" ], "parameters": [ { "name": "cmplsFrrFacRouteProtectedIfIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cmplsFrrFacRouteProtectingTunIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cmplsFrrFacRouteProtectedTunIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cmplsFrrFacRouteProtectedTunInstance", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cmplsFrrFacRouteProtectedTunIngressLSRId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cmplsFrrFacRouteProtectedTunEgressLSRId", "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": { "cmplsFrrFacRouteProtectedIfIndex": { "type": "string", "description": "Uniquely identifies the interface configured for FRR protection.", "x-yang-type": "if-mib:InterfaceIndex" }, "cmplsFrrFacRouteProtectingTunIndex": { "type": "string", "description": "Uniquely identifies the mplsTunnelEntry primary index for\n the tunnel head interface designated to protect the \n interface as specified in the mplsFrrFacRouteIfProtectedIndex\n (and all of the tunnels using this interface).", "x-yang-type": "mpls-tc:MplsTunnelIndex" }, "cmplsFrrFacRouteProtectedTunIndex": { "type": "string", "description": "Uniquely identifies an mplsTunnelEntry that is\n being protected by FRR.", "x-yang-type": "mpls-tc:MplsTunnelIndex" }, "cmplsFrrFacRouteProtectedTunInstance": { "type": "string", "description": "Uniquely identifies an mplsTunnelEntry that is\n being protected by FRR.", "x-yang-type": "mpls-tc:MplsTunnelInstanceIndex" }, "cmplsFrrFacRouteProtectedTunIngressLSRId": { "type": "string", "description": "Uniquely identifies an mplsTunnelEntry that is\n being protected by FRR.", "x-yang-type": "mpls-tc:MplsLsrIdentifier" }, "cmplsFrrFacRouteProtectedTunEgressLSRId": { "type": "string", "description": "Uniquely identifies an mplsTunnelEntry that is\n being protected by FRR.", "x-yang-type": "mpls-tc:MplsLsrIdentifier" }, "cmplsFrrFacRouteProtectedTunStatus": { "type": "string", "description": "Specifies the state of the protected tunnel.\n \n active This tunnel's label has been placed in the\n LFIB and is ready to be applied to incoming\n packets.\n \n ready - This tunnel's label entry has been created but is\n not yet in the LFIB.\n \n partial - This tunnel's label entry as not been fully\n created." }, "cmplsFrrFacRouteProtectingTunResvBw": { "type": "string", "description": "Specifies the amount of bandwidth in megabytes per second\n that is actually reserved by the backup tunnel for\n facility backup. This value is repeated here from the MPLS-\n TE MIB because the tunnel entry will reveal the bandwidth\n reserved by the signaling protocol, which is typically 0\n for backup tunnels so as to not over-book bandwidth.\n However, internal reservations are typically made on the\n PLR, thus this value should be revealed here.", "x-yang-type": "mpls-tc:MplsBitRate" }, "cmplsFrrFacRouteProtectingTunProtectionType": { "type": "string", "description": "Indicates type of the resource protection." } } }, "example": { "CISCO-IETF-FRR-MIB:cmplsFrrFacRouteDBEntry": { "cmplsFrrFacRouteProtectedIfIndex": "example-string", "cmplsFrrFacRouteProtectingTunIndex": "example-string", "cmplsFrrFacRouteProtectedTunIndex": "example-string", "cmplsFrrFacRouteProtectedTunInstance": "example-string", "cmplsFrrFacRouteProtectedTunIngressLSRId": "example-string", "cmplsFrrFacRouteProtectedTunEgressLSRId": "example-string", "cmplsFrrFacRouteProtectedTunStatus": "up(1)", "cmplsFrrFacRouteProtectingTunResvBw": "example-string", "cmplsFrrFacRouteProtectingTunProtectionType": "ethernetCsmacd(6)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cmplsFrrFacRouteDBEntry-4" }, "x-yang-path": "/cmplsFrrFacRouteDBEntry={cmplsFrrFacRouteProtectedIfIndex cmplsFrrFacRouteProtectingTunIndex cmplsFrrFacRouteProtectedTunIndex cmplsFrrFacRouteProtectedTunInstance cmplsFrrFacRouteProtectedTunIngressLSRId cmplsFrrFacRouteProtectedTunEgressLSRId}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cmplsFrrFacRouteProtectedIfIndex cmplsFrrFacRouteProtectingTunIndex cmplsFrrFacRouteProtectedTunIndex cmplsFrrFacRouteProtectedTunInstance cmplsFrrFacRouteProtectedTunIngressLSRId cmplsFrrFacRouteProtectedTunEgressLSRId" ] } }, "components": { "schemas": { "CISCO-IETF-FRR-MIB_CISCO-IETF-FRR-MIB": { "type": "object", "description": "The number of detour LSPs entering the device if\n mplsFrrConstProtectionMethod is set to oneToOneBackup(0), or\n or 0 if mplsFrrConstProtectionMethod is set to\n facilityBackup(1).", "properties": { "cmplsFrrConstEntry": { "type": "array", "description": "cmplsFrrConstEntry", "items": { "type": "object", "properties": { "cmplsFrrConstIfIndex": { "type": "string", "description": "Uniquely identifies an interface for which fast reroute is\n configured. Tabular entries indexed with a 0 value apply to all\n interfaces on this device for which the FRR feature can operate\n on.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "cmplsFrrConstTunnelIndex": { "type": "string", "description": "Uniquely identifies a tunnel for which fast reroute is\n requested.", "x-yang-type": "mpls-tc:MplsTunnelIndex", "readOnly": true }, "cmplsFrrConstTunnelInstance": { "type": "string", "description": "Uniquely identifies an instance of this tunnel for which fast\n reroute is requested.", "x-yang-type": "mpls-tc:MplsTunnelInstanceIndex", "readOnly": true }, "cmplsFrrConstSetupPrio": { "type": "integer", "description": "Indicates the setup priority of detour LSP.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmplsFrrConstHoldingPrio": { "type": "integer", "description": "Indicates the holding priority for detour LSP.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmplsFrrConstInclAnyAffinity": { "type": "string", "description": "A link satisfies the include-any constraint if and only if the\n constraint is zero, or the link and the constraint have a\n resource class in common.", "x-yang-type": "mpls-tc:MplsTunnelAffinity", "readOnly": true }, "cmplsFrrConstInclAllAffinity": { "type": "string", "description": "A link satisfies the include-all constraint if and only if the\n link contains all of the administrative groups specified in the\n constraint.", "x-yang-type": "mpls-tc:MplsTunnelAffinity", "readOnly": true }, "cmplsFrrConstExclAllAffinity": { "type": "string", "description": "A link satisfies the exclude-all constraint if and only if the\n link contains none of the administrative groups specified in the\n constraint.", "x-yang-type": "mpls-tc:MplsTunnelAffinity", "readOnly": true }, "cmplsFrrConstHopLimit": { "type": "integer", "description": "The maximum number of hops that the detour LSP may traverse.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmplsFrrConstBandwidth": { "type": "string", "description": "This variable represents the bandwidth for detour LSPs of this\n tunnel, in units of thousands of bits per second (Kbps).", "x-yang-type": "mpls-tc:MplsBitRate", "readOnly": true }, "cmplsFrrConstRowStatus": { "type": "string", "description": "This object is used to create, modify, and/or delete a row in\n this table.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "cmplsFrrConstNumProtectingTunOnIf": { "type": "integer", "description": "The number of backup tunnels protecting the specified\n interface.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmplsFrrConstNumProtectedTunOnIf": { "type": "integer", "description": "The number of tunnels protected on this interface.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "cmplsFrrLogEntry": { "type": "array", "description": "An entry in this table is created to describe one fast\n reroute event. Entries in this table are only created and\n destroyed by the agent implementation. The maximum number \n of entries in this log is governed by the scalar.", "items": { "type": "object", "properties": { "cmplsFrrLogIndex": { "type": "integer", "description": "Uniquely identifies a fast reroute event entry.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmplsFrrLogEventTime": { "type": "string", "description": "This object provides the amount of time ticks since this\n event occured.", "x-yang-type": "yang:timestamp", "readOnly": true }, "cmplsFrrLogInterface": { "type": "string", "description": "This object indicates which interface was affected by this\n FRR event. This value may be set to 0 if\n mplsFrrConstProtectionMethod is set to oneToOneBackup(0).", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "cmplsFrrLogEventType": { "type": "string", "description": "This object describes what type of fast reroute event\n occured.", "readOnly": true }, "cmplsFrrLogEventDuration": { "type": "string", "description": "This object describes the duration of this event.", "x-yang-type": "yang:timeticks", "readOnly": true }, "cmplsFrrLogEventReasonString": { "type": "string", "description": "This object contains an implementation-specific explanation\n of the event.", "format": "binary", "readOnly": true } } }, "readOnly": true }, "cmplsFrrFacRouteDBEntry": { "type": "array", "description": "cmplsFrrFacRouteDBEntry", "items": { "type": "object", "properties": { "cmplsFrrFacRouteProtectedIfIndex": { "type": "string", "description": "Uniquely identifies the interface configured for FRR protection.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "cmplsFrrFacRouteProtectingTunIndex": { "type": "string", "description": "Uniquely identifies the mplsTunnelEntry primary index for\n the tunnel head interface designated to protect the \n interface as specified in the mplsFrrFacRouteIfProtectedIndex\n (and all of the tunnels using this interface).", "x-yang-type": "mpls-tc:MplsTunnelIndex", "readOnly": true }, "cmplsFrrFacRouteProtectedTunIndex": { "type": "string", "description": "Uniquely identifies an mplsTunnelEntry that is\n being protected by FRR.", "x-yang-type": "mpls-tc:MplsTunnelIndex", "readOnly": true }, "cmplsFrrFacRouteProtectedTunInstance": { "type": "string", "description": "Uniquely identifies an mplsTunnelEntry that is\n being protected by FRR.", "x-yang-type": "mpls-tc:MplsTunnelInstanceIndex", "readOnly": true }, "cmplsFrrFacRouteProtectedTunIngressLSRId": { "type": "string", "description": "Uniquely identifies an mplsTunnelEntry that is\n being protected by FRR.", "x-yang-type": "mpls-tc:MplsLsrIdentifier", "readOnly": true }, "cmplsFrrFacRouteProtectedTunEgressLSRId": { "type": "string", "description": "Uniquely identifies an mplsTunnelEntry that is\n being protected by FRR.", "x-yang-type": "mpls-tc:MplsLsrIdentifier", "readOnly": true }, "cmplsFrrFacRouteProtectedTunStatus": { "type": "string", "description": "Specifies the state of the protected tunnel.\n \n active This tunnel's label has been placed in the\n LFIB and is ready to be applied to incoming\n packets.\n \n ready - This tunnel's label entry has been created but is\n not yet in the LFIB.\n \n partial - This tunnel's label entry as not been fully\n created.", "readOnly": true }, "cmplsFrrFacRouteProtectingTunResvBw": { "type": "string", "description": "Specifies the amount of bandwidth in megabytes per second\n that is actually reserved by the backup tunnel for\n facility backup. This value is repeated here from the MPLS-\n TE MIB because the tunnel entry will reveal the bandwidth\n reserved by the signaling protocol, which is typically 0\n for backup tunnels so as to not over-book bandwidth.\n However, internal reservations are typically made on the\n PLR, thus this value should be revealed here.", "x-yang-type": "mpls-tc:MplsBitRate", "readOnly": true }, "cmplsFrrFacRouteProtectingTunProtectionType": { "type": "string", "description": "Indicates type of the resource protection.", "readOnly": true } } }, "readOnly": true }, "cmplsFrrScalars": { "type": "object", "description": "The number of detour LSPs entering the device if\n mplsFrrConstProtectionMethod is set to oneToOneBackup(0), or\n or 0 if mplsFrrConstProtectionMethod is set to\n facilityBackup(1).", "properties": { "cmplsFrrDetourIncoming": { "type": "integer", "description": "The number of detour LSPs entering the device if\n mplsFrrConstProtectionMethod is set to oneToOneBackup(0), or\n or 0 if mplsFrrConstProtectionMethod is set to\n facilityBackup(1).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmplsFrrDetourOutgoing": { "type": "integer", "description": "The number of detour LSPs leaving the device if\n mplsFrrConstProtectionMethod is set to oneToOneBackup(0),\n or 0 if mplsFrrConstProtectionMethod is set to \n to facilityBackup(1).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmplsFrrDetourOriginating": { "type": "integer", "description": "The number of detour LSPs originating at this PLR if\n mplsFrrConstProtectionMethod is set to oneToOneBackup(0).\n This object MUST return 0 if the mplsFrrConstProtectionMethod \n is set to facilityBackup(1).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmplsFrrSwitchover": { "type": "integer", "description": "The number of tunnel instances that are switched over to their\n corresponding detour LSP if mplsFrrConstProtectionMethod is set\n to oneToOneBackup(0), or tunnels being switched over if\n mplsFrrConstProtectionMethod is set to facilityBackup(1).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmplsFrrNumOfConfIfs": { "type": "integer", "description": "Indicates the number of MPLS interfaces configured for \n protection by the FRR feature, otherwise this value\n MUST return 0 to indicate that LSPs traversing any \n interface may be protected.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmplsFrrActProtectedIfs": { "type": "integer", "description": "Indicates the number of interfaces currently being protected \n by the FRR feature if mplsFrrConstProtectionMethod is set to\n facilityBackup(1), otherwise this value should return 0 to\n indicate that LSPs traversing any interface may be protected.\n This value MUST be less than or equal to mplsFrrConfIfs.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmplsFrrConfProtectingTuns": { "type": "integer", "description": "Indicates the number of bypass tunnels configured to \n protect facilities on this LSR using the FRR feature \n if mplsFrrConstProtectionMethod is set to \n facilityBackup(1), otherwise this value MUST return \n 0.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmplsFrrActProtectedTuns": { "type": "integer", "description": "Indicates the number of bypass tunnels indicated in\n mplsFrrConfProtectingTuns whose operStatus\n is up(1) indicating that they are currently protecting\n facilities on this LSR using the FRR feature. This\n object MUST return 0 if mplsFrrConstProtectionMethod \n is set to facilityBackup(1).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmplsFrrActProtectedLSPs": { "type": "integer", "description": "Indicates the number of LSPs currently protected by \n the FRR feature. If mplsFrrConstProtectionMethod is set \n to facilityBackup(1)this object MUST return 0.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmplsFrrConstProtectionMethod": { "type": "string", "description": "Indicates which protection method is to be used for fast\n reroute. Some devices may require a reboot of their routing\n processors if this variable is changed. An agent which\n does not wish to reboot or modify its FRR mode \n MUST return an inconsistentValue error. Please \n consult the device's agent capability statement \n for more details.", "readOnly": true }, "cmplsFrrNotifsEnabled": { "type": "boolean", "description": "Enables or disables FRR notifications defined in this MIB\n module. Notifications are disabled by default.", "readOnly": true }, "cmplsFrrLogTableMaxEntries": { "type": "integer", "description": "Indicates the maximum number of entries allowed in the FRR\n Log table. Agents receiving SETs for values that cannot be\n used must return an inconsistent value error. If a manager\n sets this value to 0, this indicates that no logging should\n take place by the agent. \n \n If this value is returned as 0, this indicates\n that no additional log entries will be added to the current\n table either because the table has been completely\n filled or logging has been disabled. However, agents\n may wish to not delete existing entries in the log table\n so that managers may review them in the future. \n \n It is implied that when mplsFrrLogTableCurrEntries \n has reached the value of this variable, that logging \n entries may not continue to be added to the table, \n although existing ones may remain. Furthermore, an\n agent may begin to delete existing (perhaps the\n oldest entries) entries to make room for new ones.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmplsFrrLogTableCurrEntries": { "type": "integer", "description": "Indicates the current number of entries in the FRR log\n table.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmplsFrrNotifMaxRate": { "type": "integer", "description": "This variable indicates the number of milliseconds\n that must elapse between notification emissions. If\n events occur more rapidly, the implementation may\n simply fail to emit these notifications during that\n period, or may queue them until an appropriate\n time in the future. A value of 0 means no minimum \n elapsed period is specified.", "minimum": 0, "maximum": 4294967295, "readOnly": true } }, "readOnly": true }, "cmplsFrrConstTable": { "type": "object", "description": "This table shows detour setup constraints.", "properties": { "cmplsFrrConstEntry": { "type": "array", "description": "cmplsFrrConstEntry", "items": { "type": "object", "properties": { "cmplsFrrConstIfIndex": { "type": "string", "description": "Uniquely identifies an interface for which fast reroute is\n configured. Tabular entries indexed with a 0 value apply to all\n interfaces on this device for which the FRR feature can operate\n on.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "cmplsFrrConstTunnelIndex": { "type": "string", "description": "Uniquely identifies a tunnel for which fast reroute is\n requested.", "x-yang-type": "mpls-tc:MplsTunnelIndex", "readOnly": true }, "cmplsFrrConstTunnelInstance": { "type": "string", "description": "Uniquely identifies an instance of this tunnel for which fast\n reroute is requested.", "x-yang-type": "mpls-tc:MplsTunnelInstanceIndex", "readOnly": true }, "cmplsFrrConstSetupPrio": { "type": "integer", "description": "Indicates the setup priority of detour LSP.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmplsFrrConstHoldingPrio": { "type": "integer", "description": "Indicates the holding priority for detour LSP.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmplsFrrConstInclAnyAffinity": { "type": "string", "description": "A link satisfies the include-any constraint if and only if the\n constraint is zero, or the link and the constraint have a\n resource class in common.", "x-yang-type": "mpls-tc:MplsTunnelAffinity", "readOnly": true }, "cmplsFrrConstInclAllAffinity": { "type": "string", "description": "A link satisfies the include-all constraint if and only if the\n link contains all of the administrative groups specified in the\n constraint.", "x-yang-type": "mpls-tc:MplsTunnelAffinity", "readOnly": true }, "cmplsFrrConstExclAllAffinity": { "type": "string", "description": "A link satisfies the exclude-all constraint if and only if the\n link contains none of the administrative groups specified in the\n constraint.", "x-yang-type": "mpls-tc:MplsTunnelAffinity", "readOnly": true }, "cmplsFrrConstHopLimit": { "type": "integer", "description": "The maximum number of hops that the detour LSP may traverse.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmplsFrrConstBandwidth": { "type": "string", "description": "This variable represents the bandwidth for detour LSPs of this\n tunnel, in units of thousands of bits per second (Kbps).", "x-yang-type": "mpls-tc:MplsBitRate", "readOnly": true }, "cmplsFrrConstRowStatus": { "type": "string", "description": "This object is used to create, modify, and/or delete a row in\n this table.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "cmplsFrrConstNumProtectingTunOnIf": { "type": "integer", "description": "The number of backup tunnels protecting the specified\n interface.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmplsFrrConstNumProtectedTunOnIf": { "type": "integer", "description": "The number of tunnels protected on this interface.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cmplsFrrLogTable": { "type": "object", "description": "The fast reroute log table records fast reroute events such\n as protected links going up or down or the FRR feature\n kicking in.", "properties": { "cmplsFrrLogEntry": { "type": "array", "description": "An entry in this table is created to describe one fast\n reroute event. Entries in this table are only created and\n destroyed by the agent implementation. The maximum number \n of entries in this log is governed by the scalar.", "items": { "type": "object", "properties": { "cmplsFrrLogIndex": { "type": "integer", "description": "Uniquely identifies a fast reroute event entry.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmplsFrrLogEventTime": { "type": "string", "description": "This object provides the amount of time ticks since this\n event occured.", "x-yang-type": "yang:timestamp", "readOnly": true }, "cmplsFrrLogInterface": { "type": "string", "description": "This object indicates which interface was affected by this\n FRR event. This value may be set to 0 if\n mplsFrrConstProtectionMethod is set to oneToOneBackup(0).", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "cmplsFrrLogEventType": { "type": "string", "description": "This object describes what type of fast reroute event\n occured.", "readOnly": true }, "cmplsFrrLogEventDuration": { "type": "string", "description": "This object describes the duration of this event.", "x-yang-type": "yang:timeticks", "readOnly": true }, "cmplsFrrLogEventReasonString": { "type": "string", "description": "This object contains an implementation-specific explanation\n of the event.", "format": "binary", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cmplsFrrFacRouteDBTable": { "type": "object", "description": "cmplsFrrFacRouteDBTable", "properties": { "cmplsFrrFacRouteDBEntry": { "type": "array", "description": "cmplsFrrFacRouteDBEntry", "items": { "type": "object", "properties": { "cmplsFrrFacRouteProtectedIfIndex": { "type": "string", "description": "Uniquely identifies the interface configured for FRR protection.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "cmplsFrrFacRouteProtectingTunIndex": { "type": "string", "description": "Uniquely identifies the mplsTunnelEntry primary index for\n the tunnel head interface designated to protect the \n interface as specified in the mplsFrrFacRouteIfProtectedIndex\n (and all of the tunnels using this interface).", "x-yang-type": "mpls-tc:MplsTunnelIndex", "readOnly": true }, "cmplsFrrFacRouteProtectedTunIndex": { "type": "string", "description": "Uniquely identifies an mplsTunnelEntry that is\n being protected by FRR.", "x-yang-type": "mpls-tc:MplsTunnelIndex", "readOnly": true }, "cmplsFrrFacRouteProtectedTunInstance": { "type": "string", "description": "Uniquely identifies an mplsTunnelEntry that is\n being protected by FRR.", "x-yang-type": "mpls-tc:MplsTunnelInstanceIndex", "readOnly": true }, "cmplsFrrFacRouteProtectedTunIngressLSRId": { "type": "string", "description": "Uniquely identifies an mplsTunnelEntry that is\n being protected by FRR.", "x-yang-type": "mpls-tc:MplsLsrIdentifier", "readOnly": true }, "cmplsFrrFacRouteProtectedTunEgressLSRId": { "type": "string", "description": "Uniquely identifies an mplsTunnelEntry that is\n being protected by FRR.", "x-yang-type": "mpls-tc:MplsLsrIdentifier", "readOnly": true }, "cmplsFrrFacRouteProtectedTunStatus": { "type": "string", "description": "Specifies the state of the protected tunnel.\n \n active This tunnel's label has been placed in the\n LFIB and is ready to be applied to incoming\n packets.\n \n ready - This tunnel's label entry has been created but is\n not yet in the LFIB.\n \n partial - This tunnel's label entry as not been fully\n created.", "readOnly": true }, "cmplsFrrFacRouteProtectingTunResvBw": { "type": "string", "description": "Specifies the amount of bandwidth in megabytes per second\n that is actually reserved by the backup tunnel for\n facility backup. This value is repeated here from the MPLS-\n TE MIB because the tunnel entry will reveal the bandwidth\n reserved by the signaling protocol, which is typically 0\n for backup tunnels so as to not over-book bandwidth.\n However, internal reservations are typically made on the\n PLR, thus this value should be revealed here.", "x-yang-type": "mpls-tc:MplsBitRate", "readOnly": true }, "cmplsFrrFacRouteProtectingTunProtectionType": { "type": "string", "description": "Indicates type of the resource protection.", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "CISCO-IETF-FRR-MIB_object-1": { "type": "object", "description": "object-1", "properties": { "cmplsFrrConstIfIndex": { "type": "string", "description": "cmplsFrrConstIfIndex", "x-yang-type": "leafref", "readOnly": true }, "cmplsFrrConstTunnelIndex": { "type": "string", "description": "cmplsFrrConstTunnelIndex", "x-yang-type": "leafref", "readOnly": true }, "cmplsFrrConstTunnelInstance": { "type": "string", "description": "cmplsFrrConstTunnelInstance", "x-yang-type": "leafref", "readOnly": true }, "cmplsFrrConstNumProtectingTunOnIf": { "type": "string", "description": "cmplsFrrConstNumProtectingTunOnIf", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-IETF-FRR-MIB_object-2": { "type": "object", "description": "object-2", "properties": { "cmplsFrrConstIfIndex": { "type": "string", "description": "cmplsFrrConstIfIndex", "x-yang-type": "leafref", "readOnly": true }, "cmplsFrrConstTunnelIndex": { "type": "string", "description": "cmplsFrrConstTunnelIndex", "x-yang-type": "leafref", "readOnly": true }, "cmplsFrrConstTunnelInstance": { "type": "string", "description": "cmplsFrrConstTunnelInstance", "x-yang-type": "leafref", "readOnly": true }, "cmplsFrrConstNumProtectedTunOnIf": { "type": "string", "description": "cmplsFrrConstNumProtectedTunOnIf", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-IETF-FRR-MIB_object-3": { "type": "object", "description": "object-3", "properties": { "cmplsFrrConstIfIndex": { "type": "string", "description": "cmplsFrrConstIfIndex", "x-yang-type": "leafref", "readOnly": true }, "cmplsFrrConstTunnelIndex": { "type": "string", "description": "cmplsFrrConstTunnelIndex", "x-yang-type": "leafref", "readOnly": true }, "cmplsFrrConstTunnelInstance": { "type": "string", "description": "cmplsFrrConstTunnelInstance", "x-yang-type": "leafref", "readOnly": true }, "cmplsFrrConstBandwidth": { "type": "string", "description": "cmplsFrrConstBandwidth", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-IETF-FRR-MIB_cmplsFrrConstEntry": { "type": "array", "description": "cmplsFrrConstEntry", "items": { "type": "object", "properties": { "cmplsFrrConstIfIndex": { "type": "string", "description": "Uniquely identifies an interface for which fast reroute is\n configured. Tabular entries indexed with a 0 value apply to all\n interfaces on this device for which the FRR feature can operate\n on.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "cmplsFrrConstTunnelIndex": { "type": "string", "description": "Uniquely identifies a tunnel for which fast reroute is\n requested.", "x-yang-type": "mpls-tc:MplsTunnelIndex", "readOnly": true }, "cmplsFrrConstTunnelInstance": { "type": "string", "description": "Uniquely identifies an instance of this tunnel for which fast\n reroute is requested.", "x-yang-type": "mpls-tc:MplsTunnelInstanceIndex", "readOnly": true }, "cmplsFrrConstSetupPrio": { "type": "integer", "description": "Indicates the setup priority of detour LSP.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmplsFrrConstHoldingPrio": { "type": "integer", "description": "Indicates the holding priority for detour LSP.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmplsFrrConstInclAnyAffinity": { "type": "string", "description": "A link satisfies the include-any constraint if and only if the\n constraint is zero, or the link and the constraint have a\n resource class in common.", "x-yang-type": "mpls-tc:MplsTunnelAffinity", "readOnly": true }, "cmplsFrrConstInclAllAffinity": { "type": "string", "description": "A link satisfies the include-all constraint if and only if the\n link contains all of the administrative groups specified in the\n constraint.", "x-yang-type": "mpls-tc:MplsTunnelAffinity", "readOnly": true }, "cmplsFrrConstExclAllAffinity": { "type": "string", "description": "A link satisfies the exclude-all constraint if and only if the\n link contains none of the administrative groups specified in the\n constraint.", "x-yang-type": "mpls-tc:MplsTunnelAffinity", "readOnly": true }, "cmplsFrrConstHopLimit": { "type": "integer", "description": "The maximum number of hops that the detour LSP may traverse.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmplsFrrConstBandwidth": { "type": "string", "description": "This variable represents the bandwidth for detour LSPs of this\n tunnel, in units of thousands of bits per second (Kbps).", "x-yang-type": "mpls-tc:MplsBitRate", "readOnly": true }, "cmplsFrrConstRowStatus": { "type": "string", "description": "This object is used to create, modify, and/or delete a row in\n this table.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "cmplsFrrConstNumProtectingTunOnIf": { "type": "integer", "description": "The number of backup tunnels protecting the specified\n interface.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmplsFrrConstNumProtectedTunOnIf": { "type": "integer", "description": "The number of tunnels protected on this interface.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } } }, "CISCO-IETF-FRR-MIB_cmplsFrrLogEntry": { "type": "array", "description": "An entry in this table is created to describe one fast\n reroute event. Entries in this table are only created and\n destroyed by the agent implementation. The maximum number \n of entries in this log is governed by the scalar.", "items": { "type": "object", "properties": { "cmplsFrrLogIndex": { "type": "integer", "description": "Uniquely identifies a fast reroute event entry.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cmplsFrrLogEventTime": { "type": "string", "description": "This object provides the amount of time ticks since this\n event occured.", "x-yang-type": "yang:timestamp", "readOnly": true }, "cmplsFrrLogInterface": { "type": "string", "description": "This object indicates which interface was affected by this\n FRR event. This value may be set to 0 if\n mplsFrrConstProtectionMethod is set to oneToOneBackup(0).", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "cmplsFrrLogEventType": { "type": "string", "description": "This object describes what type of fast reroute event\n occured.", "readOnly": true }, "cmplsFrrLogEventDuration": { "type": "string", "description": "This object describes the duration of this event.", "x-yang-type": "yang:timeticks", "readOnly": true }, "cmplsFrrLogEventReasonString": { "type": "string", "description": "This object contains an implementation-specific explanation\n of the event.", "format": "binary", "readOnly": true } } } }, "CISCO-IETF-FRR-MIB_cmplsFrrFacRouteDBEntry": { "type": "array", "description": "cmplsFrrFacRouteDBEntry", "items": { "type": "object", "properties": { "cmplsFrrFacRouteProtectedIfIndex": { "type": "string", "description": "Uniquely identifies the interface configured for FRR protection.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "cmplsFrrFacRouteProtectingTunIndex": { "type": "string", "description": "Uniquely identifies the mplsTunnelEntry primary index for\n the tunnel head interface designated to protect the \n interface as specified in the mplsFrrFacRouteIfProtectedIndex\n (and all of the tunnels using this interface).", "x-yang-type": "mpls-tc:MplsTunnelIndex", "readOnly": true }, "cmplsFrrFacRouteProtectedTunIndex": { "type": "string", "description": "Uniquely identifies an mplsTunnelEntry that is\n being protected by FRR.", "x-yang-type": "mpls-tc:MplsTunnelIndex", "readOnly": true }, "cmplsFrrFacRouteProtectedTunInstance": { "type": "string", "description": "Uniquely identifies an mplsTunnelEntry that is\n being protected by FRR.", "x-yang-type": "mpls-tc:MplsTunnelInstanceIndex", "readOnly": true }, "cmplsFrrFacRouteProtectedTunIngressLSRId": { "type": "string", "description": "Uniquely identifies an mplsTunnelEntry that is\n being protected by FRR.", "x-yang-type": "mpls-tc:MplsLsrIdentifier", "readOnly": true }, "cmplsFrrFacRouteProtectedTunEgressLSRId": { "type": "string", "description": "Uniquely identifies an mplsTunnelEntry that is\n being protected by FRR.", "x-yang-type": "mpls-tc:MplsLsrIdentifier", "readOnly": true }, "cmplsFrrFacRouteProtectedTunStatus": { "type": "string", "description": "Specifies the state of the protected tunnel.\n \n active This tunnel's label has been placed in the\n LFIB and is ready to be applied to incoming\n packets.\n \n ready - This tunnel's label entry has been created but is\n not yet in the LFIB.\n \n partial - This tunnel's label entry as not been fully\n created.", "readOnly": true }, "cmplsFrrFacRouteProtectingTunResvBw": { "type": "string", "description": "Specifies the amount of bandwidth in megabytes per second\n that is actually reserved by the backup tunnel for\n facility backup. This value is repeated here from the MPLS-\n TE MIB because the tunnel entry will reveal the bandwidth\n reserved by the signaling protocol, which is typically 0\n for backup tunnels so as to not over-book bandwidth.\n However, internal reservations are typically made on the\n PLR, thus this value should be revealed here.", "x-yang-type": "mpls-tc:MplsBitRate", "readOnly": true }, "cmplsFrrFacRouteProtectingTunProtectionType": { "type": "string", "description": "Indicates type of the resource protection.", "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-IETF-FRR-MIB", "description": "MIB operations for CISCO-IETF-FRR-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }