{ "openapi": "3.0.0", "info": { "title": "CISCO-BGP4-MIB MIB API", "version": "1.0.0", "description": "SNMP MIB translated to YANG data model\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-BGP4-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/CISCO-BGP4-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "CISCO-BGP4-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-BGP4-MIB:cbgpGlobal": { "get": { "summary": "Get cbgpGlobal data", "description": "Retrieve cbgpGlobal operational data from MIB", "tags": [ "CISCO-BGP4-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "cbgpGlobal", "properties": { "cbgpNotifsEnable": { "type": "string", "description": "Indicates whether the specific notifications are\n enabled. \n If notifsEnable(0) bit is set to 1,\n then the notifications defined in\n ciscoBgp4NotificationsGroup1 are enabled; \n If notifsPeer2Enable(1) bit is set to 1,\n then the notifications defined in\n ciscoBgp4Peer2NotificationsGroup are enabled." }, "cbgpLocalAs": { "type": "string", "description": "The local autonomous system (AS) number.", "format": "inet:as-number" } } }, "example": { "CISCO-BGP4-MIB:cbgpGlobal": { "cbgpNotifsEnable": "example-string", "cbgpLocalAs": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpGlobal", "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": "/cbgpGlobal", "x-restconf-kind": "container" }, "/data/CISCO-BGP4-MIB:cbgpRouteTable": { "get": { "summary": "Get cbgpRouteTable data", "description": "Retrieve cbgpRouteTable operational data from MIB", "tags": [ "CISCO-BGP4-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "cbgpRouteTable", "properties": { "cbgpRouteEntry": { "type": "array", "description": "Information about a path to a network received from\n a peer.", "items": { "type": "object", "properties": { "cbgpRouteAfi": { "type": "string", "description": "Represents Address Family Identifier(AFI) of the\n Network Layer protocol associated with the route.\n An implementation is only required to support IPv4\n unicast and VPNv4 (Value - 1) address families.", "x-yang-type": "inet-address:InetAddressType" }, "cbgpRouteSafi": { "type": "string", "description": "Represents Subsequent Address Family Identifier(SAFI)\n of the route. It gives additional information about\n the type of the route. An implementation is only \n required to support IPv4 unicast(Value - 1) and VPNv4(\n Value - 128) address families.", "x-yang-type": "CISCO-BGP4-MIB:CbgpSafi" }, "cbgpRoutePeerType": { "type": "string", "description": "Represents the type of Network Layer address stored\n in cbgpRoutePeer. An implementation is only required\n to support IPv4 address type(Value - 1).", "x-yang-type": "inet-address:InetAddressType" }, "cbgpRoutePeer": { "type": "string", "description": "The Network Layer address of the peer where the route\n information was learned. An implementation is only \n required to support an IPv4 peer.", "x-yang-type": "inet-address:InetAddress" }, "cbgpRouteAddrPrefix": { "type": "string", "description": "A Network Address prefix in the Network Layer\n Reachability Information field of BGP UPDATE message.\n This object is a Network Address containing the prefix\n with length specified by cbgpRouteAddrPrefixLen. Any\n bits beyond the length specified by\n cbgpRouteAddrPrefixLen are zeroed.", "x-yang-type": "CISCO-BGP4-MIB:CbgpNetworkAddress" }, "cbgpRouteAddrPrefixLen": { "type": "integer", "description": "Length in bits of the Network Address prefix in the\n Network Layer Reachability Information field.", "minimum": 0, "maximum": 4294967295 }, "cbgpRouteOrigin": { "type": "string", "description": "The ultimate origin of the route information." }, "cbgpRouteASPathSegment": { "type": "string", "description": "The sequence of AS path segments. Each AS\n path segment is represented by a triple\n .\n \n The type is a 1-octet field which has two\n possible values:\n 1 AS_SET: unordered set of ASs a route in the \n UPDATE message has traversed\n 2 AS_SEQUENCE: ordered set of ASs a route in the\n UPDATE message has traversed.\n \n The length is a 1-octet field containing the\n number of ASs in the value field.\n \n The value field contains one or more AS\n numbers, each AS is represented in the octet\n string as a pair of octets according to the\n following algorithm:\n \n first-byte-of-pair = ASNumber / 256;\n second-byte-of-pair = ASNumber & 255;", "format": "binary" }, "cbgpRouteNextHop": { "type": "string", "description": "The Network Layer address of the border router\n that should be used for the destination network.", "x-yang-type": "CISCO-BGP4-MIB:CbgpNetworkAddress" }, "cbgpRouteMedPresent": { "type": "boolean", "description": "Indicates the presence/absence of MULTI_EXIT_DISC\n attribute for the route." }, "cbgpRouteMultiExitDisc": { "type": "integer", "description": "This metric is used to discriminate between multiple\n exit points to an adjacent autonomous system. The\n value of this object is irrelevant if the value of\n of cbgpRouteMedPresent is false(2).", "minimum": 0, "maximum": 4294967295 }, "cbgpRouteLocalPrefPresent": { "type": "boolean", "description": "Indicates the presence/absence of LOCAL_PREF\n attribute for the route." }, "cbgpRouteLocalPref": { "type": "integer", "description": "The degree of preference calculated by the local BGP4\n speaker for the route. The value of this object is \n irrelevant if the value of cbgpRouteLocalPrefPresent \n is false(2).", "minimum": 0, "maximum": 4294967295 }, "cbgpRouteAtomicAggregate": { "type": "string", "description": "Whether or not the local system has selected a less\n specific route without selecting a more specific\n route." }, "cbgpRouteAggregatorAS": { "type": "integer", "description": "The AS number of the last BGP4 speaker that performed\n route aggregation. A value of zero (0) indicates the \n absence of this attribute.", "minimum": 0, "maximum": 4294967295 }, "cbgpRouteAggregatorAddrType": { "type": "string", "description": "Represents the type of Network Layer address stored\n in cbgpRouteAggregatorAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cbgpRouteAggregatorAddr": { "type": "string", "description": "The Network Layer address of the last BGP4 speaker\n that performed route aggregation. A value of all zeros\n indicates the absence of this attribute.", "x-yang-type": "inet-address:InetAddress" }, "cbgpRouteBest": { "type": "boolean", "description": "An indication of whether or not this route was chosen\n as the best BGP4 route." }, "cbgpRouteUnknownAttr": { "type": "string", "description": "One or more path attributes not understood by this\n BGP4 speaker. Size zero (0) indicates the absence of\n such attribute(s). Octets beyond the maximum size, if\n any, are not recorded by this object. \n \n Each path attribute is a triple of variable length.\n Attribute Type is a two-octet field that consists of\n the Attribute Flags octet followed by the Attribute\n Type Code octet. If the Extended Length bit of the \n Attribute Flags octet is set to 0, the third octet of \n the Path Attribute contains the length of the\n attribute data in octets. If the Extended Length bit \n of the Attribute Flags octet is set to 1, then the\n third and the fourth octets of the path attribute \n contain the length of the attribute data in octets.\n The remaining octets of the Path Attribute represent \n the attribute value and are interpreted according to \n the Attribute Flags and the Attribute Type Code.", "format": "binary" } } } } } }, "example": { "CISCO-BGP4-MIB:cbgpRouteTable": { "cbgpRouteEntry": [ { "cbgpRouteAfi": "example-string", "cbgpRouteSafi": "example-string", "cbgpRoutePeerType": "ethernetCsmacd(6)", "cbgpRoutePeer": "example-string", "cbgpRouteAddrPrefix": "192.168.1.1", "cbgpRouteAddrPrefixLen": 0, "cbgpRouteOrigin": "example-string", "cbgpRouteASPathSegment": "example-string", "cbgpRouteNextHop": "example-string", "cbgpRouteMedPresent": true, "cbgpRouteMultiExitDisc": 0, "cbgpRouteLocalPrefPresent": true, "cbgpRouteLocalPref": 0, "cbgpRouteAtomicAggregate": "example-string", "cbgpRouteAggregatorAS": 0, "cbgpRouteAggregatorAddrType": "192.168.1.1", "cbgpRouteAggregatorAddr": "192.168.1.1", "cbgpRouteBest": true, "cbgpRouteUnknownAttr": "example-string" }, { "cbgpRouteAfi": "example-string", "cbgpRouteSafi": "example-string", "cbgpRoutePeerType": "ethernetCsmacd(6)", "cbgpRoutePeer": "example-string", "cbgpRouteAddrPrefix": "192.168.1.1", "cbgpRouteAddrPrefixLen": 0, "cbgpRouteOrigin": "example-string", "cbgpRouteASPathSegment": "example-string", "cbgpRouteNextHop": "example-string", "cbgpRouteMedPresent": true, "cbgpRouteMultiExitDisc": 0, "cbgpRouteLocalPrefPresent": true, "cbgpRouteLocalPref": 0, "cbgpRouteAtomicAggregate": "example-string", "cbgpRouteAggregatorAS": 0, "cbgpRouteAggregatorAddrType": "192.168.1.1", "cbgpRouteAggregatorAddr": "192.168.1.1", "cbgpRouteBest": true, "cbgpRouteUnknownAttr": "example-string" }, { "cbgpRouteAfi": "example-string", "cbgpRouteSafi": "example-string", "cbgpRoutePeerType": "ethernetCsmacd(6)", "cbgpRoutePeer": "example-string", "cbgpRouteAddrPrefix": "192.168.1.1", "cbgpRouteAddrPrefixLen": 0, "cbgpRouteOrigin": "example-string", "cbgpRouteASPathSegment": "example-string", "cbgpRouteNextHop": "example-string", "cbgpRouteMedPresent": true, "cbgpRouteMultiExitDisc": 0, "cbgpRouteLocalPrefPresent": true, "cbgpRouteLocalPref": 0, "cbgpRouteAtomicAggregate": "example-string", "cbgpRouteAggregatorAS": 0, "cbgpRouteAggregatorAddrType": "192.168.1.1", "cbgpRouteAggregatorAddr": "192.168.1.1", "cbgpRouteBest": true, "cbgpRouteUnknownAttr": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpRouteTable", "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": "/cbgpRouteTable", "x-restconf-kind": "container" }, "/data/CISCO-BGP4-MIB:cbgpRouteTable/cbgpRouteEntry": { "get": { "summary": "Get cbgpRouteEntry list", "description": "Retrieve list of cbgpRouteEntry entries from MIB", "tags": [ "CISCO-BGP4-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about a path to a network received from\n a peer.", "items": { "type": "object", "properties": { "cbgpRouteAfi": { "type": "string", "description": "Represents Address Family Identifier(AFI) of the\n Network Layer protocol associated with the route.\n An implementation is only required to support IPv4\n unicast and VPNv4 (Value - 1) address families.", "x-yang-type": "inet-address:InetAddressType" }, "cbgpRouteSafi": { "type": "string", "description": "Represents Subsequent Address Family Identifier(SAFI)\n of the route. It gives additional information about\n the type of the route. An implementation is only \n required to support IPv4 unicast(Value - 1) and VPNv4(\n Value - 128) address families.", "x-yang-type": "CISCO-BGP4-MIB:CbgpSafi" }, "cbgpRoutePeerType": { "type": "string", "description": "Represents the type of Network Layer address stored\n in cbgpRoutePeer. An implementation is only required\n to support IPv4 address type(Value - 1).", "x-yang-type": "inet-address:InetAddressType" }, "cbgpRoutePeer": { "type": "string", "description": "The Network Layer address of the peer where the route\n information was learned. An implementation is only \n required to support an IPv4 peer.", "x-yang-type": "inet-address:InetAddress" }, "cbgpRouteAddrPrefix": { "type": "string", "description": "A Network Address prefix in the Network Layer\n Reachability Information field of BGP UPDATE message.\n This object is a Network Address containing the prefix\n with length specified by cbgpRouteAddrPrefixLen. Any\n bits beyond the length specified by\n cbgpRouteAddrPrefixLen are zeroed.", "x-yang-type": "CISCO-BGP4-MIB:CbgpNetworkAddress" }, "cbgpRouteAddrPrefixLen": { "type": "integer", "description": "Length in bits of the Network Address prefix in the\n Network Layer Reachability Information field.", "minimum": 0, "maximum": 4294967295 }, "cbgpRouteOrigin": { "type": "string", "description": "The ultimate origin of the route information." }, "cbgpRouteASPathSegment": { "type": "string", "description": "The sequence of AS path segments. Each AS\n path segment is represented by a triple\n .\n \n The type is a 1-octet field which has two\n possible values:\n 1 AS_SET: unordered set of ASs a route in the \n UPDATE message has traversed\n 2 AS_SEQUENCE: ordered set of ASs a route in the\n UPDATE message has traversed.\n \n The length is a 1-octet field containing the\n number of ASs in the value field.\n \n The value field contains one or more AS\n numbers, each AS is represented in the octet\n string as a pair of octets according to the\n following algorithm:\n \n first-byte-of-pair = ASNumber / 256;\n second-byte-of-pair = ASNumber & 255;", "format": "binary" }, "cbgpRouteNextHop": { "type": "string", "description": "The Network Layer address of the border router\n that should be used for the destination network.", "x-yang-type": "CISCO-BGP4-MIB:CbgpNetworkAddress" }, "cbgpRouteMedPresent": { "type": "boolean", "description": "Indicates the presence/absence of MULTI_EXIT_DISC\n attribute for the route." }, "cbgpRouteMultiExitDisc": { "type": "integer", "description": "This metric is used to discriminate between multiple\n exit points to an adjacent autonomous system. The\n value of this object is irrelevant if the value of\n of cbgpRouteMedPresent is false(2).", "minimum": 0, "maximum": 4294967295 }, "cbgpRouteLocalPrefPresent": { "type": "boolean", "description": "Indicates the presence/absence of LOCAL_PREF\n attribute for the route." }, "cbgpRouteLocalPref": { "type": "integer", "description": "The degree of preference calculated by the local BGP4\n speaker for the route. The value of this object is \n irrelevant if the value of cbgpRouteLocalPrefPresent \n is false(2).", "minimum": 0, "maximum": 4294967295 }, "cbgpRouteAtomicAggregate": { "type": "string", "description": "Whether or not the local system has selected a less\n specific route without selecting a more specific\n route." }, "cbgpRouteAggregatorAS": { "type": "integer", "description": "The AS number of the last BGP4 speaker that performed\n route aggregation. A value of zero (0) indicates the \n absence of this attribute.", "minimum": 0, "maximum": 4294967295 }, "cbgpRouteAggregatorAddrType": { "type": "string", "description": "Represents the type of Network Layer address stored\n in cbgpRouteAggregatorAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cbgpRouteAggregatorAddr": { "type": "string", "description": "The Network Layer address of the last BGP4 speaker\n that performed route aggregation. A value of all zeros\n indicates the absence of this attribute.", "x-yang-type": "inet-address:InetAddress" }, "cbgpRouteBest": { "type": "boolean", "description": "An indication of whether or not this route was chosen\n as the best BGP4 route." }, "cbgpRouteUnknownAttr": { "type": "string", "description": "One or more path attributes not understood by this\n BGP4 speaker. Size zero (0) indicates the absence of\n such attribute(s). Octets beyond the maximum size, if\n any, are not recorded by this object. \n \n Each path attribute is a triple of variable length.\n Attribute Type is a two-octet field that consists of\n the Attribute Flags octet followed by the Attribute\n Type Code octet. If the Extended Length bit of the \n Attribute Flags octet is set to 0, the third octet of \n the Path Attribute contains the length of the\n attribute data in octets. If the Extended Length bit \n of the Attribute Flags octet is set to 1, then the\n third and the fourth octets of the path attribute \n contain the length of the attribute data in octets.\n The remaining octets of the Path Attribute represent \n the attribute value and are interpreted according to \n the Attribute Flags and the Attribute Type Code.", "format": "binary" } } } }, "example": { "CISCO-BGP4-MIB:cbgpRouteEntry": [ { "cbgpRouteAfi": "example-string", "cbgpRouteSafi": "example-string", "cbgpRoutePeerType": "ethernetCsmacd(6)", "cbgpRoutePeer": "example-string", "cbgpRouteAddrPrefix": "192.168.1.1", "cbgpRouteAddrPrefixLen": 0, "cbgpRouteOrigin": "example-string", "cbgpRouteASPathSegment": "example-string", "cbgpRouteNextHop": "example-string", "cbgpRouteMedPresent": true, "cbgpRouteMultiExitDisc": 0, "cbgpRouteLocalPrefPresent": true, "cbgpRouteLocalPref": 0, "cbgpRouteAtomicAggregate": "example-string", "cbgpRouteAggregatorAS": 0, "cbgpRouteAggregatorAddrType": "192.168.1.1", "cbgpRouteAggregatorAddr": "192.168.1.1", "cbgpRouteBest": true, "cbgpRouteUnknownAttr": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpRouteEntry", "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": "/cbgpRouteTable/cbgpRouteEntry", "x-restconf-kind": "container" }, "/data/CISCO-BGP4-MIB:cbgpPeerCapsTable": { "get": { "summary": "Get cbgpPeerCapsTable data", "description": "Retrieve cbgpPeerCapsTable operational data from MIB", "tags": [ "CISCO-BGP4-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "cbgpPeerCapsTable", "properties": { "cbgpPeerCapsEntry": { "type": "array", "description": "Each entry represents a capability received from a\n peer with a particular code and an index. When a \n capability is received multiple times with different\n values during a BGP connection establishment, \n corresponding entries are differentiated with indices.", "items": { "type": "object", "properties": { "bgpPeerRemoteAddr": { "type": "string", "description": "bgpPeerRemoteAddr", "x-yang-type": "leafref" }, "cbgpPeerCapCode": { "type": "string", "description": "The BGP Capability Advertisement Capability Code." }, "cbgpPeerCapIndex": { "type": "integer", "description": "Multiple instances of a given capability may be\n sent by a BGP speaker. This variable is used\n to index them.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerCapValue": { "type": "string", "description": "The value of the announced capability. This\n MIB object value is organized as given below,\n Capability : Route Refresh Capability\n Null string\n Capability : Multiprotocol Extensions\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n Capability : Graceful Restart\n +----------------------------------+\n | Restart Flags (4 bits) |\n +----------------------------------+\n | Restart Time in seconds (12 bits)|\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Flags for Address Family (8 bits)|\n +----------------------------------+\n | ... |\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Flags for Address Family (8 bits)|\n +----------------------------------+", "format": "binary" } } } } } }, "example": { "CISCO-BGP4-MIB:cbgpPeerCapsTable": { "cbgpPeerCapsEntry": [ { "bgpPeerRemoteAddr": "192.168.1.1", "cbgpPeerCapCode": "example-string", "cbgpPeerCapIndex": 1, "cbgpPeerCapValue": "example-string" }, { "bgpPeerRemoteAddr": "192.168.1.1", "cbgpPeerCapCode": "example-string", "cbgpPeerCapIndex": 2, "cbgpPeerCapValue": "example-string" }, { "bgpPeerRemoteAddr": "192.168.1.1", "cbgpPeerCapCode": "example-string", "cbgpPeerCapIndex": 3, "cbgpPeerCapValue": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeerCapsTable", "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": "/cbgpPeerCapsTable", "x-restconf-kind": "container" }, "/data/CISCO-BGP4-MIB:cbgpPeerCapsTable/cbgpPeerCapsEntry": { "get": { "summary": "Get cbgpPeerCapsEntry list", "description": "Retrieve list of cbgpPeerCapsEntry entries from MIB", "tags": [ "CISCO-BGP4-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Each entry represents a capability received from a\n peer with a particular code and an index. When a \n capability is received multiple times with different\n values during a BGP connection establishment, \n corresponding entries are differentiated with indices.", "items": { "type": "object", "properties": { "bgpPeerRemoteAddr": { "type": "string", "description": "bgpPeerRemoteAddr", "x-yang-type": "leafref" }, "cbgpPeerCapCode": { "type": "string", "description": "The BGP Capability Advertisement Capability Code." }, "cbgpPeerCapIndex": { "type": "integer", "description": "Multiple instances of a given capability may be\n sent by a BGP speaker. This variable is used\n to index them.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerCapValue": { "type": "string", "description": "The value of the announced capability. This\n MIB object value is organized as given below,\n Capability : Route Refresh Capability\n Null string\n Capability : Multiprotocol Extensions\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n Capability : Graceful Restart\n +----------------------------------+\n | Restart Flags (4 bits) |\n +----------------------------------+\n | Restart Time in seconds (12 bits)|\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Flags for Address Family (8 bits)|\n +----------------------------------+\n | ... |\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Flags for Address Family (8 bits)|\n +----------------------------------+", "format": "binary" } } } }, "example": { "CISCO-BGP4-MIB:cbgpPeerCapsEntry": [ { "bgpPeerRemoteAddr": "192.168.1.1", "cbgpPeerCapCode": "example-string", "cbgpPeerCapIndex": 1, "cbgpPeerCapValue": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeerCapsEntry", "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": "/cbgpPeerCapsTable/cbgpPeerCapsEntry", "x-restconf-kind": "container" }, "/data/CISCO-BGP4-MIB:cbgpPeerAddrFamilyTable": { "get": { "summary": "Get cbgpPeerAddrFamilyTable data", "description": "Retrieve cbgpPeerAddrFamilyTable operational data from MIB", "tags": [ "CISCO-BGP4-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains information related to\n address families supported by a peer. Supported\n address families of a peer are known during BGP \n connection establishment. When a new supported \n address family is known, this table is updated \n with a new entry. When an address family is not \n supported any more, corresponding entry is deleted \n from the table.", "properties": { "cbgpPeerAddrFamilyEntry": { "type": "array", "description": "An entry is identified by an AFI/SAFI pair and\n peer address. It contains names associated with\n an address family.", "items": { "type": "object", "properties": { "bgpPeerRemoteAddr": { "type": "string", "description": "bgpPeerRemoteAddr", "x-yang-type": "leafref" }, "cbgpPeerAddrFamilyAfi": { "type": "string", "description": "The AFI index of the entry. An implementation\n is only required to support IPv4 unicast and \n VPNv4 (Value - 1) address families.", "x-yang-type": "inet-address:InetAddressType" }, "cbgpPeerAddrFamilySafi": { "type": "string", "description": "The SAFI index of the entry. An implementation\n is only required to support IPv4 unicast(Value \n - 1) and VPNv4( Value - 128) address families.", "x-yang-type": "CISCO-BGP4-MIB:CbgpSafi" }, "cbgpPeerAddrFamilyName": { "type": "string", "description": "Implementation specific Address Family name.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } } } }, "example": { "CISCO-BGP4-MIB:cbgpPeerAddrFamilyTable": { "cbgpPeerAddrFamilyEntry": [ { "bgpPeerRemoteAddr": "192.168.1.1", "cbgpPeerAddrFamilyAfi": "192.168.1.1", "cbgpPeerAddrFamilySafi": "192.168.1.1", "cbgpPeerAddrFamilyName": "192.168.1.1" }, { "bgpPeerRemoteAddr": "192.168.1.1", "cbgpPeerAddrFamilyAfi": "192.168.1.1", "cbgpPeerAddrFamilySafi": "192.168.1.1", "cbgpPeerAddrFamilyName": "192.168.1.1" }, { "bgpPeerRemoteAddr": "192.168.1.1", "cbgpPeerAddrFamilyAfi": "192.168.1.1", "cbgpPeerAddrFamilySafi": "192.168.1.1", "cbgpPeerAddrFamilyName": "192.168.1.1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeerAddrFamilyTable", "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": "/cbgpPeerAddrFamilyTable", "x-restconf-kind": "container" }, "/data/CISCO-BGP4-MIB:cbgpPeerAddrFamilyTable/cbgpPeerAddrFamilyEntry": { "get": { "summary": "Get cbgpPeerAddrFamilyEntry list", "description": "Retrieve list of cbgpPeerAddrFamilyEntry entries from MIB", "tags": [ "CISCO-BGP4-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry is identified by an AFI/SAFI pair and\n peer address. It contains names associated with\n an address family.", "items": { "type": "object", "properties": { "bgpPeerRemoteAddr": { "type": "string", "description": "bgpPeerRemoteAddr", "x-yang-type": "leafref" }, "cbgpPeerAddrFamilyAfi": { "type": "string", "description": "The AFI index of the entry. An implementation\n is only required to support IPv4 unicast and \n VPNv4 (Value - 1) address families.", "x-yang-type": "inet-address:InetAddressType" }, "cbgpPeerAddrFamilySafi": { "type": "string", "description": "The SAFI index of the entry. An implementation\n is only required to support IPv4 unicast(Value \n - 1) and VPNv4( Value - 128) address families.", "x-yang-type": "CISCO-BGP4-MIB:CbgpSafi" }, "cbgpPeerAddrFamilyName": { "type": "string", "description": "Implementation specific Address Family name.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } }, "example": { "CISCO-BGP4-MIB:cbgpPeerAddrFamilyEntry": [ { "bgpPeerRemoteAddr": "192.168.1.1", "cbgpPeerAddrFamilyAfi": "192.168.1.1", "cbgpPeerAddrFamilySafi": "192.168.1.1", "cbgpPeerAddrFamilyName": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeerAddrFamilyEntry", "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": "/cbgpPeerAddrFamilyTable/cbgpPeerAddrFamilyEntry", "x-restconf-kind": "container" }, "/data/CISCO-BGP4-MIB:cbgpPeerAddrFamilyPrefixTable": { "get": { "summary": "Get cbgpPeerAddrFamilyPrefixTable data", "description": "Retrieve cbgpPeerAddrFamilyPrefixTable operational data from MIB", "tags": [ "CISCO-BGP4-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains prefix related information\n related to address families supported by a peer. \n Supported address families of a peer are known \n during BGP connection establishment. When a new \n supported address family is known, this table \n is updated with a new entry. When an address \n family is not supported any more, corresponding \n entry is deleted from the table.", "properties": { "cbgpPeerAddrFamilyPrefixEntry": { "type": "array", "description": "An entry is identified by an AFI/SAFI pair and\n peer address. It contains information associated \n with route prefixes belonging to an address family.", "items": { "type": "object", "properties": { "bgpPeerRemoteAddr": { "type": "string", "description": "bgpPeerRemoteAddr", "x-yang-type": "leafref" }, "cbgpPeerAddrFamilyAfi": { "type": "string", "description": "cbgpPeerAddrFamilyAfi", "x-yang-type": "leafref" }, "cbgpPeerAddrFamilySafi": { "type": "string", "description": "cbgpPeerAddrFamilySafi", "x-yang-type": "leafref" }, "cbgpPeerAcceptedPrefixes": { "type": "integer", "description": "Number of accepted route prefixes on this connection,\n which belong to an address family.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerDeniedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix, which\n belongs to an address family, received on this \n connection is denied. It is initialized to zero when \n the connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerPrefixAdminLimit": { "type": "integer", "description": "Max number of route prefixes accepted for an address\n family on this connection.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerPrefixThreshold": { "type": "integer", "description": "Prefix threshold value (%) for an address family\n on this connection at which warning message stating\n the prefix count is crossed the threshold or \n corresponding SNMP notification is generated.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerPrefixClearThreshold": { "type": "integer", "description": "Prefix threshold value (%) for an address family\n on this connection at which SNMP clear notification\n is generated if prefix threshold notification is\n already generated.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerAdvertisedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family is advertised\n on this connection. It is initialized to zero when \n the connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerSuppressedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family is suppressed\n from being sent on this connection. It is \n initialized to zero when the connection is undergone\n a hard reset.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerWithdrawnPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family, is withdrawn on\n this connection. It is initialized to zero when the\n connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "CISCO-BGP4-MIB:cbgpPeerAddrFamilyPrefixTable": { "cbgpPeerAddrFamilyPrefixEntry": [ { "bgpPeerRemoteAddr": "192.168.1.1", "cbgpPeerAddrFamilyAfi": "192.168.1.1", "cbgpPeerAddrFamilySafi": "192.168.1.1", "cbgpPeerAcceptedPrefixes": 0, "cbgpPeerDeniedPrefixes": 0, "cbgpPeerPrefixAdminLimit": 1, "cbgpPeerPrefixThreshold": 0, "cbgpPeerPrefixClearThreshold": 0, "cbgpPeerAdvertisedPrefixes": 0, "cbgpPeerSuppressedPrefixes": 0, "cbgpPeerWithdrawnPrefixes": 0 }, { "bgpPeerRemoteAddr": "192.168.1.1", "cbgpPeerAddrFamilyAfi": "192.168.1.1", "cbgpPeerAddrFamilySafi": "192.168.1.1", "cbgpPeerAcceptedPrefixes": 0, "cbgpPeerDeniedPrefixes": 0, "cbgpPeerPrefixAdminLimit": 1, "cbgpPeerPrefixThreshold": 0, "cbgpPeerPrefixClearThreshold": 0, "cbgpPeerAdvertisedPrefixes": 0, "cbgpPeerSuppressedPrefixes": 0, "cbgpPeerWithdrawnPrefixes": 0 }, { "bgpPeerRemoteAddr": "192.168.1.1", "cbgpPeerAddrFamilyAfi": "192.168.1.1", "cbgpPeerAddrFamilySafi": "192.168.1.1", "cbgpPeerAcceptedPrefixes": 0, "cbgpPeerDeniedPrefixes": 0, "cbgpPeerPrefixAdminLimit": 1, "cbgpPeerPrefixThreshold": 0, "cbgpPeerPrefixClearThreshold": 0, "cbgpPeerAdvertisedPrefixes": 0, "cbgpPeerSuppressedPrefixes": 0, "cbgpPeerWithdrawnPrefixes": 0 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeerAddrFamilyPrefixTable", "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": "/cbgpPeerAddrFamilyPrefixTable", "x-restconf-kind": "container" }, "/data/CISCO-BGP4-MIB:cbgpPeerAddrFamilyPrefixTable/cbgpPeerAddrFamilyPrefixEntry": { "get": { "summary": "Get cbgpPeerAddrFamilyPrefixEntry list", "description": "Retrieve list of cbgpPeerAddrFamilyPrefixEntry entries from MIB", "tags": [ "CISCO-BGP4-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry is identified by an AFI/SAFI pair and\n peer address. It contains information associated \n with route prefixes belonging to an address family.", "items": { "type": "object", "properties": { "bgpPeerRemoteAddr": { "type": "string", "description": "bgpPeerRemoteAddr", "x-yang-type": "leafref" }, "cbgpPeerAddrFamilyAfi": { "type": "string", "description": "cbgpPeerAddrFamilyAfi", "x-yang-type": "leafref" }, "cbgpPeerAddrFamilySafi": { "type": "string", "description": "cbgpPeerAddrFamilySafi", "x-yang-type": "leafref" }, "cbgpPeerAcceptedPrefixes": { "type": "integer", "description": "Number of accepted route prefixes on this connection,\n which belong to an address family.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerDeniedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix, which\n belongs to an address family, received on this \n connection is denied. It is initialized to zero when \n the connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerPrefixAdminLimit": { "type": "integer", "description": "Max number of route prefixes accepted for an address\n family on this connection.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerPrefixThreshold": { "type": "integer", "description": "Prefix threshold value (%) for an address family\n on this connection at which warning message stating\n the prefix count is crossed the threshold or \n corresponding SNMP notification is generated.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerPrefixClearThreshold": { "type": "integer", "description": "Prefix threshold value (%) for an address family\n on this connection at which SNMP clear notification\n is generated if prefix threshold notification is\n already generated.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerAdvertisedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family is advertised\n on this connection. It is initialized to zero when \n the connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerSuppressedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family is suppressed\n from being sent on this connection. It is \n initialized to zero when the connection is undergone\n a hard reset.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerWithdrawnPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family, is withdrawn on\n this connection. It is initialized to zero when the\n connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-BGP4-MIB:cbgpPeerAddrFamilyPrefixEntry": [ { "bgpPeerRemoteAddr": "192.168.1.1", "cbgpPeerAddrFamilyAfi": "192.168.1.1", "cbgpPeerAddrFamilySafi": "192.168.1.1", "cbgpPeerAcceptedPrefixes": 0, "cbgpPeerDeniedPrefixes": 0, "cbgpPeerPrefixAdminLimit": 1, "cbgpPeerPrefixThreshold": 0, "cbgpPeerPrefixClearThreshold": 0, "cbgpPeerAdvertisedPrefixes": 0, "cbgpPeerSuppressedPrefixes": 0, "cbgpPeerWithdrawnPrefixes": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeerAddrFamilyPrefixEntry", "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": "/cbgpPeerAddrFamilyPrefixTable/cbgpPeerAddrFamilyPrefixEntry", "x-restconf-kind": "container" }, "/data/CISCO-BGP4-MIB:cbgpPeer2Table": { "get": { "summary": "Get cbgpPeer2Table data", "description": "Retrieve cbgpPeer2Table operational data from MIB", "tags": [ "CISCO-BGP4-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "BGP peer table. This table contains,\n one entry per BGP peer, information about\n the connections with BGP peers.", "properties": { "cbgpPeer2Entry": { "type": "array", "description": "Entry containing information about the\n connection with a BGP peer.", "items": { "type": "object", "properties": { "cbgpPeer2Type": { "type": "string", "description": "Represents the type of Peer address stored\n in cbgpPeer2Entry.", "x-yang-type": "inet-address:InetAddressType" }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "The remote IP address of this entry's BGP\n peer.", "x-yang-type": "inet-address:InetAddress" }, "cbgpPeer2State": { "type": "string", "description": "The BGP peer connection state." }, "cbgpPeer2AdminStatus": { "type": "string", "description": "The desired state of the BGP connection.\n A transition from 'stop' to 'start' will cause\n the BGP Manual Start Event to be generated.\n A transition from 'start' to 'stop' will cause\n the BGP Manual Stop Event to be generated.\n This parameter can be used to restart BGP peer\n connections. Care should be used in providing\n write access to this object without adequate\n authentication." }, "cbgpPeer2NegotiatedVersion": { "type": "integer", "description": "The negotiated version of BGP running between\n the two peers.\n \n This entry MUST be zero (0) unless the\n cbgpPeer2State is in the openconfirm or the\n established state.\n \n Note that legal values for this object are\n between 0 and 255.", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2LocalAddr": { "type": "string", "description": "The local IP address of this entry's BGP\n connection.", "x-yang-type": "inet-address:InetAddress" }, "cbgpPeer2LocalPort": { "type": "string", "description": "The local port for the TCP connection between\n the BGP peers.", "format": "inet:port-number" }, "cbgpPeer2LocalAs": { "type": "string", "description": "The local AS number for this session.", "format": "inet:as-number" }, "cbgpPeer2LocalIdentifier": { "type": "string", "description": "The BGP Identifier of this entry's BGP peer.", "format": "inet:ipv4-address" }, "cbgpPeer2RemotePort": { "type": "string", "description": "The remote port for the TCP connection\n between the BGP peers. Note that the\n objects cbgpPeer2LocalAddr,\n cbgpPeer2LocalPort, cbgpPeer2RemoteAddr, and\n cbgpPeer2RemotePort provide the appropriate\n reference to the standard MIB TCP\n connection table.", "format": "inet:port-number" }, "cbgpPeer2RemoteAs": { "type": "string", "description": "The remote autonomous system number received in\n the BGP OPEN message.", "format": "inet:as-number" }, "cbgpPeer2RemoteIdentifier": { "type": "string", "description": "The BGP Identifier of this entry's BGP peer.\n This entry MUST be 0.0.0.0 unless the\n cbgpPeer2State is in the openconfirm or the\n established state.", "format": "inet:ipv4-address" }, "cbgpPeer2InUpdates": { "type": "integer", "description": "The number of BGP UPDATE messages\n received on this connection.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2OutUpdates": { "type": "integer", "description": "The number of BGP UPDATE messages\n transmitted on this connection.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2InTotalMessages": { "type": "integer", "description": "The total number of messages received\n from the remote peer on this connection.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2OutTotalMessages": { "type": "integer", "description": "The total number of messages transmitted to\n the remote peer on this connection.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2LastError": { "type": "string", "description": "The last error code and subcode seen by this\n peer on this connection. If no error has\n occurred, this field is zero. Otherwise, the\n first byte of this two byte OCTET STRING\n contains the error code, and the second byte\n contains the subcode.", "format": "binary" }, "cbgpPeer2FsmEstablishedTransitions": { "type": "integer", "description": "The total number of times the BGP FSM\n transitioned into the established state\n for this peer.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2FsmEstablishedTime": { "type": "integer", "description": "This timer indicates how long (in\n seconds) this peer has been in the\n established state or how long\n since this peer was last in the\n established state. It is set to zero when\n a new peer is configured or when the router is\n booted.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2ConnectRetryInterval": { "type": "integer", "description": "Time interval (in seconds) for the\n ConnectRetry timer. The suggested value\n for this timer is 120 seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2HoldTime": { "type": "integer", "description": "Time interval (in seconds) for the Hold\n Timer established with the peer. The\n value of this object is calculated by this\n BGP speaker, using the smaller of the\n values in cbgpPeer2HoldTimeConfigured and the\n Hold Time received in the OPEN message.\n \n This value must be at least three seconds\n if it is not zero (0).\n \n If the Hold Timer has not been established\n with the peer this object MUST have a value\n of zero (0).\n \n If the cbgpPeer2HoldTimeConfigured object has\n a value of (0), then this object MUST have a\n value of (0).", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2KeepAlive": { "type": "integer", "description": "Time interval (in seconds) for the KeepAlive\n timer established with the peer. The value\n of this object is calculated by this BGP\n speaker such that, when compared with\n cbgpPeer2HoldTime, it has the same proportion\n that cbgpPeer2KeepAliveConfigured has,\n compared with cbgpPeer2HoldTimeConfigured.\n \n If the KeepAlive timer has not been established\n with the peer, this object MUST have a value\n of zero (0).\n \n If the of cbgpPeer2KeepAliveConfigured object\n has a value of (0), then this object MUST have\n a value of (0).", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2HoldTimeConfigured": { "type": "integer", "description": "Time interval (in seconds) for the Hold Time\n configured for this BGP speaker with this\n peer. This value is placed in an OPEN\n message sent to this peer by this BGP\n speaker, and is compared with the Hold\n Time field in an OPEN message received\n from the peer when determining the Hold\n Time (cbgpPeer2HoldTime) with the peer.\n This value must not be less than three\n seconds if it is not zero (0). If it is\n zero (0), the Hold Time is NOT to be\n established with the peer. The suggested\n value for this timer is 90 seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2KeepAliveConfigured": { "type": "integer", "description": "Time interval (in seconds) for the\n KeepAlive timer configured for this BGP\n speaker with this peer. The value of this\n object will only determine the\n KEEPALIVE messages' frequency relative to\n the value specified in\n cbgpPeer2HoldTimeConfigured; the actual\n time interval for the KEEPALIVE messages is\n indicated by cbgpPeer2KeepAlive. A\n reasonable maximum value for this timer\n would be one third of that of\n cbgpPeer2HoldTimeConfigured.\n If the value of this object is zero (0),\n no periodical KEEPALIVE messages are sent\n to the peer after the BGP connection has\n been established. The suggested value for\n this timer is 30 seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2MinASOriginationInterval": { "type": "integer", "description": "Time interval (in seconds) for the\n MinASOriginationInterval timer.\n The suggested value for this timer is 15\n seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2MinRouteAdvertisementInterval": { "type": "integer", "description": "Time interval (in seconds) for the\n MinRouteAdvertisementInterval timer.\n The suggested value for this timer is 30\n seconds for EBGP connections and 5\n seconds for IBGP connections.", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2InUpdateElapsedTime": { "type": "integer", "description": "Elapsed time (in seconds) since the last BGP\n UPDATE message was received from the peer.\n Each time cbgpPeer2InUpdates is incremented,\n the value of this object is set to zero (0).", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2LastErrorTxt": { "type": "string", "description": "Implementation specific error description for\n bgpPeerLastErrorReceived.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cbgpPeer2PrevState": { "type": "string", "description": "The BGP peer connection previous state." } } } } } }, "example": { "CISCO-BGP4-MIB:cbgpPeer2Table": { "cbgpPeer2Entry": [ { "cbgpPeer2Type": "ethernetCsmacd(6)", "cbgpPeer2RemoteAddr": "192.168.1.1", "cbgpPeer2State": "up(1)", "cbgpPeer2AdminStatus": "up(1)", "cbgpPeer2NegotiatedVersion": -2147483648, "cbgpPeer2LocalAddr": "192.168.1.1", "cbgpPeer2LocalPort": "example-string", "cbgpPeer2LocalAs": "example-string", "cbgpPeer2LocalIdentifier": "example-string", "cbgpPeer2RemotePort": "example-string", "cbgpPeer2RemoteAs": "example-string", "cbgpPeer2RemoteIdentifier": "example-string", "cbgpPeer2InUpdates": 0, "cbgpPeer2OutUpdates": 0, "cbgpPeer2InTotalMessages": 0, "cbgpPeer2OutTotalMessages": 0, "cbgpPeer2LastError": "example-string", "cbgpPeer2FsmEstablishedTransitions": 0, "cbgpPeer2FsmEstablishedTime": 0, "cbgpPeer2ConnectRetryInterval": -2147483648, "cbgpPeer2HoldTime": -2147483648, "cbgpPeer2KeepAlive": -2147483648, "cbgpPeer2HoldTimeConfigured": -2147483648, "cbgpPeer2KeepAliveConfigured": -2147483648, "cbgpPeer2MinASOriginationInterval": -2147483648, "cbgpPeer2MinRouteAdvertisementInterval": -2147483648, "cbgpPeer2InUpdateElapsedTime": 0, "cbgpPeer2LastErrorTxt": "example-string", "cbgpPeer2PrevState": "up(1)" }, { "cbgpPeer2Type": "ethernetCsmacd(6)", "cbgpPeer2RemoteAddr": "192.168.1.1", "cbgpPeer2State": "up(1)", "cbgpPeer2AdminStatus": "up(1)", "cbgpPeer2NegotiatedVersion": -2147483648, "cbgpPeer2LocalAddr": "192.168.1.1", "cbgpPeer2LocalPort": "example-string", "cbgpPeer2LocalAs": "example-string", "cbgpPeer2LocalIdentifier": "example-string", "cbgpPeer2RemotePort": "example-string", "cbgpPeer2RemoteAs": "example-string", "cbgpPeer2RemoteIdentifier": "example-string", "cbgpPeer2InUpdates": 0, "cbgpPeer2OutUpdates": 0, "cbgpPeer2InTotalMessages": 0, "cbgpPeer2OutTotalMessages": 0, "cbgpPeer2LastError": "example-string", "cbgpPeer2FsmEstablishedTransitions": 0, "cbgpPeer2FsmEstablishedTime": 0, "cbgpPeer2ConnectRetryInterval": -2147483648, "cbgpPeer2HoldTime": -2147483648, "cbgpPeer2KeepAlive": -2147483648, "cbgpPeer2HoldTimeConfigured": -2147483648, "cbgpPeer2KeepAliveConfigured": -2147483648, "cbgpPeer2MinASOriginationInterval": -2147483648, "cbgpPeer2MinRouteAdvertisementInterval": -2147483648, "cbgpPeer2InUpdateElapsedTime": 0, "cbgpPeer2LastErrorTxt": "example-string", "cbgpPeer2PrevState": "up(1)" }, { "cbgpPeer2Type": "ethernetCsmacd(6)", "cbgpPeer2RemoteAddr": "192.168.1.1", "cbgpPeer2State": "up(1)", "cbgpPeer2AdminStatus": "up(1)", "cbgpPeer2NegotiatedVersion": -2147483648, "cbgpPeer2LocalAddr": "192.168.1.1", "cbgpPeer2LocalPort": "example-string", "cbgpPeer2LocalAs": "example-string", "cbgpPeer2LocalIdentifier": "example-string", "cbgpPeer2RemotePort": "example-string", "cbgpPeer2RemoteAs": "example-string", "cbgpPeer2RemoteIdentifier": "example-string", "cbgpPeer2InUpdates": 0, "cbgpPeer2OutUpdates": 0, "cbgpPeer2InTotalMessages": 0, "cbgpPeer2OutTotalMessages": 0, "cbgpPeer2LastError": "example-string", "cbgpPeer2FsmEstablishedTransitions": 0, "cbgpPeer2FsmEstablishedTime": 0, "cbgpPeer2ConnectRetryInterval": -2147483648, "cbgpPeer2HoldTime": -2147483648, "cbgpPeer2KeepAlive": -2147483648, "cbgpPeer2HoldTimeConfigured": -2147483648, "cbgpPeer2KeepAliveConfigured": -2147483648, "cbgpPeer2MinASOriginationInterval": -2147483648, "cbgpPeer2MinRouteAdvertisementInterval": -2147483648, "cbgpPeer2InUpdateElapsedTime": 0, "cbgpPeer2LastErrorTxt": "example-string", "cbgpPeer2PrevState": "up(1)" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeer2Table", "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": "/cbgpPeer2Table", "x-restconf-kind": "container" }, "/data/CISCO-BGP4-MIB:cbgpPeer2Table/cbgpPeer2Entry": { "get": { "summary": "Get cbgpPeer2Entry list", "description": "Retrieve list of cbgpPeer2Entry entries from MIB", "tags": [ "CISCO-BGP4-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Entry containing information about the\n connection with a BGP peer.", "items": { "type": "object", "properties": { "cbgpPeer2Type": { "type": "string", "description": "Represents the type of Peer address stored\n in cbgpPeer2Entry.", "x-yang-type": "inet-address:InetAddressType" }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "The remote IP address of this entry's BGP\n peer.", "x-yang-type": "inet-address:InetAddress" }, "cbgpPeer2State": { "type": "string", "description": "The BGP peer connection state." }, "cbgpPeer2AdminStatus": { "type": "string", "description": "The desired state of the BGP connection.\n A transition from 'stop' to 'start' will cause\n the BGP Manual Start Event to be generated.\n A transition from 'start' to 'stop' will cause\n the BGP Manual Stop Event to be generated.\n This parameter can be used to restart BGP peer\n connections. Care should be used in providing\n write access to this object without adequate\n authentication." }, "cbgpPeer2NegotiatedVersion": { "type": "integer", "description": "The negotiated version of BGP running between\n the two peers.\n \n This entry MUST be zero (0) unless the\n cbgpPeer2State is in the openconfirm or the\n established state.\n \n Note that legal values for this object are\n between 0 and 255.", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2LocalAddr": { "type": "string", "description": "The local IP address of this entry's BGP\n connection.", "x-yang-type": "inet-address:InetAddress" }, "cbgpPeer2LocalPort": { "type": "string", "description": "The local port for the TCP connection between\n the BGP peers.", "format": "inet:port-number" }, "cbgpPeer2LocalAs": { "type": "string", "description": "The local AS number for this session.", "format": "inet:as-number" }, "cbgpPeer2LocalIdentifier": { "type": "string", "description": "The BGP Identifier of this entry's BGP peer.", "format": "inet:ipv4-address" }, "cbgpPeer2RemotePort": { "type": "string", "description": "The remote port for the TCP connection\n between the BGP peers. Note that the\n objects cbgpPeer2LocalAddr,\n cbgpPeer2LocalPort, cbgpPeer2RemoteAddr, and\n cbgpPeer2RemotePort provide the appropriate\n reference to the standard MIB TCP\n connection table.", "format": "inet:port-number" }, "cbgpPeer2RemoteAs": { "type": "string", "description": "The remote autonomous system number received in\n the BGP OPEN message.", "format": "inet:as-number" }, "cbgpPeer2RemoteIdentifier": { "type": "string", "description": "The BGP Identifier of this entry's BGP peer.\n This entry MUST be 0.0.0.0 unless the\n cbgpPeer2State is in the openconfirm or the\n established state.", "format": "inet:ipv4-address" }, "cbgpPeer2InUpdates": { "type": "integer", "description": "The number of BGP UPDATE messages\n received on this connection.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2OutUpdates": { "type": "integer", "description": "The number of BGP UPDATE messages\n transmitted on this connection.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2InTotalMessages": { "type": "integer", "description": "The total number of messages received\n from the remote peer on this connection.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2OutTotalMessages": { "type": "integer", "description": "The total number of messages transmitted to\n the remote peer on this connection.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2LastError": { "type": "string", "description": "The last error code and subcode seen by this\n peer on this connection. If no error has\n occurred, this field is zero. Otherwise, the\n first byte of this two byte OCTET STRING\n contains the error code, and the second byte\n contains the subcode.", "format": "binary" }, "cbgpPeer2FsmEstablishedTransitions": { "type": "integer", "description": "The total number of times the BGP FSM\n transitioned into the established state\n for this peer.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2FsmEstablishedTime": { "type": "integer", "description": "This timer indicates how long (in\n seconds) this peer has been in the\n established state or how long\n since this peer was last in the\n established state. It is set to zero when\n a new peer is configured or when the router is\n booted.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2ConnectRetryInterval": { "type": "integer", "description": "Time interval (in seconds) for the\n ConnectRetry timer. The suggested value\n for this timer is 120 seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2HoldTime": { "type": "integer", "description": "Time interval (in seconds) for the Hold\n Timer established with the peer. The\n value of this object is calculated by this\n BGP speaker, using the smaller of the\n values in cbgpPeer2HoldTimeConfigured and the\n Hold Time received in the OPEN message.\n \n This value must be at least three seconds\n if it is not zero (0).\n \n If the Hold Timer has not been established\n with the peer this object MUST have a value\n of zero (0).\n \n If the cbgpPeer2HoldTimeConfigured object has\n a value of (0), then this object MUST have a\n value of (0).", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2KeepAlive": { "type": "integer", "description": "Time interval (in seconds) for the KeepAlive\n timer established with the peer. The value\n of this object is calculated by this BGP\n speaker such that, when compared with\n cbgpPeer2HoldTime, it has the same proportion\n that cbgpPeer2KeepAliveConfigured has,\n compared with cbgpPeer2HoldTimeConfigured.\n \n If the KeepAlive timer has not been established\n with the peer, this object MUST have a value\n of zero (0).\n \n If the of cbgpPeer2KeepAliveConfigured object\n has a value of (0), then this object MUST have\n a value of (0).", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2HoldTimeConfigured": { "type": "integer", "description": "Time interval (in seconds) for the Hold Time\n configured for this BGP speaker with this\n peer. This value is placed in an OPEN\n message sent to this peer by this BGP\n speaker, and is compared with the Hold\n Time field in an OPEN message received\n from the peer when determining the Hold\n Time (cbgpPeer2HoldTime) with the peer.\n This value must not be less than three\n seconds if it is not zero (0). If it is\n zero (0), the Hold Time is NOT to be\n established with the peer. The suggested\n value for this timer is 90 seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2KeepAliveConfigured": { "type": "integer", "description": "Time interval (in seconds) for the\n KeepAlive timer configured for this BGP\n speaker with this peer. The value of this\n object will only determine the\n KEEPALIVE messages' frequency relative to\n the value specified in\n cbgpPeer2HoldTimeConfigured; the actual\n time interval for the KEEPALIVE messages is\n indicated by cbgpPeer2KeepAlive. A\n reasonable maximum value for this timer\n would be one third of that of\n cbgpPeer2HoldTimeConfigured.\n If the value of this object is zero (0),\n no periodical KEEPALIVE messages are sent\n to the peer after the BGP connection has\n been established. The suggested value for\n this timer is 30 seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2MinASOriginationInterval": { "type": "integer", "description": "Time interval (in seconds) for the\n MinASOriginationInterval timer.\n The suggested value for this timer is 15\n seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2MinRouteAdvertisementInterval": { "type": "integer", "description": "Time interval (in seconds) for the\n MinRouteAdvertisementInterval timer.\n The suggested value for this timer is 30\n seconds for EBGP connections and 5\n seconds for IBGP connections.", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2InUpdateElapsedTime": { "type": "integer", "description": "Elapsed time (in seconds) since the last BGP\n UPDATE message was received from the peer.\n Each time cbgpPeer2InUpdates is incremented,\n the value of this object is set to zero (0).", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2LastErrorTxt": { "type": "string", "description": "Implementation specific error description for\n bgpPeerLastErrorReceived.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cbgpPeer2PrevState": { "type": "string", "description": "The BGP peer connection previous state." } } } }, "example": { "CISCO-BGP4-MIB:cbgpPeer2Entry": [ { "cbgpPeer2Type": "ethernetCsmacd(6)", "cbgpPeer2RemoteAddr": "192.168.1.1", "cbgpPeer2State": "up(1)", "cbgpPeer2AdminStatus": "up(1)", "cbgpPeer2NegotiatedVersion": -2147483648, "cbgpPeer2LocalAddr": "192.168.1.1", "cbgpPeer2LocalPort": "example-string", "cbgpPeer2LocalAs": "example-string", "cbgpPeer2LocalIdentifier": "example-string", "cbgpPeer2RemotePort": "example-string", "cbgpPeer2RemoteAs": "example-string", "cbgpPeer2RemoteIdentifier": "example-string", "cbgpPeer2InUpdates": 0, "cbgpPeer2OutUpdates": 0, "cbgpPeer2InTotalMessages": 0, "cbgpPeer2OutTotalMessages": 0, "cbgpPeer2LastError": "example-string", "cbgpPeer2FsmEstablishedTransitions": 0, "cbgpPeer2FsmEstablishedTime": 0, "cbgpPeer2ConnectRetryInterval": -2147483648, "cbgpPeer2HoldTime": -2147483648, "cbgpPeer2KeepAlive": -2147483648, "cbgpPeer2HoldTimeConfigured": -2147483648, "cbgpPeer2KeepAliveConfigured": -2147483648, "cbgpPeer2MinASOriginationInterval": -2147483648, "cbgpPeer2MinRouteAdvertisementInterval": -2147483648, "cbgpPeer2InUpdateElapsedTime": 0, "cbgpPeer2LastErrorTxt": "example-string", "cbgpPeer2PrevState": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeer2Entry", "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": "/cbgpPeer2Table/cbgpPeer2Entry", "x-restconf-kind": "container" }, "/data/CISCO-BGP4-MIB:cbgpPeer2CapsTable": { "get": { "summary": "Get cbgpPeer2CapsTable data", "description": "Retrieve cbgpPeer2CapsTable operational data from MIB", "tags": [ "CISCO-BGP4-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "cbgpPeer2CapsTable", "properties": { "cbgpPeer2CapsEntry": { "type": "array", "description": "Each entry represents a capability received from a\n peer with a particular code and an index. When a\n capability is received multiple times with different\n values during a BGP connection establishment,\n corresponding entries are differentiated with indices.", "items": { "type": "object", "properties": { "cbgpPeer2Type": { "type": "string", "description": "cbgpPeer2Type", "x-yang-type": "leafref" }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "cbgpPeer2RemoteAddr", "x-yang-type": "leafref" }, "cbgpPeer2CapCode": { "type": "string", "description": "The BGP Capability Advertisement Capability Code." }, "cbgpPeer2CapIndex": { "type": "integer", "description": "Multiple instances of a given capability may be\n sent by a BGP speaker. This variable is used\n to index them.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2CapValue": { "type": "string", "description": "The value of the announced capability. This\n MIB object value is organized as given below,\n Capability : Route Refresh Capability\n 4-Byte AS Capability\n Null string\n Capability : Multiprotocol Extensions\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n Capability : Graceful Restart\n +----------------------------------+\n | Restart Flags (4 bits) |\n +----------------------------------+\n | Restart Time in seconds (12 bits)|\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Flags for Address Family (8 bits)|\n +----------------------------------+\n | ... |\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Flags for Address Family (8 bits)|\n +----------------------------------+\n Capability : Additional Paths\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Send/Receive (8 bits) |\n +----------------------------------+", "format": "binary" } } } } } }, "example": { "CISCO-BGP4-MIB:cbgpPeer2CapsTable": { "cbgpPeer2CapsEntry": [ { "cbgpPeer2Type": "ethernetCsmacd(6)", "cbgpPeer2RemoteAddr": "192.168.1.1", "cbgpPeer2CapCode": "example-string", "cbgpPeer2CapIndex": 1, "cbgpPeer2CapValue": "example-string" }, { "cbgpPeer2Type": "ethernetCsmacd(6)", "cbgpPeer2RemoteAddr": "192.168.1.1", "cbgpPeer2CapCode": "example-string", "cbgpPeer2CapIndex": 2, "cbgpPeer2CapValue": "example-string" }, { "cbgpPeer2Type": "ethernetCsmacd(6)", "cbgpPeer2RemoteAddr": "192.168.1.1", "cbgpPeer2CapCode": "example-string", "cbgpPeer2CapIndex": 3, "cbgpPeer2CapValue": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeer2CapsTable", "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": "/cbgpPeer2CapsTable", "x-restconf-kind": "container" }, "/data/CISCO-BGP4-MIB:cbgpPeer2CapsTable/cbgpPeer2CapsEntry": { "get": { "summary": "Get cbgpPeer2CapsEntry list", "description": "Retrieve list of cbgpPeer2CapsEntry entries from MIB", "tags": [ "CISCO-BGP4-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Each entry represents a capability received from a\n peer with a particular code and an index. When a\n capability is received multiple times with different\n values during a BGP connection establishment,\n corresponding entries are differentiated with indices.", "items": { "type": "object", "properties": { "cbgpPeer2Type": { "type": "string", "description": "cbgpPeer2Type", "x-yang-type": "leafref" }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "cbgpPeer2RemoteAddr", "x-yang-type": "leafref" }, "cbgpPeer2CapCode": { "type": "string", "description": "The BGP Capability Advertisement Capability Code." }, "cbgpPeer2CapIndex": { "type": "integer", "description": "Multiple instances of a given capability may be\n sent by a BGP speaker. This variable is used\n to index them.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2CapValue": { "type": "string", "description": "The value of the announced capability. This\n MIB object value is organized as given below,\n Capability : Route Refresh Capability\n 4-Byte AS Capability\n Null string\n Capability : Multiprotocol Extensions\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n Capability : Graceful Restart\n +----------------------------------+\n | Restart Flags (4 bits) |\n +----------------------------------+\n | Restart Time in seconds (12 bits)|\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Flags for Address Family (8 bits)|\n +----------------------------------+\n | ... |\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Flags for Address Family (8 bits)|\n +----------------------------------+\n Capability : Additional Paths\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Send/Receive (8 bits) |\n +----------------------------------+", "format": "binary" } } } }, "example": { "CISCO-BGP4-MIB:cbgpPeer2CapsEntry": [ { "cbgpPeer2Type": "ethernetCsmacd(6)", "cbgpPeer2RemoteAddr": "192.168.1.1", "cbgpPeer2CapCode": "example-string", "cbgpPeer2CapIndex": 1, "cbgpPeer2CapValue": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeer2CapsEntry", "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": "/cbgpPeer2CapsTable/cbgpPeer2CapsEntry", "x-restconf-kind": "container" }, "/data/CISCO-BGP4-MIB:cbgpPeer2AddrFamilyTable": { "get": { "summary": "Get cbgpPeer2AddrFamilyTable data", "description": "Retrieve cbgpPeer2AddrFamilyTable operational data from MIB", "tags": [ "CISCO-BGP4-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains information related to\n address families supported by a peer. Supported\n address families of a peer are known during BGP\n connection establishment. When a new supported\n address family is known, this table is updated\n with a new entry. When an address family is not\n supported any more, corresponding entry is deleted\n from the table.", "properties": { "cbgpPeer2AddrFamilyEntry": { "type": "array", "description": "An entry is identified by an AFI/SAFI pair and\n peer address. It contains names associated with\n an address family.", "items": { "type": "object", "properties": { "cbgpPeer2Type": { "type": "string", "description": "cbgpPeer2Type", "x-yang-type": "leafref" }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "cbgpPeer2RemoteAddr", "x-yang-type": "leafref" }, "cbgpPeer2AddrFamilyAfi": { "type": "string", "description": "The AFI index of the entry. An implementation\n is only required to support IPv4 unicast and\n VPNv4 (Value - 1) address families.", "x-yang-type": "inet-address:InetAddressType" }, "cbgpPeer2AddrFamilySafi": { "type": "string", "description": "The SAFI index of the entry. An implementation\n is only required to support IPv4 unicast(Value\n - 1) and VPNv4( Value - 128) address families.", "x-yang-type": "CISCO-BGP4-MIB:CbgpSafi" }, "cbgpPeer2AddrFamilyName": { "type": "string", "description": "Implementation specific Address Family name.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } } } }, "example": { "CISCO-BGP4-MIB:cbgpPeer2AddrFamilyTable": { "cbgpPeer2AddrFamilyEntry": [ { "cbgpPeer2Type": "ethernetCsmacd(6)", "cbgpPeer2RemoteAddr": "192.168.1.1", "cbgpPeer2AddrFamilyAfi": "192.168.1.1", "cbgpPeer2AddrFamilySafi": "192.168.1.1", "cbgpPeer2AddrFamilyName": "192.168.1.1" }, { "cbgpPeer2Type": "ethernetCsmacd(6)", "cbgpPeer2RemoteAddr": "192.168.1.1", "cbgpPeer2AddrFamilyAfi": "192.168.1.1", "cbgpPeer2AddrFamilySafi": "192.168.1.1", "cbgpPeer2AddrFamilyName": "192.168.1.1" }, { "cbgpPeer2Type": "ethernetCsmacd(6)", "cbgpPeer2RemoteAddr": "192.168.1.1", "cbgpPeer2AddrFamilyAfi": "192.168.1.1", "cbgpPeer2AddrFamilySafi": "192.168.1.1", "cbgpPeer2AddrFamilyName": "192.168.1.1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeer2AddrFamilyTable", "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": "/cbgpPeer2AddrFamilyTable", "x-restconf-kind": "container" }, "/data/CISCO-BGP4-MIB:cbgpPeer2AddrFamilyTable/cbgpPeer2AddrFamilyEntry": { "get": { "summary": "Get cbgpPeer2AddrFamilyEntry list", "description": "Retrieve list of cbgpPeer2AddrFamilyEntry entries from MIB", "tags": [ "CISCO-BGP4-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry is identified by an AFI/SAFI pair and\n peer address. It contains names associated with\n an address family.", "items": { "type": "object", "properties": { "cbgpPeer2Type": { "type": "string", "description": "cbgpPeer2Type", "x-yang-type": "leafref" }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "cbgpPeer2RemoteAddr", "x-yang-type": "leafref" }, "cbgpPeer2AddrFamilyAfi": { "type": "string", "description": "The AFI index of the entry. An implementation\n is only required to support IPv4 unicast and\n VPNv4 (Value - 1) address families.", "x-yang-type": "inet-address:InetAddressType" }, "cbgpPeer2AddrFamilySafi": { "type": "string", "description": "The SAFI index of the entry. An implementation\n is only required to support IPv4 unicast(Value\n - 1) and VPNv4( Value - 128) address families.", "x-yang-type": "CISCO-BGP4-MIB:CbgpSafi" }, "cbgpPeer2AddrFamilyName": { "type": "string", "description": "Implementation specific Address Family name.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } }, "example": { "CISCO-BGP4-MIB:cbgpPeer2AddrFamilyEntry": [ { "cbgpPeer2Type": "ethernetCsmacd(6)", "cbgpPeer2RemoteAddr": "192.168.1.1", "cbgpPeer2AddrFamilyAfi": "192.168.1.1", "cbgpPeer2AddrFamilySafi": "192.168.1.1", "cbgpPeer2AddrFamilyName": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeer2AddrFamilyEntry", "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": "/cbgpPeer2AddrFamilyTable/cbgpPeer2AddrFamilyEntry", "x-restconf-kind": "container" }, "/data/CISCO-BGP4-MIB:cbgpPeer2AddrFamilyPrefixTable": { "get": { "summary": "Get cbgpPeer2AddrFamilyPrefixTable data", "description": "Retrieve cbgpPeer2AddrFamilyPrefixTable operational data from MIB", "tags": [ "CISCO-BGP4-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains prefix related information\n related to address families supported by a peer.\n Supported address families of a peer are known\n during BGP connection establishment. When a new\n supported address family is known, this table\n is updated with a new entry. When an address\n family is not supported any more, corresponding\n entry is deleted from the table.", "properties": { "cbgpPeer2AddrFamilyPrefixEntry": { "type": "array", "description": "An entry is identified by an AFI/SAFI pair and\n peer address. It contains information associated\n with route prefixes belonging to an address family.", "items": { "type": "object", "properties": { "cbgpPeer2Type": { "type": "string", "description": "cbgpPeer2Type", "x-yang-type": "leafref" }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "cbgpPeer2RemoteAddr", "x-yang-type": "leafref" }, "cbgpPeer2AddrFamilyAfi": { "type": "string", "description": "cbgpPeer2AddrFamilyAfi", "x-yang-type": "leafref" }, "cbgpPeer2AddrFamilySafi": { "type": "string", "description": "cbgpPeer2AddrFamilySafi", "x-yang-type": "leafref" }, "cbgpPeer2AcceptedPrefixes": { "type": "integer", "description": "Number of accepted route prefixes on this connection,\n which belong to an address family.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2DeniedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix, which\n belongs to an address family, received on this\n connection is denied. It is initialized to zero when\n the connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2PrefixAdminLimit": { "type": "integer", "description": "Max number of route prefixes accepted for an address\n family on this connection.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2PrefixThreshold": { "type": "integer", "description": "Prefix threshold value (%) for an address family\n on this connection at which warning message stating\n the prefix count is crossed the threshold or\n corresponding SNMP notification is generated.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2PrefixClearThreshold": { "type": "integer", "description": "Prefix threshold value (%) for an address family\n on this connection at which SNMP clear notification\n is generated if prefix threshold notification is\n already generated.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2AdvertisedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family is advertised\n on this connection. It is initialized to zero when\n the connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2SuppressedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family is suppressed\n from being sent on this connection. It is\n initialized to zero when the connection is undergone\n a hard reset.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2WithdrawnPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family, is withdrawn on\n this connection. It is initialized to zero when the\n connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "CISCO-BGP4-MIB:cbgpPeer2AddrFamilyPrefixTable": { "cbgpPeer2AddrFamilyPrefixEntry": [ { "cbgpPeer2Type": "ethernetCsmacd(6)", "cbgpPeer2RemoteAddr": "192.168.1.1", "cbgpPeer2AddrFamilyAfi": "192.168.1.1", "cbgpPeer2AddrFamilySafi": "192.168.1.1", "cbgpPeer2AcceptedPrefixes": 0, "cbgpPeer2DeniedPrefixes": 0, "cbgpPeer2PrefixAdminLimit": 1, "cbgpPeer2PrefixThreshold": 0, "cbgpPeer2PrefixClearThreshold": 0, "cbgpPeer2AdvertisedPrefixes": 0, "cbgpPeer2SuppressedPrefixes": 0, "cbgpPeer2WithdrawnPrefixes": 0 }, { "cbgpPeer2Type": "ethernetCsmacd(6)", "cbgpPeer2RemoteAddr": "192.168.1.1", "cbgpPeer2AddrFamilyAfi": "192.168.1.1", "cbgpPeer2AddrFamilySafi": "192.168.1.1", "cbgpPeer2AcceptedPrefixes": 0, "cbgpPeer2DeniedPrefixes": 0, "cbgpPeer2PrefixAdminLimit": 1, "cbgpPeer2PrefixThreshold": 0, "cbgpPeer2PrefixClearThreshold": 0, "cbgpPeer2AdvertisedPrefixes": 0, "cbgpPeer2SuppressedPrefixes": 0, "cbgpPeer2WithdrawnPrefixes": 0 }, { "cbgpPeer2Type": "ethernetCsmacd(6)", "cbgpPeer2RemoteAddr": "192.168.1.1", "cbgpPeer2AddrFamilyAfi": "192.168.1.1", "cbgpPeer2AddrFamilySafi": "192.168.1.1", "cbgpPeer2AcceptedPrefixes": 0, "cbgpPeer2DeniedPrefixes": 0, "cbgpPeer2PrefixAdminLimit": 1, "cbgpPeer2PrefixThreshold": 0, "cbgpPeer2PrefixClearThreshold": 0, "cbgpPeer2AdvertisedPrefixes": 0, "cbgpPeer2SuppressedPrefixes": 0, "cbgpPeer2WithdrawnPrefixes": 0 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeer2AddrFamilyPrefixTable", "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": "/cbgpPeer2AddrFamilyPrefixTable", "x-restconf-kind": "container" }, "/data/CISCO-BGP4-MIB:cbgpPeer2AddrFamilyPrefixTable/cbgpPeer2AddrFamilyPrefixEntry": { "get": { "summary": "Get cbgpPeer2AddrFamilyPrefixEntry list", "description": "Retrieve list of cbgpPeer2AddrFamilyPrefixEntry entries from MIB", "tags": [ "CISCO-BGP4-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry is identified by an AFI/SAFI pair and\n peer address. It contains information associated\n with route prefixes belonging to an address family.", "items": { "type": "object", "properties": { "cbgpPeer2Type": { "type": "string", "description": "cbgpPeer2Type", "x-yang-type": "leafref" }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "cbgpPeer2RemoteAddr", "x-yang-type": "leafref" }, "cbgpPeer2AddrFamilyAfi": { "type": "string", "description": "cbgpPeer2AddrFamilyAfi", "x-yang-type": "leafref" }, "cbgpPeer2AddrFamilySafi": { "type": "string", "description": "cbgpPeer2AddrFamilySafi", "x-yang-type": "leafref" }, "cbgpPeer2AcceptedPrefixes": { "type": "integer", "description": "Number of accepted route prefixes on this connection,\n which belong to an address family.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2DeniedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix, which\n belongs to an address family, received on this\n connection is denied. It is initialized to zero when\n the connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2PrefixAdminLimit": { "type": "integer", "description": "Max number of route prefixes accepted for an address\n family on this connection.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2PrefixThreshold": { "type": "integer", "description": "Prefix threshold value (%) for an address family\n on this connection at which warning message stating\n the prefix count is crossed the threshold or\n corresponding SNMP notification is generated.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2PrefixClearThreshold": { "type": "integer", "description": "Prefix threshold value (%) for an address family\n on this connection at which SNMP clear notification\n is generated if prefix threshold notification is\n already generated.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2AdvertisedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family is advertised\n on this connection. It is initialized to zero when\n the connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2SuppressedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family is suppressed\n from being sent on this connection. It is\n initialized to zero when the connection is undergone\n a hard reset.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2WithdrawnPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family, is withdrawn on\n this connection. It is initialized to zero when the\n connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-BGP4-MIB:cbgpPeer2AddrFamilyPrefixEntry": [ { "cbgpPeer2Type": "ethernetCsmacd(6)", "cbgpPeer2RemoteAddr": "192.168.1.1", "cbgpPeer2AddrFamilyAfi": "192.168.1.1", "cbgpPeer2AddrFamilySafi": "192.168.1.1", "cbgpPeer2AcceptedPrefixes": 0, "cbgpPeer2DeniedPrefixes": 0, "cbgpPeer2PrefixAdminLimit": 1, "cbgpPeer2PrefixThreshold": 0, "cbgpPeer2PrefixClearThreshold": 0, "cbgpPeer2AdvertisedPrefixes": 0, "cbgpPeer2SuppressedPrefixes": 0, "cbgpPeer2WithdrawnPrefixes": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeer2AddrFamilyPrefixEntry", "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": "/cbgpPeer2AddrFamilyPrefixTable/cbgpPeer2AddrFamilyPrefixEntry", "x-restconf-kind": "container" }, "/data/CISCO-BGP4-MIB:cbgpRouteEntry": { "get": { "summary": "Get cbgpRouteEntry list", "description": "Retrieve list of cbgpRouteEntry entries from MIB", "tags": [ "CISCO-BGP4-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about a path to a network received from\n a peer.", "items": { "type": "object", "properties": { "cbgpRouteAfi": { "type": "string", "description": "Represents Address Family Identifier(AFI) of the\n Network Layer protocol associated with the route.\n An implementation is only required to support IPv4\n unicast and VPNv4 (Value - 1) address families.", "x-yang-type": "inet-address:InetAddressType" }, "cbgpRouteSafi": { "type": "string", "description": "Represents Subsequent Address Family Identifier(SAFI)\n of the route. It gives additional information about\n the type of the route. An implementation is only \n required to support IPv4 unicast(Value - 1) and VPNv4(\n Value - 128) address families.", "x-yang-type": "CISCO-BGP4-MIB:CbgpSafi" }, "cbgpRoutePeerType": { "type": "string", "description": "Represents the type of Network Layer address stored\n in cbgpRoutePeer. An implementation is only required\n to support IPv4 address type(Value - 1).", "x-yang-type": "inet-address:InetAddressType" }, "cbgpRoutePeer": { "type": "string", "description": "The Network Layer address of the peer where the route\n information was learned. An implementation is only \n required to support an IPv4 peer.", "x-yang-type": "inet-address:InetAddress" }, "cbgpRouteAddrPrefix": { "type": "string", "description": "A Network Address prefix in the Network Layer\n Reachability Information field of BGP UPDATE message.\n This object is a Network Address containing the prefix\n with length specified by cbgpRouteAddrPrefixLen. Any\n bits beyond the length specified by\n cbgpRouteAddrPrefixLen are zeroed.", "x-yang-type": "CISCO-BGP4-MIB:CbgpNetworkAddress" }, "cbgpRouteAddrPrefixLen": { "type": "integer", "description": "Length in bits of the Network Address prefix in the\n Network Layer Reachability Information field.", "minimum": 0, "maximum": 4294967295 }, "cbgpRouteOrigin": { "type": "string", "description": "The ultimate origin of the route information." }, "cbgpRouteASPathSegment": { "type": "string", "description": "The sequence of AS path segments. Each AS\n path segment is represented by a triple\n .\n \n The type is a 1-octet field which has two\n possible values:\n 1 AS_SET: unordered set of ASs a route in the \n UPDATE message has traversed\n 2 AS_SEQUENCE: ordered set of ASs a route in the\n UPDATE message has traversed.\n \n The length is a 1-octet field containing the\n number of ASs in the value field.\n \n The value field contains one or more AS\n numbers, each AS is represented in the octet\n string as a pair of octets according to the\n following algorithm:\n \n first-byte-of-pair = ASNumber / 256;\n second-byte-of-pair = ASNumber & 255;", "format": "binary" }, "cbgpRouteNextHop": { "type": "string", "description": "The Network Layer address of the border router\n that should be used for the destination network.", "x-yang-type": "CISCO-BGP4-MIB:CbgpNetworkAddress" }, "cbgpRouteMedPresent": { "type": "boolean", "description": "Indicates the presence/absence of MULTI_EXIT_DISC\n attribute for the route." }, "cbgpRouteMultiExitDisc": { "type": "integer", "description": "This metric is used to discriminate between multiple\n exit points to an adjacent autonomous system. The\n value of this object is irrelevant if the value of\n of cbgpRouteMedPresent is false(2).", "minimum": 0, "maximum": 4294967295 }, "cbgpRouteLocalPrefPresent": { "type": "boolean", "description": "Indicates the presence/absence of LOCAL_PREF\n attribute for the route." }, "cbgpRouteLocalPref": { "type": "integer", "description": "The degree of preference calculated by the local BGP4\n speaker for the route. The value of this object is \n irrelevant if the value of cbgpRouteLocalPrefPresent \n is false(2).", "minimum": 0, "maximum": 4294967295 }, "cbgpRouteAtomicAggregate": { "type": "string", "description": "Whether or not the local system has selected a less\n specific route without selecting a more specific\n route." }, "cbgpRouteAggregatorAS": { "type": "integer", "description": "The AS number of the last BGP4 speaker that performed\n route aggregation. A value of zero (0) indicates the \n absence of this attribute.", "minimum": 0, "maximum": 4294967295 }, "cbgpRouteAggregatorAddrType": { "type": "string", "description": "Represents the type of Network Layer address stored\n in cbgpRouteAggregatorAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cbgpRouteAggregatorAddr": { "type": "string", "description": "The Network Layer address of the last BGP4 speaker\n that performed route aggregation. A value of all zeros\n indicates the absence of this attribute.", "x-yang-type": "inet-address:InetAddress" }, "cbgpRouteBest": { "type": "boolean", "description": "An indication of whether or not this route was chosen\n as the best BGP4 route." }, "cbgpRouteUnknownAttr": { "type": "string", "description": "One or more path attributes not understood by this\n BGP4 speaker. Size zero (0) indicates the absence of\n such attribute(s). Octets beyond the maximum size, if\n any, are not recorded by this object. \n \n Each path attribute is a triple of variable length.\n Attribute Type is a two-octet field that consists of\n the Attribute Flags octet followed by the Attribute\n Type Code octet. If the Extended Length bit of the \n Attribute Flags octet is set to 0, the third octet of \n the Path Attribute contains the length of the\n attribute data in octets. If the Extended Length bit \n of the Attribute Flags octet is set to 1, then the\n third and the fourth octets of the path attribute \n contain the length of the attribute data in octets.\n The remaining octets of the Path Attribute represent \n the attribute value and are interpreted according to \n the Attribute Flags and the Attribute Type Code.", "format": "binary" } } } }, "example": { "CISCO-BGP4-MIB:cbgpRouteEntry": [ { "cbgpRouteAfi": "example-string", "cbgpRouteSafi": "example-string", "cbgpRoutePeerType": "ethernetCsmacd(6)", "cbgpRoutePeer": "example-string", "cbgpRouteAddrPrefix": "192.168.1.1", "cbgpRouteAddrPrefixLen": 0, "cbgpRouteOrigin": "example-string", "cbgpRouteASPathSegment": "example-string", "cbgpRouteNextHop": "example-string", "cbgpRouteMedPresent": true, "cbgpRouteMultiExitDisc": 0, "cbgpRouteLocalPrefPresent": true, "cbgpRouteLocalPref": 0, "cbgpRouteAtomicAggregate": "example-string", "cbgpRouteAggregatorAS": 0, "cbgpRouteAggregatorAddrType": "192.168.1.1", "cbgpRouteAggregatorAddr": "192.168.1.1", "cbgpRouteBest": true, "cbgpRouteUnknownAttr": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpRouteEntry-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": "/cbgpRouteEntry", "x-restconf-kind": "container" }, "/data/CISCO-BGP4-MIB:cbgpPeerCapsEntry": { "get": { "summary": "Get cbgpPeerCapsEntry list", "description": "Retrieve list of cbgpPeerCapsEntry entries from MIB", "tags": [ "CISCO-BGP4-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Each entry represents a capability received from a\n peer with a particular code and an index. When a \n capability is received multiple times with different\n values during a BGP connection establishment, \n corresponding entries are differentiated with indices.", "items": { "type": "object", "properties": { "bgpPeerRemoteAddr": { "type": "string", "description": "bgpPeerRemoteAddr", "x-yang-type": "leafref" }, "cbgpPeerCapCode": { "type": "string", "description": "The BGP Capability Advertisement Capability Code." }, "cbgpPeerCapIndex": { "type": "integer", "description": "Multiple instances of a given capability may be\n sent by a BGP speaker. This variable is used\n to index them.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerCapValue": { "type": "string", "description": "The value of the announced capability. This\n MIB object value is organized as given below,\n Capability : Route Refresh Capability\n Null string\n Capability : Multiprotocol Extensions\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n Capability : Graceful Restart\n +----------------------------------+\n | Restart Flags (4 bits) |\n +----------------------------------+\n | Restart Time in seconds (12 bits)|\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Flags for Address Family (8 bits)|\n +----------------------------------+\n | ... |\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Flags for Address Family (8 bits)|\n +----------------------------------+", "format": "binary" } } } }, "example": { "CISCO-BGP4-MIB:cbgpPeerCapsEntry": [ { "bgpPeerRemoteAddr": "192.168.1.1", "cbgpPeerCapCode": "example-string", "cbgpPeerCapIndex": 1, "cbgpPeerCapValue": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeerCapsEntry-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": "/cbgpPeerCapsEntry", "x-restconf-kind": "container" }, "/data/CISCO-BGP4-MIB:cbgpPeerAddrFamilyEntry": { "get": { "summary": "Get cbgpPeerAddrFamilyEntry list", "description": "Retrieve list of cbgpPeerAddrFamilyEntry entries from MIB", "tags": [ "CISCO-BGP4-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry is identified by an AFI/SAFI pair and\n peer address. It contains names associated with\n an address family.", "items": { "type": "object", "properties": { "bgpPeerRemoteAddr": { "type": "string", "description": "bgpPeerRemoteAddr", "x-yang-type": "leafref" }, "cbgpPeerAddrFamilyAfi": { "type": "string", "description": "The AFI index of the entry. An implementation\n is only required to support IPv4 unicast and \n VPNv4 (Value - 1) address families.", "x-yang-type": "inet-address:InetAddressType" }, "cbgpPeerAddrFamilySafi": { "type": "string", "description": "The SAFI index of the entry. An implementation\n is only required to support IPv4 unicast(Value \n - 1) and VPNv4( Value - 128) address families.", "x-yang-type": "CISCO-BGP4-MIB:CbgpSafi" }, "cbgpPeerAddrFamilyName": { "type": "string", "description": "Implementation specific Address Family name.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } }, "example": { "CISCO-BGP4-MIB:cbgpPeerAddrFamilyEntry": [ { "bgpPeerRemoteAddr": "192.168.1.1", "cbgpPeerAddrFamilyAfi": "192.168.1.1", "cbgpPeerAddrFamilySafi": "192.168.1.1", "cbgpPeerAddrFamilyName": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeerAddrFamilyEntry-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": "/cbgpPeerAddrFamilyEntry", "x-restconf-kind": "container" }, "/data/CISCO-BGP4-MIB:cbgpPeerAddrFamilyPrefixEntry": { "get": { "summary": "Get cbgpPeerAddrFamilyPrefixEntry list", "description": "Retrieve list of cbgpPeerAddrFamilyPrefixEntry entries from MIB", "tags": [ "CISCO-BGP4-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry is identified by an AFI/SAFI pair and\n peer address. It contains information associated \n with route prefixes belonging to an address family.", "items": { "type": "object", "properties": { "bgpPeerRemoteAddr": { "type": "string", "description": "bgpPeerRemoteAddr", "x-yang-type": "leafref" }, "cbgpPeerAddrFamilyAfi": { "type": "string", "description": "cbgpPeerAddrFamilyAfi", "x-yang-type": "leafref" }, "cbgpPeerAddrFamilySafi": { "type": "string", "description": "cbgpPeerAddrFamilySafi", "x-yang-type": "leafref" }, "cbgpPeerAcceptedPrefixes": { "type": "integer", "description": "Number of accepted route prefixes on this connection,\n which belong to an address family.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerDeniedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix, which\n belongs to an address family, received on this \n connection is denied. It is initialized to zero when \n the connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerPrefixAdminLimit": { "type": "integer", "description": "Max number of route prefixes accepted for an address\n family on this connection.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerPrefixThreshold": { "type": "integer", "description": "Prefix threshold value (%) for an address family\n on this connection at which warning message stating\n the prefix count is crossed the threshold or \n corresponding SNMP notification is generated.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerPrefixClearThreshold": { "type": "integer", "description": "Prefix threshold value (%) for an address family\n on this connection at which SNMP clear notification\n is generated if prefix threshold notification is\n already generated.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerAdvertisedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family is advertised\n on this connection. It is initialized to zero when \n the connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerSuppressedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family is suppressed\n from being sent on this connection. It is \n initialized to zero when the connection is undergone\n a hard reset.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerWithdrawnPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family, is withdrawn on\n this connection. It is initialized to zero when the\n connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-BGP4-MIB:cbgpPeerAddrFamilyPrefixEntry": [ { "bgpPeerRemoteAddr": "192.168.1.1", "cbgpPeerAddrFamilyAfi": "192.168.1.1", "cbgpPeerAddrFamilySafi": "192.168.1.1", "cbgpPeerAcceptedPrefixes": 0, "cbgpPeerDeniedPrefixes": 0, "cbgpPeerPrefixAdminLimit": 1, "cbgpPeerPrefixThreshold": 0, "cbgpPeerPrefixClearThreshold": 0, "cbgpPeerAdvertisedPrefixes": 0, "cbgpPeerSuppressedPrefixes": 0, "cbgpPeerWithdrawnPrefixes": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeerAddrFamilyPrefixEntry-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": "/cbgpPeerAddrFamilyPrefixEntry", "x-restconf-kind": "container" }, "/data/CISCO-BGP4-MIB:cbgpPeer2Entry": { "get": { "summary": "Get cbgpPeer2Entry list", "description": "Retrieve list of cbgpPeer2Entry entries from MIB", "tags": [ "CISCO-BGP4-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Entry containing information about the\n connection with a BGP peer.", "items": { "type": "object", "properties": { "cbgpPeer2Type": { "type": "string", "description": "Represents the type of Peer address stored\n in cbgpPeer2Entry.", "x-yang-type": "inet-address:InetAddressType" }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "The remote IP address of this entry's BGP\n peer.", "x-yang-type": "inet-address:InetAddress" }, "cbgpPeer2State": { "type": "string", "description": "The BGP peer connection state." }, "cbgpPeer2AdminStatus": { "type": "string", "description": "The desired state of the BGP connection.\n A transition from 'stop' to 'start' will cause\n the BGP Manual Start Event to be generated.\n A transition from 'start' to 'stop' will cause\n the BGP Manual Stop Event to be generated.\n This parameter can be used to restart BGP peer\n connections. Care should be used in providing\n write access to this object without adequate\n authentication." }, "cbgpPeer2NegotiatedVersion": { "type": "integer", "description": "The negotiated version of BGP running between\n the two peers.\n \n This entry MUST be zero (0) unless the\n cbgpPeer2State is in the openconfirm or the\n established state.\n \n Note that legal values for this object are\n between 0 and 255.", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2LocalAddr": { "type": "string", "description": "The local IP address of this entry's BGP\n connection.", "x-yang-type": "inet-address:InetAddress" }, "cbgpPeer2LocalPort": { "type": "string", "description": "The local port for the TCP connection between\n the BGP peers.", "format": "inet:port-number" }, "cbgpPeer2LocalAs": { "type": "string", "description": "The local AS number for this session.", "format": "inet:as-number" }, "cbgpPeer2LocalIdentifier": { "type": "string", "description": "The BGP Identifier of this entry's BGP peer.", "format": "inet:ipv4-address" }, "cbgpPeer2RemotePort": { "type": "string", "description": "The remote port for the TCP connection\n between the BGP peers. Note that the\n objects cbgpPeer2LocalAddr,\n cbgpPeer2LocalPort, cbgpPeer2RemoteAddr, and\n cbgpPeer2RemotePort provide the appropriate\n reference to the standard MIB TCP\n connection table.", "format": "inet:port-number" }, "cbgpPeer2RemoteAs": { "type": "string", "description": "The remote autonomous system number received in\n the BGP OPEN message.", "format": "inet:as-number" }, "cbgpPeer2RemoteIdentifier": { "type": "string", "description": "The BGP Identifier of this entry's BGP peer.\n This entry MUST be 0.0.0.0 unless the\n cbgpPeer2State is in the openconfirm or the\n established state.", "format": "inet:ipv4-address" }, "cbgpPeer2InUpdates": { "type": "integer", "description": "The number of BGP UPDATE messages\n received on this connection.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2OutUpdates": { "type": "integer", "description": "The number of BGP UPDATE messages\n transmitted on this connection.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2InTotalMessages": { "type": "integer", "description": "The total number of messages received\n from the remote peer on this connection.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2OutTotalMessages": { "type": "integer", "description": "The total number of messages transmitted to\n the remote peer on this connection.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2LastError": { "type": "string", "description": "The last error code and subcode seen by this\n peer on this connection. If no error has\n occurred, this field is zero. Otherwise, the\n first byte of this two byte OCTET STRING\n contains the error code, and the second byte\n contains the subcode.", "format": "binary" }, "cbgpPeer2FsmEstablishedTransitions": { "type": "integer", "description": "The total number of times the BGP FSM\n transitioned into the established state\n for this peer.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2FsmEstablishedTime": { "type": "integer", "description": "This timer indicates how long (in\n seconds) this peer has been in the\n established state or how long\n since this peer was last in the\n established state. It is set to zero when\n a new peer is configured or when the router is\n booted.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2ConnectRetryInterval": { "type": "integer", "description": "Time interval (in seconds) for the\n ConnectRetry timer. The suggested value\n for this timer is 120 seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2HoldTime": { "type": "integer", "description": "Time interval (in seconds) for the Hold\n Timer established with the peer. The\n value of this object is calculated by this\n BGP speaker, using the smaller of the\n values in cbgpPeer2HoldTimeConfigured and the\n Hold Time received in the OPEN message.\n \n This value must be at least three seconds\n if it is not zero (0).\n \n If the Hold Timer has not been established\n with the peer this object MUST have a value\n of zero (0).\n \n If the cbgpPeer2HoldTimeConfigured object has\n a value of (0), then this object MUST have a\n value of (0).", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2KeepAlive": { "type": "integer", "description": "Time interval (in seconds) for the KeepAlive\n timer established with the peer. The value\n of this object is calculated by this BGP\n speaker such that, when compared with\n cbgpPeer2HoldTime, it has the same proportion\n that cbgpPeer2KeepAliveConfigured has,\n compared with cbgpPeer2HoldTimeConfigured.\n \n If the KeepAlive timer has not been established\n with the peer, this object MUST have a value\n of zero (0).\n \n If the of cbgpPeer2KeepAliveConfigured object\n has a value of (0), then this object MUST have\n a value of (0).", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2HoldTimeConfigured": { "type": "integer", "description": "Time interval (in seconds) for the Hold Time\n configured for this BGP speaker with this\n peer. This value is placed in an OPEN\n message sent to this peer by this BGP\n speaker, and is compared with the Hold\n Time field in an OPEN message received\n from the peer when determining the Hold\n Time (cbgpPeer2HoldTime) with the peer.\n This value must not be less than three\n seconds if it is not zero (0). If it is\n zero (0), the Hold Time is NOT to be\n established with the peer. The suggested\n value for this timer is 90 seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2KeepAliveConfigured": { "type": "integer", "description": "Time interval (in seconds) for the\n KeepAlive timer configured for this BGP\n speaker with this peer. The value of this\n object will only determine the\n KEEPALIVE messages' frequency relative to\n the value specified in\n cbgpPeer2HoldTimeConfigured; the actual\n time interval for the KEEPALIVE messages is\n indicated by cbgpPeer2KeepAlive. A\n reasonable maximum value for this timer\n would be one third of that of\n cbgpPeer2HoldTimeConfigured.\n If the value of this object is zero (0),\n no periodical KEEPALIVE messages are sent\n to the peer after the BGP connection has\n been established. The suggested value for\n this timer is 30 seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2MinASOriginationInterval": { "type": "integer", "description": "Time interval (in seconds) for the\n MinASOriginationInterval timer.\n The suggested value for this timer is 15\n seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2MinRouteAdvertisementInterval": { "type": "integer", "description": "Time interval (in seconds) for the\n MinRouteAdvertisementInterval timer.\n The suggested value for this timer is 30\n seconds for EBGP connections and 5\n seconds for IBGP connections.", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2InUpdateElapsedTime": { "type": "integer", "description": "Elapsed time (in seconds) since the last BGP\n UPDATE message was received from the peer.\n Each time cbgpPeer2InUpdates is incremented,\n the value of this object is set to zero (0).", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2LastErrorTxt": { "type": "string", "description": "Implementation specific error description for\n bgpPeerLastErrorReceived.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cbgpPeer2PrevState": { "type": "string", "description": "The BGP peer connection previous state." } } } }, "example": { "CISCO-BGP4-MIB:cbgpPeer2Entry": [ { "cbgpPeer2Type": "ethernetCsmacd(6)", "cbgpPeer2RemoteAddr": "192.168.1.1", "cbgpPeer2State": "up(1)", "cbgpPeer2AdminStatus": "up(1)", "cbgpPeer2NegotiatedVersion": -2147483648, "cbgpPeer2LocalAddr": "192.168.1.1", "cbgpPeer2LocalPort": "example-string", "cbgpPeer2LocalAs": "example-string", "cbgpPeer2LocalIdentifier": "example-string", "cbgpPeer2RemotePort": "example-string", "cbgpPeer2RemoteAs": "example-string", "cbgpPeer2RemoteIdentifier": "example-string", "cbgpPeer2InUpdates": 0, "cbgpPeer2OutUpdates": 0, "cbgpPeer2InTotalMessages": 0, "cbgpPeer2OutTotalMessages": 0, "cbgpPeer2LastError": "example-string", "cbgpPeer2FsmEstablishedTransitions": 0, "cbgpPeer2FsmEstablishedTime": 0, "cbgpPeer2ConnectRetryInterval": -2147483648, "cbgpPeer2HoldTime": -2147483648, "cbgpPeer2KeepAlive": -2147483648, "cbgpPeer2HoldTimeConfigured": -2147483648, "cbgpPeer2KeepAliveConfigured": -2147483648, "cbgpPeer2MinASOriginationInterval": -2147483648, "cbgpPeer2MinRouteAdvertisementInterval": -2147483648, "cbgpPeer2InUpdateElapsedTime": 0, "cbgpPeer2LastErrorTxt": "example-string", "cbgpPeer2PrevState": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeer2Entry-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": "/cbgpPeer2Entry", "x-restconf-kind": "container" }, "/data/CISCO-BGP4-MIB:cbgpPeer2CapsEntry": { "get": { "summary": "Get cbgpPeer2CapsEntry list", "description": "Retrieve list of cbgpPeer2CapsEntry entries from MIB", "tags": [ "CISCO-BGP4-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Each entry represents a capability received from a\n peer with a particular code and an index. When a\n capability is received multiple times with different\n values during a BGP connection establishment,\n corresponding entries are differentiated with indices.", "items": { "type": "object", "properties": { "cbgpPeer2Type": { "type": "string", "description": "cbgpPeer2Type", "x-yang-type": "leafref" }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "cbgpPeer2RemoteAddr", "x-yang-type": "leafref" }, "cbgpPeer2CapCode": { "type": "string", "description": "The BGP Capability Advertisement Capability Code." }, "cbgpPeer2CapIndex": { "type": "integer", "description": "Multiple instances of a given capability may be\n sent by a BGP speaker. This variable is used\n to index them.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2CapValue": { "type": "string", "description": "The value of the announced capability. This\n MIB object value is organized as given below,\n Capability : Route Refresh Capability\n 4-Byte AS Capability\n Null string\n Capability : Multiprotocol Extensions\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n Capability : Graceful Restart\n +----------------------------------+\n | Restart Flags (4 bits) |\n +----------------------------------+\n | Restart Time in seconds (12 bits)|\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Flags for Address Family (8 bits)|\n +----------------------------------+\n | ... |\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Flags for Address Family (8 bits)|\n +----------------------------------+\n Capability : Additional Paths\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Send/Receive (8 bits) |\n +----------------------------------+", "format": "binary" } } } }, "example": { "CISCO-BGP4-MIB:cbgpPeer2CapsEntry": [ { "cbgpPeer2Type": "ethernetCsmacd(6)", "cbgpPeer2RemoteAddr": "192.168.1.1", "cbgpPeer2CapCode": "example-string", "cbgpPeer2CapIndex": 1, "cbgpPeer2CapValue": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeer2CapsEntry-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": "/cbgpPeer2CapsEntry", "x-restconf-kind": "container" }, "/data/CISCO-BGP4-MIB:cbgpPeer2AddrFamilyEntry": { "get": { "summary": "Get cbgpPeer2AddrFamilyEntry list", "description": "Retrieve list of cbgpPeer2AddrFamilyEntry entries from MIB", "tags": [ "CISCO-BGP4-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry is identified by an AFI/SAFI pair and\n peer address. It contains names associated with\n an address family.", "items": { "type": "object", "properties": { "cbgpPeer2Type": { "type": "string", "description": "cbgpPeer2Type", "x-yang-type": "leafref" }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "cbgpPeer2RemoteAddr", "x-yang-type": "leafref" }, "cbgpPeer2AddrFamilyAfi": { "type": "string", "description": "The AFI index of the entry. An implementation\n is only required to support IPv4 unicast and\n VPNv4 (Value - 1) address families.", "x-yang-type": "inet-address:InetAddressType" }, "cbgpPeer2AddrFamilySafi": { "type": "string", "description": "The SAFI index of the entry. An implementation\n is only required to support IPv4 unicast(Value\n - 1) and VPNv4( Value - 128) address families.", "x-yang-type": "CISCO-BGP4-MIB:CbgpSafi" }, "cbgpPeer2AddrFamilyName": { "type": "string", "description": "Implementation specific Address Family name.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } }, "example": { "CISCO-BGP4-MIB:cbgpPeer2AddrFamilyEntry": [ { "cbgpPeer2Type": "ethernetCsmacd(6)", "cbgpPeer2RemoteAddr": "192.168.1.1", "cbgpPeer2AddrFamilyAfi": "192.168.1.1", "cbgpPeer2AddrFamilySafi": "192.168.1.1", "cbgpPeer2AddrFamilyName": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeer2AddrFamilyEntry-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": "/cbgpPeer2AddrFamilyEntry", "x-restconf-kind": "container" }, "/data/CISCO-BGP4-MIB:cbgpPeer2AddrFamilyPrefixEntry": { "get": { "summary": "Get cbgpPeer2AddrFamilyPrefixEntry list", "description": "Retrieve list of cbgpPeer2AddrFamilyPrefixEntry entries from MIB", "tags": [ "CISCO-BGP4-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry is identified by an AFI/SAFI pair and\n peer address. It contains information associated\n with route prefixes belonging to an address family.", "items": { "type": "object", "properties": { "cbgpPeer2Type": { "type": "string", "description": "cbgpPeer2Type", "x-yang-type": "leafref" }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "cbgpPeer2RemoteAddr", "x-yang-type": "leafref" }, "cbgpPeer2AddrFamilyAfi": { "type": "string", "description": "cbgpPeer2AddrFamilyAfi", "x-yang-type": "leafref" }, "cbgpPeer2AddrFamilySafi": { "type": "string", "description": "cbgpPeer2AddrFamilySafi", "x-yang-type": "leafref" }, "cbgpPeer2AcceptedPrefixes": { "type": "integer", "description": "Number of accepted route prefixes on this connection,\n which belong to an address family.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2DeniedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix, which\n belongs to an address family, received on this\n connection is denied. It is initialized to zero when\n the connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2PrefixAdminLimit": { "type": "integer", "description": "Max number of route prefixes accepted for an address\n family on this connection.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2PrefixThreshold": { "type": "integer", "description": "Prefix threshold value (%) for an address family\n on this connection at which warning message stating\n the prefix count is crossed the threshold or\n corresponding SNMP notification is generated.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2PrefixClearThreshold": { "type": "integer", "description": "Prefix threshold value (%) for an address family\n on this connection at which SNMP clear notification\n is generated if prefix threshold notification is\n already generated.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2AdvertisedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family is advertised\n on this connection. It is initialized to zero when\n the connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2SuppressedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family is suppressed\n from being sent on this connection. It is\n initialized to zero when the connection is undergone\n a hard reset.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2WithdrawnPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family, is withdrawn on\n this connection. It is initialized to zero when the\n connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-BGP4-MIB:cbgpPeer2AddrFamilyPrefixEntry": [ { "cbgpPeer2Type": "ethernetCsmacd(6)", "cbgpPeer2RemoteAddr": "192.168.1.1", "cbgpPeer2AddrFamilyAfi": "192.168.1.1", "cbgpPeer2AddrFamilySafi": "192.168.1.1", "cbgpPeer2AcceptedPrefixes": 0, "cbgpPeer2DeniedPrefixes": 0, "cbgpPeer2PrefixAdminLimit": 1, "cbgpPeer2PrefixThreshold": 0, "cbgpPeer2PrefixClearThreshold": 0, "cbgpPeer2AdvertisedPrefixes": 0, "cbgpPeer2SuppressedPrefixes": 0, "cbgpPeer2WithdrawnPrefixes": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeer2AddrFamilyPrefixEntry-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": "/cbgpPeer2AddrFamilyPrefixEntry", "x-restconf-kind": "container" }, "/data/CISCO-BGP4-MIB:cbgpRouteTable/cbgpRouteEntry={cbgpRouteAfi},{cbgpRouteSafi},{cbgpRoutePeerType},{cbgpRoutePeer},{cbgpRouteAddrPrefix},{cbgpRouteAddrPrefixLen}": { "get": { "summary": "Get cbgpRouteEntry entry", "description": "Retrieve specific cbgpRouteEntry entry by key from MIB", "tags": [ "CISCO-BGP4-MIB" ], "parameters": [ { "name": "cbgpRouteAfi", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpRouteSafi", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpRoutePeerType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpRoutePeer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpRouteAddrPrefix", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpRouteAddrPrefixLen", "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": { "cbgpRouteAfi": { "type": "string", "description": "Represents Address Family Identifier(AFI) of the\n Network Layer protocol associated with the route.\n An implementation is only required to support IPv4\n unicast and VPNv4 (Value - 1) address families.", "x-yang-type": "inet-address:InetAddressType" }, "cbgpRouteSafi": { "type": "string", "description": "Represents Subsequent Address Family Identifier(SAFI)\n of the route. It gives additional information about\n the type of the route. An implementation is only \n required to support IPv4 unicast(Value - 1) and VPNv4(\n Value - 128) address families.", "x-yang-type": "CISCO-BGP4-MIB:CbgpSafi" }, "cbgpRoutePeerType": { "type": "string", "description": "Represents the type of Network Layer address stored\n in cbgpRoutePeer. An implementation is only required\n to support IPv4 address type(Value - 1).", "x-yang-type": "inet-address:InetAddressType" }, "cbgpRoutePeer": { "type": "string", "description": "The Network Layer address of the peer where the route\n information was learned. An implementation is only \n required to support an IPv4 peer.", "x-yang-type": "inet-address:InetAddress" }, "cbgpRouteAddrPrefix": { "type": "string", "description": "A Network Address prefix in the Network Layer\n Reachability Information field of BGP UPDATE message.\n This object is a Network Address containing the prefix\n with length specified by cbgpRouteAddrPrefixLen. Any\n bits beyond the length specified by\n cbgpRouteAddrPrefixLen are zeroed.", "x-yang-type": "CISCO-BGP4-MIB:CbgpNetworkAddress" }, "cbgpRouteAddrPrefixLen": { "type": "integer", "description": "Length in bits of the Network Address prefix in the\n Network Layer Reachability Information field.", "minimum": 0, "maximum": 4294967295 }, "cbgpRouteOrigin": { "type": "string", "description": "The ultimate origin of the route information." }, "cbgpRouteASPathSegment": { "type": "string", "description": "The sequence of AS path segments. Each AS\n path segment is represented by a triple\n .\n \n The type is a 1-octet field which has two\n possible values:\n 1 AS_SET: unordered set of ASs a route in the \n UPDATE message has traversed\n 2 AS_SEQUENCE: ordered set of ASs a route in the\n UPDATE message has traversed.\n \n The length is a 1-octet field containing the\n number of ASs in the value field.\n \n The value field contains one or more AS\n numbers, each AS is represented in the octet\n string as a pair of octets according to the\n following algorithm:\n \n first-byte-of-pair = ASNumber / 256;\n second-byte-of-pair = ASNumber & 255;", "format": "binary" }, "cbgpRouteNextHop": { "type": "string", "description": "The Network Layer address of the border router\n that should be used for the destination network.", "x-yang-type": "CISCO-BGP4-MIB:CbgpNetworkAddress" }, "cbgpRouteMedPresent": { "type": "boolean", "description": "Indicates the presence/absence of MULTI_EXIT_DISC\n attribute for the route." }, "cbgpRouteMultiExitDisc": { "type": "integer", "description": "This metric is used to discriminate between multiple\n exit points to an adjacent autonomous system. The\n value of this object is irrelevant if the value of\n of cbgpRouteMedPresent is false(2).", "minimum": 0, "maximum": 4294967295 }, "cbgpRouteLocalPrefPresent": { "type": "boolean", "description": "Indicates the presence/absence of LOCAL_PREF\n attribute for the route." }, "cbgpRouteLocalPref": { "type": "integer", "description": "The degree of preference calculated by the local BGP4\n speaker for the route. The value of this object is \n irrelevant if the value of cbgpRouteLocalPrefPresent \n is false(2).", "minimum": 0, "maximum": 4294967295 }, "cbgpRouteAtomicAggregate": { "type": "string", "description": "Whether or not the local system has selected a less\n specific route without selecting a more specific\n route." }, "cbgpRouteAggregatorAS": { "type": "integer", "description": "The AS number of the last BGP4 speaker that performed\n route aggregation. A value of zero (0) indicates the \n absence of this attribute.", "minimum": 0, "maximum": 4294967295 }, "cbgpRouteAggregatorAddrType": { "type": "string", "description": "Represents the type of Network Layer address stored\n in cbgpRouteAggregatorAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cbgpRouteAggregatorAddr": { "type": "string", "description": "The Network Layer address of the last BGP4 speaker\n that performed route aggregation. A value of all zeros\n indicates the absence of this attribute.", "x-yang-type": "inet-address:InetAddress" }, "cbgpRouteBest": { "type": "boolean", "description": "An indication of whether or not this route was chosen\n as the best BGP4 route." }, "cbgpRouteUnknownAttr": { "type": "string", "description": "One or more path attributes not understood by this\n BGP4 speaker. Size zero (0) indicates the absence of\n such attribute(s). Octets beyond the maximum size, if\n any, are not recorded by this object. \n \n Each path attribute is a triple of variable length.\n Attribute Type is a two-octet field that consists of\n the Attribute Flags octet followed by the Attribute\n Type Code octet. If the Extended Length bit of the \n Attribute Flags octet is set to 0, the third octet of \n the Path Attribute contains the length of the\n attribute data in octets. If the Extended Length bit \n of the Attribute Flags octet is set to 1, then the\n third and the fourth octets of the path attribute \n contain the length of the attribute data in octets.\n The remaining octets of the Path Attribute represent \n the attribute value and are interpreted according to \n the Attribute Flags and the Attribute Type Code.", "format": "binary" } } }, "example": { "CISCO-BGP4-MIB:cbgpRouteEntry": { "cbgpRouteAfi": "example-string", "cbgpRouteSafi": "example-string", "cbgpRoutePeerType": "ethernetCsmacd(6)", "cbgpRoutePeer": "example-string", "cbgpRouteAddrPrefix": "192.168.1.1", "cbgpRouteAddrPrefixLen": 0, "cbgpRouteOrigin": "example-string", "cbgpRouteASPathSegment": "example-string", "cbgpRouteNextHop": "example-string", "cbgpRouteMedPresent": true, "cbgpRouteMultiExitDisc": 0, "cbgpRouteLocalPrefPresent": true, "cbgpRouteLocalPref": 0, "cbgpRouteAtomicAggregate": "example-string", "cbgpRouteAggregatorAS": 0, "cbgpRouteAggregatorAddrType": "192.168.1.1", "cbgpRouteAggregatorAddr": "192.168.1.1", "cbgpRouteBest": true, "cbgpRouteUnknownAttr": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpRouteEntry-2" }, "x-yang-path": "/cbgpRouteTable/cbgpRouteEntry={cbgpRouteAfi cbgpRouteSafi cbgpRoutePeerType cbgpRoutePeer cbgpRouteAddrPrefix cbgpRouteAddrPrefixLen}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cbgpRouteAfi cbgpRouteSafi cbgpRoutePeerType cbgpRoutePeer cbgpRouteAddrPrefix cbgpRouteAddrPrefixLen" ] }, "/data/CISCO-BGP4-MIB:cbgpPeerCapsTable/cbgpPeerCapsEntry={bgpPeerRemoteAddr},{cbgpPeerCapCode},{cbgpPeerCapIndex}": { "get": { "summary": "Get cbgpPeerCapsEntry entry", "description": "Retrieve specific cbgpPeerCapsEntry entry by key from MIB", "tags": [ "CISCO-BGP4-MIB" ], "parameters": [ { "name": "bgpPeerRemoteAddr", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpPeerCapCode", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpPeerCapIndex", "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": { "bgpPeerRemoteAddr": { "type": "string", "description": "bgpPeerRemoteAddr", "x-yang-type": "leafref" }, "cbgpPeerCapCode": { "type": "string", "description": "The BGP Capability Advertisement Capability Code." }, "cbgpPeerCapIndex": { "type": "integer", "description": "Multiple instances of a given capability may be\n sent by a BGP speaker. This variable is used\n to index them.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerCapValue": { "type": "string", "description": "The value of the announced capability. This\n MIB object value is organized as given below,\n Capability : Route Refresh Capability\n Null string\n Capability : Multiprotocol Extensions\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n Capability : Graceful Restart\n +----------------------------------+\n | Restart Flags (4 bits) |\n +----------------------------------+\n | Restart Time in seconds (12 bits)|\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Flags for Address Family (8 bits)|\n +----------------------------------+\n | ... |\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Flags for Address Family (8 bits)|\n +----------------------------------+", "format": "binary" } } }, "example": { "CISCO-BGP4-MIB:cbgpPeerCapsEntry": { "bgpPeerRemoteAddr": "192.168.1.1", "cbgpPeerCapCode": "example-string", "cbgpPeerCapIndex": 1, "cbgpPeerCapValue": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeerCapsEntry-2" }, "x-yang-path": "/cbgpPeerCapsTable/cbgpPeerCapsEntry={bgpPeerRemoteAddr cbgpPeerCapCode cbgpPeerCapIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "bgpPeerRemoteAddr cbgpPeerCapCode cbgpPeerCapIndex" ] }, "/data/CISCO-BGP4-MIB:cbgpPeerAddrFamilyTable/cbgpPeerAddrFamilyEntry={bgpPeerRemoteAddr},{cbgpPeerAddrFamilyAfi},{cbgpPeerAddrFamilySafi}": { "get": { "summary": "Get cbgpPeerAddrFamilyEntry entry", "description": "Retrieve specific cbgpPeerAddrFamilyEntry entry by key from MIB", "tags": [ "CISCO-BGP4-MIB" ], "parameters": [ { "name": "bgpPeerRemoteAddr", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpPeerAddrFamilyAfi", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpPeerAddrFamilySafi", "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": { "bgpPeerRemoteAddr": { "type": "string", "description": "bgpPeerRemoteAddr", "x-yang-type": "leafref" }, "cbgpPeerAddrFamilyAfi": { "type": "string", "description": "The AFI index of the entry. An implementation\n is only required to support IPv4 unicast and \n VPNv4 (Value - 1) address families.", "x-yang-type": "inet-address:InetAddressType" }, "cbgpPeerAddrFamilySafi": { "type": "string", "description": "The SAFI index of the entry. An implementation\n is only required to support IPv4 unicast(Value \n - 1) and VPNv4( Value - 128) address families.", "x-yang-type": "CISCO-BGP4-MIB:CbgpSafi" }, "cbgpPeerAddrFamilyName": { "type": "string", "description": "Implementation specific Address Family name.", "x-yang-type": "snmp-framework:SnmpAdminString" } } }, "example": { "CISCO-BGP4-MIB:cbgpPeerAddrFamilyEntry": { "bgpPeerRemoteAddr": "192.168.1.1", "cbgpPeerAddrFamilyAfi": "192.168.1.1", "cbgpPeerAddrFamilySafi": "192.168.1.1", "cbgpPeerAddrFamilyName": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeerAddrFamilyEntry-2" }, "x-yang-path": "/cbgpPeerAddrFamilyTable/cbgpPeerAddrFamilyEntry={bgpPeerRemoteAddr cbgpPeerAddrFamilyAfi cbgpPeerAddrFamilySafi}", "x-restconf-kind": "list-instance", "x-list-keys": [ "bgpPeerRemoteAddr cbgpPeerAddrFamilyAfi cbgpPeerAddrFamilySafi" ] }, "/data/CISCO-BGP4-MIB:cbgpPeerAddrFamilyPrefixTable/cbgpPeerAddrFamilyPrefixEntry={bgpPeerRemoteAddr},{cbgpPeerAddrFamilyAfi},{cbgpPeerAddrFamilySafi}": { "get": { "summary": "Get cbgpPeerAddrFamilyPrefixEntry entry", "description": "Retrieve specific cbgpPeerAddrFamilyPrefixEntry entry by key from MIB", "tags": [ "CISCO-BGP4-MIB" ], "parameters": [ { "name": "bgpPeerRemoteAddr", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpPeerAddrFamilyAfi", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpPeerAddrFamilySafi", "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": { "bgpPeerRemoteAddr": { "type": "string", "description": "bgpPeerRemoteAddr", "x-yang-type": "leafref" }, "cbgpPeerAddrFamilyAfi": { "type": "string", "description": "cbgpPeerAddrFamilyAfi", "x-yang-type": "leafref" }, "cbgpPeerAddrFamilySafi": { "type": "string", "description": "cbgpPeerAddrFamilySafi", "x-yang-type": "leafref" }, "cbgpPeerAcceptedPrefixes": { "type": "integer", "description": "Number of accepted route prefixes on this connection,\n which belong to an address family.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerDeniedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix, which\n belongs to an address family, received on this \n connection is denied. It is initialized to zero when \n the connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerPrefixAdminLimit": { "type": "integer", "description": "Max number of route prefixes accepted for an address\n family on this connection.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerPrefixThreshold": { "type": "integer", "description": "Prefix threshold value (%) for an address family\n on this connection at which warning message stating\n the prefix count is crossed the threshold or \n corresponding SNMP notification is generated.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerPrefixClearThreshold": { "type": "integer", "description": "Prefix threshold value (%) for an address family\n on this connection at which SNMP clear notification\n is generated if prefix threshold notification is\n already generated.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerAdvertisedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family is advertised\n on this connection. It is initialized to zero when \n the connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerSuppressedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family is suppressed\n from being sent on this connection. It is \n initialized to zero when the connection is undergone\n a hard reset.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerWithdrawnPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family, is withdrawn on\n this connection. It is initialized to zero when the\n connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-BGP4-MIB:cbgpPeerAddrFamilyPrefixEntry": { "bgpPeerRemoteAddr": "192.168.1.1", "cbgpPeerAddrFamilyAfi": "192.168.1.1", "cbgpPeerAddrFamilySafi": "192.168.1.1", "cbgpPeerAcceptedPrefixes": 0, "cbgpPeerDeniedPrefixes": 0, "cbgpPeerPrefixAdminLimit": 1, "cbgpPeerPrefixThreshold": 0, "cbgpPeerPrefixClearThreshold": 0, "cbgpPeerAdvertisedPrefixes": 0, "cbgpPeerSuppressedPrefixes": 0, "cbgpPeerWithdrawnPrefixes": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeerAddrFamilyPrefixEntry-2" }, "x-yang-path": "/cbgpPeerAddrFamilyPrefixTable/cbgpPeerAddrFamilyPrefixEntry={bgpPeerRemoteAddr cbgpPeerAddrFamilyAfi cbgpPeerAddrFamilySafi}", "x-restconf-kind": "list-instance", "x-list-keys": [ "bgpPeerRemoteAddr cbgpPeerAddrFamilyAfi cbgpPeerAddrFamilySafi" ] }, "/data/CISCO-BGP4-MIB:cbgpPeer2Table/cbgpPeer2Entry={cbgpPeer2Type},{cbgpPeer2RemoteAddr}": { "get": { "summary": "Get cbgpPeer2Entry entry", "description": "Retrieve specific cbgpPeer2Entry entry by key from MIB", "tags": [ "CISCO-BGP4-MIB" ], "parameters": [ { "name": "cbgpPeer2Type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpPeer2RemoteAddr", "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": { "cbgpPeer2Type": { "type": "string", "description": "Represents the type of Peer address stored\n in cbgpPeer2Entry.", "x-yang-type": "inet-address:InetAddressType" }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "The remote IP address of this entry's BGP\n peer.", "x-yang-type": "inet-address:InetAddress" }, "cbgpPeer2State": { "type": "string", "description": "The BGP peer connection state." }, "cbgpPeer2AdminStatus": { "type": "string", "description": "The desired state of the BGP connection.\n A transition from 'stop' to 'start' will cause\n the BGP Manual Start Event to be generated.\n A transition from 'start' to 'stop' will cause\n the BGP Manual Stop Event to be generated.\n This parameter can be used to restart BGP peer\n connections. Care should be used in providing\n write access to this object without adequate\n authentication." }, "cbgpPeer2NegotiatedVersion": { "type": "integer", "description": "The negotiated version of BGP running between\n the two peers.\n \n This entry MUST be zero (0) unless the\n cbgpPeer2State is in the openconfirm or the\n established state.\n \n Note that legal values for this object are\n between 0 and 255.", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2LocalAddr": { "type": "string", "description": "The local IP address of this entry's BGP\n connection.", "x-yang-type": "inet-address:InetAddress" }, "cbgpPeer2LocalPort": { "type": "string", "description": "The local port for the TCP connection between\n the BGP peers.", "format": "inet:port-number" }, "cbgpPeer2LocalAs": { "type": "string", "description": "The local AS number for this session.", "format": "inet:as-number" }, "cbgpPeer2LocalIdentifier": { "type": "string", "description": "The BGP Identifier of this entry's BGP peer.", "format": "inet:ipv4-address" }, "cbgpPeer2RemotePort": { "type": "string", "description": "The remote port for the TCP connection\n between the BGP peers. Note that the\n objects cbgpPeer2LocalAddr,\n cbgpPeer2LocalPort, cbgpPeer2RemoteAddr, and\n cbgpPeer2RemotePort provide the appropriate\n reference to the standard MIB TCP\n connection table.", "format": "inet:port-number" }, "cbgpPeer2RemoteAs": { "type": "string", "description": "The remote autonomous system number received in\n the BGP OPEN message.", "format": "inet:as-number" }, "cbgpPeer2RemoteIdentifier": { "type": "string", "description": "The BGP Identifier of this entry's BGP peer.\n This entry MUST be 0.0.0.0 unless the\n cbgpPeer2State is in the openconfirm or the\n established state.", "format": "inet:ipv4-address" }, "cbgpPeer2InUpdates": { "type": "integer", "description": "The number of BGP UPDATE messages\n received on this connection.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2OutUpdates": { "type": "integer", "description": "The number of BGP UPDATE messages\n transmitted on this connection.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2InTotalMessages": { "type": "integer", "description": "The total number of messages received\n from the remote peer on this connection.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2OutTotalMessages": { "type": "integer", "description": "The total number of messages transmitted to\n the remote peer on this connection.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2LastError": { "type": "string", "description": "The last error code and subcode seen by this\n peer on this connection. If no error has\n occurred, this field is zero. Otherwise, the\n first byte of this two byte OCTET STRING\n contains the error code, and the second byte\n contains the subcode.", "format": "binary" }, "cbgpPeer2FsmEstablishedTransitions": { "type": "integer", "description": "The total number of times the BGP FSM\n transitioned into the established state\n for this peer.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2FsmEstablishedTime": { "type": "integer", "description": "This timer indicates how long (in\n seconds) this peer has been in the\n established state or how long\n since this peer was last in the\n established state. It is set to zero when\n a new peer is configured or when the router is\n booted.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2ConnectRetryInterval": { "type": "integer", "description": "Time interval (in seconds) for the\n ConnectRetry timer. The suggested value\n for this timer is 120 seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2HoldTime": { "type": "integer", "description": "Time interval (in seconds) for the Hold\n Timer established with the peer. The\n value of this object is calculated by this\n BGP speaker, using the smaller of the\n values in cbgpPeer2HoldTimeConfigured and the\n Hold Time received in the OPEN message.\n \n This value must be at least three seconds\n if it is not zero (0).\n \n If the Hold Timer has not been established\n with the peer this object MUST have a value\n of zero (0).\n \n If the cbgpPeer2HoldTimeConfigured object has\n a value of (0), then this object MUST have a\n value of (0).", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2KeepAlive": { "type": "integer", "description": "Time interval (in seconds) for the KeepAlive\n timer established with the peer. The value\n of this object is calculated by this BGP\n speaker such that, when compared with\n cbgpPeer2HoldTime, it has the same proportion\n that cbgpPeer2KeepAliveConfigured has,\n compared with cbgpPeer2HoldTimeConfigured.\n \n If the KeepAlive timer has not been established\n with the peer, this object MUST have a value\n of zero (0).\n \n If the of cbgpPeer2KeepAliveConfigured object\n has a value of (0), then this object MUST have\n a value of (0).", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2HoldTimeConfigured": { "type": "integer", "description": "Time interval (in seconds) for the Hold Time\n configured for this BGP speaker with this\n peer. This value is placed in an OPEN\n message sent to this peer by this BGP\n speaker, and is compared with the Hold\n Time field in an OPEN message received\n from the peer when determining the Hold\n Time (cbgpPeer2HoldTime) with the peer.\n This value must not be less than three\n seconds if it is not zero (0). If it is\n zero (0), the Hold Time is NOT to be\n established with the peer. The suggested\n value for this timer is 90 seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2KeepAliveConfigured": { "type": "integer", "description": "Time interval (in seconds) for the\n KeepAlive timer configured for this BGP\n speaker with this peer. The value of this\n object will only determine the\n KEEPALIVE messages' frequency relative to\n the value specified in\n cbgpPeer2HoldTimeConfigured; the actual\n time interval for the KEEPALIVE messages is\n indicated by cbgpPeer2KeepAlive. A\n reasonable maximum value for this timer\n would be one third of that of\n cbgpPeer2HoldTimeConfigured.\n If the value of this object is zero (0),\n no periodical KEEPALIVE messages are sent\n to the peer after the BGP connection has\n been established. The suggested value for\n this timer is 30 seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2MinASOriginationInterval": { "type": "integer", "description": "Time interval (in seconds) for the\n MinASOriginationInterval timer.\n The suggested value for this timer is 15\n seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2MinRouteAdvertisementInterval": { "type": "integer", "description": "Time interval (in seconds) for the\n MinRouteAdvertisementInterval timer.\n The suggested value for this timer is 30\n seconds for EBGP connections and 5\n seconds for IBGP connections.", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2InUpdateElapsedTime": { "type": "integer", "description": "Elapsed time (in seconds) since the last BGP\n UPDATE message was received from the peer.\n Each time cbgpPeer2InUpdates is incremented,\n the value of this object is set to zero (0).", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2LastErrorTxt": { "type": "string", "description": "Implementation specific error description for\n bgpPeerLastErrorReceived.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cbgpPeer2PrevState": { "type": "string", "description": "The BGP peer connection previous state." } } }, "example": { "CISCO-BGP4-MIB:cbgpPeer2Entry": { "cbgpPeer2Type": "ethernetCsmacd(6)", "cbgpPeer2RemoteAddr": "192.168.1.1", "cbgpPeer2State": "up(1)", "cbgpPeer2AdminStatus": "up(1)", "cbgpPeer2NegotiatedVersion": -2147483648, "cbgpPeer2LocalAddr": "192.168.1.1", "cbgpPeer2LocalPort": "example-string", "cbgpPeer2LocalAs": "example-string", "cbgpPeer2LocalIdentifier": "example-string", "cbgpPeer2RemotePort": "example-string", "cbgpPeer2RemoteAs": "example-string", "cbgpPeer2RemoteIdentifier": "example-string", "cbgpPeer2InUpdates": 0, "cbgpPeer2OutUpdates": 0, "cbgpPeer2InTotalMessages": 0, "cbgpPeer2OutTotalMessages": 0, "cbgpPeer2LastError": "example-string", "cbgpPeer2FsmEstablishedTransitions": 0, "cbgpPeer2FsmEstablishedTime": 0, "cbgpPeer2ConnectRetryInterval": -2147483648, "cbgpPeer2HoldTime": -2147483648, "cbgpPeer2KeepAlive": -2147483648, "cbgpPeer2HoldTimeConfigured": -2147483648, "cbgpPeer2KeepAliveConfigured": -2147483648, "cbgpPeer2MinASOriginationInterval": -2147483648, "cbgpPeer2MinRouteAdvertisementInterval": -2147483648, "cbgpPeer2InUpdateElapsedTime": 0, "cbgpPeer2LastErrorTxt": "example-string", "cbgpPeer2PrevState": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeer2Entry-2" }, "x-yang-path": "/cbgpPeer2Table/cbgpPeer2Entry={cbgpPeer2Type cbgpPeer2RemoteAddr}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cbgpPeer2Type cbgpPeer2RemoteAddr" ] }, "/data/CISCO-BGP4-MIB:cbgpPeer2CapsTable/cbgpPeer2CapsEntry={cbgpPeer2Type},{cbgpPeer2RemoteAddr},{cbgpPeer2CapCode},{cbgpPeer2CapIndex}": { "get": { "summary": "Get cbgpPeer2CapsEntry entry", "description": "Retrieve specific cbgpPeer2CapsEntry entry by key from MIB", "tags": [ "CISCO-BGP4-MIB" ], "parameters": [ { "name": "cbgpPeer2Type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpPeer2RemoteAddr", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpPeer2CapCode", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpPeer2CapIndex", "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": { "cbgpPeer2Type": { "type": "string", "description": "cbgpPeer2Type", "x-yang-type": "leafref" }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "cbgpPeer2RemoteAddr", "x-yang-type": "leafref" }, "cbgpPeer2CapCode": { "type": "string", "description": "The BGP Capability Advertisement Capability Code." }, "cbgpPeer2CapIndex": { "type": "integer", "description": "Multiple instances of a given capability may be\n sent by a BGP speaker. This variable is used\n to index them.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2CapValue": { "type": "string", "description": "The value of the announced capability. This\n MIB object value is organized as given below,\n Capability : Route Refresh Capability\n 4-Byte AS Capability\n Null string\n Capability : Multiprotocol Extensions\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n Capability : Graceful Restart\n +----------------------------------+\n | Restart Flags (4 bits) |\n +----------------------------------+\n | Restart Time in seconds (12 bits)|\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Flags for Address Family (8 bits)|\n +----------------------------------+\n | ... |\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Flags for Address Family (8 bits)|\n +----------------------------------+\n Capability : Additional Paths\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Send/Receive (8 bits) |\n +----------------------------------+", "format": "binary" } } }, "example": { "CISCO-BGP4-MIB:cbgpPeer2CapsEntry": { "cbgpPeer2Type": "ethernetCsmacd(6)", "cbgpPeer2RemoteAddr": "192.168.1.1", "cbgpPeer2CapCode": "example-string", "cbgpPeer2CapIndex": 1, "cbgpPeer2CapValue": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeer2CapsEntry-2" }, "x-yang-path": "/cbgpPeer2CapsTable/cbgpPeer2CapsEntry={cbgpPeer2Type cbgpPeer2RemoteAddr cbgpPeer2CapCode cbgpPeer2CapIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cbgpPeer2Type cbgpPeer2RemoteAddr cbgpPeer2CapCode cbgpPeer2CapIndex" ] }, "/data/CISCO-BGP4-MIB:cbgpPeer2AddrFamilyTable/cbgpPeer2AddrFamilyEntry={cbgpPeer2Type},{cbgpPeer2RemoteAddr},{cbgpPeer2AddrFamilyAfi},{cbgpPeer2AddrFamilySafi}": { "get": { "summary": "Get cbgpPeer2AddrFamilyEntry entry", "description": "Retrieve specific cbgpPeer2AddrFamilyEntry entry by key from MIB", "tags": [ "CISCO-BGP4-MIB" ], "parameters": [ { "name": "cbgpPeer2Type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpPeer2RemoteAddr", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpPeer2AddrFamilyAfi", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpPeer2AddrFamilySafi", "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": { "cbgpPeer2Type": { "type": "string", "description": "cbgpPeer2Type", "x-yang-type": "leafref" }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "cbgpPeer2RemoteAddr", "x-yang-type": "leafref" }, "cbgpPeer2AddrFamilyAfi": { "type": "string", "description": "The AFI index of the entry. An implementation\n is only required to support IPv4 unicast and\n VPNv4 (Value - 1) address families.", "x-yang-type": "inet-address:InetAddressType" }, "cbgpPeer2AddrFamilySafi": { "type": "string", "description": "The SAFI index of the entry. An implementation\n is only required to support IPv4 unicast(Value\n - 1) and VPNv4( Value - 128) address families.", "x-yang-type": "CISCO-BGP4-MIB:CbgpSafi" }, "cbgpPeer2AddrFamilyName": { "type": "string", "description": "Implementation specific Address Family name.", "x-yang-type": "snmp-framework:SnmpAdminString" } } }, "example": { "CISCO-BGP4-MIB:cbgpPeer2AddrFamilyEntry": { "cbgpPeer2Type": "ethernetCsmacd(6)", "cbgpPeer2RemoteAddr": "192.168.1.1", "cbgpPeer2AddrFamilyAfi": "192.168.1.1", "cbgpPeer2AddrFamilySafi": "192.168.1.1", "cbgpPeer2AddrFamilyName": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeer2AddrFamilyEntry-2" }, "x-yang-path": "/cbgpPeer2AddrFamilyTable/cbgpPeer2AddrFamilyEntry={cbgpPeer2Type cbgpPeer2RemoteAddr cbgpPeer2AddrFamilyAfi cbgpPeer2AddrFamilySafi}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cbgpPeer2Type cbgpPeer2RemoteAddr cbgpPeer2AddrFamilyAfi cbgpPeer2AddrFamilySafi" ] }, "/data/CISCO-BGP4-MIB:cbgpPeer2AddrFamilyPrefixTable/cbgpPeer2AddrFamilyPrefixEntry={cbgpPeer2Type},{cbgpPeer2RemoteAddr},{cbgpPeer2AddrFamilyAfi},{cbgpPeer2AddrFamilySafi}": { "get": { "summary": "Get cbgpPeer2AddrFamilyPrefixEntry entry", "description": "Retrieve specific cbgpPeer2AddrFamilyPrefixEntry entry by key from MIB", "tags": [ "CISCO-BGP4-MIB" ], "parameters": [ { "name": "cbgpPeer2Type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpPeer2RemoteAddr", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpPeer2AddrFamilyAfi", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpPeer2AddrFamilySafi", "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": { "cbgpPeer2Type": { "type": "string", "description": "cbgpPeer2Type", "x-yang-type": "leafref" }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "cbgpPeer2RemoteAddr", "x-yang-type": "leafref" }, "cbgpPeer2AddrFamilyAfi": { "type": "string", "description": "cbgpPeer2AddrFamilyAfi", "x-yang-type": "leafref" }, "cbgpPeer2AddrFamilySafi": { "type": "string", "description": "cbgpPeer2AddrFamilySafi", "x-yang-type": "leafref" }, "cbgpPeer2AcceptedPrefixes": { "type": "integer", "description": "Number of accepted route prefixes on this connection,\n which belong to an address family.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2DeniedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix, which\n belongs to an address family, received on this\n connection is denied. It is initialized to zero when\n the connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2PrefixAdminLimit": { "type": "integer", "description": "Max number of route prefixes accepted for an address\n family on this connection.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2PrefixThreshold": { "type": "integer", "description": "Prefix threshold value (%) for an address family\n on this connection at which warning message stating\n the prefix count is crossed the threshold or\n corresponding SNMP notification is generated.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2PrefixClearThreshold": { "type": "integer", "description": "Prefix threshold value (%) for an address family\n on this connection at which SNMP clear notification\n is generated if prefix threshold notification is\n already generated.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2AdvertisedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family is advertised\n on this connection. It is initialized to zero when\n the connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2SuppressedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family is suppressed\n from being sent on this connection. It is\n initialized to zero when the connection is undergone\n a hard reset.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2WithdrawnPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family, is withdrawn on\n this connection. It is initialized to zero when the\n connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-BGP4-MIB:cbgpPeer2AddrFamilyPrefixEntry": { "cbgpPeer2Type": "ethernetCsmacd(6)", "cbgpPeer2RemoteAddr": "192.168.1.1", "cbgpPeer2AddrFamilyAfi": "192.168.1.1", "cbgpPeer2AddrFamilySafi": "192.168.1.1", "cbgpPeer2AcceptedPrefixes": 0, "cbgpPeer2DeniedPrefixes": 0, "cbgpPeer2PrefixAdminLimit": 1, "cbgpPeer2PrefixThreshold": 0, "cbgpPeer2PrefixClearThreshold": 0, "cbgpPeer2AdvertisedPrefixes": 0, "cbgpPeer2SuppressedPrefixes": 0, "cbgpPeer2WithdrawnPrefixes": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeer2AddrFamilyPrefixEntry-2" }, "x-yang-path": "/cbgpPeer2AddrFamilyPrefixTable/cbgpPeer2AddrFamilyPrefixEntry={cbgpPeer2Type cbgpPeer2RemoteAddr cbgpPeer2AddrFamilyAfi cbgpPeer2AddrFamilySafi}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cbgpPeer2Type cbgpPeer2RemoteAddr cbgpPeer2AddrFamilyAfi cbgpPeer2AddrFamilySafi" ] }, "/data/CISCO-BGP4-MIB:cbgpRouteEntry={cbgpRouteAfi},{cbgpRouteSafi},{cbgpRoutePeerType},{cbgpRoutePeer},{cbgpRouteAddrPrefix},{cbgpRouteAddrPrefixLen}": { "get": { "summary": "Get cbgpRouteEntry entry", "description": "Retrieve specific cbgpRouteEntry entry by key from MIB", "tags": [ "CISCO-BGP4-MIB" ], "parameters": [ { "name": "cbgpRouteAfi", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpRouteSafi", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpRoutePeerType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpRoutePeer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpRouteAddrPrefix", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpRouteAddrPrefixLen", "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": { "cbgpRouteAfi": { "type": "string", "description": "Represents Address Family Identifier(AFI) of the\n Network Layer protocol associated with the route.\n An implementation is only required to support IPv4\n unicast and VPNv4 (Value - 1) address families.", "x-yang-type": "inet-address:InetAddressType" }, "cbgpRouteSafi": { "type": "string", "description": "Represents Subsequent Address Family Identifier(SAFI)\n of the route. It gives additional information about\n the type of the route. An implementation is only \n required to support IPv4 unicast(Value - 1) and VPNv4(\n Value - 128) address families.", "x-yang-type": "CISCO-BGP4-MIB:CbgpSafi" }, "cbgpRoutePeerType": { "type": "string", "description": "Represents the type of Network Layer address stored\n in cbgpRoutePeer. An implementation is only required\n to support IPv4 address type(Value - 1).", "x-yang-type": "inet-address:InetAddressType" }, "cbgpRoutePeer": { "type": "string", "description": "The Network Layer address of the peer where the route\n information was learned. An implementation is only \n required to support an IPv4 peer.", "x-yang-type": "inet-address:InetAddress" }, "cbgpRouteAddrPrefix": { "type": "string", "description": "A Network Address prefix in the Network Layer\n Reachability Information field of BGP UPDATE message.\n This object is a Network Address containing the prefix\n with length specified by cbgpRouteAddrPrefixLen. Any\n bits beyond the length specified by\n cbgpRouteAddrPrefixLen are zeroed.", "x-yang-type": "CISCO-BGP4-MIB:CbgpNetworkAddress" }, "cbgpRouteAddrPrefixLen": { "type": "integer", "description": "Length in bits of the Network Address prefix in the\n Network Layer Reachability Information field.", "minimum": 0, "maximum": 4294967295 }, "cbgpRouteOrigin": { "type": "string", "description": "The ultimate origin of the route information." }, "cbgpRouteASPathSegment": { "type": "string", "description": "The sequence of AS path segments. Each AS\n path segment is represented by a triple\n .\n \n The type is a 1-octet field which has two\n possible values:\n 1 AS_SET: unordered set of ASs a route in the \n UPDATE message has traversed\n 2 AS_SEQUENCE: ordered set of ASs a route in the\n UPDATE message has traversed.\n \n The length is a 1-octet field containing the\n number of ASs in the value field.\n \n The value field contains one or more AS\n numbers, each AS is represented in the octet\n string as a pair of octets according to the\n following algorithm:\n \n first-byte-of-pair = ASNumber / 256;\n second-byte-of-pair = ASNumber & 255;", "format": "binary" }, "cbgpRouteNextHop": { "type": "string", "description": "The Network Layer address of the border router\n that should be used for the destination network.", "x-yang-type": "CISCO-BGP4-MIB:CbgpNetworkAddress" }, "cbgpRouteMedPresent": { "type": "boolean", "description": "Indicates the presence/absence of MULTI_EXIT_DISC\n attribute for the route." }, "cbgpRouteMultiExitDisc": { "type": "integer", "description": "This metric is used to discriminate between multiple\n exit points to an adjacent autonomous system. The\n value of this object is irrelevant if the value of\n of cbgpRouteMedPresent is false(2).", "minimum": 0, "maximum": 4294967295 }, "cbgpRouteLocalPrefPresent": { "type": "boolean", "description": "Indicates the presence/absence of LOCAL_PREF\n attribute for the route." }, "cbgpRouteLocalPref": { "type": "integer", "description": "The degree of preference calculated by the local BGP4\n speaker for the route. The value of this object is \n irrelevant if the value of cbgpRouteLocalPrefPresent \n is false(2).", "minimum": 0, "maximum": 4294967295 }, "cbgpRouteAtomicAggregate": { "type": "string", "description": "Whether or not the local system has selected a less\n specific route without selecting a more specific\n route." }, "cbgpRouteAggregatorAS": { "type": "integer", "description": "The AS number of the last BGP4 speaker that performed\n route aggregation. A value of zero (0) indicates the \n absence of this attribute.", "minimum": 0, "maximum": 4294967295 }, "cbgpRouteAggregatorAddrType": { "type": "string", "description": "Represents the type of Network Layer address stored\n in cbgpRouteAggregatorAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cbgpRouteAggregatorAddr": { "type": "string", "description": "The Network Layer address of the last BGP4 speaker\n that performed route aggregation. A value of all zeros\n indicates the absence of this attribute.", "x-yang-type": "inet-address:InetAddress" }, "cbgpRouteBest": { "type": "boolean", "description": "An indication of whether or not this route was chosen\n as the best BGP4 route." }, "cbgpRouteUnknownAttr": { "type": "string", "description": "One or more path attributes not understood by this\n BGP4 speaker. Size zero (0) indicates the absence of\n such attribute(s). Octets beyond the maximum size, if\n any, are not recorded by this object. \n \n Each path attribute is a triple of variable length.\n Attribute Type is a two-octet field that consists of\n the Attribute Flags octet followed by the Attribute\n Type Code octet. If the Extended Length bit of the \n Attribute Flags octet is set to 0, the third octet of \n the Path Attribute contains the length of the\n attribute data in octets. If the Extended Length bit \n of the Attribute Flags octet is set to 1, then the\n third and the fourth octets of the path attribute \n contain the length of the attribute data in octets.\n The remaining octets of the Path Attribute represent \n the attribute value and are interpreted according to \n the Attribute Flags and the Attribute Type Code.", "format": "binary" } } }, "example": { "CISCO-BGP4-MIB:cbgpRouteEntry": { "cbgpRouteAfi": "example-string", "cbgpRouteSafi": "example-string", "cbgpRoutePeerType": "ethernetCsmacd(6)", "cbgpRoutePeer": "example-string", "cbgpRouteAddrPrefix": "192.168.1.1", "cbgpRouteAddrPrefixLen": 0, "cbgpRouteOrigin": "example-string", "cbgpRouteASPathSegment": "example-string", "cbgpRouteNextHop": "example-string", "cbgpRouteMedPresent": true, "cbgpRouteMultiExitDisc": 0, "cbgpRouteLocalPrefPresent": true, "cbgpRouteLocalPref": 0, "cbgpRouteAtomicAggregate": "example-string", "cbgpRouteAggregatorAS": 0, "cbgpRouteAggregatorAddrType": "192.168.1.1", "cbgpRouteAggregatorAddr": "192.168.1.1", "cbgpRouteBest": true, "cbgpRouteUnknownAttr": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpRouteEntry-4" }, "x-yang-path": "/cbgpRouteEntry={cbgpRouteAfi cbgpRouteSafi cbgpRoutePeerType cbgpRoutePeer cbgpRouteAddrPrefix cbgpRouteAddrPrefixLen}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cbgpRouteAfi cbgpRouteSafi cbgpRoutePeerType cbgpRoutePeer cbgpRouteAddrPrefix cbgpRouteAddrPrefixLen" ] }, "/data/CISCO-BGP4-MIB:cbgpPeerCapsEntry={bgpPeerRemoteAddr},{cbgpPeerCapCode},{cbgpPeerCapIndex}": { "get": { "summary": "Get cbgpPeerCapsEntry entry", "description": "Retrieve specific cbgpPeerCapsEntry entry by key from MIB", "tags": [ "CISCO-BGP4-MIB" ], "parameters": [ { "name": "bgpPeerRemoteAddr", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpPeerCapCode", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpPeerCapIndex", "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": { "bgpPeerRemoteAddr": { "type": "string", "description": "bgpPeerRemoteAddr", "x-yang-type": "leafref" }, "cbgpPeerCapCode": { "type": "string", "description": "The BGP Capability Advertisement Capability Code." }, "cbgpPeerCapIndex": { "type": "integer", "description": "Multiple instances of a given capability may be\n sent by a BGP speaker. This variable is used\n to index them.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerCapValue": { "type": "string", "description": "The value of the announced capability. This\n MIB object value is organized as given below,\n Capability : Route Refresh Capability\n Null string\n Capability : Multiprotocol Extensions\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n Capability : Graceful Restart\n +----------------------------------+\n | Restart Flags (4 bits) |\n +----------------------------------+\n | Restart Time in seconds (12 bits)|\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Flags for Address Family (8 bits)|\n +----------------------------------+\n | ... |\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Flags for Address Family (8 bits)|\n +----------------------------------+", "format": "binary" } } }, "example": { "CISCO-BGP4-MIB:cbgpPeerCapsEntry": { "bgpPeerRemoteAddr": "192.168.1.1", "cbgpPeerCapCode": "example-string", "cbgpPeerCapIndex": 1, "cbgpPeerCapValue": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeerCapsEntry-4" }, "x-yang-path": "/cbgpPeerCapsEntry={bgpPeerRemoteAddr cbgpPeerCapCode cbgpPeerCapIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "bgpPeerRemoteAddr cbgpPeerCapCode cbgpPeerCapIndex" ] }, "/data/CISCO-BGP4-MIB:cbgpPeerAddrFamilyEntry={bgpPeerRemoteAddr},{cbgpPeerAddrFamilyAfi},{cbgpPeerAddrFamilySafi}": { "get": { "summary": "Get cbgpPeerAddrFamilyEntry entry", "description": "Retrieve specific cbgpPeerAddrFamilyEntry entry by key from MIB", "tags": [ "CISCO-BGP4-MIB" ], "parameters": [ { "name": "bgpPeerRemoteAddr", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpPeerAddrFamilyAfi", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpPeerAddrFamilySafi", "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": { "bgpPeerRemoteAddr": { "type": "string", "description": "bgpPeerRemoteAddr", "x-yang-type": "leafref" }, "cbgpPeerAddrFamilyAfi": { "type": "string", "description": "The AFI index of the entry. An implementation\n is only required to support IPv4 unicast and \n VPNv4 (Value - 1) address families.", "x-yang-type": "inet-address:InetAddressType" }, "cbgpPeerAddrFamilySafi": { "type": "string", "description": "The SAFI index of the entry. An implementation\n is only required to support IPv4 unicast(Value \n - 1) and VPNv4( Value - 128) address families.", "x-yang-type": "CISCO-BGP4-MIB:CbgpSafi" }, "cbgpPeerAddrFamilyName": { "type": "string", "description": "Implementation specific Address Family name.", "x-yang-type": "snmp-framework:SnmpAdminString" } } }, "example": { "CISCO-BGP4-MIB:cbgpPeerAddrFamilyEntry": { "bgpPeerRemoteAddr": "192.168.1.1", "cbgpPeerAddrFamilyAfi": "192.168.1.1", "cbgpPeerAddrFamilySafi": "192.168.1.1", "cbgpPeerAddrFamilyName": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeerAddrFamilyEntry-4" }, "x-yang-path": "/cbgpPeerAddrFamilyEntry={bgpPeerRemoteAddr cbgpPeerAddrFamilyAfi cbgpPeerAddrFamilySafi}", "x-restconf-kind": "list-instance", "x-list-keys": [ "bgpPeerRemoteAddr cbgpPeerAddrFamilyAfi cbgpPeerAddrFamilySafi" ] }, "/data/CISCO-BGP4-MIB:cbgpPeerAddrFamilyPrefixEntry={bgpPeerRemoteAddr},{cbgpPeerAddrFamilyAfi},{cbgpPeerAddrFamilySafi}": { "get": { "summary": "Get cbgpPeerAddrFamilyPrefixEntry entry", "description": "Retrieve specific cbgpPeerAddrFamilyPrefixEntry entry by key from MIB", "tags": [ "CISCO-BGP4-MIB" ], "parameters": [ { "name": "bgpPeerRemoteAddr", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpPeerAddrFamilyAfi", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpPeerAddrFamilySafi", "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": { "bgpPeerRemoteAddr": { "type": "string", "description": "bgpPeerRemoteAddr", "x-yang-type": "leafref" }, "cbgpPeerAddrFamilyAfi": { "type": "string", "description": "cbgpPeerAddrFamilyAfi", "x-yang-type": "leafref" }, "cbgpPeerAddrFamilySafi": { "type": "string", "description": "cbgpPeerAddrFamilySafi", "x-yang-type": "leafref" }, "cbgpPeerAcceptedPrefixes": { "type": "integer", "description": "Number of accepted route prefixes on this connection,\n which belong to an address family.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerDeniedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix, which\n belongs to an address family, received on this \n connection is denied. It is initialized to zero when \n the connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerPrefixAdminLimit": { "type": "integer", "description": "Max number of route prefixes accepted for an address\n family on this connection.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerPrefixThreshold": { "type": "integer", "description": "Prefix threshold value (%) for an address family\n on this connection at which warning message stating\n the prefix count is crossed the threshold or \n corresponding SNMP notification is generated.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerPrefixClearThreshold": { "type": "integer", "description": "Prefix threshold value (%) for an address family\n on this connection at which SNMP clear notification\n is generated if prefix threshold notification is\n already generated.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerAdvertisedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family is advertised\n on this connection. It is initialized to zero when \n the connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerSuppressedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family is suppressed\n from being sent on this connection. It is \n initialized to zero when the connection is undergone\n a hard reset.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeerWithdrawnPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family, is withdrawn on\n this connection. It is initialized to zero when the\n connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-BGP4-MIB:cbgpPeerAddrFamilyPrefixEntry": { "bgpPeerRemoteAddr": "192.168.1.1", "cbgpPeerAddrFamilyAfi": "192.168.1.1", "cbgpPeerAddrFamilySafi": "192.168.1.1", "cbgpPeerAcceptedPrefixes": 0, "cbgpPeerDeniedPrefixes": 0, "cbgpPeerPrefixAdminLimit": 1, "cbgpPeerPrefixThreshold": 0, "cbgpPeerPrefixClearThreshold": 0, "cbgpPeerAdvertisedPrefixes": 0, "cbgpPeerSuppressedPrefixes": 0, "cbgpPeerWithdrawnPrefixes": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeerAddrFamilyPrefixEntry-4" }, "x-yang-path": "/cbgpPeerAddrFamilyPrefixEntry={bgpPeerRemoteAddr cbgpPeerAddrFamilyAfi cbgpPeerAddrFamilySafi}", "x-restconf-kind": "list-instance", "x-list-keys": [ "bgpPeerRemoteAddr cbgpPeerAddrFamilyAfi cbgpPeerAddrFamilySafi" ] }, "/data/CISCO-BGP4-MIB:cbgpPeer2Entry={cbgpPeer2Type},{cbgpPeer2RemoteAddr}": { "get": { "summary": "Get cbgpPeer2Entry entry", "description": "Retrieve specific cbgpPeer2Entry entry by key from MIB", "tags": [ "CISCO-BGP4-MIB" ], "parameters": [ { "name": "cbgpPeer2Type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpPeer2RemoteAddr", "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": { "cbgpPeer2Type": { "type": "string", "description": "Represents the type of Peer address stored\n in cbgpPeer2Entry.", "x-yang-type": "inet-address:InetAddressType" }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "The remote IP address of this entry's BGP\n peer.", "x-yang-type": "inet-address:InetAddress" }, "cbgpPeer2State": { "type": "string", "description": "The BGP peer connection state." }, "cbgpPeer2AdminStatus": { "type": "string", "description": "The desired state of the BGP connection.\n A transition from 'stop' to 'start' will cause\n the BGP Manual Start Event to be generated.\n A transition from 'start' to 'stop' will cause\n the BGP Manual Stop Event to be generated.\n This parameter can be used to restart BGP peer\n connections. Care should be used in providing\n write access to this object without adequate\n authentication." }, "cbgpPeer2NegotiatedVersion": { "type": "integer", "description": "The negotiated version of BGP running between\n the two peers.\n \n This entry MUST be zero (0) unless the\n cbgpPeer2State is in the openconfirm or the\n established state.\n \n Note that legal values for this object are\n between 0 and 255.", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2LocalAddr": { "type": "string", "description": "The local IP address of this entry's BGP\n connection.", "x-yang-type": "inet-address:InetAddress" }, "cbgpPeer2LocalPort": { "type": "string", "description": "The local port for the TCP connection between\n the BGP peers.", "format": "inet:port-number" }, "cbgpPeer2LocalAs": { "type": "string", "description": "The local AS number for this session.", "format": "inet:as-number" }, "cbgpPeer2LocalIdentifier": { "type": "string", "description": "The BGP Identifier of this entry's BGP peer.", "format": "inet:ipv4-address" }, "cbgpPeer2RemotePort": { "type": "string", "description": "The remote port for the TCP connection\n between the BGP peers. Note that the\n objects cbgpPeer2LocalAddr,\n cbgpPeer2LocalPort, cbgpPeer2RemoteAddr, and\n cbgpPeer2RemotePort provide the appropriate\n reference to the standard MIB TCP\n connection table.", "format": "inet:port-number" }, "cbgpPeer2RemoteAs": { "type": "string", "description": "The remote autonomous system number received in\n the BGP OPEN message.", "format": "inet:as-number" }, "cbgpPeer2RemoteIdentifier": { "type": "string", "description": "The BGP Identifier of this entry's BGP peer.\n This entry MUST be 0.0.0.0 unless the\n cbgpPeer2State is in the openconfirm or the\n established state.", "format": "inet:ipv4-address" }, "cbgpPeer2InUpdates": { "type": "integer", "description": "The number of BGP UPDATE messages\n received on this connection.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2OutUpdates": { "type": "integer", "description": "The number of BGP UPDATE messages\n transmitted on this connection.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2InTotalMessages": { "type": "integer", "description": "The total number of messages received\n from the remote peer on this connection.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2OutTotalMessages": { "type": "integer", "description": "The total number of messages transmitted to\n the remote peer on this connection.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2LastError": { "type": "string", "description": "The last error code and subcode seen by this\n peer on this connection. If no error has\n occurred, this field is zero. Otherwise, the\n first byte of this two byte OCTET STRING\n contains the error code, and the second byte\n contains the subcode.", "format": "binary" }, "cbgpPeer2FsmEstablishedTransitions": { "type": "integer", "description": "The total number of times the BGP FSM\n transitioned into the established state\n for this peer.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2FsmEstablishedTime": { "type": "integer", "description": "This timer indicates how long (in\n seconds) this peer has been in the\n established state or how long\n since this peer was last in the\n established state. It is set to zero when\n a new peer is configured or when the router is\n booted.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2ConnectRetryInterval": { "type": "integer", "description": "Time interval (in seconds) for the\n ConnectRetry timer. The suggested value\n for this timer is 120 seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2HoldTime": { "type": "integer", "description": "Time interval (in seconds) for the Hold\n Timer established with the peer. The\n value of this object is calculated by this\n BGP speaker, using the smaller of the\n values in cbgpPeer2HoldTimeConfigured and the\n Hold Time received in the OPEN message.\n \n This value must be at least three seconds\n if it is not zero (0).\n \n If the Hold Timer has not been established\n with the peer this object MUST have a value\n of zero (0).\n \n If the cbgpPeer2HoldTimeConfigured object has\n a value of (0), then this object MUST have a\n value of (0).", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2KeepAlive": { "type": "integer", "description": "Time interval (in seconds) for the KeepAlive\n timer established with the peer. The value\n of this object is calculated by this BGP\n speaker such that, when compared with\n cbgpPeer2HoldTime, it has the same proportion\n that cbgpPeer2KeepAliveConfigured has,\n compared with cbgpPeer2HoldTimeConfigured.\n \n If the KeepAlive timer has not been established\n with the peer, this object MUST have a value\n of zero (0).\n \n If the of cbgpPeer2KeepAliveConfigured object\n has a value of (0), then this object MUST have\n a value of (0).", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2HoldTimeConfigured": { "type": "integer", "description": "Time interval (in seconds) for the Hold Time\n configured for this BGP speaker with this\n peer. This value is placed in an OPEN\n message sent to this peer by this BGP\n speaker, and is compared with the Hold\n Time field in an OPEN message received\n from the peer when determining the Hold\n Time (cbgpPeer2HoldTime) with the peer.\n This value must not be less than three\n seconds if it is not zero (0). If it is\n zero (0), the Hold Time is NOT to be\n established with the peer. The suggested\n value for this timer is 90 seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2KeepAliveConfigured": { "type": "integer", "description": "Time interval (in seconds) for the\n KeepAlive timer configured for this BGP\n speaker with this peer. The value of this\n object will only determine the\n KEEPALIVE messages' frequency relative to\n the value specified in\n cbgpPeer2HoldTimeConfigured; the actual\n time interval for the KEEPALIVE messages is\n indicated by cbgpPeer2KeepAlive. A\n reasonable maximum value for this timer\n would be one third of that of\n cbgpPeer2HoldTimeConfigured.\n If the value of this object is zero (0),\n no periodical KEEPALIVE messages are sent\n to the peer after the BGP connection has\n been established. The suggested value for\n this timer is 30 seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2MinASOriginationInterval": { "type": "integer", "description": "Time interval (in seconds) for the\n MinASOriginationInterval timer.\n The suggested value for this timer is 15\n seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2MinRouteAdvertisementInterval": { "type": "integer", "description": "Time interval (in seconds) for the\n MinRouteAdvertisementInterval timer.\n The suggested value for this timer is 30\n seconds for EBGP connections and 5\n seconds for IBGP connections.", "minimum": -2147483648, "maximum": 2147483647 }, "cbgpPeer2InUpdateElapsedTime": { "type": "integer", "description": "Elapsed time (in seconds) since the last BGP\n UPDATE message was received from the peer.\n Each time cbgpPeer2InUpdates is incremented,\n the value of this object is set to zero (0).", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2LastErrorTxt": { "type": "string", "description": "Implementation specific error description for\n bgpPeerLastErrorReceived.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cbgpPeer2PrevState": { "type": "string", "description": "The BGP peer connection previous state." } } }, "example": { "CISCO-BGP4-MIB:cbgpPeer2Entry": { "cbgpPeer2Type": "ethernetCsmacd(6)", "cbgpPeer2RemoteAddr": "192.168.1.1", "cbgpPeer2State": "up(1)", "cbgpPeer2AdminStatus": "up(1)", "cbgpPeer2NegotiatedVersion": -2147483648, "cbgpPeer2LocalAddr": "192.168.1.1", "cbgpPeer2LocalPort": "example-string", "cbgpPeer2LocalAs": "example-string", "cbgpPeer2LocalIdentifier": "example-string", "cbgpPeer2RemotePort": "example-string", "cbgpPeer2RemoteAs": "example-string", "cbgpPeer2RemoteIdentifier": "example-string", "cbgpPeer2InUpdates": 0, "cbgpPeer2OutUpdates": 0, "cbgpPeer2InTotalMessages": 0, "cbgpPeer2OutTotalMessages": 0, "cbgpPeer2LastError": "example-string", "cbgpPeer2FsmEstablishedTransitions": 0, "cbgpPeer2FsmEstablishedTime": 0, "cbgpPeer2ConnectRetryInterval": -2147483648, "cbgpPeer2HoldTime": -2147483648, "cbgpPeer2KeepAlive": -2147483648, "cbgpPeer2HoldTimeConfigured": -2147483648, "cbgpPeer2KeepAliveConfigured": -2147483648, "cbgpPeer2MinASOriginationInterval": -2147483648, "cbgpPeer2MinRouteAdvertisementInterval": -2147483648, "cbgpPeer2InUpdateElapsedTime": 0, "cbgpPeer2LastErrorTxt": "example-string", "cbgpPeer2PrevState": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeer2Entry-4" }, "x-yang-path": "/cbgpPeer2Entry={cbgpPeer2Type cbgpPeer2RemoteAddr}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cbgpPeer2Type cbgpPeer2RemoteAddr" ] }, "/data/CISCO-BGP4-MIB:cbgpPeer2CapsEntry={cbgpPeer2Type},{cbgpPeer2RemoteAddr},{cbgpPeer2CapCode},{cbgpPeer2CapIndex}": { "get": { "summary": "Get cbgpPeer2CapsEntry entry", "description": "Retrieve specific cbgpPeer2CapsEntry entry by key from MIB", "tags": [ "CISCO-BGP4-MIB" ], "parameters": [ { "name": "cbgpPeer2Type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpPeer2RemoteAddr", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpPeer2CapCode", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpPeer2CapIndex", "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": { "cbgpPeer2Type": { "type": "string", "description": "cbgpPeer2Type", "x-yang-type": "leafref" }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "cbgpPeer2RemoteAddr", "x-yang-type": "leafref" }, "cbgpPeer2CapCode": { "type": "string", "description": "The BGP Capability Advertisement Capability Code." }, "cbgpPeer2CapIndex": { "type": "integer", "description": "Multiple instances of a given capability may be\n sent by a BGP speaker. This variable is used\n to index them.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2CapValue": { "type": "string", "description": "The value of the announced capability. This\n MIB object value is organized as given below,\n Capability : Route Refresh Capability\n 4-Byte AS Capability\n Null string\n Capability : Multiprotocol Extensions\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n Capability : Graceful Restart\n +----------------------------------+\n | Restart Flags (4 bits) |\n +----------------------------------+\n | Restart Time in seconds (12 bits)|\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Flags for Address Family (8 bits)|\n +----------------------------------+\n | ... |\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Flags for Address Family (8 bits)|\n +----------------------------------+\n Capability : Additional Paths\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Send/Receive (8 bits) |\n +----------------------------------+", "format": "binary" } } }, "example": { "CISCO-BGP4-MIB:cbgpPeer2CapsEntry": { "cbgpPeer2Type": "ethernetCsmacd(6)", "cbgpPeer2RemoteAddr": "192.168.1.1", "cbgpPeer2CapCode": "example-string", "cbgpPeer2CapIndex": 1, "cbgpPeer2CapValue": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeer2CapsEntry-4" }, "x-yang-path": "/cbgpPeer2CapsEntry={cbgpPeer2Type cbgpPeer2RemoteAddr cbgpPeer2CapCode cbgpPeer2CapIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cbgpPeer2Type cbgpPeer2RemoteAddr cbgpPeer2CapCode cbgpPeer2CapIndex" ] }, "/data/CISCO-BGP4-MIB:cbgpPeer2AddrFamilyEntry={cbgpPeer2Type},{cbgpPeer2RemoteAddr},{cbgpPeer2AddrFamilyAfi},{cbgpPeer2AddrFamilySafi}": { "get": { "summary": "Get cbgpPeer2AddrFamilyEntry entry", "description": "Retrieve specific cbgpPeer2AddrFamilyEntry entry by key from MIB", "tags": [ "CISCO-BGP4-MIB" ], "parameters": [ { "name": "cbgpPeer2Type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpPeer2RemoteAddr", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpPeer2AddrFamilyAfi", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpPeer2AddrFamilySafi", "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": { "cbgpPeer2Type": { "type": "string", "description": "cbgpPeer2Type", "x-yang-type": "leafref" }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "cbgpPeer2RemoteAddr", "x-yang-type": "leafref" }, "cbgpPeer2AddrFamilyAfi": { "type": "string", "description": "The AFI index of the entry. An implementation\n is only required to support IPv4 unicast and\n VPNv4 (Value - 1) address families.", "x-yang-type": "inet-address:InetAddressType" }, "cbgpPeer2AddrFamilySafi": { "type": "string", "description": "The SAFI index of the entry. An implementation\n is only required to support IPv4 unicast(Value\n - 1) and VPNv4( Value - 128) address families.", "x-yang-type": "CISCO-BGP4-MIB:CbgpSafi" }, "cbgpPeer2AddrFamilyName": { "type": "string", "description": "Implementation specific Address Family name.", "x-yang-type": "snmp-framework:SnmpAdminString" } } }, "example": { "CISCO-BGP4-MIB:cbgpPeer2AddrFamilyEntry": { "cbgpPeer2Type": "ethernetCsmacd(6)", "cbgpPeer2RemoteAddr": "192.168.1.1", "cbgpPeer2AddrFamilyAfi": "192.168.1.1", "cbgpPeer2AddrFamilySafi": "192.168.1.1", "cbgpPeer2AddrFamilyName": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeer2AddrFamilyEntry-4" }, "x-yang-path": "/cbgpPeer2AddrFamilyEntry={cbgpPeer2Type cbgpPeer2RemoteAddr cbgpPeer2AddrFamilyAfi cbgpPeer2AddrFamilySafi}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cbgpPeer2Type cbgpPeer2RemoteAddr cbgpPeer2AddrFamilyAfi cbgpPeer2AddrFamilySafi" ] }, "/data/CISCO-BGP4-MIB:cbgpPeer2AddrFamilyPrefixEntry={cbgpPeer2Type},{cbgpPeer2RemoteAddr},{cbgpPeer2AddrFamilyAfi},{cbgpPeer2AddrFamilySafi}": { "get": { "summary": "Get cbgpPeer2AddrFamilyPrefixEntry entry", "description": "Retrieve specific cbgpPeer2AddrFamilyPrefixEntry entry by key from MIB", "tags": [ "CISCO-BGP4-MIB" ], "parameters": [ { "name": "cbgpPeer2Type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpPeer2RemoteAddr", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpPeer2AddrFamilyAfi", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cbgpPeer2AddrFamilySafi", "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": { "cbgpPeer2Type": { "type": "string", "description": "cbgpPeer2Type", "x-yang-type": "leafref" }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "cbgpPeer2RemoteAddr", "x-yang-type": "leafref" }, "cbgpPeer2AddrFamilyAfi": { "type": "string", "description": "cbgpPeer2AddrFamilyAfi", "x-yang-type": "leafref" }, "cbgpPeer2AddrFamilySafi": { "type": "string", "description": "cbgpPeer2AddrFamilySafi", "x-yang-type": "leafref" }, "cbgpPeer2AcceptedPrefixes": { "type": "integer", "description": "Number of accepted route prefixes on this connection,\n which belong to an address family.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2DeniedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix, which\n belongs to an address family, received on this\n connection is denied. It is initialized to zero when\n the connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2PrefixAdminLimit": { "type": "integer", "description": "Max number of route prefixes accepted for an address\n family on this connection.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2PrefixThreshold": { "type": "integer", "description": "Prefix threshold value (%) for an address family\n on this connection at which warning message stating\n the prefix count is crossed the threshold or\n corresponding SNMP notification is generated.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2PrefixClearThreshold": { "type": "integer", "description": "Prefix threshold value (%) for an address family\n on this connection at which SNMP clear notification\n is generated if prefix threshold notification is\n already generated.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2AdvertisedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family is advertised\n on this connection. It is initialized to zero when\n the connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2SuppressedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family is suppressed\n from being sent on this connection. It is\n initialized to zero when the connection is undergone\n a hard reset.", "minimum": 0, "maximum": 4294967295 }, "cbgpPeer2WithdrawnPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family, is withdrawn on\n this connection. It is initialized to zero when the\n connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-BGP4-MIB:cbgpPeer2AddrFamilyPrefixEntry": { "cbgpPeer2Type": "ethernetCsmacd(6)", "cbgpPeer2RemoteAddr": "192.168.1.1", "cbgpPeer2AddrFamilyAfi": "192.168.1.1", "cbgpPeer2AddrFamilySafi": "192.168.1.1", "cbgpPeer2AcceptedPrefixes": 0, "cbgpPeer2DeniedPrefixes": 0, "cbgpPeer2PrefixAdminLimit": 1, "cbgpPeer2PrefixThreshold": 0, "cbgpPeer2PrefixClearThreshold": 0, "cbgpPeer2AdvertisedPrefixes": 0, "cbgpPeer2SuppressedPrefixes": 0, "cbgpPeer2WithdrawnPrefixes": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cbgpPeer2AddrFamilyPrefixEntry-4" }, "x-yang-path": "/cbgpPeer2AddrFamilyPrefixEntry={cbgpPeer2Type cbgpPeer2RemoteAddr cbgpPeer2AddrFamilyAfi cbgpPeer2AddrFamilySafi}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cbgpPeer2Type cbgpPeer2RemoteAddr cbgpPeer2AddrFamilyAfi cbgpPeer2AddrFamilySafi" ] } }, "components": { "schemas": { "CISCO-BGP4-MIB_CISCO-BGP4-MIB": { "type": "object", "description": "CISCO-BGP4-MIB", "properties": { "cbgpRouteEntry": { "type": "array", "description": "Information about a path to a network received from\n a peer.", "items": { "type": "object", "properties": { "cbgpRouteAfi": { "type": "string", "description": "Represents Address Family Identifier(AFI) of the\n Network Layer protocol associated with the route.\n An implementation is only required to support IPv4\n unicast and VPNv4 (Value - 1) address families.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cbgpRouteSafi": { "type": "string", "description": "Represents Subsequent Address Family Identifier(SAFI)\n of the route. It gives additional information about\n the type of the route. An implementation is only \n required to support IPv4 unicast(Value - 1) and VPNv4(\n Value - 128) address families.", "x-yang-type": "CISCO-BGP4-MIB:CbgpSafi", "readOnly": true }, "cbgpRoutePeerType": { "type": "string", "description": "Represents the type of Network Layer address stored\n in cbgpRoutePeer. An implementation is only required\n to support IPv4 address type(Value - 1).", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cbgpRoutePeer": { "type": "string", "description": "The Network Layer address of the peer where the route\n information was learned. An implementation is only \n required to support an IPv4 peer.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cbgpRouteAddrPrefix": { "type": "string", "description": "A Network Address prefix in the Network Layer\n Reachability Information field of BGP UPDATE message.\n This object is a Network Address containing the prefix\n with length specified by cbgpRouteAddrPrefixLen. Any\n bits beyond the length specified by\n cbgpRouteAddrPrefixLen are zeroed.", "x-yang-type": "CISCO-BGP4-MIB:CbgpNetworkAddress", "readOnly": true }, "cbgpRouteAddrPrefixLen": { "type": "integer", "description": "Length in bits of the Network Address prefix in the\n Network Layer Reachability Information field.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpRouteOrigin": { "type": "string", "description": "The ultimate origin of the route information.", "readOnly": true }, "cbgpRouteASPathSegment": { "type": "string", "description": "The sequence of AS path segments. Each AS\n path segment is represented by a triple\n .\n \n The type is a 1-octet field which has two\n possible values:\n 1 AS_SET: unordered set of ASs a route in the \n UPDATE message has traversed\n 2 AS_SEQUENCE: ordered set of ASs a route in the\n UPDATE message has traversed.\n \n The length is a 1-octet field containing the\n number of ASs in the value field.\n \n The value field contains one or more AS\n numbers, each AS is represented in the octet\n string as a pair of octets according to the\n following algorithm:\n \n first-byte-of-pair = ASNumber / 256;\n second-byte-of-pair = ASNumber & 255;", "format": "binary", "readOnly": true }, "cbgpRouteNextHop": { "type": "string", "description": "The Network Layer address of the border router\n that should be used for the destination network.", "x-yang-type": "CISCO-BGP4-MIB:CbgpNetworkAddress", "readOnly": true }, "cbgpRouteMedPresent": { "type": "boolean", "description": "Indicates the presence/absence of MULTI_EXIT_DISC\n attribute for the route.", "readOnly": true }, "cbgpRouteMultiExitDisc": { "type": "integer", "description": "This metric is used to discriminate between multiple\n exit points to an adjacent autonomous system. The\n value of this object is irrelevant if the value of\n of cbgpRouteMedPresent is false(2).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpRouteLocalPrefPresent": { "type": "boolean", "description": "Indicates the presence/absence of LOCAL_PREF\n attribute for the route.", "readOnly": true }, "cbgpRouteLocalPref": { "type": "integer", "description": "The degree of preference calculated by the local BGP4\n speaker for the route. The value of this object is \n irrelevant if the value of cbgpRouteLocalPrefPresent \n is false(2).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpRouteAtomicAggregate": { "type": "string", "description": "Whether or not the local system has selected a less\n specific route without selecting a more specific\n route.", "readOnly": true }, "cbgpRouteAggregatorAS": { "type": "integer", "description": "The AS number of the last BGP4 speaker that performed\n route aggregation. A value of zero (0) indicates the \n absence of this attribute.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpRouteAggregatorAddrType": { "type": "string", "description": "Represents the type of Network Layer address stored\n in cbgpRouteAggregatorAddr.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cbgpRouteAggregatorAddr": { "type": "string", "description": "The Network Layer address of the last BGP4 speaker\n that performed route aggregation. A value of all zeros\n indicates the absence of this attribute.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cbgpRouteBest": { "type": "boolean", "description": "An indication of whether or not this route was chosen\n as the best BGP4 route.", "readOnly": true }, "cbgpRouteUnknownAttr": { "type": "string", "description": "One or more path attributes not understood by this\n BGP4 speaker. Size zero (0) indicates the absence of\n such attribute(s). Octets beyond the maximum size, if\n any, are not recorded by this object. \n \n Each path attribute is a triple of variable length.\n Attribute Type is a two-octet field that consists of\n the Attribute Flags octet followed by the Attribute\n Type Code octet. If the Extended Length bit of the \n Attribute Flags octet is set to 0, the third octet of \n the Path Attribute contains the length of the\n attribute data in octets. If the Extended Length bit \n of the Attribute Flags octet is set to 1, then the\n third and the fourth octets of the path attribute \n contain the length of the attribute data in octets.\n The remaining octets of the Path Attribute represent \n the attribute value and are interpreted according to \n the Attribute Flags and the Attribute Type Code.", "format": "binary", "readOnly": true } } }, "readOnly": true }, "cbgpPeerCapsEntry": { "type": "array", "description": "Each entry represents a capability received from a\n peer with a particular code and an index. When a \n capability is received multiple times with different\n values during a BGP connection establishment, \n corresponding entries are differentiated with indices.", "items": { "type": "object", "properties": { "bgpPeerRemoteAddr": { "type": "string", "description": "bgpPeerRemoteAddr", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeerCapCode": { "type": "string", "description": "The BGP Capability Advertisement Capability Code.", "readOnly": true }, "cbgpPeerCapIndex": { "type": "integer", "description": "Multiple instances of a given capability may be\n sent by a BGP speaker. This variable is used\n to index them.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeerCapValue": { "type": "string", "description": "The value of the announced capability. This\n MIB object value is organized as given below,\n Capability : Route Refresh Capability\n Null string\n Capability : Multiprotocol Extensions\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n Capability : Graceful Restart\n +----------------------------------+\n | Restart Flags (4 bits) |\n +----------------------------------+\n | Restart Time in seconds (12 bits)|\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Flags for Address Family (8 bits)|\n +----------------------------------+\n | ... |\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Flags for Address Family (8 bits)|\n +----------------------------------+", "format": "binary", "readOnly": true } } }, "readOnly": true }, "cbgpPeerAddrFamilyEntry": { "type": "array", "description": "An entry is identified by an AFI/SAFI pair and\n peer address. It contains names associated with\n an address family.", "items": { "type": "object", "properties": { "bgpPeerRemoteAddr": { "type": "string", "description": "bgpPeerRemoteAddr", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeerAddrFamilyAfi": { "type": "string", "description": "The AFI index of the entry. An implementation\n is only required to support IPv4 unicast and \n VPNv4 (Value - 1) address families.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cbgpPeerAddrFamilySafi": { "type": "string", "description": "The SAFI index of the entry. An implementation\n is only required to support IPv4 unicast(Value \n - 1) and VPNv4( Value - 128) address families.", "x-yang-type": "CISCO-BGP4-MIB:CbgpSafi", "readOnly": true }, "cbgpPeerAddrFamilyName": { "type": "string", "description": "Implementation specific Address Family name.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } }, "readOnly": true }, "cbgpPeerAddrFamilyPrefixEntry": { "type": "array", "description": "An entry is identified by an AFI/SAFI pair and\n peer address. It contains information associated \n with route prefixes belonging to an address family.", "items": { "type": "object", "properties": { "bgpPeerRemoteAddr": { "type": "string", "description": "bgpPeerRemoteAddr", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeerAddrFamilyAfi": { "type": "string", "description": "cbgpPeerAddrFamilyAfi", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeerAddrFamilySafi": { "type": "string", "description": "cbgpPeerAddrFamilySafi", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeerAcceptedPrefixes": { "type": "integer", "description": "Number of accepted route prefixes on this connection,\n which belong to an address family.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeerDeniedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix, which\n belongs to an address family, received on this \n connection is denied. It is initialized to zero when \n the connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeerPrefixAdminLimit": { "type": "integer", "description": "Max number of route prefixes accepted for an address\n family on this connection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeerPrefixThreshold": { "type": "integer", "description": "Prefix threshold value (%) for an address family\n on this connection at which warning message stating\n the prefix count is crossed the threshold or \n corresponding SNMP notification is generated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeerPrefixClearThreshold": { "type": "integer", "description": "Prefix threshold value (%) for an address family\n on this connection at which SNMP clear notification\n is generated if prefix threshold notification is\n already generated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeerAdvertisedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family is advertised\n on this connection. It is initialized to zero when \n the connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeerSuppressedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family is suppressed\n from being sent on this connection. It is \n initialized to zero when the connection is undergone\n a hard reset.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeerWithdrawnPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family, is withdrawn on\n this connection. It is initialized to zero when the\n connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "cbgpPeer2Entry": { "type": "array", "description": "Entry containing information about the\n connection with a BGP peer.", "items": { "type": "object", "properties": { "cbgpPeer2Type": { "type": "string", "description": "Represents the type of Peer address stored\n in cbgpPeer2Entry.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "The remote IP address of this entry's BGP\n peer.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cbgpPeer2State": { "type": "string", "description": "The BGP peer connection state.", "readOnly": true }, "cbgpPeer2AdminStatus": { "type": "string", "description": "The desired state of the BGP connection.\n A transition from 'stop' to 'start' will cause\n the BGP Manual Start Event to be generated.\n A transition from 'start' to 'stop' will cause\n the BGP Manual Stop Event to be generated.\n This parameter can be used to restart BGP peer\n connections. Care should be used in providing\n write access to this object without adequate\n authentication.", "readOnly": true }, "cbgpPeer2NegotiatedVersion": { "type": "integer", "description": "The negotiated version of BGP running between\n the two peers.\n \n This entry MUST be zero (0) unless the\n cbgpPeer2State is in the openconfirm or the\n established state.\n \n Note that legal values for this object are\n between 0 and 255.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cbgpPeer2LocalAddr": { "type": "string", "description": "The local IP address of this entry's BGP\n connection.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cbgpPeer2LocalPort": { "type": "string", "description": "The local port for the TCP connection between\n the BGP peers.", "format": "inet:port-number", "readOnly": true }, "cbgpPeer2LocalAs": { "type": "string", "description": "The local AS number for this session.", "format": "inet:as-number", "readOnly": true }, "cbgpPeer2LocalIdentifier": { "type": "string", "description": "The BGP Identifier of this entry's BGP peer.", "format": "inet:ipv4-address", "readOnly": true }, "cbgpPeer2RemotePort": { "type": "string", "description": "The remote port for the TCP connection\n between the BGP peers. Note that the\n objects cbgpPeer2LocalAddr,\n cbgpPeer2LocalPort, cbgpPeer2RemoteAddr, and\n cbgpPeer2RemotePort provide the appropriate\n reference to the standard MIB TCP\n connection table.", "format": "inet:port-number", "readOnly": true }, "cbgpPeer2RemoteAs": { "type": "string", "description": "The remote autonomous system number received in\n the BGP OPEN message.", "format": "inet:as-number", "readOnly": true }, "cbgpPeer2RemoteIdentifier": { "type": "string", "description": "The BGP Identifier of this entry's BGP peer.\n This entry MUST be 0.0.0.0 unless the\n cbgpPeer2State is in the openconfirm or the\n established state.", "format": "inet:ipv4-address", "readOnly": true }, "cbgpPeer2InUpdates": { "type": "integer", "description": "The number of BGP UPDATE messages\n received on this connection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2OutUpdates": { "type": "integer", "description": "The number of BGP UPDATE messages\n transmitted on this connection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2InTotalMessages": { "type": "integer", "description": "The total number of messages received\n from the remote peer on this connection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2OutTotalMessages": { "type": "integer", "description": "The total number of messages transmitted to\n the remote peer on this connection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2LastError": { "type": "string", "description": "The last error code and subcode seen by this\n peer on this connection. If no error has\n occurred, this field is zero. Otherwise, the\n first byte of this two byte OCTET STRING\n contains the error code, and the second byte\n contains the subcode.", "format": "binary", "readOnly": true }, "cbgpPeer2FsmEstablishedTransitions": { "type": "integer", "description": "The total number of times the BGP FSM\n transitioned into the established state\n for this peer.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2FsmEstablishedTime": { "type": "integer", "description": "This timer indicates how long (in\n seconds) this peer has been in the\n established state or how long\n since this peer was last in the\n established state. It is set to zero when\n a new peer is configured or when the router is\n booted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2ConnectRetryInterval": { "type": "integer", "description": "Time interval (in seconds) for the\n ConnectRetry timer. The suggested value\n for this timer is 120 seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cbgpPeer2HoldTime": { "type": "integer", "description": "Time interval (in seconds) for the Hold\n Timer established with the peer. The\n value of this object is calculated by this\n BGP speaker, using the smaller of the\n values in cbgpPeer2HoldTimeConfigured and the\n Hold Time received in the OPEN message.\n \n This value must be at least three seconds\n if it is not zero (0).\n \n If the Hold Timer has not been established\n with the peer this object MUST have a value\n of zero (0).\n \n If the cbgpPeer2HoldTimeConfigured object has\n a value of (0), then this object MUST have a\n value of (0).", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cbgpPeer2KeepAlive": { "type": "integer", "description": "Time interval (in seconds) for the KeepAlive\n timer established with the peer. The value\n of this object is calculated by this BGP\n speaker such that, when compared with\n cbgpPeer2HoldTime, it has the same proportion\n that cbgpPeer2KeepAliveConfigured has,\n compared with cbgpPeer2HoldTimeConfigured.\n \n If the KeepAlive timer has not been established\n with the peer, this object MUST have a value\n of zero (0).\n \n If the of cbgpPeer2KeepAliveConfigured object\n has a value of (0), then this object MUST have\n a value of (0).", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cbgpPeer2HoldTimeConfigured": { "type": "integer", "description": "Time interval (in seconds) for the Hold Time\n configured for this BGP speaker with this\n peer. This value is placed in an OPEN\n message sent to this peer by this BGP\n speaker, and is compared with the Hold\n Time field in an OPEN message received\n from the peer when determining the Hold\n Time (cbgpPeer2HoldTime) with the peer.\n This value must not be less than three\n seconds if it is not zero (0). If it is\n zero (0), the Hold Time is NOT to be\n established with the peer. The suggested\n value for this timer is 90 seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cbgpPeer2KeepAliveConfigured": { "type": "integer", "description": "Time interval (in seconds) for the\n KeepAlive timer configured for this BGP\n speaker with this peer. The value of this\n object will only determine the\n KEEPALIVE messages' frequency relative to\n the value specified in\n cbgpPeer2HoldTimeConfigured; the actual\n time interval for the KEEPALIVE messages is\n indicated by cbgpPeer2KeepAlive. A\n reasonable maximum value for this timer\n would be one third of that of\n cbgpPeer2HoldTimeConfigured.\n If the value of this object is zero (0),\n no periodical KEEPALIVE messages are sent\n to the peer after the BGP connection has\n been established. The suggested value for\n this timer is 30 seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cbgpPeer2MinASOriginationInterval": { "type": "integer", "description": "Time interval (in seconds) for the\n MinASOriginationInterval timer.\n The suggested value for this timer is 15\n seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cbgpPeer2MinRouteAdvertisementInterval": { "type": "integer", "description": "Time interval (in seconds) for the\n MinRouteAdvertisementInterval timer.\n The suggested value for this timer is 30\n seconds for EBGP connections and 5\n seconds for IBGP connections.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cbgpPeer2InUpdateElapsedTime": { "type": "integer", "description": "Elapsed time (in seconds) since the last BGP\n UPDATE message was received from the peer.\n Each time cbgpPeer2InUpdates is incremented,\n the value of this object is set to zero (0).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2LastErrorTxt": { "type": "string", "description": "Implementation specific error description for\n bgpPeerLastErrorReceived.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cbgpPeer2PrevState": { "type": "string", "description": "The BGP peer connection previous state.", "readOnly": true } } }, "readOnly": true }, "cbgpPeer2CapsEntry": { "type": "array", "description": "Each entry represents a capability received from a\n peer with a particular code and an index. When a\n capability is received multiple times with different\n values during a BGP connection establishment,\n corresponding entries are differentiated with indices.", "items": { "type": "object", "properties": { "cbgpPeer2Type": { "type": "string", "description": "cbgpPeer2Type", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "cbgpPeer2RemoteAddr", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2CapCode": { "type": "string", "description": "The BGP Capability Advertisement Capability Code.", "readOnly": true }, "cbgpPeer2CapIndex": { "type": "integer", "description": "Multiple instances of a given capability may be\n sent by a BGP speaker. This variable is used\n to index them.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2CapValue": { "type": "string", "description": "The value of the announced capability. This\n MIB object value is organized as given below,\n Capability : Route Refresh Capability\n 4-Byte AS Capability\n Null string\n Capability : Multiprotocol Extensions\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n Capability : Graceful Restart\n +----------------------------------+\n | Restart Flags (4 bits) |\n +----------------------------------+\n | Restart Time in seconds (12 bits)|\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Flags for Address Family (8 bits)|\n +----------------------------------+\n | ... |\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Flags for Address Family (8 bits)|\n +----------------------------------+\n Capability : Additional Paths\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Send/Receive (8 bits) |\n +----------------------------------+", "format": "binary", "readOnly": true } } }, "readOnly": true }, "cbgpPeer2AddrFamilyEntry": { "type": "array", "description": "An entry is identified by an AFI/SAFI pair and\n peer address. It contains names associated with\n an address family.", "items": { "type": "object", "properties": { "cbgpPeer2Type": { "type": "string", "description": "cbgpPeer2Type", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "cbgpPeer2RemoteAddr", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2AddrFamilyAfi": { "type": "string", "description": "The AFI index of the entry. An implementation\n is only required to support IPv4 unicast and\n VPNv4 (Value - 1) address families.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cbgpPeer2AddrFamilySafi": { "type": "string", "description": "The SAFI index of the entry. An implementation\n is only required to support IPv4 unicast(Value\n - 1) and VPNv4( Value - 128) address families.", "x-yang-type": "CISCO-BGP4-MIB:CbgpSafi", "readOnly": true }, "cbgpPeer2AddrFamilyName": { "type": "string", "description": "Implementation specific Address Family name.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } }, "readOnly": true }, "cbgpPeer2AddrFamilyPrefixEntry": { "type": "array", "description": "An entry is identified by an AFI/SAFI pair and\n peer address. It contains information associated\n with route prefixes belonging to an address family.", "items": { "type": "object", "properties": { "cbgpPeer2Type": { "type": "string", "description": "cbgpPeer2Type", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "cbgpPeer2RemoteAddr", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2AddrFamilyAfi": { "type": "string", "description": "cbgpPeer2AddrFamilyAfi", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2AddrFamilySafi": { "type": "string", "description": "cbgpPeer2AddrFamilySafi", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2AcceptedPrefixes": { "type": "integer", "description": "Number of accepted route prefixes on this connection,\n which belong to an address family.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2DeniedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix, which\n belongs to an address family, received on this\n connection is denied. It is initialized to zero when\n the connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2PrefixAdminLimit": { "type": "integer", "description": "Max number of route prefixes accepted for an address\n family on this connection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2PrefixThreshold": { "type": "integer", "description": "Prefix threshold value (%) for an address family\n on this connection at which warning message stating\n the prefix count is crossed the threshold or\n corresponding SNMP notification is generated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2PrefixClearThreshold": { "type": "integer", "description": "Prefix threshold value (%) for an address family\n on this connection at which SNMP clear notification\n is generated if prefix threshold notification is\n already generated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2AdvertisedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family is advertised\n on this connection. It is initialized to zero when\n the connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2SuppressedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family is suppressed\n from being sent on this connection. It is\n initialized to zero when the connection is undergone\n a hard reset.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2WithdrawnPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family, is withdrawn on\n this connection. It is initialized to zero when the\n connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "cbgpGlobal": { "type": "object", "description": "cbgpGlobal", "properties": { "cbgpNotifsEnable": { "type": "string", "description": "Indicates whether the specific notifications are\n enabled. \n If notifsEnable(0) bit is set to 1,\n then the notifications defined in\n ciscoBgp4NotificationsGroup1 are enabled; \n If notifsPeer2Enable(1) bit is set to 1,\n then the notifications defined in\n ciscoBgp4Peer2NotificationsGroup are enabled.", "readOnly": true }, "cbgpLocalAs": { "type": "string", "description": "The local autonomous system (AS) number.", "format": "inet:as-number", "readOnly": true } }, "readOnly": true }, "cbgpRouteTable": { "type": "object", "description": "cbgpRouteTable", "properties": { "cbgpRouteEntry": { "type": "array", "description": "Information about a path to a network received from\n a peer.", "items": { "type": "object", "properties": { "cbgpRouteAfi": { "type": "string", "description": "Represents Address Family Identifier(AFI) of the\n Network Layer protocol associated with the route.\n An implementation is only required to support IPv4\n unicast and VPNv4 (Value - 1) address families.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cbgpRouteSafi": { "type": "string", "description": "Represents Subsequent Address Family Identifier(SAFI)\n of the route. It gives additional information about\n the type of the route. An implementation is only \n required to support IPv4 unicast(Value - 1) and VPNv4(\n Value - 128) address families.", "x-yang-type": "CISCO-BGP4-MIB:CbgpSafi", "readOnly": true }, "cbgpRoutePeerType": { "type": "string", "description": "Represents the type of Network Layer address stored\n in cbgpRoutePeer. An implementation is only required\n to support IPv4 address type(Value - 1).", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cbgpRoutePeer": { "type": "string", "description": "The Network Layer address of the peer where the route\n information was learned. An implementation is only \n required to support an IPv4 peer.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cbgpRouteAddrPrefix": { "type": "string", "description": "A Network Address prefix in the Network Layer\n Reachability Information field of BGP UPDATE message.\n This object is a Network Address containing the prefix\n with length specified by cbgpRouteAddrPrefixLen. Any\n bits beyond the length specified by\n cbgpRouteAddrPrefixLen are zeroed.", "x-yang-type": "CISCO-BGP4-MIB:CbgpNetworkAddress", "readOnly": true }, "cbgpRouteAddrPrefixLen": { "type": "integer", "description": "Length in bits of the Network Address prefix in the\n Network Layer Reachability Information field.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpRouteOrigin": { "type": "string", "description": "The ultimate origin of the route information.", "readOnly": true }, "cbgpRouteASPathSegment": { "type": "string", "description": "The sequence of AS path segments. Each AS\n path segment is represented by a triple\n .\n \n The type is a 1-octet field which has two\n possible values:\n 1 AS_SET: unordered set of ASs a route in the \n UPDATE message has traversed\n 2 AS_SEQUENCE: ordered set of ASs a route in the\n UPDATE message has traversed.\n \n The length is a 1-octet field containing the\n number of ASs in the value field.\n \n The value field contains one or more AS\n numbers, each AS is represented in the octet\n string as a pair of octets according to the\n following algorithm:\n \n first-byte-of-pair = ASNumber / 256;\n second-byte-of-pair = ASNumber & 255;", "format": "binary", "readOnly": true }, "cbgpRouteNextHop": { "type": "string", "description": "The Network Layer address of the border router\n that should be used for the destination network.", "x-yang-type": "CISCO-BGP4-MIB:CbgpNetworkAddress", "readOnly": true }, "cbgpRouteMedPresent": { "type": "boolean", "description": "Indicates the presence/absence of MULTI_EXIT_DISC\n attribute for the route.", "readOnly": true }, "cbgpRouteMultiExitDisc": { "type": "integer", "description": "This metric is used to discriminate between multiple\n exit points to an adjacent autonomous system. The\n value of this object is irrelevant if the value of\n of cbgpRouteMedPresent is false(2).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpRouteLocalPrefPresent": { "type": "boolean", "description": "Indicates the presence/absence of LOCAL_PREF\n attribute for the route.", "readOnly": true }, "cbgpRouteLocalPref": { "type": "integer", "description": "The degree of preference calculated by the local BGP4\n speaker for the route. The value of this object is \n irrelevant if the value of cbgpRouteLocalPrefPresent \n is false(2).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpRouteAtomicAggregate": { "type": "string", "description": "Whether or not the local system has selected a less\n specific route without selecting a more specific\n route.", "readOnly": true }, "cbgpRouteAggregatorAS": { "type": "integer", "description": "The AS number of the last BGP4 speaker that performed\n route aggregation. A value of zero (0) indicates the \n absence of this attribute.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpRouteAggregatorAddrType": { "type": "string", "description": "Represents the type of Network Layer address stored\n in cbgpRouteAggregatorAddr.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cbgpRouteAggregatorAddr": { "type": "string", "description": "The Network Layer address of the last BGP4 speaker\n that performed route aggregation. A value of all zeros\n indicates the absence of this attribute.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cbgpRouteBest": { "type": "boolean", "description": "An indication of whether or not this route was chosen\n as the best BGP4 route.", "readOnly": true }, "cbgpRouteUnknownAttr": { "type": "string", "description": "One or more path attributes not understood by this\n BGP4 speaker. Size zero (0) indicates the absence of\n such attribute(s). Octets beyond the maximum size, if\n any, are not recorded by this object. \n \n Each path attribute is a triple of variable length.\n Attribute Type is a two-octet field that consists of\n the Attribute Flags octet followed by the Attribute\n Type Code octet. If the Extended Length bit of the \n Attribute Flags octet is set to 0, the third octet of \n the Path Attribute contains the length of the\n attribute data in octets. If the Extended Length bit \n of the Attribute Flags octet is set to 1, then the\n third and the fourth octets of the path attribute \n contain the length of the attribute data in octets.\n The remaining octets of the Path Attribute represent \n the attribute value and are interpreted according to \n the Attribute Flags and the Attribute Type Code.", "format": "binary", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cbgpPeerCapsTable": { "type": "object", "description": "cbgpPeerCapsTable", "properties": { "cbgpPeerCapsEntry": { "type": "array", "description": "Each entry represents a capability received from a\n peer with a particular code and an index. When a \n capability is received multiple times with different\n values during a BGP connection establishment, \n corresponding entries are differentiated with indices.", "items": { "type": "object", "properties": { "bgpPeerRemoteAddr": { "type": "string", "description": "bgpPeerRemoteAddr", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeerCapCode": { "type": "string", "description": "The BGP Capability Advertisement Capability Code.", "readOnly": true }, "cbgpPeerCapIndex": { "type": "integer", "description": "Multiple instances of a given capability may be\n sent by a BGP speaker. This variable is used\n to index them.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeerCapValue": { "type": "string", "description": "The value of the announced capability. This\n MIB object value is organized as given below,\n Capability : Route Refresh Capability\n Null string\n Capability : Multiprotocol Extensions\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n Capability : Graceful Restart\n +----------------------------------+\n | Restart Flags (4 bits) |\n +----------------------------------+\n | Restart Time in seconds (12 bits)|\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Flags for Address Family (8 bits)|\n +----------------------------------+\n | ... |\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Flags for Address Family (8 bits)|\n +----------------------------------+", "format": "binary", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cbgpPeerAddrFamilyTable": { "type": "object", "description": "This table contains information related to\n address families supported by a peer. Supported\n address families of a peer are known during BGP \n connection establishment. When a new supported \n address family is known, this table is updated \n with a new entry. When an address family is not \n supported any more, corresponding entry is deleted \n from the table.", "properties": { "cbgpPeerAddrFamilyEntry": { "type": "array", "description": "An entry is identified by an AFI/SAFI pair and\n peer address. It contains names associated with\n an address family.", "items": { "type": "object", "properties": { "bgpPeerRemoteAddr": { "type": "string", "description": "bgpPeerRemoteAddr", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeerAddrFamilyAfi": { "type": "string", "description": "The AFI index of the entry. An implementation\n is only required to support IPv4 unicast and \n VPNv4 (Value - 1) address families.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cbgpPeerAddrFamilySafi": { "type": "string", "description": "The SAFI index of the entry. An implementation\n is only required to support IPv4 unicast(Value \n - 1) and VPNv4( Value - 128) address families.", "x-yang-type": "CISCO-BGP4-MIB:CbgpSafi", "readOnly": true }, "cbgpPeerAddrFamilyName": { "type": "string", "description": "Implementation specific Address Family name.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cbgpPeerAddrFamilyPrefixTable": { "type": "object", "description": "This table contains prefix related information\n related to address families supported by a peer. \n Supported address families of a peer are known \n during BGP connection establishment. When a new \n supported address family is known, this table \n is updated with a new entry. When an address \n family is not supported any more, corresponding \n entry is deleted from the table.", "properties": { "cbgpPeerAddrFamilyPrefixEntry": { "type": "array", "description": "An entry is identified by an AFI/SAFI pair and\n peer address. It contains information associated \n with route prefixes belonging to an address family.", "items": { "type": "object", "properties": { "bgpPeerRemoteAddr": { "type": "string", "description": "bgpPeerRemoteAddr", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeerAddrFamilyAfi": { "type": "string", "description": "cbgpPeerAddrFamilyAfi", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeerAddrFamilySafi": { "type": "string", "description": "cbgpPeerAddrFamilySafi", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeerAcceptedPrefixes": { "type": "integer", "description": "Number of accepted route prefixes on this connection,\n which belong to an address family.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeerDeniedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix, which\n belongs to an address family, received on this \n connection is denied. It is initialized to zero when \n the connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeerPrefixAdminLimit": { "type": "integer", "description": "Max number of route prefixes accepted for an address\n family on this connection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeerPrefixThreshold": { "type": "integer", "description": "Prefix threshold value (%) for an address family\n on this connection at which warning message stating\n the prefix count is crossed the threshold or \n corresponding SNMP notification is generated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeerPrefixClearThreshold": { "type": "integer", "description": "Prefix threshold value (%) for an address family\n on this connection at which SNMP clear notification\n is generated if prefix threshold notification is\n already generated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeerAdvertisedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family is advertised\n on this connection. It is initialized to zero when \n the connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeerSuppressedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family is suppressed\n from being sent on this connection. It is \n initialized to zero when the connection is undergone\n a hard reset.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeerWithdrawnPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family, is withdrawn on\n this connection. It is initialized to zero when the\n connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cbgpPeer2Table": { "type": "object", "description": "BGP peer table. This table contains,\n one entry per BGP peer, information about\n the connections with BGP peers.", "properties": { "cbgpPeer2Entry": { "type": "array", "description": "Entry containing information about the\n connection with a BGP peer.", "items": { "type": "object", "properties": { "cbgpPeer2Type": { "type": "string", "description": "Represents the type of Peer address stored\n in cbgpPeer2Entry.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "The remote IP address of this entry's BGP\n peer.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cbgpPeer2State": { "type": "string", "description": "The BGP peer connection state.", "readOnly": true }, "cbgpPeer2AdminStatus": { "type": "string", "description": "The desired state of the BGP connection.\n A transition from 'stop' to 'start' will cause\n the BGP Manual Start Event to be generated.\n A transition from 'start' to 'stop' will cause\n the BGP Manual Stop Event to be generated.\n This parameter can be used to restart BGP peer\n connections. Care should be used in providing\n write access to this object without adequate\n authentication.", "readOnly": true }, "cbgpPeer2NegotiatedVersion": { "type": "integer", "description": "The negotiated version of BGP running between\n the two peers.\n \n This entry MUST be zero (0) unless the\n cbgpPeer2State is in the openconfirm or the\n established state.\n \n Note that legal values for this object are\n between 0 and 255.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cbgpPeer2LocalAddr": { "type": "string", "description": "The local IP address of this entry's BGP\n connection.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cbgpPeer2LocalPort": { "type": "string", "description": "The local port for the TCP connection between\n the BGP peers.", "format": "inet:port-number", "readOnly": true }, "cbgpPeer2LocalAs": { "type": "string", "description": "The local AS number for this session.", "format": "inet:as-number", "readOnly": true }, "cbgpPeer2LocalIdentifier": { "type": "string", "description": "The BGP Identifier of this entry's BGP peer.", "format": "inet:ipv4-address", "readOnly": true }, "cbgpPeer2RemotePort": { "type": "string", "description": "The remote port for the TCP connection\n between the BGP peers. Note that the\n objects cbgpPeer2LocalAddr,\n cbgpPeer2LocalPort, cbgpPeer2RemoteAddr, and\n cbgpPeer2RemotePort provide the appropriate\n reference to the standard MIB TCP\n connection table.", "format": "inet:port-number", "readOnly": true }, "cbgpPeer2RemoteAs": { "type": "string", "description": "The remote autonomous system number received in\n the BGP OPEN message.", "format": "inet:as-number", "readOnly": true }, "cbgpPeer2RemoteIdentifier": { "type": "string", "description": "The BGP Identifier of this entry's BGP peer.\n This entry MUST be 0.0.0.0 unless the\n cbgpPeer2State is in the openconfirm or the\n established state.", "format": "inet:ipv4-address", "readOnly": true }, "cbgpPeer2InUpdates": { "type": "integer", "description": "The number of BGP UPDATE messages\n received on this connection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2OutUpdates": { "type": "integer", "description": "The number of BGP UPDATE messages\n transmitted on this connection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2InTotalMessages": { "type": "integer", "description": "The total number of messages received\n from the remote peer on this connection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2OutTotalMessages": { "type": "integer", "description": "The total number of messages transmitted to\n the remote peer on this connection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2LastError": { "type": "string", "description": "The last error code and subcode seen by this\n peer on this connection. If no error has\n occurred, this field is zero. Otherwise, the\n first byte of this two byte OCTET STRING\n contains the error code, and the second byte\n contains the subcode.", "format": "binary", "readOnly": true }, "cbgpPeer2FsmEstablishedTransitions": { "type": "integer", "description": "The total number of times the BGP FSM\n transitioned into the established state\n for this peer.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2FsmEstablishedTime": { "type": "integer", "description": "This timer indicates how long (in\n seconds) this peer has been in the\n established state or how long\n since this peer was last in the\n established state. It is set to zero when\n a new peer is configured or when the router is\n booted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2ConnectRetryInterval": { "type": "integer", "description": "Time interval (in seconds) for the\n ConnectRetry timer. The suggested value\n for this timer is 120 seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cbgpPeer2HoldTime": { "type": "integer", "description": "Time interval (in seconds) for the Hold\n Timer established with the peer. The\n value of this object is calculated by this\n BGP speaker, using the smaller of the\n values in cbgpPeer2HoldTimeConfigured and the\n Hold Time received in the OPEN message.\n \n This value must be at least three seconds\n if it is not zero (0).\n \n If the Hold Timer has not been established\n with the peer this object MUST have a value\n of zero (0).\n \n If the cbgpPeer2HoldTimeConfigured object has\n a value of (0), then this object MUST have a\n value of (0).", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cbgpPeer2KeepAlive": { "type": "integer", "description": "Time interval (in seconds) for the KeepAlive\n timer established with the peer. The value\n of this object is calculated by this BGP\n speaker such that, when compared with\n cbgpPeer2HoldTime, it has the same proportion\n that cbgpPeer2KeepAliveConfigured has,\n compared with cbgpPeer2HoldTimeConfigured.\n \n If the KeepAlive timer has not been established\n with the peer, this object MUST have a value\n of zero (0).\n \n If the of cbgpPeer2KeepAliveConfigured object\n has a value of (0), then this object MUST have\n a value of (0).", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cbgpPeer2HoldTimeConfigured": { "type": "integer", "description": "Time interval (in seconds) for the Hold Time\n configured for this BGP speaker with this\n peer. This value is placed in an OPEN\n message sent to this peer by this BGP\n speaker, and is compared with the Hold\n Time field in an OPEN message received\n from the peer when determining the Hold\n Time (cbgpPeer2HoldTime) with the peer.\n This value must not be less than three\n seconds if it is not zero (0). If it is\n zero (0), the Hold Time is NOT to be\n established with the peer. The suggested\n value for this timer is 90 seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cbgpPeer2KeepAliveConfigured": { "type": "integer", "description": "Time interval (in seconds) for the\n KeepAlive timer configured for this BGP\n speaker with this peer. The value of this\n object will only determine the\n KEEPALIVE messages' frequency relative to\n the value specified in\n cbgpPeer2HoldTimeConfigured; the actual\n time interval for the KEEPALIVE messages is\n indicated by cbgpPeer2KeepAlive. A\n reasonable maximum value for this timer\n would be one third of that of\n cbgpPeer2HoldTimeConfigured.\n If the value of this object is zero (0),\n no periodical KEEPALIVE messages are sent\n to the peer after the BGP connection has\n been established. The suggested value for\n this timer is 30 seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cbgpPeer2MinASOriginationInterval": { "type": "integer", "description": "Time interval (in seconds) for the\n MinASOriginationInterval timer.\n The suggested value for this timer is 15\n seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cbgpPeer2MinRouteAdvertisementInterval": { "type": "integer", "description": "Time interval (in seconds) for the\n MinRouteAdvertisementInterval timer.\n The suggested value for this timer is 30\n seconds for EBGP connections and 5\n seconds for IBGP connections.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cbgpPeer2InUpdateElapsedTime": { "type": "integer", "description": "Elapsed time (in seconds) since the last BGP\n UPDATE message was received from the peer.\n Each time cbgpPeer2InUpdates is incremented,\n the value of this object is set to zero (0).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2LastErrorTxt": { "type": "string", "description": "Implementation specific error description for\n bgpPeerLastErrorReceived.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cbgpPeer2PrevState": { "type": "string", "description": "The BGP peer connection previous state.", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cbgpPeer2CapsTable": { "type": "object", "description": "cbgpPeer2CapsTable", "properties": { "cbgpPeer2CapsEntry": { "type": "array", "description": "Each entry represents a capability received from a\n peer with a particular code and an index. When a\n capability is received multiple times with different\n values during a BGP connection establishment,\n corresponding entries are differentiated with indices.", "items": { "type": "object", "properties": { "cbgpPeer2Type": { "type": "string", "description": "cbgpPeer2Type", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "cbgpPeer2RemoteAddr", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2CapCode": { "type": "string", "description": "The BGP Capability Advertisement Capability Code.", "readOnly": true }, "cbgpPeer2CapIndex": { "type": "integer", "description": "Multiple instances of a given capability may be\n sent by a BGP speaker. This variable is used\n to index them.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2CapValue": { "type": "string", "description": "The value of the announced capability. This\n MIB object value is organized as given below,\n Capability : Route Refresh Capability\n 4-Byte AS Capability\n Null string\n Capability : Multiprotocol Extensions\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n Capability : Graceful Restart\n +----------------------------------+\n | Restart Flags (4 bits) |\n +----------------------------------+\n | Restart Time in seconds (12 bits)|\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Flags for Address Family (8 bits)|\n +----------------------------------+\n | ... |\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Flags for Address Family (8 bits)|\n +----------------------------------+\n Capability : Additional Paths\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Send/Receive (8 bits) |\n +----------------------------------+", "format": "binary", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cbgpPeer2AddrFamilyTable": { "type": "object", "description": "This table contains information related to\n address families supported by a peer. Supported\n address families of a peer are known during BGP\n connection establishment. When a new supported\n address family is known, this table is updated\n with a new entry. When an address family is not\n supported any more, corresponding entry is deleted\n from the table.", "properties": { "cbgpPeer2AddrFamilyEntry": { "type": "array", "description": "An entry is identified by an AFI/SAFI pair and\n peer address. It contains names associated with\n an address family.", "items": { "type": "object", "properties": { "cbgpPeer2Type": { "type": "string", "description": "cbgpPeer2Type", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "cbgpPeer2RemoteAddr", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2AddrFamilyAfi": { "type": "string", "description": "The AFI index of the entry. An implementation\n is only required to support IPv4 unicast and\n VPNv4 (Value - 1) address families.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cbgpPeer2AddrFamilySafi": { "type": "string", "description": "The SAFI index of the entry. An implementation\n is only required to support IPv4 unicast(Value\n - 1) and VPNv4( Value - 128) address families.", "x-yang-type": "CISCO-BGP4-MIB:CbgpSafi", "readOnly": true }, "cbgpPeer2AddrFamilyName": { "type": "string", "description": "Implementation specific Address Family name.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cbgpPeer2AddrFamilyPrefixTable": { "type": "object", "description": "This table contains prefix related information\n related to address families supported by a peer.\n Supported address families of a peer are known\n during BGP connection establishment. When a new\n supported address family is known, this table\n is updated with a new entry. When an address\n family is not supported any more, corresponding\n entry is deleted from the table.", "properties": { "cbgpPeer2AddrFamilyPrefixEntry": { "type": "array", "description": "An entry is identified by an AFI/SAFI pair and\n peer address. It contains information associated\n with route prefixes belonging to an address family.", "items": { "type": "object", "properties": { "cbgpPeer2Type": { "type": "string", "description": "cbgpPeer2Type", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "cbgpPeer2RemoteAddr", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2AddrFamilyAfi": { "type": "string", "description": "cbgpPeer2AddrFamilyAfi", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2AddrFamilySafi": { "type": "string", "description": "cbgpPeer2AddrFamilySafi", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2AcceptedPrefixes": { "type": "integer", "description": "Number of accepted route prefixes on this connection,\n which belong to an address family.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2DeniedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix, which\n belongs to an address family, received on this\n connection is denied. It is initialized to zero when\n the connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2PrefixAdminLimit": { "type": "integer", "description": "Max number of route prefixes accepted for an address\n family on this connection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2PrefixThreshold": { "type": "integer", "description": "Prefix threshold value (%) for an address family\n on this connection at which warning message stating\n the prefix count is crossed the threshold or\n corresponding SNMP notification is generated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2PrefixClearThreshold": { "type": "integer", "description": "Prefix threshold value (%) for an address family\n on this connection at which SNMP clear notification\n is generated if prefix threshold notification is\n already generated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2AdvertisedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family is advertised\n on this connection. It is initialized to zero when\n the connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2SuppressedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family is suppressed\n from being sent on this connection. It is\n initialized to zero when the connection is undergone\n a hard reset.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2WithdrawnPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family, is withdrawn on\n this connection. It is initialized to zero when the\n connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "CISCO-BGP4-MIB_object-1": { "type": "object", "description": "object-1", "properties": { "cbgpPeer2Type": { "type": "string", "description": "cbgpPeer2Type", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "cbgpPeer2RemoteAddr", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2AddrFamilyAfi": { "type": "string", "description": "cbgpPeer2AddrFamilyAfi", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2AddrFamilySafi": { "type": "string", "description": "cbgpPeer2AddrFamilySafi", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2PrefixAdminLimit": { "type": "string", "description": "cbgpPeer2PrefixAdminLimit", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-BGP4-MIB_object-2": { "type": "object", "description": "object-2", "properties": { "cbgpPeer2Type": { "type": "string", "description": "cbgpPeer2Type", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "cbgpPeer2RemoteAddr", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2AddrFamilyAfi": { "type": "string", "description": "cbgpPeer2AddrFamilyAfi", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2AddrFamilySafi": { "type": "string", "description": "cbgpPeer2AddrFamilySafi", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2PrefixClearThreshold": { "type": "string", "description": "cbgpPeer2PrefixClearThreshold", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-BGP4-MIB_object-3": { "type": "object", "description": "object-3", "properties": { "cbgpPeer2Type": { "type": "string", "description": "cbgpPeer2Type", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "cbgpPeer2RemoteAddr", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2LastErrorTxt": { "type": "string", "description": "cbgpPeer2LastErrorTxt", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-BGP4-MIB_object-4": { "type": "object", "description": "object-4", "properties": { "cbgpPeer2Type": { "type": "string", "description": "cbgpPeer2Type", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "cbgpPeer2RemoteAddr", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2PrevState": { "type": "string", "description": "cbgpPeer2PrevState", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-BGP4-MIB_cbgpRouteEntry": { "type": "array", "description": "Information about a path to a network received from\n a peer.", "items": { "type": "object", "properties": { "cbgpRouteAfi": { "type": "string", "description": "Represents Address Family Identifier(AFI) of the\n Network Layer protocol associated with the route.\n An implementation is only required to support IPv4\n unicast and VPNv4 (Value - 1) address families.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cbgpRouteSafi": { "type": "string", "description": "Represents Subsequent Address Family Identifier(SAFI)\n of the route. It gives additional information about\n the type of the route. An implementation is only \n required to support IPv4 unicast(Value - 1) and VPNv4(\n Value - 128) address families.", "x-yang-type": "CISCO-BGP4-MIB:CbgpSafi", "readOnly": true }, "cbgpRoutePeerType": { "type": "string", "description": "Represents the type of Network Layer address stored\n in cbgpRoutePeer. An implementation is only required\n to support IPv4 address type(Value - 1).", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cbgpRoutePeer": { "type": "string", "description": "The Network Layer address of the peer where the route\n information was learned. An implementation is only \n required to support an IPv4 peer.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cbgpRouteAddrPrefix": { "type": "string", "description": "A Network Address prefix in the Network Layer\n Reachability Information field of BGP UPDATE message.\n This object is a Network Address containing the prefix\n with length specified by cbgpRouteAddrPrefixLen. Any\n bits beyond the length specified by\n cbgpRouteAddrPrefixLen are zeroed.", "x-yang-type": "CISCO-BGP4-MIB:CbgpNetworkAddress", "readOnly": true }, "cbgpRouteAddrPrefixLen": { "type": "integer", "description": "Length in bits of the Network Address prefix in the\n Network Layer Reachability Information field.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpRouteOrigin": { "type": "string", "description": "The ultimate origin of the route information.", "readOnly": true }, "cbgpRouteASPathSegment": { "type": "string", "description": "The sequence of AS path segments. Each AS\n path segment is represented by a triple\n .\n \n The type is a 1-octet field which has two\n possible values:\n 1 AS_SET: unordered set of ASs a route in the \n UPDATE message has traversed\n 2 AS_SEQUENCE: ordered set of ASs a route in the\n UPDATE message has traversed.\n \n The length is a 1-octet field containing the\n number of ASs in the value field.\n \n The value field contains one or more AS\n numbers, each AS is represented in the octet\n string as a pair of octets according to the\n following algorithm:\n \n first-byte-of-pair = ASNumber / 256;\n second-byte-of-pair = ASNumber & 255;", "format": "binary", "readOnly": true }, "cbgpRouteNextHop": { "type": "string", "description": "The Network Layer address of the border router\n that should be used for the destination network.", "x-yang-type": "CISCO-BGP4-MIB:CbgpNetworkAddress", "readOnly": true }, "cbgpRouteMedPresent": { "type": "boolean", "description": "Indicates the presence/absence of MULTI_EXIT_DISC\n attribute for the route.", "readOnly": true }, "cbgpRouteMultiExitDisc": { "type": "integer", "description": "This metric is used to discriminate between multiple\n exit points to an adjacent autonomous system. The\n value of this object is irrelevant if the value of\n of cbgpRouteMedPresent is false(2).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpRouteLocalPrefPresent": { "type": "boolean", "description": "Indicates the presence/absence of LOCAL_PREF\n attribute for the route.", "readOnly": true }, "cbgpRouteLocalPref": { "type": "integer", "description": "The degree of preference calculated by the local BGP4\n speaker for the route. The value of this object is \n irrelevant if the value of cbgpRouteLocalPrefPresent \n is false(2).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpRouteAtomicAggregate": { "type": "string", "description": "Whether or not the local system has selected a less\n specific route without selecting a more specific\n route.", "readOnly": true }, "cbgpRouteAggregatorAS": { "type": "integer", "description": "The AS number of the last BGP4 speaker that performed\n route aggregation. A value of zero (0) indicates the \n absence of this attribute.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpRouteAggregatorAddrType": { "type": "string", "description": "Represents the type of Network Layer address stored\n in cbgpRouteAggregatorAddr.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cbgpRouteAggregatorAddr": { "type": "string", "description": "The Network Layer address of the last BGP4 speaker\n that performed route aggregation. A value of all zeros\n indicates the absence of this attribute.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cbgpRouteBest": { "type": "boolean", "description": "An indication of whether or not this route was chosen\n as the best BGP4 route.", "readOnly": true }, "cbgpRouteUnknownAttr": { "type": "string", "description": "One or more path attributes not understood by this\n BGP4 speaker. Size zero (0) indicates the absence of\n such attribute(s). Octets beyond the maximum size, if\n any, are not recorded by this object. \n \n Each path attribute is a triple of variable length.\n Attribute Type is a two-octet field that consists of\n the Attribute Flags octet followed by the Attribute\n Type Code octet. If the Extended Length bit of the \n Attribute Flags octet is set to 0, the third octet of \n the Path Attribute contains the length of the\n attribute data in octets. If the Extended Length bit \n of the Attribute Flags octet is set to 1, then the\n third and the fourth octets of the path attribute \n contain the length of the attribute data in octets.\n The remaining octets of the Path Attribute represent \n the attribute value and are interpreted according to \n the Attribute Flags and the Attribute Type Code.", "format": "binary", "readOnly": true } } } }, "CISCO-BGP4-MIB_cbgpPeerCapsEntry": { "type": "array", "description": "Each entry represents a capability received from a\n peer with a particular code and an index. When a \n capability is received multiple times with different\n values during a BGP connection establishment, \n corresponding entries are differentiated with indices.", "items": { "type": "object", "properties": { "bgpPeerRemoteAddr": { "type": "string", "description": "bgpPeerRemoteAddr", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeerCapCode": { "type": "string", "description": "The BGP Capability Advertisement Capability Code.", "readOnly": true }, "cbgpPeerCapIndex": { "type": "integer", "description": "Multiple instances of a given capability may be\n sent by a BGP speaker. This variable is used\n to index them.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeerCapValue": { "type": "string", "description": "The value of the announced capability. This\n MIB object value is organized as given below,\n Capability : Route Refresh Capability\n Null string\n Capability : Multiprotocol Extensions\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n Capability : Graceful Restart\n +----------------------------------+\n | Restart Flags (4 bits) |\n +----------------------------------+\n | Restart Time in seconds (12 bits)|\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Flags for Address Family (8 bits)|\n +----------------------------------+\n | ... |\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Flags for Address Family (8 bits)|\n +----------------------------------+", "format": "binary", "readOnly": true } } } }, "CISCO-BGP4-MIB_cbgpPeerAddrFamilyEntry": { "type": "array", "description": "An entry is identified by an AFI/SAFI pair and\n peer address. It contains names associated with\n an address family.", "items": { "type": "object", "properties": { "bgpPeerRemoteAddr": { "type": "string", "description": "bgpPeerRemoteAddr", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeerAddrFamilyAfi": { "type": "string", "description": "The AFI index of the entry. An implementation\n is only required to support IPv4 unicast and \n VPNv4 (Value - 1) address families.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cbgpPeerAddrFamilySafi": { "type": "string", "description": "The SAFI index of the entry. An implementation\n is only required to support IPv4 unicast(Value \n - 1) and VPNv4( Value - 128) address families.", "x-yang-type": "CISCO-BGP4-MIB:CbgpSafi", "readOnly": true }, "cbgpPeerAddrFamilyName": { "type": "string", "description": "Implementation specific Address Family name.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } } }, "CISCO-BGP4-MIB_cbgpPeerAddrFamilyPrefixEntry": { "type": "array", "description": "An entry is identified by an AFI/SAFI pair and\n peer address. It contains information associated \n with route prefixes belonging to an address family.", "items": { "type": "object", "properties": { "bgpPeerRemoteAddr": { "type": "string", "description": "bgpPeerRemoteAddr", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeerAddrFamilyAfi": { "type": "string", "description": "cbgpPeerAddrFamilyAfi", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeerAddrFamilySafi": { "type": "string", "description": "cbgpPeerAddrFamilySafi", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeerAcceptedPrefixes": { "type": "integer", "description": "Number of accepted route prefixes on this connection,\n which belong to an address family.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeerDeniedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix, which\n belongs to an address family, received on this \n connection is denied. It is initialized to zero when \n the connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeerPrefixAdminLimit": { "type": "integer", "description": "Max number of route prefixes accepted for an address\n family on this connection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeerPrefixThreshold": { "type": "integer", "description": "Prefix threshold value (%) for an address family\n on this connection at which warning message stating\n the prefix count is crossed the threshold or \n corresponding SNMP notification is generated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeerPrefixClearThreshold": { "type": "integer", "description": "Prefix threshold value (%) for an address family\n on this connection at which SNMP clear notification\n is generated if prefix threshold notification is\n already generated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeerAdvertisedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family is advertised\n on this connection. It is initialized to zero when \n the connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeerSuppressedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family is suppressed\n from being sent on this connection. It is \n initialized to zero when the connection is undergone\n a hard reset.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeerWithdrawnPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family, is withdrawn on\n this connection. It is initialized to zero when the\n connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } } }, "CISCO-BGP4-MIB_cbgpPeer2Entry": { "type": "array", "description": "Entry containing information about the\n connection with a BGP peer.", "items": { "type": "object", "properties": { "cbgpPeer2Type": { "type": "string", "description": "Represents the type of Peer address stored\n in cbgpPeer2Entry.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "The remote IP address of this entry's BGP\n peer.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cbgpPeer2State": { "type": "string", "description": "The BGP peer connection state.", "readOnly": true }, "cbgpPeer2AdminStatus": { "type": "string", "description": "The desired state of the BGP connection.\n A transition from 'stop' to 'start' will cause\n the BGP Manual Start Event to be generated.\n A transition from 'start' to 'stop' will cause\n the BGP Manual Stop Event to be generated.\n This parameter can be used to restart BGP peer\n connections. Care should be used in providing\n write access to this object without adequate\n authentication.", "readOnly": true }, "cbgpPeer2NegotiatedVersion": { "type": "integer", "description": "The negotiated version of BGP running between\n the two peers.\n \n This entry MUST be zero (0) unless the\n cbgpPeer2State is in the openconfirm or the\n established state.\n \n Note that legal values for this object are\n between 0 and 255.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cbgpPeer2LocalAddr": { "type": "string", "description": "The local IP address of this entry's BGP\n connection.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cbgpPeer2LocalPort": { "type": "string", "description": "The local port for the TCP connection between\n the BGP peers.", "format": "inet:port-number", "readOnly": true }, "cbgpPeer2LocalAs": { "type": "string", "description": "The local AS number for this session.", "format": "inet:as-number", "readOnly": true }, "cbgpPeer2LocalIdentifier": { "type": "string", "description": "The BGP Identifier of this entry's BGP peer.", "format": "inet:ipv4-address", "readOnly": true }, "cbgpPeer2RemotePort": { "type": "string", "description": "The remote port for the TCP connection\n between the BGP peers. Note that the\n objects cbgpPeer2LocalAddr,\n cbgpPeer2LocalPort, cbgpPeer2RemoteAddr, and\n cbgpPeer2RemotePort provide the appropriate\n reference to the standard MIB TCP\n connection table.", "format": "inet:port-number", "readOnly": true }, "cbgpPeer2RemoteAs": { "type": "string", "description": "The remote autonomous system number received in\n the BGP OPEN message.", "format": "inet:as-number", "readOnly": true }, "cbgpPeer2RemoteIdentifier": { "type": "string", "description": "The BGP Identifier of this entry's BGP peer.\n This entry MUST be 0.0.0.0 unless the\n cbgpPeer2State is in the openconfirm or the\n established state.", "format": "inet:ipv4-address", "readOnly": true }, "cbgpPeer2InUpdates": { "type": "integer", "description": "The number of BGP UPDATE messages\n received on this connection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2OutUpdates": { "type": "integer", "description": "The number of BGP UPDATE messages\n transmitted on this connection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2InTotalMessages": { "type": "integer", "description": "The total number of messages received\n from the remote peer on this connection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2OutTotalMessages": { "type": "integer", "description": "The total number of messages transmitted to\n the remote peer on this connection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2LastError": { "type": "string", "description": "The last error code and subcode seen by this\n peer on this connection. If no error has\n occurred, this field is zero. Otherwise, the\n first byte of this two byte OCTET STRING\n contains the error code, and the second byte\n contains the subcode.", "format": "binary", "readOnly": true }, "cbgpPeer2FsmEstablishedTransitions": { "type": "integer", "description": "The total number of times the BGP FSM\n transitioned into the established state\n for this peer.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2FsmEstablishedTime": { "type": "integer", "description": "This timer indicates how long (in\n seconds) this peer has been in the\n established state or how long\n since this peer was last in the\n established state. It is set to zero when\n a new peer is configured or when the router is\n booted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2ConnectRetryInterval": { "type": "integer", "description": "Time interval (in seconds) for the\n ConnectRetry timer. The suggested value\n for this timer is 120 seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cbgpPeer2HoldTime": { "type": "integer", "description": "Time interval (in seconds) for the Hold\n Timer established with the peer. The\n value of this object is calculated by this\n BGP speaker, using the smaller of the\n values in cbgpPeer2HoldTimeConfigured and the\n Hold Time received in the OPEN message.\n \n This value must be at least three seconds\n if it is not zero (0).\n \n If the Hold Timer has not been established\n with the peer this object MUST have a value\n of zero (0).\n \n If the cbgpPeer2HoldTimeConfigured object has\n a value of (0), then this object MUST have a\n value of (0).", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cbgpPeer2KeepAlive": { "type": "integer", "description": "Time interval (in seconds) for the KeepAlive\n timer established with the peer. The value\n of this object is calculated by this BGP\n speaker such that, when compared with\n cbgpPeer2HoldTime, it has the same proportion\n that cbgpPeer2KeepAliveConfigured has,\n compared with cbgpPeer2HoldTimeConfigured.\n \n If the KeepAlive timer has not been established\n with the peer, this object MUST have a value\n of zero (0).\n \n If the of cbgpPeer2KeepAliveConfigured object\n has a value of (0), then this object MUST have\n a value of (0).", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cbgpPeer2HoldTimeConfigured": { "type": "integer", "description": "Time interval (in seconds) for the Hold Time\n configured for this BGP speaker with this\n peer. This value is placed in an OPEN\n message sent to this peer by this BGP\n speaker, and is compared with the Hold\n Time field in an OPEN message received\n from the peer when determining the Hold\n Time (cbgpPeer2HoldTime) with the peer.\n This value must not be less than three\n seconds if it is not zero (0). If it is\n zero (0), the Hold Time is NOT to be\n established with the peer. The suggested\n value for this timer is 90 seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cbgpPeer2KeepAliveConfigured": { "type": "integer", "description": "Time interval (in seconds) for the\n KeepAlive timer configured for this BGP\n speaker with this peer. The value of this\n object will only determine the\n KEEPALIVE messages' frequency relative to\n the value specified in\n cbgpPeer2HoldTimeConfigured; the actual\n time interval for the KEEPALIVE messages is\n indicated by cbgpPeer2KeepAlive. A\n reasonable maximum value for this timer\n would be one third of that of\n cbgpPeer2HoldTimeConfigured.\n If the value of this object is zero (0),\n no periodical KEEPALIVE messages are sent\n to the peer after the BGP connection has\n been established. The suggested value for\n this timer is 30 seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cbgpPeer2MinASOriginationInterval": { "type": "integer", "description": "Time interval (in seconds) for the\n MinASOriginationInterval timer.\n The suggested value for this timer is 15\n seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cbgpPeer2MinRouteAdvertisementInterval": { "type": "integer", "description": "Time interval (in seconds) for the\n MinRouteAdvertisementInterval timer.\n The suggested value for this timer is 30\n seconds for EBGP connections and 5\n seconds for IBGP connections.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cbgpPeer2InUpdateElapsedTime": { "type": "integer", "description": "Elapsed time (in seconds) since the last BGP\n UPDATE message was received from the peer.\n Each time cbgpPeer2InUpdates is incremented,\n the value of this object is set to zero (0).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2LastErrorTxt": { "type": "string", "description": "Implementation specific error description for\n bgpPeerLastErrorReceived.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cbgpPeer2PrevState": { "type": "string", "description": "The BGP peer connection previous state.", "readOnly": true } } } }, "CISCO-BGP4-MIB_cbgpPeer2CapsEntry": { "type": "array", "description": "Each entry represents a capability received from a\n peer with a particular code and an index. When a\n capability is received multiple times with different\n values during a BGP connection establishment,\n corresponding entries are differentiated with indices.", "items": { "type": "object", "properties": { "cbgpPeer2Type": { "type": "string", "description": "cbgpPeer2Type", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "cbgpPeer2RemoteAddr", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2CapCode": { "type": "string", "description": "The BGP Capability Advertisement Capability Code.", "readOnly": true }, "cbgpPeer2CapIndex": { "type": "integer", "description": "Multiple instances of a given capability may be\n sent by a BGP speaker. This variable is used\n to index them.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2CapValue": { "type": "string", "description": "The value of the announced capability. This\n MIB object value is organized as given below,\n Capability : Route Refresh Capability\n 4-Byte AS Capability\n Null string\n Capability : Multiprotocol Extensions\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n Capability : Graceful Restart\n +----------------------------------+\n | Restart Flags (4 bits) |\n +----------------------------------+\n | Restart Time in seconds (12 bits)|\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Flags for Address Family (8 bits)|\n +----------------------------------+\n | ... |\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Flags for Address Family (8 bits)|\n +----------------------------------+\n Capability : Additional Paths\n +----------------------------------+\n | AFI(16 bits) |\n +----------------------------------+\n | SAFI (8 bits) |\n +----------------------------------+\n | Send/Receive (8 bits) |\n +----------------------------------+", "format": "binary", "readOnly": true } } } }, "CISCO-BGP4-MIB_cbgpPeer2AddrFamilyEntry": { "type": "array", "description": "An entry is identified by an AFI/SAFI pair and\n peer address. It contains names associated with\n an address family.", "items": { "type": "object", "properties": { "cbgpPeer2Type": { "type": "string", "description": "cbgpPeer2Type", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "cbgpPeer2RemoteAddr", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2AddrFamilyAfi": { "type": "string", "description": "The AFI index of the entry. An implementation\n is only required to support IPv4 unicast and\n VPNv4 (Value - 1) address families.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cbgpPeer2AddrFamilySafi": { "type": "string", "description": "The SAFI index of the entry. An implementation\n is only required to support IPv4 unicast(Value\n - 1) and VPNv4( Value - 128) address families.", "x-yang-type": "CISCO-BGP4-MIB:CbgpSafi", "readOnly": true }, "cbgpPeer2AddrFamilyName": { "type": "string", "description": "Implementation specific Address Family name.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } } }, "CISCO-BGP4-MIB_cbgpPeer2AddrFamilyPrefixEntry": { "type": "array", "description": "An entry is identified by an AFI/SAFI pair and\n peer address. It contains information associated\n with route prefixes belonging to an address family.", "items": { "type": "object", "properties": { "cbgpPeer2Type": { "type": "string", "description": "cbgpPeer2Type", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2RemoteAddr": { "type": "string", "description": "cbgpPeer2RemoteAddr", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2AddrFamilyAfi": { "type": "string", "description": "cbgpPeer2AddrFamilyAfi", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2AddrFamilySafi": { "type": "string", "description": "cbgpPeer2AddrFamilySafi", "x-yang-type": "leafref", "readOnly": true }, "cbgpPeer2AcceptedPrefixes": { "type": "integer", "description": "Number of accepted route prefixes on this connection,\n which belong to an address family.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2DeniedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix, which\n belongs to an address family, received on this\n connection is denied. It is initialized to zero when\n the connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2PrefixAdminLimit": { "type": "integer", "description": "Max number of route prefixes accepted for an address\n family on this connection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2PrefixThreshold": { "type": "integer", "description": "Prefix threshold value (%) for an address family\n on this connection at which warning message stating\n the prefix count is crossed the threshold or\n corresponding SNMP notification is generated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2PrefixClearThreshold": { "type": "integer", "description": "Prefix threshold value (%) for an address family\n on this connection at which SNMP clear notification\n is generated if prefix threshold notification is\n already generated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2AdvertisedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family is advertised\n on this connection. It is initialized to zero when\n the connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2SuppressedPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family is suppressed\n from being sent on this connection. It is\n initialized to zero when the connection is undergone\n a hard reset.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cbgpPeer2WithdrawnPrefixes": { "type": "integer", "description": "This counter is incremented when a route prefix,\n which belongs to an address family, is withdrawn on\n this connection. It is initialized to zero when the\n connection is undergone a hard reset.", "minimum": 0, "maximum": 4294967295, "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-BGP4-MIB", "description": "MIB operations for CISCO-BGP4-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }