{ "openapi": "3.0.0", "info": { "title": "CISCO-IETF-BFD-MIB MIB API", "version": "1.0.0", "description": "This document contains the Management information base for\n Bidirectional Forwarding Detection(BFD) Protocol as defined\n in draft-ietf-bfd-base-06.txt.\n \n BFD is a protocol intended to detect faults in the\n bidirectional path between two forwarding engines, including\n interfaces, data link(s), and to the extent possible the forwarding\n engines themselves, with potentially very low latency. It operates\n independently of media, data protocols, and routing protocols.\n \n This MIB module is based on the Internet Draft\n draft-ietf-bfd-mib-03.txt and draft-ietf-bfd-mib-04.txt\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-BFD-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/CISCO-IETF-BFD-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "CISCO-IETF-BFD-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-BFD-MIB:ciscoBfdScalarObjects": { "get": { "summary": "Get ciscoBfdScalarObjects data", "description": "Retrieve ciscoBfdScalarObjects operational data from MIB", "tags": [ "CISCO-IETF-BFD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The global administrative status of BFD in this router.\n The value 'enabled' denotes that the BFD Process is \n active on at least one interface; 'disabled' disables \n it on all interfaces.", "properties": { "ciscoBfdAdminStatus": { "type": "string", "description": "The global administrative status of BFD in this router.\n The value 'enabled' denotes that the BFD Process is \n active on at least one interface; 'disabled' disables \n it on all interfaces." }, "ciscoBfdVersionNumber": { "type": "integer", "description": "The current version number of the BFD protocol.", "minimum": 0, "maximum": 4294967295 }, "ciscoBfdSessNotificationsEnable": { "type": "boolean", "description": "If this object is set to true(1), then it enables\n the emission of ciscoBfdSessUp and ciscoBfdSessDown \n notifications; otherwise these notifications are not \n emitted." } } }, "example": { "CISCO-IETF-BFD-MIB:ciscoBfdScalarObjects": { "ciscoBfdAdminStatus": "up(1)", "ciscoBfdVersionNumber": 0, "ciscoBfdSessNotificationsEnable": true } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoBfdScalarObjects", "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": "/ciscoBfdScalarObjects", "x-restconf-kind": "container" }, "/data/CISCO-IETF-BFD-MIB:ciscoBfdSessTable": { "get": { "summary": "Get ciscoBfdSessTable data", "description": "Retrieve ciscoBfdSessTable operational data from MIB", "tags": [ "CISCO-IETF-BFD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The BFD Session Table describes the BFD sessions.", "properties": { "ciscoBfdSessEntry": { "type": "array", "description": "The BFD Session Entry describes BFD session.", "items": { "type": "object", "properties": { "ciscoBfdSessIndex": { "type": "string", "description": "This object contains an index used to represent a\n unique BFD session on this device.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdSessIndexTC" }, "ciscoBfdSessApplicationId": { "type": "integer", "description": "This object contains an index used to indicate\n a local application which owns or maintains this \n BFD session. For instance, the MPLS VPN process may \n maintain a subset of the total number of BFD \n sessions. This application ID provides a convenient \n way to segregate sessions by the applications which \n maintain them.", "minimum": 0, "maximum": 4294967295 }, "ciscoBfdSessDiscriminator": { "type": "integer", "description": "This object specifies the local discriminator for this BFD\n session, used to uniquely identify it.", "minimum": 0, "maximum": 4294967295 }, "ciscoBfdSessRemoteDiscr": { "type": "integer", "description": "This object specifies the session discriminator chosen\n by the remote system for this BFD session.", "minimum": 0, "maximum": 4294967295 }, "ciscoBfdSessUdpPort": { "type": "string", "description": "The destination UDP Port for BFD. The default value is\n the well-known value for this port. BFD State failing(5)\n is only applicable if this BFD session is running\n version 0", "format": "inet:port-number" }, "ciscoBfdSessState": { "type": "string", "description": "The perceived state of the BFD session." }, "ciscoBfdSessRemoteHeardFlag": { "type": "boolean", "description": "This object specifies status of BFD packet reception from\n the remote system. Specifically, it is set to true(1) if \n the local system is actively receiving BFD packets from the \n remote system, and is set to false(0) if the local system \n has not received BFD packets recently (within the detection \n time) or if the local system is attempting to tear down \n the BFD session." }, "ciscoBfdSessDiag": { "type": "string", "description": "A diagnostic code specifying the local system's reason\n for the last transition of the session from up(1) \n to some other state.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdDiag" }, "ciscoBfdSessOperMode": { "type": "string", "description": "This object specifies current operating mode that BFD\n session is operating in." }, "ciscoBfdSessDemandModeDesiredFlag": { "type": "boolean", "description": "This object indicates that the local system's\n desire to use Demand mode. Specifically, it is set \n to true(1) if the local system wishes to use \n Demand mode or false(0) if not" }, "ciscoBfdSessEchoFuncModeDesiredFlag": { "type": "boolean", "description": "This object indicates that the local system's\n desire to use Echo mode. Specifically, it is set \n to true(1) if the local system wishes to use \n Echo mode or false(0) if not" }, "ciscoBfdSessControlPlanIndepFlag": { "type": "boolean", "description": "This object indicates that the local system's\n ability to continue to function through a disruption of \n the control plane. Specifically, it is set \n to true(1) if the local system BFD implementation is \n independent of the control plane. Otherwise, the \n value is set to false(0)" }, "ciscoBfdSessAddrType": { "type": "string", "description": "This object specifies IP address type of the neighboring IP\n address which is being monitored with this BFD session.\n \n Only values unknown(0), ipv4(1) or ipv6(2) \n have to be supported. \n \n A value of unknown(0) is allowed only when \n the outgoing interface is of type point-to-point, or \n when the BFD session is not associated with a specific \n interface. \n \n If any other unsupported values are attempted in a set \n operation, the agent MUST return an inconsistentValue \n error.", "x-yang-type": "inet-address:InetAddressType" }, "ciscoBfdSessAddr": { "type": "string", "description": "This object specifies the neighboring IP address which is\n being monitored with this BFD session.\n It can also be used to enabled BFD on a specific \n interface. The value is set to zero when BFD session is not \n associated with a specific interface.", "x-yang-type": "inet-address:InetAddress" }, "ciscoBfdSessDesiredMinTxInterval": { "type": "string", "description": "This object specifies the minimum interval, in\n microseconds, that the local system would like to use when \n transmitting BFD Control packets.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdInterval" }, "ciscoBfdSessReqMinRxInterval": { "type": "string", "description": "This object specifies the minimum interval, in\n microseconds, between received BFD Control packets the \n local system is capable of supporting.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdInterval" }, "ciscoBfdSessReqMinEchoRxInterval": { "type": "string", "description": "This object specifies the minimum interval, in\n microseconds, between received BFD Echo packets that this \n system is capable of supporting.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdInterval" }, "ciscoBfdSessDetectMult": { "type": "integer", "description": "This object specifies the Detect time multiplier.", "minimum": 0, "maximum": 4294967295 }, "ciscoBfdSessStorType": { "type": "string", "description": "This variable indicates the storage type for this\n object. Conceptual rows having the value \n 'permanent' need not allow write-access to any \n columnar objects in the row.", "x-yang-type": "snmpv2-tc:StorageType" }, "ciscoBfdSessRowStatus": { "type": "string", "description": "This variable is used to create, modify, and/or\n delete a row in this table. When a row in this \n table has a row in the active(1) state, no \n objects in this row can be modified except the \n ciscoBfdSessRowStatus and ciscoBfdSessStorageType.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ciscoBfdSessAuthPresFlag": { "type": "boolean", "description": "This object indicates that the local system's\n desire to use Authentication. Specifically, it is set \n to true(1) if the local system wishes the session \n to be authenticated or false(0) if not" }, "ciscoBfdSessAuthenticationType": { "type": "string", "description": "The Authentication Type used for this BFD session. This\n field is valid only when the Authentication Present bit is set" }, "ciscoBfdSessVersionNumber": { "type": "integer", "description": "The version number of the BFD protocol that this session is\n running in.", "minimum": 0, "maximum": 4294967295 }, "ciscoBfdSessType": { "type": "string", "description": "The type of this BFD session." }, "ciscoBfdSessInterface": { "type": "string", "description": "This object contains an interface index used to indicate\n the interface which this BFD session is running on.", "x-yang-type": "if-mib:InterfaceIndex" } } } } } }, "example": { "CISCO-IETF-BFD-MIB:ciscoBfdSessTable": { "ciscoBfdSessEntry": [ { "ciscoBfdSessIndex": "1", "ciscoBfdSessApplicationId": 0, "ciscoBfdSessDiscriminator": 0, "ciscoBfdSessRemoteDiscr": 0, "ciscoBfdSessUdpPort": "example-string", "ciscoBfdSessState": "up(1)", "ciscoBfdSessRemoteHeardFlag": true, "ciscoBfdSessDiag": "example-string", "ciscoBfdSessOperMode": "example-string", "ciscoBfdSessDemandModeDesiredFlag": true, "ciscoBfdSessEchoFuncModeDesiredFlag": true, "ciscoBfdSessControlPlanIndepFlag": true, "ciscoBfdSessAddrType": "192.168.1.1", "ciscoBfdSessAddr": "192.168.1.1", "ciscoBfdSessDesiredMinTxInterval": "example-string", "ciscoBfdSessReqMinRxInterval": "example-string", "ciscoBfdSessReqMinEchoRxInterval": "example-string", "ciscoBfdSessDetectMult": 0, "ciscoBfdSessStorType": "ethernetCsmacd(6)", "ciscoBfdSessRowStatus": "up(1)", "ciscoBfdSessAuthPresFlag": true, "ciscoBfdSessAuthenticationType": "ethernetCsmacd(6)", "ciscoBfdSessVersionNumber": 0, "ciscoBfdSessType": "ethernetCsmacd(6)", "ciscoBfdSessInterface": "GigabitEthernet1/0/1" }, { "ciscoBfdSessIndex": "2", "ciscoBfdSessApplicationId": 0, "ciscoBfdSessDiscriminator": 0, "ciscoBfdSessRemoteDiscr": 0, "ciscoBfdSessUdpPort": "example-string", "ciscoBfdSessState": "up(1)", "ciscoBfdSessRemoteHeardFlag": true, "ciscoBfdSessDiag": "example-string", "ciscoBfdSessOperMode": "example-string", "ciscoBfdSessDemandModeDesiredFlag": true, "ciscoBfdSessEchoFuncModeDesiredFlag": true, "ciscoBfdSessControlPlanIndepFlag": true, "ciscoBfdSessAddrType": "192.168.1.1", "ciscoBfdSessAddr": "192.168.1.1", "ciscoBfdSessDesiredMinTxInterval": "example-string", "ciscoBfdSessReqMinRxInterval": "example-string", "ciscoBfdSessReqMinEchoRxInterval": "example-string", "ciscoBfdSessDetectMult": 0, "ciscoBfdSessStorType": "ethernetCsmacd(6)", "ciscoBfdSessRowStatus": "up(1)", "ciscoBfdSessAuthPresFlag": true, "ciscoBfdSessAuthenticationType": "ethernetCsmacd(6)", "ciscoBfdSessVersionNumber": 0, "ciscoBfdSessType": "ethernetCsmacd(6)", "ciscoBfdSessInterface": "GigabitEthernet1/0/1" }, { "ciscoBfdSessIndex": "3", "ciscoBfdSessApplicationId": 0, "ciscoBfdSessDiscriminator": 0, "ciscoBfdSessRemoteDiscr": 0, "ciscoBfdSessUdpPort": "example-string", "ciscoBfdSessState": "up(1)", "ciscoBfdSessRemoteHeardFlag": true, "ciscoBfdSessDiag": "example-string", "ciscoBfdSessOperMode": "example-string", "ciscoBfdSessDemandModeDesiredFlag": true, "ciscoBfdSessEchoFuncModeDesiredFlag": true, "ciscoBfdSessControlPlanIndepFlag": true, "ciscoBfdSessAddrType": "192.168.1.1", "ciscoBfdSessAddr": "192.168.1.1", "ciscoBfdSessDesiredMinTxInterval": "example-string", "ciscoBfdSessReqMinRxInterval": "example-string", "ciscoBfdSessReqMinEchoRxInterval": "example-string", "ciscoBfdSessDetectMult": 0, "ciscoBfdSessStorType": "ethernetCsmacd(6)", "ciscoBfdSessRowStatus": "up(1)", "ciscoBfdSessAuthPresFlag": true, "ciscoBfdSessAuthenticationType": "ethernetCsmacd(6)", "ciscoBfdSessVersionNumber": 0, "ciscoBfdSessType": "ethernetCsmacd(6)", "ciscoBfdSessInterface": "GigabitEthernet1/0/1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoBfdSessTable", "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": "/ciscoBfdSessTable", "x-restconf-kind": "container" }, "/data/CISCO-IETF-BFD-MIB:ciscoBfdSessTable/ciscoBfdSessEntry": { "get": { "summary": "Get ciscoBfdSessEntry list", "description": "Retrieve list of ciscoBfdSessEntry entries from MIB", "tags": [ "CISCO-IETF-BFD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "The BFD Session Entry describes BFD session.", "items": { "type": "object", "properties": { "ciscoBfdSessIndex": { "type": "string", "description": "This object contains an index used to represent a\n unique BFD session on this device.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdSessIndexTC" }, "ciscoBfdSessApplicationId": { "type": "integer", "description": "This object contains an index used to indicate\n a local application which owns or maintains this \n BFD session. For instance, the MPLS VPN process may \n maintain a subset of the total number of BFD \n sessions. This application ID provides a convenient \n way to segregate sessions by the applications which \n maintain them.", "minimum": 0, "maximum": 4294967295 }, "ciscoBfdSessDiscriminator": { "type": "integer", "description": "This object specifies the local discriminator for this BFD\n session, used to uniquely identify it.", "minimum": 0, "maximum": 4294967295 }, "ciscoBfdSessRemoteDiscr": { "type": "integer", "description": "This object specifies the session discriminator chosen\n by the remote system for this BFD session.", "minimum": 0, "maximum": 4294967295 }, "ciscoBfdSessUdpPort": { "type": "string", "description": "The destination UDP Port for BFD. The default value is\n the well-known value for this port. BFD State failing(5)\n is only applicable if this BFD session is running\n version 0", "format": "inet:port-number" }, "ciscoBfdSessState": { "type": "string", "description": "The perceived state of the BFD session." }, "ciscoBfdSessRemoteHeardFlag": { "type": "boolean", "description": "This object specifies status of BFD packet reception from\n the remote system. Specifically, it is set to true(1) if \n the local system is actively receiving BFD packets from the \n remote system, and is set to false(0) if the local system \n has not received BFD packets recently (within the detection \n time) or if the local system is attempting to tear down \n the BFD session." }, "ciscoBfdSessDiag": { "type": "string", "description": "A diagnostic code specifying the local system's reason\n for the last transition of the session from up(1) \n to some other state.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdDiag" }, "ciscoBfdSessOperMode": { "type": "string", "description": "This object specifies current operating mode that BFD\n session is operating in." }, "ciscoBfdSessDemandModeDesiredFlag": { "type": "boolean", "description": "This object indicates that the local system's\n desire to use Demand mode. Specifically, it is set \n to true(1) if the local system wishes to use \n Demand mode or false(0) if not" }, "ciscoBfdSessEchoFuncModeDesiredFlag": { "type": "boolean", "description": "This object indicates that the local system's\n desire to use Echo mode. Specifically, it is set \n to true(1) if the local system wishes to use \n Echo mode or false(0) if not" }, "ciscoBfdSessControlPlanIndepFlag": { "type": "boolean", "description": "This object indicates that the local system's\n ability to continue to function through a disruption of \n the control plane. Specifically, it is set \n to true(1) if the local system BFD implementation is \n independent of the control plane. Otherwise, the \n value is set to false(0)" }, "ciscoBfdSessAddrType": { "type": "string", "description": "This object specifies IP address type of the neighboring IP\n address which is being monitored with this BFD session.\n \n Only values unknown(0), ipv4(1) or ipv6(2) \n have to be supported. \n \n A value of unknown(0) is allowed only when \n the outgoing interface is of type point-to-point, or \n when the BFD session is not associated with a specific \n interface. \n \n If any other unsupported values are attempted in a set \n operation, the agent MUST return an inconsistentValue \n error.", "x-yang-type": "inet-address:InetAddressType" }, "ciscoBfdSessAddr": { "type": "string", "description": "This object specifies the neighboring IP address which is\n being monitored with this BFD session.\n It can also be used to enabled BFD on a specific \n interface. The value is set to zero when BFD session is not \n associated with a specific interface.", "x-yang-type": "inet-address:InetAddress" }, "ciscoBfdSessDesiredMinTxInterval": { "type": "string", "description": "This object specifies the minimum interval, in\n microseconds, that the local system would like to use when \n transmitting BFD Control packets.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdInterval" }, "ciscoBfdSessReqMinRxInterval": { "type": "string", "description": "This object specifies the minimum interval, in\n microseconds, between received BFD Control packets the \n local system is capable of supporting.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdInterval" }, "ciscoBfdSessReqMinEchoRxInterval": { "type": "string", "description": "This object specifies the minimum interval, in\n microseconds, between received BFD Echo packets that this \n system is capable of supporting.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdInterval" }, "ciscoBfdSessDetectMult": { "type": "integer", "description": "This object specifies the Detect time multiplier.", "minimum": 0, "maximum": 4294967295 }, "ciscoBfdSessStorType": { "type": "string", "description": "This variable indicates the storage type for this\n object. Conceptual rows having the value \n 'permanent' need not allow write-access to any \n columnar objects in the row.", "x-yang-type": "snmpv2-tc:StorageType" }, "ciscoBfdSessRowStatus": { "type": "string", "description": "This variable is used to create, modify, and/or\n delete a row in this table. When a row in this \n table has a row in the active(1) state, no \n objects in this row can be modified except the \n ciscoBfdSessRowStatus and ciscoBfdSessStorageType.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ciscoBfdSessAuthPresFlag": { "type": "boolean", "description": "This object indicates that the local system's\n desire to use Authentication. Specifically, it is set \n to true(1) if the local system wishes the session \n to be authenticated or false(0) if not" }, "ciscoBfdSessAuthenticationType": { "type": "string", "description": "The Authentication Type used for this BFD session. This\n field is valid only when the Authentication Present bit is set" }, "ciscoBfdSessVersionNumber": { "type": "integer", "description": "The version number of the BFD protocol that this session is\n running in.", "minimum": 0, "maximum": 4294967295 }, "ciscoBfdSessType": { "type": "string", "description": "The type of this BFD session." }, "ciscoBfdSessInterface": { "type": "string", "description": "This object contains an interface index used to indicate\n the interface which this BFD session is running on.", "x-yang-type": "if-mib:InterfaceIndex" } } } }, "example": { "CISCO-IETF-BFD-MIB:ciscoBfdSessEntry": [ { "ciscoBfdSessIndex": "example-string", "ciscoBfdSessApplicationId": 0, "ciscoBfdSessDiscriminator": 0, "ciscoBfdSessRemoteDiscr": 0, "ciscoBfdSessUdpPort": "example-string", "ciscoBfdSessState": "up(1)", "ciscoBfdSessRemoteHeardFlag": true, "ciscoBfdSessDiag": "example-string", "ciscoBfdSessOperMode": "example-string", "ciscoBfdSessDemandModeDesiredFlag": true, "ciscoBfdSessEchoFuncModeDesiredFlag": true, "ciscoBfdSessControlPlanIndepFlag": true, "ciscoBfdSessAddrType": "192.168.1.1", "ciscoBfdSessAddr": "192.168.1.1", "ciscoBfdSessDesiredMinTxInterval": "example-string", "ciscoBfdSessReqMinRxInterval": "example-string", "ciscoBfdSessReqMinEchoRxInterval": "example-string", "ciscoBfdSessDetectMult": 0, "ciscoBfdSessStorType": "ethernetCsmacd(6)", "ciscoBfdSessRowStatus": "up(1)", "ciscoBfdSessAuthPresFlag": true, "ciscoBfdSessAuthenticationType": "ethernetCsmacd(6)", "ciscoBfdSessVersionNumber": 0, "ciscoBfdSessType": "ethernetCsmacd(6)", "ciscoBfdSessInterface": "GigabitEthernet1/0/1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoBfdSessEntry", "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": "/ciscoBfdSessTable/ciscoBfdSessEntry", "x-restconf-kind": "container" }, "/data/CISCO-IETF-BFD-MIB:ciscoBfdSessTable/ciscoBfdSessEntry={ciscoBfdSessIndex}": { "get": { "summary": "Get ciscoBfdSessEntry entry", "description": "Retrieve specific ciscoBfdSessEntry entry by key from MIB", "tags": [ "CISCO-IETF-BFD-MIB" ], "parameters": [ { "name": "ciscoBfdSessIndex", "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": { "ciscoBfdSessIndex": { "type": "string", "description": "This object contains an index used to represent a\n unique BFD session on this device.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdSessIndexTC" }, "ciscoBfdSessApplicationId": { "type": "integer", "description": "This object contains an index used to indicate\n a local application which owns or maintains this \n BFD session. For instance, the MPLS VPN process may \n maintain a subset of the total number of BFD \n sessions. This application ID provides a convenient \n way to segregate sessions by the applications which \n maintain them.", "minimum": 0, "maximum": 4294967295 }, "ciscoBfdSessDiscriminator": { "type": "integer", "description": "This object specifies the local discriminator for this BFD\n session, used to uniquely identify it.", "minimum": 0, "maximum": 4294967295 }, "ciscoBfdSessRemoteDiscr": { "type": "integer", "description": "This object specifies the session discriminator chosen\n by the remote system for this BFD session.", "minimum": 0, "maximum": 4294967295 }, "ciscoBfdSessUdpPort": { "type": "string", "description": "The destination UDP Port for BFD. The default value is\n the well-known value for this port. BFD State failing(5)\n is only applicable if this BFD session is running\n version 0", "format": "inet:port-number" }, "ciscoBfdSessState": { "type": "string", "description": "The perceived state of the BFD session." }, "ciscoBfdSessRemoteHeardFlag": { "type": "boolean", "description": "This object specifies status of BFD packet reception from\n the remote system. Specifically, it is set to true(1) if \n the local system is actively receiving BFD packets from the \n remote system, and is set to false(0) if the local system \n has not received BFD packets recently (within the detection \n time) or if the local system is attempting to tear down \n the BFD session." }, "ciscoBfdSessDiag": { "type": "string", "description": "A diagnostic code specifying the local system's reason\n for the last transition of the session from up(1) \n to some other state.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdDiag" }, "ciscoBfdSessOperMode": { "type": "string", "description": "This object specifies current operating mode that BFD\n session is operating in." }, "ciscoBfdSessDemandModeDesiredFlag": { "type": "boolean", "description": "This object indicates that the local system's\n desire to use Demand mode. Specifically, it is set \n to true(1) if the local system wishes to use \n Demand mode or false(0) if not" }, "ciscoBfdSessEchoFuncModeDesiredFlag": { "type": "boolean", "description": "This object indicates that the local system's\n desire to use Echo mode. Specifically, it is set \n to true(1) if the local system wishes to use \n Echo mode or false(0) if not" }, "ciscoBfdSessControlPlanIndepFlag": { "type": "boolean", "description": "This object indicates that the local system's\n ability to continue to function through a disruption of \n the control plane. Specifically, it is set \n to true(1) if the local system BFD implementation is \n independent of the control plane. Otherwise, the \n value is set to false(0)" }, "ciscoBfdSessAddrType": { "type": "string", "description": "This object specifies IP address type of the neighboring IP\n address which is being monitored with this BFD session.\n \n Only values unknown(0), ipv4(1) or ipv6(2) \n have to be supported. \n \n A value of unknown(0) is allowed only when \n the outgoing interface is of type point-to-point, or \n when the BFD session is not associated with a specific \n interface. \n \n If any other unsupported values are attempted in a set \n operation, the agent MUST return an inconsistentValue \n error.", "x-yang-type": "inet-address:InetAddressType" }, "ciscoBfdSessAddr": { "type": "string", "description": "This object specifies the neighboring IP address which is\n being monitored with this BFD session.\n It can also be used to enabled BFD on a specific \n interface. The value is set to zero when BFD session is not \n associated with a specific interface.", "x-yang-type": "inet-address:InetAddress" }, "ciscoBfdSessDesiredMinTxInterval": { "type": "string", "description": "This object specifies the minimum interval, in\n microseconds, that the local system would like to use when \n transmitting BFD Control packets.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdInterval" }, "ciscoBfdSessReqMinRxInterval": { "type": "string", "description": "This object specifies the minimum interval, in\n microseconds, between received BFD Control packets the \n local system is capable of supporting.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdInterval" }, "ciscoBfdSessReqMinEchoRxInterval": { "type": "string", "description": "This object specifies the minimum interval, in\n microseconds, between received BFD Echo packets that this \n system is capable of supporting.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdInterval" }, "ciscoBfdSessDetectMult": { "type": "integer", "description": "This object specifies the Detect time multiplier.", "minimum": 0, "maximum": 4294967295 }, "ciscoBfdSessStorType": { "type": "string", "description": "This variable indicates the storage type for this\n object. Conceptual rows having the value \n 'permanent' need not allow write-access to any \n columnar objects in the row.", "x-yang-type": "snmpv2-tc:StorageType" }, "ciscoBfdSessRowStatus": { "type": "string", "description": "This variable is used to create, modify, and/or\n delete a row in this table. When a row in this \n table has a row in the active(1) state, no \n objects in this row can be modified except the \n ciscoBfdSessRowStatus and ciscoBfdSessStorageType.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ciscoBfdSessAuthPresFlag": { "type": "boolean", "description": "This object indicates that the local system's\n desire to use Authentication. Specifically, it is set \n to true(1) if the local system wishes the session \n to be authenticated or false(0) if not" }, "ciscoBfdSessAuthenticationType": { "type": "string", "description": "The Authentication Type used for this BFD session. This\n field is valid only when the Authentication Present bit is set" }, "ciscoBfdSessVersionNumber": { "type": "integer", "description": "The version number of the BFD protocol that this session is\n running in.", "minimum": 0, "maximum": 4294967295 }, "ciscoBfdSessType": { "type": "string", "description": "The type of this BFD session." }, "ciscoBfdSessInterface": { "type": "string", "description": "This object contains an interface index used to indicate\n the interface which this BFD session is running on.", "x-yang-type": "if-mib:InterfaceIndex" } } }, "example": { "CISCO-IETF-BFD-MIB:ciscoBfdSessEntry": { "ciscoBfdSessIndex": "example-string", "ciscoBfdSessApplicationId": 0, "ciscoBfdSessDiscriminator": 0, "ciscoBfdSessRemoteDiscr": 0, "ciscoBfdSessUdpPort": "example-string", "ciscoBfdSessState": "up(1)", "ciscoBfdSessRemoteHeardFlag": true, "ciscoBfdSessDiag": "example-string", "ciscoBfdSessOperMode": "example-string", "ciscoBfdSessDemandModeDesiredFlag": true, "ciscoBfdSessEchoFuncModeDesiredFlag": true, "ciscoBfdSessControlPlanIndepFlag": true, "ciscoBfdSessAddrType": "192.168.1.1", "ciscoBfdSessAddr": "192.168.1.1", "ciscoBfdSessDesiredMinTxInterval": "example-string", "ciscoBfdSessReqMinRxInterval": "example-string", "ciscoBfdSessReqMinEchoRxInterval": "example-string", "ciscoBfdSessDetectMult": 0, "ciscoBfdSessStorType": "ethernetCsmacd(6)", "ciscoBfdSessRowStatus": "up(1)", "ciscoBfdSessAuthPresFlag": true, "ciscoBfdSessAuthenticationType": "ethernetCsmacd(6)", "ciscoBfdSessVersionNumber": 0, "ciscoBfdSessType": "ethernetCsmacd(6)", "ciscoBfdSessInterface": "GigabitEthernet1/0/1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoBfdSessEntry-2" }, "x-yang-path": "/ciscoBfdSessTable/ciscoBfdSessEntry={ciscoBfdSessIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ciscoBfdSessIndex" ] }, "/data/CISCO-IETF-BFD-MIB:ciscoBfdSessMapTable": { "get": { "summary": "Get ciscoBfdSessMapTable data", "description": "Retrieve ciscoBfdSessMapTable operational data from MIB", "tags": [ "CISCO-IETF-BFD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The BFD Session Mapping Table maps the complex\n indexing of the BFD sessions to the flat \n CiscoBfdSessIndexTC used in the ciscoBfdSessTable.", "properties": { "ciscoBfdSessMapEntry": { "type": "array", "description": "The BFD Session Entry describes BFD session\n that is mapped to this index.", "items": { "type": "object", "properties": { "ciscoBfdSessApplicationId": { "type": "string", "description": "ciscoBfdSessApplicationId", "x-yang-type": "leafref" }, "ciscoBfdSessDiscriminator": { "type": "string", "description": "ciscoBfdSessDiscriminator", "x-yang-type": "leafref" }, "ciscoBfdSessAddrType": { "type": "string", "description": "ciscoBfdSessAddrType", "x-yang-type": "leafref" }, "ciscoBfdSessAddr": { "type": "string", "description": "ciscoBfdSessAddr", "x-yang-type": "leafref" }, "ciscoBfdSessMapBfdIndex": { "type": "string", "description": "This object indicates the CiscoBfdSessIndexTC referred to\n by the indices of this row. In essence, a mapping is \n provided between these indices and the ciscoBfdSessTable.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdSessIndexTC" } } } } } }, "example": { "CISCO-IETF-BFD-MIB:ciscoBfdSessMapTable": { "ciscoBfdSessMapEntry": [ { "ciscoBfdSessApplicationId": "example-string", "ciscoBfdSessDiscriminator": "example-string", "ciscoBfdSessAddrType": "192.168.1.1", "ciscoBfdSessAddr": "192.168.1.1", "ciscoBfdSessMapBfdIndex": "1" }, { "ciscoBfdSessApplicationId": "example-string", "ciscoBfdSessDiscriminator": "example-string", "ciscoBfdSessAddrType": "192.168.1.1", "ciscoBfdSessAddr": "192.168.1.1", "ciscoBfdSessMapBfdIndex": "2" }, { "ciscoBfdSessApplicationId": "example-string", "ciscoBfdSessDiscriminator": "example-string", "ciscoBfdSessAddrType": "192.168.1.1", "ciscoBfdSessAddr": "192.168.1.1", "ciscoBfdSessMapBfdIndex": "3" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoBfdSessMapTable", "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": "/ciscoBfdSessMapTable", "x-restconf-kind": "container" }, "/data/CISCO-IETF-BFD-MIB:ciscoBfdSessMapTable/ciscoBfdSessMapEntry": { "get": { "summary": "Get ciscoBfdSessMapEntry list", "description": "Retrieve list of ciscoBfdSessMapEntry entries from MIB", "tags": [ "CISCO-IETF-BFD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "The BFD Session Entry describes BFD session\n that is mapped to this index.", "items": { "type": "object", "properties": { "ciscoBfdSessApplicationId": { "type": "string", "description": "ciscoBfdSessApplicationId", "x-yang-type": "leafref" }, "ciscoBfdSessDiscriminator": { "type": "string", "description": "ciscoBfdSessDiscriminator", "x-yang-type": "leafref" }, "ciscoBfdSessAddrType": { "type": "string", "description": "ciscoBfdSessAddrType", "x-yang-type": "leafref" }, "ciscoBfdSessAddr": { "type": "string", "description": "ciscoBfdSessAddr", "x-yang-type": "leafref" }, "ciscoBfdSessMapBfdIndex": { "type": "string", "description": "This object indicates the CiscoBfdSessIndexTC referred to\n by the indices of this row. In essence, a mapping is \n provided between these indices and the ciscoBfdSessTable.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdSessIndexTC" } } } }, "example": { "CISCO-IETF-BFD-MIB:ciscoBfdSessMapEntry": [ { "ciscoBfdSessApplicationId": "example-string", "ciscoBfdSessDiscriminator": "example-string", "ciscoBfdSessAddrType": "192.168.1.1", "ciscoBfdSessAddr": "192.168.1.1", "ciscoBfdSessMapBfdIndex": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoBfdSessMapEntry", "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": "/ciscoBfdSessMapTable/ciscoBfdSessMapEntry", "x-restconf-kind": "container" }, "/data/CISCO-IETF-BFD-MIB:ciscoBfdSessDiscMapTable": { "get": { "summary": "Get ciscoBfdSessDiscMapTable data", "description": "Retrieve ciscoBfdSessDiscMapTable operational data from MIB", "tags": [ "CISCO-IETF-BFD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The BFD Session Discriminator Mapping Table maps a\n local discriminator value to associated BFD sessions'\n CiscoBfdSessIndexTC used in the ciscoBfdSessTable.", "properties": { "ciscoBfdSessDiscMapEntry": { "type": "array", "description": "Each row contains a mapping between a local discriminator\n value to an entry in ciscoBfdSessTable.", "items": { "type": "object", "properties": { "ciscoBfdSessDiscriminator": { "type": "string", "description": "ciscoBfdSessDiscriminator", "x-yang-type": "leafref" }, "ciscoBfdSessDiscMapIndex": { "type": "string", "description": "This object indicates the CiscoBfdSessIndexTC referred to by\n the index of this row. In essence, a mapping is \n provided between this index and the ciscoBfdSessTable.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdSessIndexTC" } } } } } }, "example": { "CISCO-IETF-BFD-MIB:ciscoBfdSessDiscMapTable": { "ciscoBfdSessDiscMapEntry": [ { "ciscoBfdSessDiscriminator": "example-string", "ciscoBfdSessDiscMapIndex": "1" }, { "ciscoBfdSessDiscriminator": "example-string", "ciscoBfdSessDiscMapIndex": "2" }, { "ciscoBfdSessDiscriminator": "example-string", "ciscoBfdSessDiscMapIndex": "3" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoBfdSessDiscMapTable", "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": "/ciscoBfdSessDiscMapTable", "x-restconf-kind": "container" }, "/data/CISCO-IETF-BFD-MIB:ciscoBfdSessDiscMapTable/ciscoBfdSessDiscMapEntry": { "get": { "summary": "Get ciscoBfdSessDiscMapEntry list", "description": "Retrieve list of ciscoBfdSessDiscMapEntry entries from MIB", "tags": [ "CISCO-IETF-BFD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Each row contains a mapping between a local discriminator\n value to an entry in ciscoBfdSessTable.", "items": { "type": "object", "properties": { "ciscoBfdSessDiscriminator": { "type": "string", "description": "ciscoBfdSessDiscriminator", "x-yang-type": "leafref" }, "ciscoBfdSessDiscMapIndex": { "type": "string", "description": "This object indicates the CiscoBfdSessIndexTC referred to by\n the index of this row. In essence, a mapping is \n provided between this index and the ciscoBfdSessTable.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdSessIndexTC" } } } }, "example": { "CISCO-IETF-BFD-MIB:ciscoBfdSessDiscMapEntry": [ { "ciscoBfdSessDiscriminator": "example-string", "ciscoBfdSessDiscMapIndex": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoBfdSessDiscMapEntry", "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": "/ciscoBfdSessDiscMapTable/ciscoBfdSessDiscMapEntry", "x-restconf-kind": "container" }, "/data/CISCO-IETF-BFD-MIB:ciscoBfdSessDiscMapTable/ciscoBfdSessDiscMapEntry={ciscoBfdSessDiscriminator}": { "get": { "summary": "Get ciscoBfdSessDiscMapEntry entry", "description": "Retrieve specific ciscoBfdSessDiscMapEntry entry by key from MIB", "tags": [ "CISCO-IETF-BFD-MIB" ], "parameters": [ { "name": "ciscoBfdSessDiscriminator", "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": { "ciscoBfdSessDiscriminator": { "type": "string", "description": "ciscoBfdSessDiscriminator", "x-yang-type": "leafref" }, "ciscoBfdSessDiscMapIndex": { "type": "string", "description": "This object indicates the CiscoBfdSessIndexTC referred to by\n the index of this row. In essence, a mapping is \n provided between this index and the ciscoBfdSessTable.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdSessIndexTC" } } }, "example": { "CISCO-IETF-BFD-MIB:ciscoBfdSessDiscMapEntry": { "ciscoBfdSessDiscriminator": "example-string", "ciscoBfdSessDiscMapIndex": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoBfdSessDiscMapEntry-2" }, "x-yang-path": "/ciscoBfdSessDiscMapTable/ciscoBfdSessDiscMapEntry={ciscoBfdSessDiscriminator}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ciscoBfdSessDiscriminator" ] }, "/data/CISCO-IETF-BFD-MIB:ciscoBfdSessIpMapTable": { "get": { "summary": "Get ciscoBfdSessIpMapTable data", "description": "Retrieve ciscoBfdSessIpMapTable operational data from MIB", "tags": [ "CISCO-IETF-BFD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The BFD Session IP Mapping Table maps given\n ciscoBfdSessInterface, ciscoBfdSessAddrType, and\n ciscoBbfdSessAddr to an associated BFD sessions'\n CiscoBfdSessIndexTC used in the ciscoBfdSessTable.\n This table SHOULD contains those BFD sessions are\n of IP type: singleHop(1) and multiHop(2).", "properties": { "ciscoBfdSessIpMapEntry": { "type": "array", "description": "Each row contains a mapping between ciscoBfdSessInterface,\n ciscoBfdSessAddrType and ciscoBfdSessAddr values to an \n entry in ciscoBfdSessTable.", "items": { "type": "object", "properties": { "ciscoBfdSessInterface": { "type": "string", "description": "ciscoBfdSessInterface", "x-yang-type": "leafref" }, "ciscoBfdSessAddrType": { "type": "string", "description": "ciscoBfdSessAddrType", "x-yang-type": "leafref" }, "ciscoBfdSessAddr": { "type": "string", "description": "ciscoBfdSessAddr", "x-yang-type": "leafref" }, "ciscoBfdSessIpMapIndex": { "type": "string", "description": "This object indicates the CiscoBfdSessIndexTC referred to by\n the indices of this row. In essence, a mapping is \n provided between these indices and an entry in ciscoBfdSessTable.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdSessIndexTC" } } } } } }, "example": { "CISCO-IETF-BFD-MIB:ciscoBfdSessIpMapTable": { "ciscoBfdSessIpMapEntry": [ { "ciscoBfdSessInterface": "GigabitEthernet1/0/1", "ciscoBfdSessAddrType": "192.168.1.1", "ciscoBfdSessAddr": "192.168.1.1", "ciscoBfdSessIpMapIndex": "1" }, { "ciscoBfdSessInterface": "GigabitEthernet1/0/1", "ciscoBfdSessAddrType": "192.168.1.1", "ciscoBfdSessAddr": "192.168.1.1", "ciscoBfdSessIpMapIndex": "2" }, { "ciscoBfdSessInterface": "GigabitEthernet1/0/1", "ciscoBfdSessAddrType": "192.168.1.1", "ciscoBfdSessAddr": "192.168.1.1", "ciscoBfdSessIpMapIndex": "3" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoBfdSessIpMapTable", "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": "/ciscoBfdSessIpMapTable", "x-restconf-kind": "container" }, "/data/CISCO-IETF-BFD-MIB:ciscoBfdSessIpMapTable/ciscoBfdSessIpMapEntry": { "get": { "summary": "Get ciscoBfdSessIpMapEntry list", "description": "Retrieve list of ciscoBfdSessIpMapEntry entries from MIB", "tags": [ "CISCO-IETF-BFD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Each row contains a mapping between ciscoBfdSessInterface,\n ciscoBfdSessAddrType and ciscoBfdSessAddr values to an \n entry in ciscoBfdSessTable.", "items": { "type": "object", "properties": { "ciscoBfdSessInterface": { "type": "string", "description": "ciscoBfdSessInterface", "x-yang-type": "leafref" }, "ciscoBfdSessAddrType": { "type": "string", "description": "ciscoBfdSessAddrType", "x-yang-type": "leafref" }, "ciscoBfdSessAddr": { "type": "string", "description": "ciscoBfdSessAddr", "x-yang-type": "leafref" }, "ciscoBfdSessIpMapIndex": { "type": "string", "description": "This object indicates the CiscoBfdSessIndexTC referred to by\n the indices of this row. In essence, a mapping is \n provided between these indices and an entry in ciscoBfdSessTable.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdSessIndexTC" } } } }, "example": { "CISCO-IETF-BFD-MIB:ciscoBfdSessIpMapEntry": [ { "ciscoBfdSessInterface": "GigabitEthernet1/0/1", "ciscoBfdSessAddrType": "192.168.1.1", "ciscoBfdSessAddr": "192.168.1.1", "ciscoBfdSessIpMapIndex": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoBfdSessIpMapEntry", "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": "/ciscoBfdSessIpMapTable/ciscoBfdSessIpMapEntry", "x-restconf-kind": "container" }, "/data/CISCO-IETF-BFD-MIB:ciscoBfdSessEntry": { "get": { "summary": "Get ciscoBfdSessEntry list", "description": "Retrieve list of ciscoBfdSessEntry entries from MIB", "tags": [ "CISCO-IETF-BFD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "The BFD Session Entry describes BFD session.", "items": { "type": "object", "properties": { "ciscoBfdSessIndex": { "type": "string", "description": "This object contains an index used to represent a\n unique BFD session on this device.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdSessIndexTC" }, "ciscoBfdSessApplicationId": { "type": "integer", "description": "This object contains an index used to indicate\n a local application which owns or maintains this \n BFD session. For instance, the MPLS VPN process may \n maintain a subset of the total number of BFD \n sessions. This application ID provides a convenient \n way to segregate sessions by the applications which \n maintain them.", "minimum": 0, "maximum": 4294967295 }, "ciscoBfdSessDiscriminator": { "type": "integer", "description": "This object specifies the local discriminator for this BFD\n session, used to uniquely identify it.", "minimum": 0, "maximum": 4294967295 }, "ciscoBfdSessRemoteDiscr": { "type": "integer", "description": "This object specifies the session discriminator chosen\n by the remote system for this BFD session.", "minimum": 0, "maximum": 4294967295 }, "ciscoBfdSessUdpPort": { "type": "string", "description": "The destination UDP Port for BFD. The default value is\n the well-known value for this port. BFD State failing(5)\n is only applicable if this BFD session is running\n version 0", "format": "inet:port-number" }, "ciscoBfdSessState": { "type": "string", "description": "The perceived state of the BFD session." }, "ciscoBfdSessRemoteHeardFlag": { "type": "boolean", "description": "This object specifies status of BFD packet reception from\n the remote system. Specifically, it is set to true(1) if \n the local system is actively receiving BFD packets from the \n remote system, and is set to false(0) if the local system \n has not received BFD packets recently (within the detection \n time) or if the local system is attempting to tear down \n the BFD session." }, "ciscoBfdSessDiag": { "type": "string", "description": "A diagnostic code specifying the local system's reason\n for the last transition of the session from up(1) \n to some other state.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdDiag" }, "ciscoBfdSessOperMode": { "type": "string", "description": "This object specifies current operating mode that BFD\n session is operating in." }, "ciscoBfdSessDemandModeDesiredFlag": { "type": "boolean", "description": "This object indicates that the local system's\n desire to use Demand mode. Specifically, it is set \n to true(1) if the local system wishes to use \n Demand mode or false(0) if not" }, "ciscoBfdSessEchoFuncModeDesiredFlag": { "type": "boolean", "description": "This object indicates that the local system's\n desire to use Echo mode. Specifically, it is set \n to true(1) if the local system wishes to use \n Echo mode or false(0) if not" }, "ciscoBfdSessControlPlanIndepFlag": { "type": "boolean", "description": "This object indicates that the local system's\n ability to continue to function through a disruption of \n the control plane. Specifically, it is set \n to true(1) if the local system BFD implementation is \n independent of the control plane. Otherwise, the \n value is set to false(0)" }, "ciscoBfdSessAddrType": { "type": "string", "description": "This object specifies IP address type of the neighboring IP\n address which is being monitored with this BFD session.\n \n Only values unknown(0), ipv4(1) or ipv6(2) \n have to be supported. \n \n A value of unknown(0) is allowed only when \n the outgoing interface is of type point-to-point, or \n when the BFD session is not associated with a specific \n interface. \n \n If any other unsupported values are attempted in a set \n operation, the agent MUST return an inconsistentValue \n error.", "x-yang-type": "inet-address:InetAddressType" }, "ciscoBfdSessAddr": { "type": "string", "description": "This object specifies the neighboring IP address which is\n being monitored with this BFD session.\n It can also be used to enabled BFD on a specific \n interface. The value is set to zero when BFD session is not \n associated with a specific interface.", "x-yang-type": "inet-address:InetAddress" }, "ciscoBfdSessDesiredMinTxInterval": { "type": "string", "description": "This object specifies the minimum interval, in\n microseconds, that the local system would like to use when \n transmitting BFD Control packets.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdInterval" }, "ciscoBfdSessReqMinRxInterval": { "type": "string", "description": "This object specifies the minimum interval, in\n microseconds, between received BFD Control packets the \n local system is capable of supporting.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdInterval" }, "ciscoBfdSessReqMinEchoRxInterval": { "type": "string", "description": "This object specifies the minimum interval, in\n microseconds, between received BFD Echo packets that this \n system is capable of supporting.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdInterval" }, "ciscoBfdSessDetectMult": { "type": "integer", "description": "This object specifies the Detect time multiplier.", "minimum": 0, "maximum": 4294967295 }, "ciscoBfdSessStorType": { "type": "string", "description": "This variable indicates the storage type for this\n object. Conceptual rows having the value \n 'permanent' need not allow write-access to any \n columnar objects in the row.", "x-yang-type": "snmpv2-tc:StorageType" }, "ciscoBfdSessRowStatus": { "type": "string", "description": "This variable is used to create, modify, and/or\n delete a row in this table. When a row in this \n table has a row in the active(1) state, no \n objects in this row can be modified except the \n ciscoBfdSessRowStatus and ciscoBfdSessStorageType.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ciscoBfdSessAuthPresFlag": { "type": "boolean", "description": "This object indicates that the local system's\n desire to use Authentication. Specifically, it is set \n to true(1) if the local system wishes the session \n to be authenticated or false(0) if not" }, "ciscoBfdSessAuthenticationType": { "type": "string", "description": "The Authentication Type used for this BFD session. This\n field is valid only when the Authentication Present bit is set" }, "ciscoBfdSessVersionNumber": { "type": "integer", "description": "The version number of the BFD protocol that this session is\n running in.", "minimum": 0, "maximum": 4294967295 }, "ciscoBfdSessType": { "type": "string", "description": "The type of this BFD session." }, "ciscoBfdSessInterface": { "type": "string", "description": "This object contains an interface index used to indicate\n the interface which this BFD session is running on.", "x-yang-type": "if-mib:InterfaceIndex" } } } }, "example": { "CISCO-IETF-BFD-MIB:ciscoBfdSessEntry": [ { "ciscoBfdSessIndex": "example-string", "ciscoBfdSessApplicationId": 0, "ciscoBfdSessDiscriminator": 0, "ciscoBfdSessRemoteDiscr": 0, "ciscoBfdSessUdpPort": "example-string", "ciscoBfdSessState": "up(1)", "ciscoBfdSessRemoteHeardFlag": true, "ciscoBfdSessDiag": "example-string", "ciscoBfdSessOperMode": "example-string", "ciscoBfdSessDemandModeDesiredFlag": true, "ciscoBfdSessEchoFuncModeDesiredFlag": true, "ciscoBfdSessControlPlanIndepFlag": true, "ciscoBfdSessAddrType": "192.168.1.1", "ciscoBfdSessAddr": "192.168.1.1", "ciscoBfdSessDesiredMinTxInterval": "example-string", "ciscoBfdSessReqMinRxInterval": "example-string", "ciscoBfdSessReqMinEchoRxInterval": "example-string", "ciscoBfdSessDetectMult": 0, "ciscoBfdSessStorType": "ethernetCsmacd(6)", "ciscoBfdSessRowStatus": "up(1)", "ciscoBfdSessAuthPresFlag": true, "ciscoBfdSessAuthenticationType": "ethernetCsmacd(6)", "ciscoBfdSessVersionNumber": 0, "ciscoBfdSessType": "ethernetCsmacd(6)", "ciscoBfdSessInterface": "GigabitEthernet1/0/1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoBfdSessEntry-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": "/ciscoBfdSessEntry", "x-restconf-kind": "container" }, "/data/CISCO-IETF-BFD-MIB:ciscoBfdSessEntry={ciscoBfdSessIndex}": { "get": { "summary": "Get ciscoBfdSessEntry entry", "description": "Retrieve specific ciscoBfdSessEntry entry by key from MIB", "tags": [ "CISCO-IETF-BFD-MIB" ], "parameters": [ { "name": "ciscoBfdSessIndex", "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": { "ciscoBfdSessIndex": { "type": "string", "description": "This object contains an index used to represent a\n unique BFD session on this device.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdSessIndexTC" }, "ciscoBfdSessApplicationId": { "type": "integer", "description": "This object contains an index used to indicate\n a local application which owns or maintains this \n BFD session. For instance, the MPLS VPN process may \n maintain a subset of the total number of BFD \n sessions. This application ID provides a convenient \n way to segregate sessions by the applications which \n maintain them.", "minimum": 0, "maximum": 4294967295 }, "ciscoBfdSessDiscriminator": { "type": "integer", "description": "This object specifies the local discriminator for this BFD\n session, used to uniquely identify it.", "minimum": 0, "maximum": 4294967295 }, "ciscoBfdSessRemoteDiscr": { "type": "integer", "description": "This object specifies the session discriminator chosen\n by the remote system for this BFD session.", "minimum": 0, "maximum": 4294967295 }, "ciscoBfdSessUdpPort": { "type": "string", "description": "The destination UDP Port for BFD. The default value is\n the well-known value for this port. BFD State failing(5)\n is only applicable if this BFD session is running\n version 0", "format": "inet:port-number" }, "ciscoBfdSessState": { "type": "string", "description": "The perceived state of the BFD session." }, "ciscoBfdSessRemoteHeardFlag": { "type": "boolean", "description": "This object specifies status of BFD packet reception from\n the remote system. Specifically, it is set to true(1) if \n the local system is actively receiving BFD packets from the \n remote system, and is set to false(0) if the local system \n has not received BFD packets recently (within the detection \n time) or if the local system is attempting to tear down \n the BFD session." }, "ciscoBfdSessDiag": { "type": "string", "description": "A diagnostic code specifying the local system's reason\n for the last transition of the session from up(1) \n to some other state.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdDiag" }, "ciscoBfdSessOperMode": { "type": "string", "description": "This object specifies current operating mode that BFD\n session is operating in." }, "ciscoBfdSessDemandModeDesiredFlag": { "type": "boolean", "description": "This object indicates that the local system's\n desire to use Demand mode. Specifically, it is set \n to true(1) if the local system wishes to use \n Demand mode or false(0) if not" }, "ciscoBfdSessEchoFuncModeDesiredFlag": { "type": "boolean", "description": "This object indicates that the local system's\n desire to use Echo mode. Specifically, it is set \n to true(1) if the local system wishes to use \n Echo mode or false(0) if not" }, "ciscoBfdSessControlPlanIndepFlag": { "type": "boolean", "description": "This object indicates that the local system's\n ability to continue to function through a disruption of \n the control plane. Specifically, it is set \n to true(1) if the local system BFD implementation is \n independent of the control plane. Otherwise, the \n value is set to false(0)" }, "ciscoBfdSessAddrType": { "type": "string", "description": "This object specifies IP address type of the neighboring IP\n address which is being monitored with this BFD session.\n \n Only values unknown(0), ipv4(1) or ipv6(2) \n have to be supported. \n \n A value of unknown(0) is allowed only when \n the outgoing interface is of type point-to-point, or \n when the BFD session is not associated with a specific \n interface. \n \n If any other unsupported values are attempted in a set \n operation, the agent MUST return an inconsistentValue \n error.", "x-yang-type": "inet-address:InetAddressType" }, "ciscoBfdSessAddr": { "type": "string", "description": "This object specifies the neighboring IP address which is\n being monitored with this BFD session.\n It can also be used to enabled BFD on a specific \n interface. The value is set to zero when BFD session is not \n associated with a specific interface.", "x-yang-type": "inet-address:InetAddress" }, "ciscoBfdSessDesiredMinTxInterval": { "type": "string", "description": "This object specifies the minimum interval, in\n microseconds, that the local system would like to use when \n transmitting BFD Control packets.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdInterval" }, "ciscoBfdSessReqMinRxInterval": { "type": "string", "description": "This object specifies the minimum interval, in\n microseconds, between received BFD Control packets the \n local system is capable of supporting.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdInterval" }, "ciscoBfdSessReqMinEchoRxInterval": { "type": "string", "description": "This object specifies the minimum interval, in\n microseconds, between received BFD Echo packets that this \n system is capable of supporting.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdInterval" }, "ciscoBfdSessDetectMult": { "type": "integer", "description": "This object specifies the Detect time multiplier.", "minimum": 0, "maximum": 4294967295 }, "ciscoBfdSessStorType": { "type": "string", "description": "This variable indicates the storage type for this\n object. Conceptual rows having the value \n 'permanent' need not allow write-access to any \n columnar objects in the row.", "x-yang-type": "snmpv2-tc:StorageType" }, "ciscoBfdSessRowStatus": { "type": "string", "description": "This variable is used to create, modify, and/or\n delete a row in this table. When a row in this \n table has a row in the active(1) state, no \n objects in this row can be modified except the \n ciscoBfdSessRowStatus and ciscoBfdSessStorageType.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ciscoBfdSessAuthPresFlag": { "type": "boolean", "description": "This object indicates that the local system's\n desire to use Authentication. Specifically, it is set \n to true(1) if the local system wishes the session \n to be authenticated or false(0) if not" }, "ciscoBfdSessAuthenticationType": { "type": "string", "description": "The Authentication Type used for this BFD session. This\n field is valid only when the Authentication Present bit is set" }, "ciscoBfdSessVersionNumber": { "type": "integer", "description": "The version number of the BFD protocol that this session is\n running in.", "minimum": 0, "maximum": 4294967295 }, "ciscoBfdSessType": { "type": "string", "description": "The type of this BFD session." }, "ciscoBfdSessInterface": { "type": "string", "description": "This object contains an interface index used to indicate\n the interface which this BFD session is running on.", "x-yang-type": "if-mib:InterfaceIndex" } } }, "example": { "CISCO-IETF-BFD-MIB:ciscoBfdSessEntry": { "ciscoBfdSessIndex": "example-string", "ciscoBfdSessApplicationId": 0, "ciscoBfdSessDiscriminator": 0, "ciscoBfdSessRemoteDiscr": 0, "ciscoBfdSessUdpPort": "example-string", "ciscoBfdSessState": "up(1)", "ciscoBfdSessRemoteHeardFlag": true, "ciscoBfdSessDiag": "example-string", "ciscoBfdSessOperMode": "example-string", "ciscoBfdSessDemandModeDesiredFlag": true, "ciscoBfdSessEchoFuncModeDesiredFlag": true, "ciscoBfdSessControlPlanIndepFlag": true, "ciscoBfdSessAddrType": "192.168.1.1", "ciscoBfdSessAddr": "192.168.1.1", "ciscoBfdSessDesiredMinTxInterval": "example-string", "ciscoBfdSessReqMinRxInterval": "example-string", "ciscoBfdSessReqMinEchoRxInterval": "example-string", "ciscoBfdSessDetectMult": 0, "ciscoBfdSessStorType": "ethernetCsmacd(6)", "ciscoBfdSessRowStatus": "up(1)", "ciscoBfdSessAuthPresFlag": true, "ciscoBfdSessAuthenticationType": "ethernetCsmacd(6)", "ciscoBfdSessVersionNumber": 0, "ciscoBfdSessType": "ethernetCsmacd(6)", "ciscoBfdSessInterface": "GigabitEthernet1/0/1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoBfdSessEntry-4" }, "x-yang-path": "/ciscoBfdSessEntry={ciscoBfdSessIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ciscoBfdSessIndex" ] }, "/data/CISCO-IETF-BFD-MIB:ciscoBfdSessMapEntry": { "get": { "summary": "Get ciscoBfdSessMapEntry list", "description": "Retrieve list of ciscoBfdSessMapEntry entries from MIB", "tags": [ "CISCO-IETF-BFD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "The BFD Session Entry describes BFD session\n that is mapped to this index.", "items": { "type": "object", "properties": { "ciscoBfdSessApplicationId": { "type": "string", "description": "ciscoBfdSessApplicationId", "x-yang-type": "leafref" }, "ciscoBfdSessDiscriminator": { "type": "string", "description": "ciscoBfdSessDiscriminator", "x-yang-type": "leafref" }, "ciscoBfdSessAddrType": { "type": "string", "description": "ciscoBfdSessAddrType", "x-yang-type": "leafref" }, "ciscoBfdSessAddr": { "type": "string", "description": "ciscoBfdSessAddr", "x-yang-type": "leafref" }, "ciscoBfdSessMapBfdIndex": { "type": "string", "description": "This object indicates the CiscoBfdSessIndexTC referred to\n by the indices of this row. In essence, a mapping is \n provided between these indices and the ciscoBfdSessTable.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdSessIndexTC" } } } }, "example": { "CISCO-IETF-BFD-MIB:ciscoBfdSessMapEntry": [ { "ciscoBfdSessApplicationId": "example-string", "ciscoBfdSessDiscriminator": "example-string", "ciscoBfdSessAddrType": "192.168.1.1", "ciscoBfdSessAddr": "192.168.1.1", "ciscoBfdSessMapBfdIndex": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoBfdSessMapEntry-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": "/ciscoBfdSessMapEntry", "x-restconf-kind": "container" }, "/data/CISCO-IETF-BFD-MIB:ciscoBfdSessDiscMapEntry": { "get": { "summary": "Get ciscoBfdSessDiscMapEntry list", "description": "Retrieve list of ciscoBfdSessDiscMapEntry entries from MIB", "tags": [ "CISCO-IETF-BFD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Each row contains a mapping between a local discriminator\n value to an entry in ciscoBfdSessTable.", "items": { "type": "object", "properties": { "ciscoBfdSessDiscriminator": { "type": "string", "description": "ciscoBfdSessDiscriminator", "x-yang-type": "leafref" }, "ciscoBfdSessDiscMapIndex": { "type": "string", "description": "This object indicates the CiscoBfdSessIndexTC referred to by\n the index of this row. In essence, a mapping is \n provided between this index and the ciscoBfdSessTable.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdSessIndexTC" } } } }, "example": { "CISCO-IETF-BFD-MIB:ciscoBfdSessDiscMapEntry": [ { "ciscoBfdSessDiscriminator": "example-string", "ciscoBfdSessDiscMapIndex": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoBfdSessDiscMapEntry-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": "/ciscoBfdSessDiscMapEntry", "x-restconf-kind": "container" }, "/data/CISCO-IETF-BFD-MIB:ciscoBfdSessDiscMapEntry={ciscoBfdSessDiscriminator}": { "get": { "summary": "Get ciscoBfdSessDiscMapEntry entry", "description": "Retrieve specific ciscoBfdSessDiscMapEntry entry by key from MIB", "tags": [ "CISCO-IETF-BFD-MIB" ], "parameters": [ { "name": "ciscoBfdSessDiscriminator", "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": { "ciscoBfdSessDiscriminator": { "type": "string", "description": "ciscoBfdSessDiscriminator", "x-yang-type": "leafref" }, "ciscoBfdSessDiscMapIndex": { "type": "string", "description": "This object indicates the CiscoBfdSessIndexTC referred to by\n the index of this row. In essence, a mapping is \n provided between this index and the ciscoBfdSessTable.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdSessIndexTC" } } }, "example": { "CISCO-IETF-BFD-MIB:ciscoBfdSessDiscMapEntry": { "ciscoBfdSessDiscriminator": "example-string", "ciscoBfdSessDiscMapIndex": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoBfdSessDiscMapEntry-4" }, "x-yang-path": "/ciscoBfdSessDiscMapEntry={ciscoBfdSessDiscriminator}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ciscoBfdSessDiscriminator" ] }, "/data/CISCO-IETF-BFD-MIB:ciscoBfdSessIpMapEntry": { "get": { "summary": "Get ciscoBfdSessIpMapEntry list", "description": "Retrieve list of ciscoBfdSessIpMapEntry entries from MIB", "tags": [ "CISCO-IETF-BFD-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Each row contains a mapping between ciscoBfdSessInterface,\n ciscoBfdSessAddrType and ciscoBfdSessAddr values to an \n entry in ciscoBfdSessTable.", "items": { "type": "object", "properties": { "ciscoBfdSessInterface": { "type": "string", "description": "ciscoBfdSessInterface", "x-yang-type": "leafref" }, "ciscoBfdSessAddrType": { "type": "string", "description": "ciscoBfdSessAddrType", "x-yang-type": "leafref" }, "ciscoBfdSessAddr": { "type": "string", "description": "ciscoBfdSessAddr", "x-yang-type": "leafref" }, "ciscoBfdSessIpMapIndex": { "type": "string", "description": "This object indicates the CiscoBfdSessIndexTC referred to by\n the indices of this row. In essence, a mapping is \n provided between these indices and an entry in ciscoBfdSessTable.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdSessIndexTC" } } } }, "example": { "CISCO-IETF-BFD-MIB:ciscoBfdSessIpMapEntry": [ { "ciscoBfdSessInterface": "GigabitEthernet1/0/1", "ciscoBfdSessAddrType": "192.168.1.1", "ciscoBfdSessAddr": "192.168.1.1", "ciscoBfdSessIpMapIndex": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoBfdSessIpMapEntry-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": "/ciscoBfdSessIpMapEntry", "x-restconf-kind": "container" }, "/data/CISCO-IETF-BFD-MIB:ciscoBfdSessMapTable/ciscoBfdSessMapEntry={ciscoBfdSessApplicationId},{ciscoBfdSessDiscriminator},{ciscoBfdSessAddrType},{ciscoBfdSessAddr}": { "get": { "summary": "Get ciscoBfdSessMapEntry entry", "description": "Retrieve specific ciscoBfdSessMapEntry entry by key from MIB", "tags": [ "CISCO-IETF-BFD-MIB" ], "parameters": [ { "name": "ciscoBfdSessApplicationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ciscoBfdSessDiscriminator", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ciscoBfdSessAddrType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ciscoBfdSessAddr", "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": { "ciscoBfdSessApplicationId": { "type": "string", "description": "ciscoBfdSessApplicationId", "x-yang-type": "leafref" }, "ciscoBfdSessDiscriminator": { "type": "string", "description": "ciscoBfdSessDiscriminator", "x-yang-type": "leafref" }, "ciscoBfdSessAddrType": { "type": "string", "description": "ciscoBfdSessAddrType", "x-yang-type": "leafref" }, "ciscoBfdSessAddr": { "type": "string", "description": "ciscoBfdSessAddr", "x-yang-type": "leafref" }, "ciscoBfdSessMapBfdIndex": { "type": "string", "description": "This object indicates the CiscoBfdSessIndexTC referred to\n by the indices of this row. In essence, a mapping is \n provided between these indices and the ciscoBfdSessTable.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdSessIndexTC" } } }, "example": { "CISCO-IETF-BFD-MIB:ciscoBfdSessMapEntry": { "ciscoBfdSessApplicationId": "example-string", "ciscoBfdSessDiscriminator": "example-string", "ciscoBfdSessAddrType": "192.168.1.1", "ciscoBfdSessAddr": "192.168.1.1", "ciscoBfdSessMapBfdIndex": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoBfdSessMapEntry-2" }, "x-yang-path": "/ciscoBfdSessMapTable/ciscoBfdSessMapEntry={ciscoBfdSessApplicationId ciscoBfdSessDiscriminator ciscoBfdSessAddrType ciscoBfdSessAddr}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ciscoBfdSessApplicationId ciscoBfdSessDiscriminator ciscoBfdSessAddrType ciscoBfdSessAddr" ] }, "/data/CISCO-IETF-BFD-MIB:ciscoBfdSessIpMapTable/ciscoBfdSessIpMapEntry={ciscoBfdSessInterface},{ciscoBfdSessAddrType},{ciscoBfdSessAddr}": { "get": { "summary": "Get ciscoBfdSessIpMapEntry entry", "description": "Retrieve specific ciscoBfdSessIpMapEntry entry by key from MIB", "tags": [ "CISCO-IETF-BFD-MIB" ], "parameters": [ { "name": "ciscoBfdSessInterface", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ciscoBfdSessAddrType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ciscoBfdSessAddr", "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": { "ciscoBfdSessInterface": { "type": "string", "description": "ciscoBfdSessInterface", "x-yang-type": "leafref" }, "ciscoBfdSessAddrType": { "type": "string", "description": "ciscoBfdSessAddrType", "x-yang-type": "leafref" }, "ciscoBfdSessAddr": { "type": "string", "description": "ciscoBfdSessAddr", "x-yang-type": "leafref" }, "ciscoBfdSessIpMapIndex": { "type": "string", "description": "This object indicates the CiscoBfdSessIndexTC referred to by\n the indices of this row. In essence, a mapping is \n provided between these indices and an entry in ciscoBfdSessTable.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdSessIndexTC" } } }, "example": { "CISCO-IETF-BFD-MIB:ciscoBfdSessIpMapEntry": { "ciscoBfdSessInterface": "GigabitEthernet1/0/1", "ciscoBfdSessAddrType": "192.168.1.1", "ciscoBfdSessAddr": "192.168.1.1", "ciscoBfdSessIpMapIndex": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoBfdSessIpMapEntry-2" }, "x-yang-path": "/ciscoBfdSessIpMapTable/ciscoBfdSessIpMapEntry={ciscoBfdSessInterface ciscoBfdSessAddrType ciscoBfdSessAddr}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ciscoBfdSessInterface ciscoBfdSessAddrType ciscoBfdSessAddr" ] }, "/data/CISCO-IETF-BFD-MIB:ciscoBfdSessMapEntry={ciscoBfdSessApplicationId},{ciscoBfdSessDiscriminator},{ciscoBfdSessAddrType},{ciscoBfdSessAddr}": { "get": { "summary": "Get ciscoBfdSessMapEntry entry", "description": "Retrieve specific ciscoBfdSessMapEntry entry by key from MIB", "tags": [ "CISCO-IETF-BFD-MIB" ], "parameters": [ { "name": "ciscoBfdSessApplicationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ciscoBfdSessDiscriminator", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ciscoBfdSessAddrType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ciscoBfdSessAddr", "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": { "ciscoBfdSessApplicationId": { "type": "string", "description": "ciscoBfdSessApplicationId", "x-yang-type": "leafref" }, "ciscoBfdSessDiscriminator": { "type": "string", "description": "ciscoBfdSessDiscriminator", "x-yang-type": "leafref" }, "ciscoBfdSessAddrType": { "type": "string", "description": "ciscoBfdSessAddrType", "x-yang-type": "leafref" }, "ciscoBfdSessAddr": { "type": "string", "description": "ciscoBfdSessAddr", "x-yang-type": "leafref" }, "ciscoBfdSessMapBfdIndex": { "type": "string", "description": "This object indicates the CiscoBfdSessIndexTC referred to\n by the indices of this row. In essence, a mapping is \n provided between these indices and the ciscoBfdSessTable.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdSessIndexTC" } } }, "example": { "CISCO-IETF-BFD-MIB:ciscoBfdSessMapEntry": { "ciscoBfdSessApplicationId": "example-string", "ciscoBfdSessDiscriminator": "example-string", "ciscoBfdSessAddrType": "192.168.1.1", "ciscoBfdSessAddr": "192.168.1.1", "ciscoBfdSessMapBfdIndex": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoBfdSessMapEntry-4" }, "x-yang-path": "/ciscoBfdSessMapEntry={ciscoBfdSessApplicationId ciscoBfdSessDiscriminator ciscoBfdSessAddrType ciscoBfdSessAddr}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ciscoBfdSessApplicationId ciscoBfdSessDiscriminator ciscoBfdSessAddrType ciscoBfdSessAddr" ] }, "/data/CISCO-IETF-BFD-MIB:ciscoBfdSessIpMapEntry={ciscoBfdSessInterface},{ciscoBfdSessAddrType},{ciscoBfdSessAddr}": { "get": { "summary": "Get ciscoBfdSessIpMapEntry entry", "description": "Retrieve specific ciscoBfdSessIpMapEntry entry by key from MIB", "tags": [ "CISCO-IETF-BFD-MIB" ], "parameters": [ { "name": "ciscoBfdSessInterface", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ciscoBfdSessAddrType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ciscoBfdSessAddr", "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": { "ciscoBfdSessInterface": { "type": "string", "description": "ciscoBfdSessInterface", "x-yang-type": "leafref" }, "ciscoBfdSessAddrType": { "type": "string", "description": "ciscoBfdSessAddrType", "x-yang-type": "leafref" }, "ciscoBfdSessAddr": { "type": "string", "description": "ciscoBfdSessAddr", "x-yang-type": "leafref" }, "ciscoBfdSessIpMapIndex": { "type": "string", "description": "This object indicates the CiscoBfdSessIndexTC referred to by\n the indices of this row. In essence, a mapping is \n provided between these indices and an entry in ciscoBfdSessTable.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdSessIndexTC" } } }, "example": { "CISCO-IETF-BFD-MIB:ciscoBfdSessIpMapEntry": { "ciscoBfdSessInterface": "GigabitEthernet1/0/1", "ciscoBfdSessAddrType": "192.168.1.1", "ciscoBfdSessAddr": "192.168.1.1", "ciscoBfdSessIpMapIndex": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoBfdSessIpMapEntry-4" }, "x-yang-path": "/ciscoBfdSessIpMapEntry={ciscoBfdSessInterface ciscoBfdSessAddrType ciscoBfdSessAddr}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ciscoBfdSessInterface ciscoBfdSessAddrType ciscoBfdSessAddr" ] } }, "components": { "schemas": { "CISCO-IETF-BFD-MIB_CISCO-IETF-BFD-MIB": { "type": "object", "description": "CISCO-IETF-BFD-MIB", "properties": { "ciscoBfdSessEntry": { "type": "array", "description": "The BFD Session Entry describes BFD session.", "items": { "type": "object", "properties": { "ciscoBfdSessIndex": { "type": "string", "description": "This object contains an index used to represent a\n unique BFD session on this device.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdSessIndexTC", "readOnly": true }, "ciscoBfdSessApplicationId": { "type": "integer", "description": "This object contains an index used to indicate\n a local application which owns or maintains this \n BFD session. For instance, the MPLS VPN process may \n maintain a subset of the total number of BFD \n sessions. This application ID provides a convenient \n way to segregate sessions by the applications which \n maintain them.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoBfdSessDiscriminator": { "type": "integer", "description": "This object specifies the local discriminator for this BFD\n session, used to uniquely identify it.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoBfdSessRemoteDiscr": { "type": "integer", "description": "This object specifies the session discriminator chosen\n by the remote system for this BFD session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoBfdSessUdpPort": { "type": "string", "description": "The destination UDP Port for BFD. The default value is\n the well-known value for this port. BFD State failing(5)\n is only applicable if this BFD session is running\n version 0", "format": "inet:port-number", "readOnly": true }, "ciscoBfdSessState": { "type": "string", "description": "The perceived state of the BFD session.", "readOnly": true }, "ciscoBfdSessRemoteHeardFlag": { "type": "boolean", "description": "This object specifies status of BFD packet reception from\n the remote system. Specifically, it is set to true(1) if \n the local system is actively receiving BFD packets from the \n remote system, and is set to false(0) if the local system \n has not received BFD packets recently (within the detection \n time) or if the local system is attempting to tear down \n the BFD session.", "readOnly": true }, "ciscoBfdSessDiag": { "type": "string", "description": "A diagnostic code specifying the local system's reason\n for the last transition of the session from up(1) \n to some other state.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdDiag", "readOnly": true }, "ciscoBfdSessOperMode": { "type": "string", "description": "This object specifies current operating mode that BFD\n session is operating in.", "readOnly": true }, "ciscoBfdSessDemandModeDesiredFlag": { "type": "boolean", "description": "This object indicates that the local system's\n desire to use Demand mode. Specifically, it is set \n to true(1) if the local system wishes to use \n Demand mode or false(0) if not", "readOnly": true }, "ciscoBfdSessEchoFuncModeDesiredFlag": { "type": "boolean", "description": "This object indicates that the local system's\n desire to use Echo mode. Specifically, it is set \n to true(1) if the local system wishes to use \n Echo mode or false(0) if not", "readOnly": true }, "ciscoBfdSessControlPlanIndepFlag": { "type": "boolean", "description": "This object indicates that the local system's\n ability to continue to function through a disruption of \n the control plane. Specifically, it is set \n to true(1) if the local system BFD implementation is \n independent of the control plane. Otherwise, the \n value is set to false(0)", "readOnly": true }, "ciscoBfdSessAddrType": { "type": "string", "description": "This object specifies IP address type of the neighboring IP\n address which is being monitored with this BFD session.\n \n Only values unknown(0), ipv4(1) or ipv6(2) \n have to be supported. \n \n A value of unknown(0) is allowed only when \n the outgoing interface is of type point-to-point, or \n when the BFD session is not associated with a specific \n interface. \n \n If any other unsupported values are attempted in a set \n operation, the agent MUST return an inconsistentValue \n error.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "ciscoBfdSessAddr": { "type": "string", "description": "This object specifies the neighboring IP address which is\n being monitored with this BFD session.\n It can also be used to enabled BFD on a specific \n interface. The value is set to zero when BFD session is not \n associated with a specific interface.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "ciscoBfdSessDesiredMinTxInterval": { "type": "string", "description": "This object specifies the minimum interval, in\n microseconds, that the local system would like to use when \n transmitting BFD Control packets.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdInterval", "readOnly": true }, "ciscoBfdSessReqMinRxInterval": { "type": "string", "description": "This object specifies the minimum interval, in\n microseconds, between received BFD Control packets the \n local system is capable of supporting.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdInterval", "readOnly": true }, "ciscoBfdSessReqMinEchoRxInterval": { "type": "string", "description": "This object specifies the minimum interval, in\n microseconds, between received BFD Echo packets that this \n system is capable of supporting.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdInterval", "readOnly": true }, "ciscoBfdSessDetectMult": { "type": "integer", "description": "This object specifies the Detect time multiplier.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoBfdSessStorType": { "type": "string", "description": "This variable indicates the storage type for this\n object. Conceptual rows having the value \n 'permanent' need not allow write-access to any \n columnar objects in the row.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "ciscoBfdSessRowStatus": { "type": "string", "description": "This variable is used to create, modify, and/or\n delete a row in this table. When a row in this \n table has a row in the active(1) state, no \n objects in this row can be modified except the \n ciscoBfdSessRowStatus and ciscoBfdSessStorageType.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ciscoBfdSessAuthPresFlag": { "type": "boolean", "description": "This object indicates that the local system's\n desire to use Authentication. Specifically, it is set \n to true(1) if the local system wishes the session \n to be authenticated or false(0) if not", "readOnly": true }, "ciscoBfdSessAuthenticationType": { "type": "string", "description": "The Authentication Type used for this BFD session. This\n field is valid only when the Authentication Present bit is set", "readOnly": true }, "ciscoBfdSessVersionNumber": { "type": "integer", "description": "The version number of the BFD protocol that this session is\n running in.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoBfdSessType": { "type": "string", "description": "The type of this BFD session.", "readOnly": true }, "ciscoBfdSessInterface": { "type": "string", "description": "This object contains an interface index used to indicate\n the interface which this BFD session is running on.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true } } }, "readOnly": true }, "ciscoBfdSessMapEntry": { "type": "array", "description": "The BFD Session Entry describes BFD session\n that is mapped to this index.", "items": { "type": "object", "properties": { "ciscoBfdSessApplicationId": { "type": "string", "description": "ciscoBfdSessApplicationId", "x-yang-type": "leafref", "readOnly": true }, "ciscoBfdSessDiscriminator": { "type": "string", "description": "ciscoBfdSessDiscriminator", "x-yang-type": "leafref", "readOnly": true }, "ciscoBfdSessAddrType": { "type": "string", "description": "ciscoBfdSessAddrType", "x-yang-type": "leafref", "readOnly": true }, "ciscoBfdSessAddr": { "type": "string", "description": "ciscoBfdSessAddr", "x-yang-type": "leafref", "readOnly": true }, "ciscoBfdSessMapBfdIndex": { "type": "string", "description": "This object indicates the CiscoBfdSessIndexTC referred to\n by the indices of this row. In essence, a mapping is \n provided between these indices and the ciscoBfdSessTable.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdSessIndexTC", "readOnly": true } } }, "readOnly": true }, "ciscoBfdSessDiscMapEntry": { "type": "array", "description": "Each row contains a mapping between a local discriminator\n value to an entry in ciscoBfdSessTable.", "items": { "type": "object", "properties": { "ciscoBfdSessDiscriminator": { "type": "string", "description": "ciscoBfdSessDiscriminator", "x-yang-type": "leafref", "readOnly": true }, "ciscoBfdSessDiscMapIndex": { "type": "string", "description": "This object indicates the CiscoBfdSessIndexTC referred to by\n the index of this row. In essence, a mapping is \n provided between this index and the ciscoBfdSessTable.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdSessIndexTC", "readOnly": true } } }, "readOnly": true }, "ciscoBfdSessIpMapEntry": { "type": "array", "description": "Each row contains a mapping between ciscoBfdSessInterface,\n ciscoBfdSessAddrType and ciscoBfdSessAddr values to an \n entry in ciscoBfdSessTable.", "items": { "type": "object", "properties": { "ciscoBfdSessInterface": { "type": "string", "description": "ciscoBfdSessInterface", "x-yang-type": "leafref", "readOnly": true }, "ciscoBfdSessAddrType": { "type": "string", "description": "ciscoBfdSessAddrType", "x-yang-type": "leafref", "readOnly": true }, "ciscoBfdSessAddr": { "type": "string", "description": "ciscoBfdSessAddr", "x-yang-type": "leafref", "readOnly": true }, "ciscoBfdSessIpMapIndex": { "type": "string", "description": "This object indicates the CiscoBfdSessIndexTC referred to by\n the indices of this row. In essence, a mapping is \n provided between these indices and an entry in ciscoBfdSessTable.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdSessIndexTC", "readOnly": true } } }, "readOnly": true }, "ciscoBfdScalarObjects": { "type": "object", "description": "The global administrative status of BFD in this router.\n The value 'enabled' denotes that the BFD Process is \n active on at least one interface; 'disabled' disables \n it on all interfaces.", "properties": { "ciscoBfdAdminStatus": { "type": "string", "description": "The global administrative status of BFD in this router.\n The value 'enabled' denotes that the BFD Process is \n active on at least one interface; 'disabled' disables \n it on all interfaces.", "readOnly": true }, "ciscoBfdVersionNumber": { "type": "integer", "description": "The current version number of the BFD protocol.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoBfdSessNotificationsEnable": { "type": "boolean", "description": "If this object is set to true(1), then it enables\n the emission of ciscoBfdSessUp and ciscoBfdSessDown \n notifications; otherwise these notifications are not \n emitted.", "readOnly": true } }, "readOnly": true }, "ciscoBfdSessTable": { "type": "object", "description": "The BFD Session Table describes the BFD sessions.", "properties": { "ciscoBfdSessEntry": { "type": "array", "description": "The BFD Session Entry describes BFD session.", "items": { "type": "object", "properties": { "ciscoBfdSessIndex": { "type": "string", "description": "This object contains an index used to represent a\n unique BFD session on this device.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdSessIndexTC", "readOnly": true }, "ciscoBfdSessApplicationId": { "type": "integer", "description": "This object contains an index used to indicate\n a local application which owns or maintains this \n BFD session. For instance, the MPLS VPN process may \n maintain a subset of the total number of BFD \n sessions. This application ID provides a convenient \n way to segregate sessions by the applications which \n maintain them.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoBfdSessDiscriminator": { "type": "integer", "description": "This object specifies the local discriminator for this BFD\n session, used to uniquely identify it.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoBfdSessRemoteDiscr": { "type": "integer", "description": "This object specifies the session discriminator chosen\n by the remote system for this BFD session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoBfdSessUdpPort": { "type": "string", "description": "The destination UDP Port for BFD. The default value is\n the well-known value for this port. BFD State failing(5)\n is only applicable if this BFD session is running\n version 0", "format": "inet:port-number", "readOnly": true }, "ciscoBfdSessState": { "type": "string", "description": "The perceived state of the BFD session.", "readOnly": true }, "ciscoBfdSessRemoteHeardFlag": { "type": "boolean", "description": "This object specifies status of BFD packet reception from\n the remote system. Specifically, it is set to true(1) if \n the local system is actively receiving BFD packets from the \n remote system, and is set to false(0) if the local system \n has not received BFD packets recently (within the detection \n time) or if the local system is attempting to tear down \n the BFD session.", "readOnly": true }, "ciscoBfdSessDiag": { "type": "string", "description": "A diagnostic code specifying the local system's reason\n for the last transition of the session from up(1) \n to some other state.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdDiag", "readOnly": true }, "ciscoBfdSessOperMode": { "type": "string", "description": "This object specifies current operating mode that BFD\n session is operating in.", "readOnly": true }, "ciscoBfdSessDemandModeDesiredFlag": { "type": "boolean", "description": "This object indicates that the local system's\n desire to use Demand mode. Specifically, it is set \n to true(1) if the local system wishes to use \n Demand mode or false(0) if not", "readOnly": true }, "ciscoBfdSessEchoFuncModeDesiredFlag": { "type": "boolean", "description": "This object indicates that the local system's\n desire to use Echo mode. Specifically, it is set \n to true(1) if the local system wishes to use \n Echo mode or false(0) if not", "readOnly": true }, "ciscoBfdSessControlPlanIndepFlag": { "type": "boolean", "description": "This object indicates that the local system's\n ability to continue to function through a disruption of \n the control plane. Specifically, it is set \n to true(1) if the local system BFD implementation is \n independent of the control plane. Otherwise, the \n value is set to false(0)", "readOnly": true }, "ciscoBfdSessAddrType": { "type": "string", "description": "This object specifies IP address type of the neighboring IP\n address which is being monitored with this BFD session.\n \n Only values unknown(0), ipv4(1) or ipv6(2) \n have to be supported. \n \n A value of unknown(0) is allowed only when \n the outgoing interface is of type point-to-point, or \n when the BFD session is not associated with a specific \n interface. \n \n If any other unsupported values are attempted in a set \n operation, the agent MUST return an inconsistentValue \n error.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "ciscoBfdSessAddr": { "type": "string", "description": "This object specifies the neighboring IP address which is\n being monitored with this BFD session.\n It can also be used to enabled BFD on a specific \n interface. The value is set to zero when BFD session is not \n associated with a specific interface.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "ciscoBfdSessDesiredMinTxInterval": { "type": "string", "description": "This object specifies the minimum interval, in\n microseconds, that the local system would like to use when \n transmitting BFD Control packets.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdInterval", "readOnly": true }, "ciscoBfdSessReqMinRxInterval": { "type": "string", "description": "This object specifies the minimum interval, in\n microseconds, between received BFD Control packets the \n local system is capable of supporting.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdInterval", "readOnly": true }, "ciscoBfdSessReqMinEchoRxInterval": { "type": "string", "description": "This object specifies the minimum interval, in\n microseconds, between received BFD Echo packets that this \n system is capable of supporting.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdInterval", "readOnly": true }, "ciscoBfdSessDetectMult": { "type": "integer", "description": "This object specifies the Detect time multiplier.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoBfdSessStorType": { "type": "string", "description": "This variable indicates the storage type for this\n object. Conceptual rows having the value \n 'permanent' need not allow write-access to any \n columnar objects in the row.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "ciscoBfdSessRowStatus": { "type": "string", "description": "This variable is used to create, modify, and/or\n delete a row in this table. When a row in this \n table has a row in the active(1) state, no \n objects in this row can be modified except the \n ciscoBfdSessRowStatus and ciscoBfdSessStorageType.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ciscoBfdSessAuthPresFlag": { "type": "boolean", "description": "This object indicates that the local system's\n desire to use Authentication. Specifically, it is set \n to true(1) if the local system wishes the session \n to be authenticated or false(0) if not", "readOnly": true }, "ciscoBfdSessAuthenticationType": { "type": "string", "description": "The Authentication Type used for this BFD session. This\n field is valid only when the Authentication Present bit is set", "readOnly": true }, "ciscoBfdSessVersionNumber": { "type": "integer", "description": "The version number of the BFD protocol that this session is\n running in.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoBfdSessType": { "type": "string", "description": "The type of this BFD session.", "readOnly": true }, "ciscoBfdSessInterface": { "type": "string", "description": "This object contains an interface index used to indicate\n the interface which this BFD session is running on.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ciscoBfdSessMapTable": { "type": "object", "description": "The BFD Session Mapping Table maps the complex\n indexing of the BFD sessions to the flat \n CiscoBfdSessIndexTC used in the ciscoBfdSessTable.", "properties": { "ciscoBfdSessMapEntry": { "type": "array", "description": "The BFD Session Entry describes BFD session\n that is mapped to this index.", "items": { "type": "object", "properties": { "ciscoBfdSessApplicationId": { "type": "string", "description": "ciscoBfdSessApplicationId", "x-yang-type": "leafref", "readOnly": true }, "ciscoBfdSessDiscriminator": { "type": "string", "description": "ciscoBfdSessDiscriminator", "x-yang-type": "leafref", "readOnly": true }, "ciscoBfdSessAddrType": { "type": "string", "description": "ciscoBfdSessAddrType", "x-yang-type": "leafref", "readOnly": true }, "ciscoBfdSessAddr": { "type": "string", "description": "ciscoBfdSessAddr", "x-yang-type": "leafref", "readOnly": true }, "ciscoBfdSessMapBfdIndex": { "type": "string", "description": "This object indicates the CiscoBfdSessIndexTC referred to\n by the indices of this row. In essence, a mapping is \n provided between these indices and the ciscoBfdSessTable.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdSessIndexTC", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ciscoBfdSessDiscMapTable": { "type": "object", "description": "The BFD Session Discriminator Mapping Table maps a\n local discriminator value to associated BFD sessions'\n CiscoBfdSessIndexTC used in the ciscoBfdSessTable.", "properties": { "ciscoBfdSessDiscMapEntry": { "type": "array", "description": "Each row contains a mapping between a local discriminator\n value to an entry in ciscoBfdSessTable.", "items": { "type": "object", "properties": { "ciscoBfdSessDiscriminator": { "type": "string", "description": "ciscoBfdSessDiscriminator", "x-yang-type": "leafref", "readOnly": true }, "ciscoBfdSessDiscMapIndex": { "type": "string", "description": "This object indicates the CiscoBfdSessIndexTC referred to by\n the index of this row. In essence, a mapping is \n provided between this index and the ciscoBfdSessTable.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdSessIndexTC", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ciscoBfdSessIpMapTable": { "type": "object", "description": "The BFD Session IP Mapping Table maps given\n ciscoBfdSessInterface, ciscoBfdSessAddrType, and\n ciscoBbfdSessAddr to an associated BFD sessions'\n CiscoBfdSessIndexTC used in the ciscoBfdSessTable.\n This table SHOULD contains those BFD sessions are\n of IP type: singleHop(1) and multiHop(2).", "properties": { "ciscoBfdSessIpMapEntry": { "type": "array", "description": "Each row contains a mapping between ciscoBfdSessInterface,\n ciscoBfdSessAddrType and ciscoBfdSessAddr values to an \n entry in ciscoBfdSessTable.", "items": { "type": "object", "properties": { "ciscoBfdSessInterface": { "type": "string", "description": "ciscoBfdSessInterface", "x-yang-type": "leafref", "readOnly": true }, "ciscoBfdSessAddrType": { "type": "string", "description": "ciscoBfdSessAddrType", "x-yang-type": "leafref", "readOnly": true }, "ciscoBfdSessAddr": { "type": "string", "description": "ciscoBfdSessAddr", "x-yang-type": "leafref", "readOnly": true }, "ciscoBfdSessIpMapIndex": { "type": "string", "description": "This object indicates the CiscoBfdSessIndexTC referred to by\n the indices of this row. In essence, a mapping is \n provided between these indices and an entry in ciscoBfdSessTable.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdSessIndexTC", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "CISCO-IETF-BFD-MIB_object-1": { "type": "object", "description": "object-1", "properties": { "ciscoBfdSessIndex": { "type": "string", "description": "ciscoBfdSessIndex", "x-yang-type": "leafref", "readOnly": true }, "ciscoBfdSessDiag": { "type": "string", "description": "ciscoBfdSessDiag", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-IETF-BFD-MIB_object-2": { "type": "object", "description": "object-2", "properties": { "ciscoBfdSessIndex": { "type": "string", "description": "ciscoBfdSessIndex", "x-yang-type": "leafref", "readOnly": true }, "ciscoBfdSessDiag": { "type": "string", "description": "ciscoBfdSessDiag", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-IETF-BFD-MIB_ciscoBfdSessEntry": { "type": "array", "description": "The BFD Session Entry describes BFD session.", "items": { "type": "object", "properties": { "ciscoBfdSessIndex": { "type": "string", "description": "This object contains an index used to represent a\n unique BFD session on this device.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdSessIndexTC", "readOnly": true }, "ciscoBfdSessApplicationId": { "type": "integer", "description": "This object contains an index used to indicate\n a local application which owns or maintains this \n BFD session. For instance, the MPLS VPN process may \n maintain a subset of the total number of BFD \n sessions. This application ID provides a convenient \n way to segregate sessions by the applications which \n maintain them.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoBfdSessDiscriminator": { "type": "integer", "description": "This object specifies the local discriminator for this BFD\n session, used to uniquely identify it.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoBfdSessRemoteDiscr": { "type": "integer", "description": "This object specifies the session discriminator chosen\n by the remote system for this BFD session.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoBfdSessUdpPort": { "type": "string", "description": "The destination UDP Port for BFD. The default value is\n the well-known value for this port. BFD State failing(5)\n is only applicable if this BFD session is running\n version 0", "format": "inet:port-number", "readOnly": true }, "ciscoBfdSessState": { "type": "string", "description": "The perceived state of the BFD session.", "readOnly": true }, "ciscoBfdSessRemoteHeardFlag": { "type": "boolean", "description": "This object specifies status of BFD packet reception from\n the remote system. Specifically, it is set to true(1) if \n the local system is actively receiving BFD packets from the \n remote system, and is set to false(0) if the local system \n has not received BFD packets recently (within the detection \n time) or if the local system is attempting to tear down \n the BFD session.", "readOnly": true }, "ciscoBfdSessDiag": { "type": "string", "description": "A diagnostic code specifying the local system's reason\n for the last transition of the session from up(1) \n to some other state.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdDiag", "readOnly": true }, "ciscoBfdSessOperMode": { "type": "string", "description": "This object specifies current operating mode that BFD\n session is operating in.", "readOnly": true }, "ciscoBfdSessDemandModeDesiredFlag": { "type": "boolean", "description": "This object indicates that the local system's\n desire to use Demand mode. Specifically, it is set \n to true(1) if the local system wishes to use \n Demand mode or false(0) if not", "readOnly": true }, "ciscoBfdSessEchoFuncModeDesiredFlag": { "type": "boolean", "description": "This object indicates that the local system's\n desire to use Echo mode. Specifically, it is set \n to true(1) if the local system wishes to use \n Echo mode or false(0) if not", "readOnly": true }, "ciscoBfdSessControlPlanIndepFlag": { "type": "boolean", "description": "This object indicates that the local system's\n ability to continue to function through a disruption of \n the control plane. Specifically, it is set \n to true(1) if the local system BFD implementation is \n independent of the control plane. Otherwise, the \n value is set to false(0)", "readOnly": true }, "ciscoBfdSessAddrType": { "type": "string", "description": "This object specifies IP address type of the neighboring IP\n address which is being monitored with this BFD session.\n \n Only values unknown(0), ipv4(1) or ipv6(2) \n have to be supported. \n \n A value of unknown(0) is allowed only when \n the outgoing interface is of type point-to-point, or \n when the BFD session is not associated with a specific \n interface. \n \n If any other unsupported values are attempted in a set \n operation, the agent MUST return an inconsistentValue \n error.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "ciscoBfdSessAddr": { "type": "string", "description": "This object specifies the neighboring IP address which is\n being monitored with this BFD session.\n It can also be used to enabled BFD on a specific \n interface. The value is set to zero when BFD session is not \n associated with a specific interface.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "ciscoBfdSessDesiredMinTxInterval": { "type": "string", "description": "This object specifies the minimum interval, in\n microseconds, that the local system would like to use when \n transmitting BFD Control packets.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdInterval", "readOnly": true }, "ciscoBfdSessReqMinRxInterval": { "type": "string", "description": "This object specifies the minimum interval, in\n microseconds, between received BFD Control packets the \n local system is capable of supporting.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdInterval", "readOnly": true }, "ciscoBfdSessReqMinEchoRxInterval": { "type": "string", "description": "This object specifies the minimum interval, in\n microseconds, between received BFD Echo packets that this \n system is capable of supporting.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdInterval", "readOnly": true }, "ciscoBfdSessDetectMult": { "type": "integer", "description": "This object specifies the Detect time multiplier.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoBfdSessStorType": { "type": "string", "description": "This variable indicates the storage type for this\n object. Conceptual rows having the value \n 'permanent' need not allow write-access to any \n columnar objects in the row.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "ciscoBfdSessRowStatus": { "type": "string", "description": "This variable is used to create, modify, and/or\n delete a row in this table. When a row in this \n table has a row in the active(1) state, no \n objects in this row can be modified except the \n ciscoBfdSessRowStatus and ciscoBfdSessStorageType.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ciscoBfdSessAuthPresFlag": { "type": "boolean", "description": "This object indicates that the local system's\n desire to use Authentication. Specifically, it is set \n to true(1) if the local system wishes the session \n to be authenticated or false(0) if not", "readOnly": true }, "ciscoBfdSessAuthenticationType": { "type": "string", "description": "The Authentication Type used for this BFD session. This\n field is valid only when the Authentication Present bit is set", "readOnly": true }, "ciscoBfdSessVersionNumber": { "type": "integer", "description": "The version number of the BFD protocol that this session is\n running in.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoBfdSessType": { "type": "string", "description": "The type of this BFD session.", "readOnly": true }, "ciscoBfdSessInterface": { "type": "string", "description": "This object contains an interface index used to indicate\n the interface which this BFD session is running on.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true } } } }, "CISCO-IETF-BFD-MIB_ciscoBfdSessMapEntry": { "type": "array", "description": "The BFD Session Entry describes BFD session\n that is mapped to this index.", "items": { "type": "object", "properties": { "ciscoBfdSessApplicationId": { "type": "string", "description": "ciscoBfdSessApplicationId", "x-yang-type": "leafref", "readOnly": true }, "ciscoBfdSessDiscriminator": { "type": "string", "description": "ciscoBfdSessDiscriminator", "x-yang-type": "leafref", "readOnly": true }, "ciscoBfdSessAddrType": { "type": "string", "description": "ciscoBfdSessAddrType", "x-yang-type": "leafref", "readOnly": true }, "ciscoBfdSessAddr": { "type": "string", "description": "ciscoBfdSessAddr", "x-yang-type": "leafref", "readOnly": true }, "ciscoBfdSessMapBfdIndex": { "type": "string", "description": "This object indicates the CiscoBfdSessIndexTC referred to\n by the indices of this row. In essence, a mapping is \n provided between these indices and the ciscoBfdSessTable.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdSessIndexTC", "readOnly": true } } } }, "CISCO-IETF-BFD-MIB_ciscoBfdSessDiscMapEntry": { "type": "array", "description": "Each row contains a mapping between a local discriminator\n value to an entry in ciscoBfdSessTable.", "items": { "type": "object", "properties": { "ciscoBfdSessDiscriminator": { "type": "string", "description": "ciscoBfdSessDiscriminator", "x-yang-type": "leafref", "readOnly": true }, "ciscoBfdSessDiscMapIndex": { "type": "string", "description": "This object indicates the CiscoBfdSessIndexTC referred to by\n the index of this row. In essence, a mapping is \n provided between this index and the ciscoBfdSessTable.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdSessIndexTC", "readOnly": true } } } }, "CISCO-IETF-BFD-MIB_ciscoBfdSessIpMapEntry": { "type": "array", "description": "Each row contains a mapping between ciscoBfdSessInterface,\n ciscoBfdSessAddrType and ciscoBfdSessAddr values to an \n entry in ciscoBfdSessTable.", "items": { "type": "object", "properties": { "ciscoBfdSessInterface": { "type": "string", "description": "ciscoBfdSessInterface", "x-yang-type": "leafref", "readOnly": true }, "ciscoBfdSessAddrType": { "type": "string", "description": "ciscoBfdSessAddrType", "x-yang-type": "leafref", "readOnly": true }, "ciscoBfdSessAddr": { "type": "string", "description": "ciscoBfdSessAddr", "x-yang-type": "leafref", "readOnly": true }, "ciscoBfdSessIpMapIndex": { "type": "string", "description": "This object indicates the CiscoBfdSessIndexTC referred to by\n the indices of this row. In essence, a mapping is \n provided between these indices and an entry in ciscoBfdSessTable.", "x-yang-type": "CISCO-IETF-BFD-MIB:CiscoBfdSessIndexTC", "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-BFD-MIB", "description": "MIB operations for CISCO-IETF-BFD-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }