{ "openapi": "3.0.0", "info": { "title": "BGP4-MIB MIB API", "version": "1.0.0", "description": "The MIB module for BGP-4.\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 BGP4-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/BGP4-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "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/BGP4-MIB:bgp": { "get": { "summary": "Get bgp data", "description": "Retrieve bgp operational data from MIB", "tags": [ "BGP4-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "bgp", "properties": { "bgpVersion": { "type": "string", "description": "Vector of supported BGP protocol version\n numbers. Each peer negotiates the version\n from this vector. Versions are identified\n via the string of bits contained within this\n object. The first octet contains bits 0 to\n 7, the second octet contains bits 8 to 15,\n and so on, with the most significant bit\n referring to the lowest bit number in the\n octet (e.g., the MSB of the first octet\n refers to bit 0). If a bit, i, is present\n and set, then the version (i+1) of the BGP\n is supported.", "format": "binary" }, "bgpLocalAs": { "type": "integer", "description": "The local autonomous system number.", "minimum": -2147483648, "maximum": 2147483647 }, "bgpIdentifier": { "type": "string", "description": "The BGP Identifier of local system.", "format": "inet:ipv4-address" } } }, "example": { "BGP4-MIB:bgp": { "bgpVersion": "example-string", "bgpLocalAs": -2147483648, "bgpIdentifier": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-bgp", "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": "/bgp", "x-restconf-kind": "container" }, "/data/BGP4-MIB:bgpPeerTable": { "get": { "summary": "Get bgpPeerTable data", "description": "Retrieve bgpPeerTable operational data from MIB", "tags": [ "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": { "bgpPeerEntry": { "type": "array", "description": "Entry containing information about the\n connection with a BGP peer.", "items": { "type": "object", "properties": { "bgpPeerIdentifier": { "type": "string", "description": "The BGP Identifier of this entry's BGP\n peer.", "format": "inet:ipv4-address" }, "bgpPeerState": { "type": "string", "description": "The BGP peer connection state." }, "bgpPeerAdminStatus": { "type": "string", "description": "The desired state of the BGP connection.\n A transition from 'stop' to 'start' will\n cause the BGP Start Event to be generated.\n A transition from 'start' to 'stop' will\n cause the BGP Stop Event to be generated.\n This parameter can be used to restart BGP\n peer connections. Care should be used in\n providing write access to this object\n without adequate authentication." }, "bgpPeerNegotiatedVersion": { "type": "integer", "description": "The negotiated version of BGP running\n between the two peers.", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerLocalAddr": { "type": "string", "description": "The local IP address of this entry's BGP\n connection.", "format": "inet:ipv4-address" }, "bgpPeerLocalPort": { "type": "integer", "description": "The local port for the TCP connection\n between the BGP peers.", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerRemoteAddr": { "type": "string", "description": "The remote IP address of this entry's BGP\n peer.", "format": "inet:ipv4-address" }, "bgpPeerRemotePort": { "type": "integer", "description": "The remote port for the TCP connection\n between the BGP peers. Note that the\n objects bgpPeerLocalAddr,\n bgpPeerLocalPort, bgpPeerRemoteAddr and\n bgpPeerRemotePort provide the appropriate\n reference to the standard MIB TCP\n connection table.", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerRemoteAs": { "type": "integer", "description": "The remote autonomous system number.", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerInUpdates": { "type": "integer", "description": "The number of BGP UPDATE messages\n received on this connection. This object\n should be initialized to zero (0) when the\n connection is established.", "minimum": 0, "maximum": 4294967295 }, "bgpPeerOutUpdates": { "type": "integer", "description": "The number of BGP UPDATE messages\n transmitted on this connection. This\n object should be initialized to zero (0)\n when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "bgpPeerInTotalMessages": { "type": "integer", "description": "The total number of messages received\n from the remote peer on this connection.\n This object should be initialized to zero\n when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "bgpPeerOutTotalMessages": { "type": "integer", "description": "The total number of messages transmitted to\n the remote peer on this connection. This\n object should be initialized to zero when\n the connection is established.", "minimum": 0, "maximum": 4294967295 }, "bgpPeerLastError": { "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" }, "bgpPeerFsmEstablishedTransitions": { "type": "integer", "description": "The total number of times the BGP FSM\n transitioned into the established state.", "minimum": 0, "maximum": 4294967295 }, "bgpPeerFsmEstablishedTime": { "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 the router is\n booted.", "minimum": 0, "maximum": 4294967295 }, "bgpPeerConnectRetryInterval": { "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 }, "bgpPeerHoldTime": { "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 by using the smaller of the\n value in bgpPeerHoldTimeConfigured and the\n Hold Time received in the OPEN message.\n This value must be at lease three seconds\n if it is not zero (0) in which case the\n Hold Timer has not been established with\n the peer, or, the value of\n bgpPeerHoldTimeConfigured is zero (0).", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerKeepAlive": { "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 bgpPeerHoldTime, it has the same\n proportion as what\n bgpPeerKeepAliveConfigured has when\n compared with bgpPeerHoldTimeConfigured.\n If the value of this object is zero (0),\n it indicates that the KeepAlive timer has\n not been established with the peer, or,\n the value of bgpPeerKeepAliveConfigured is\n zero (0).", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerHoldTimeConfigured": { "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 (bgpPeerHoldTime) with the peer.\n This value must not be less than three\n seconds if it is not zero (0) in which\n case 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 }, "bgpPeerKeepAliveConfigured": { "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 bgpPeerHoldTimeConfigured; the actual\n time interval for the KEEPALIVE messages\n is indicated by bgpPeerKeepAlive. A\n reasonable maximum value for this timer\n would be configured to be one\n third of that of\n bgpPeerHoldTimeConfigured.\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 }, "bgpPeerMinASOriginationInterval": { "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 }, "bgpPeerMinRouteAdvertisementInterval": { "type": "integer", "description": "Time interval in seconds for the\n MinRouteAdvertisementInterval timer.\n The suggested value for this timer is 30\n seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerInUpdateElapsedTime": { "type": "integer", "description": "Elapsed time in seconds since the last BGP\n UPDATE message was received from the peer.\n Each time bgpPeerInUpdates is incremented,\n the value of this object is set to zero\n (0).", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "BGP4-MIB:bgpPeerTable": { "bgpPeerEntry": [ { "bgpPeerIdentifier": "example-string", "bgpPeerState": "up(1)", "bgpPeerAdminStatus": "up(1)", "bgpPeerNegotiatedVersion": -2147483648, "bgpPeerLocalAddr": "192.168.1.1", "bgpPeerLocalPort": -2147483648, "bgpPeerRemoteAddr": "192.168.1.1", "bgpPeerRemotePort": -2147483648, "bgpPeerRemoteAs": -2147483648, "bgpPeerInUpdates": 0, "bgpPeerOutUpdates": 0, "bgpPeerInTotalMessages": 0, "bgpPeerOutTotalMessages": 0, "bgpPeerLastError": "example-string", "bgpPeerFsmEstablishedTransitions": 0, "bgpPeerFsmEstablishedTime": 0, "bgpPeerConnectRetryInterval": -2147483648, "bgpPeerHoldTime": -2147483648, "bgpPeerKeepAlive": -2147483648, "bgpPeerHoldTimeConfigured": -2147483648, "bgpPeerKeepAliveConfigured": -2147483648, "bgpPeerMinASOriginationInterval": -2147483648, "bgpPeerMinRouteAdvertisementInterval": -2147483648, "bgpPeerInUpdateElapsedTime": 0 }, { "bgpPeerIdentifier": "example-string", "bgpPeerState": "up(1)", "bgpPeerAdminStatus": "up(1)", "bgpPeerNegotiatedVersion": -2147483648, "bgpPeerLocalAddr": "192.168.1.1", "bgpPeerLocalPort": -2147483648, "bgpPeerRemoteAddr": "192.168.1.1", "bgpPeerRemotePort": -2147483648, "bgpPeerRemoteAs": -2147483648, "bgpPeerInUpdates": 0, "bgpPeerOutUpdates": 0, "bgpPeerInTotalMessages": 0, "bgpPeerOutTotalMessages": 0, "bgpPeerLastError": "example-string", "bgpPeerFsmEstablishedTransitions": 0, "bgpPeerFsmEstablishedTime": 0, "bgpPeerConnectRetryInterval": -2147483648, "bgpPeerHoldTime": -2147483648, "bgpPeerKeepAlive": -2147483648, "bgpPeerHoldTimeConfigured": -2147483648, "bgpPeerKeepAliveConfigured": -2147483648, "bgpPeerMinASOriginationInterval": -2147483648, "bgpPeerMinRouteAdvertisementInterval": -2147483648, "bgpPeerInUpdateElapsedTime": 0 }, { "bgpPeerIdentifier": "example-string", "bgpPeerState": "up(1)", "bgpPeerAdminStatus": "up(1)", "bgpPeerNegotiatedVersion": -2147483648, "bgpPeerLocalAddr": "192.168.1.1", "bgpPeerLocalPort": -2147483648, "bgpPeerRemoteAddr": "192.168.1.1", "bgpPeerRemotePort": -2147483648, "bgpPeerRemoteAs": -2147483648, "bgpPeerInUpdates": 0, "bgpPeerOutUpdates": 0, "bgpPeerInTotalMessages": 0, "bgpPeerOutTotalMessages": 0, "bgpPeerLastError": "example-string", "bgpPeerFsmEstablishedTransitions": 0, "bgpPeerFsmEstablishedTime": 0, "bgpPeerConnectRetryInterval": -2147483648, "bgpPeerHoldTime": -2147483648, "bgpPeerKeepAlive": -2147483648, "bgpPeerHoldTimeConfigured": -2147483648, "bgpPeerKeepAliveConfigured": -2147483648, "bgpPeerMinASOriginationInterval": -2147483648, "bgpPeerMinRouteAdvertisementInterval": -2147483648, "bgpPeerInUpdateElapsedTime": 0 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-bgpPeerTable", "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": "/bgpPeerTable", "x-restconf-kind": "container" }, "/data/BGP4-MIB:bgpPeerTable/bgpPeerEntry": { "get": { "summary": "Get bgpPeerEntry list", "description": "Retrieve list of bgpPeerEntry entries from MIB", "tags": [ "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": { "bgpPeerIdentifier": { "type": "string", "description": "The BGP Identifier of this entry's BGP\n peer.", "format": "inet:ipv4-address" }, "bgpPeerState": { "type": "string", "description": "The BGP peer connection state." }, "bgpPeerAdminStatus": { "type": "string", "description": "The desired state of the BGP connection.\n A transition from 'stop' to 'start' will\n cause the BGP Start Event to be generated.\n A transition from 'start' to 'stop' will\n cause the BGP Stop Event to be generated.\n This parameter can be used to restart BGP\n peer connections. Care should be used in\n providing write access to this object\n without adequate authentication." }, "bgpPeerNegotiatedVersion": { "type": "integer", "description": "The negotiated version of BGP running\n between the two peers.", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerLocalAddr": { "type": "string", "description": "The local IP address of this entry's BGP\n connection.", "format": "inet:ipv4-address" }, "bgpPeerLocalPort": { "type": "integer", "description": "The local port for the TCP connection\n between the BGP peers.", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerRemoteAddr": { "type": "string", "description": "The remote IP address of this entry's BGP\n peer.", "format": "inet:ipv4-address" }, "bgpPeerRemotePort": { "type": "integer", "description": "The remote port for the TCP connection\n between the BGP peers. Note that the\n objects bgpPeerLocalAddr,\n bgpPeerLocalPort, bgpPeerRemoteAddr and\n bgpPeerRemotePort provide the appropriate\n reference to the standard MIB TCP\n connection table.", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerRemoteAs": { "type": "integer", "description": "The remote autonomous system number.", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerInUpdates": { "type": "integer", "description": "The number of BGP UPDATE messages\n received on this connection. This object\n should be initialized to zero (0) when the\n connection is established.", "minimum": 0, "maximum": 4294967295 }, "bgpPeerOutUpdates": { "type": "integer", "description": "The number of BGP UPDATE messages\n transmitted on this connection. This\n object should be initialized to zero (0)\n when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "bgpPeerInTotalMessages": { "type": "integer", "description": "The total number of messages received\n from the remote peer on this connection.\n This object should be initialized to zero\n when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "bgpPeerOutTotalMessages": { "type": "integer", "description": "The total number of messages transmitted to\n the remote peer on this connection. This\n object should be initialized to zero when\n the connection is established.", "minimum": 0, "maximum": 4294967295 }, "bgpPeerLastError": { "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" }, "bgpPeerFsmEstablishedTransitions": { "type": "integer", "description": "The total number of times the BGP FSM\n transitioned into the established state.", "minimum": 0, "maximum": 4294967295 }, "bgpPeerFsmEstablishedTime": { "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 the router is\n booted.", "minimum": 0, "maximum": 4294967295 }, "bgpPeerConnectRetryInterval": { "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 }, "bgpPeerHoldTime": { "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 by using the smaller of the\n value in bgpPeerHoldTimeConfigured and the\n Hold Time received in the OPEN message.\n This value must be at lease three seconds\n if it is not zero (0) in which case the\n Hold Timer has not been established with\n the peer, or, the value of\n bgpPeerHoldTimeConfigured is zero (0).", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerKeepAlive": { "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 bgpPeerHoldTime, it has the same\n proportion as what\n bgpPeerKeepAliveConfigured has when\n compared with bgpPeerHoldTimeConfigured.\n If the value of this object is zero (0),\n it indicates that the KeepAlive timer has\n not been established with the peer, or,\n the value of bgpPeerKeepAliveConfigured is\n zero (0).", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerHoldTimeConfigured": { "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 (bgpPeerHoldTime) with the peer.\n This value must not be less than three\n seconds if it is not zero (0) in which\n case 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 }, "bgpPeerKeepAliveConfigured": { "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 bgpPeerHoldTimeConfigured; the actual\n time interval for the KEEPALIVE messages\n is indicated by bgpPeerKeepAlive. A\n reasonable maximum value for this timer\n would be configured to be one\n third of that of\n bgpPeerHoldTimeConfigured.\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 }, "bgpPeerMinASOriginationInterval": { "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 }, "bgpPeerMinRouteAdvertisementInterval": { "type": "integer", "description": "Time interval in seconds for the\n MinRouteAdvertisementInterval timer.\n The suggested value for this timer is 30\n seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerInUpdateElapsedTime": { "type": "integer", "description": "Elapsed time in seconds since the last BGP\n UPDATE message was received from the peer.\n Each time bgpPeerInUpdates is incremented,\n the value of this object is set to zero\n (0).", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "BGP4-MIB:bgpPeerEntry": [ { "bgpPeerIdentifier": "example-string", "bgpPeerState": "up(1)", "bgpPeerAdminStatus": "up(1)", "bgpPeerNegotiatedVersion": -2147483648, "bgpPeerLocalAddr": "192.168.1.1", "bgpPeerLocalPort": -2147483648, "bgpPeerRemoteAddr": "192.168.1.1", "bgpPeerRemotePort": -2147483648, "bgpPeerRemoteAs": -2147483648, "bgpPeerInUpdates": 0, "bgpPeerOutUpdates": 0, "bgpPeerInTotalMessages": 0, "bgpPeerOutTotalMessages": 0, "bgpPeerLastError": "example-string", "bgpPeerFsmEstablishedTransitions": 0, "bgpPeerFsmEstablishedTime": 0, "bgpPeerConnectRetryInterval": -2147483648, "bgpPeerHoldTime": -2147483648, "bgpPeerKeepAlive": -2147483648, "bgpPeerHoldTimeConfigured": -2147483648, "bgpPeerKeepAliveConfigured": -2147483648, "bgpPeerMinASOriginationInterval": -2147483648, "bgpPeerMinRouteAdvertisementInterval": -2147483648, "bgpPeerInUpdateElapsedTime": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-bgpPeerEntry", "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": "/bgpPeerTable/bgpPeerEntry", "x-restconf-kind": "container" }, "/data/BGP4-MIB:bgpPeerTable/bgpPeerEntry={bgpPeerRemoteAddr}": { "get": { "summary": "Get bgpPeerEntry entry", "description": "Retrieve specific bgpPeerEntry entry by key from MIB", "tags": [ "BGP4-MIB" ], "parameters": [ { "name": "bgpPeerRemoteAddr", "in": "path", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "bgpPeerIdentifier": { "type": "string", "description": "The BGP Identifier of this entry's BGP\n peer.", "format": "inet:ipv4-address" }, "bgpPeerState": { "type": "string", "description": "The BGP peer connection state." }, "bgpPeerAdminStatus": { "type": "string", "description": "The desired state of the BGP connection.\n A transition from 'stop' to 'start' will\n cause the BGP Start Event to be generated.\n A transition from 'start' to 'stop' will\n cause the BGP Stop Event to be generated.\n This parameter can be used to restart BGP\n peer connections. Care should be used in\n providing write access to this object\n without adequate authentication." }, "bgpPeerNegotiatedVersion": { "type": "integer", "description": "The negotiated version of BGP running\n between the two peers.", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerLocalAddr": { "type": "string", "description": "The local IP address of this entry's BGP\n connection.", "format": "inet:ipv4-address" }, "bgpPeerLocalPort": { "type": "integer", "description": "The local port for the TCP connection\n between the BGP peers.", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerRemoteAddr": { "type": "string", "description": "The remote IP address of this entry's BGP\n peer.", "format": "inet:ipv4-address" }, "bgpPeerRemotePort": { "type": "integer", "description": "The remote port for the TCP connection\n between the BGP peers. Note that the\n objects bgpPeerLocalAddr,\n bgpPeerLocalPort, bgpPeerRemoteAddr and\n bgpPeerRemotePort provide the appropriate\n reference to the standard MIB TCP\n connection table.", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerRemoteAs": { "type": "integer", "description": "The remote autonomous system number.", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerInUpdates": { "type": "integer", "description": "The number of BGP UPDATE messages\n received on this connection. This object\n should be initialized to zero (0) when the\n connection is established.", "minimum": 0, "maximum": 4294967295 }, "bgpPeerOutUpdates": { "type": "integer", "description": "The number of BGP UPDATE messages\n transmitted on this connection. This\n object should be initialized to zero (0)\n when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "bgpPeerInTotalMessages": { "type": "integer", "description": "The total number of messages received\n from the remote peer on this connection.\n This object should be initialized to zero\n when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "bgpPeerOutTotalMessages": { "type": "integer", "description": "The total number of messages transmitted to\n the remote peer on this connection. This\n object should be initialized to zero when\n the connection is established.", "minimum": 0, "maximum": 4294967295 }, "bgpPeerLastError": { "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" }, "bgpPeerFsmEstablishedTransitions": { "type": "integer", "description": "The total number of times the BGP FSM\n transitioned into the established state.", "minimum": 0, "maximum": 4294967295 }, "bgpPeerFsmEstablishedTime": { "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 the router is\n booted.", "minimum": 0, "maximum": 4294967295 }, "bgpPeerConnectRetryInterval": { "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 }, "bgpPeerHoldTime": { "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 by using the smaller of the\n value in bgpPeerHoldTimeConfigured and the\n Hold Time received in the OPEN message.\n This value must be at lease three seconds\n if it is not zero (0) in which case the\n Hold Timer has not been established with\n the peer, or, the value of\n bgpPeerHoldTimeConfigured is zero (0).", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerKeepAlive": { "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 bgpPeerHoldTime, it has the same\n proportion as what\n bgpPeerKeepAliveConfigured has when\n compared with bgpPeerHoldTimeConfigured.\n If the value of this object is zero (0),\n it indicates that the KeepAlive timer has\n not been established with the peer, or,\n the value of bgpPeerKeepAliveConfigured is\n zero (0).", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerHoldTimeConfigured": { "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 (bgpPeerHoldTime) with the peer.\n This value must not be less than three\n seconds if it is not zero (0) in which\n case 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 }, "bgpPeerKeepAliveConfigured": { "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 bgpPeerHoldTimeConfigured; the actual\n time interval for the KEEPALIVE messages\n is indicated by bgpPeerKeepAlive. A\n reasonable maximum value for this timer\n would be configured to be one\n third of that of\n bgpPeerHoldTimeConfigured.\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 }, "bgpPeerMinASOriginationInterval": { "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 }, "bgpPeerMinRouteAdvertisementInterval": { "type": "integer", "description": "Time interval in seconds for the\n MinRouteAdvertisementInterval timer.\n The suggested value for this timer is 30\n seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerInUpdateElapsedTime": { "type": "integer", "description": "Elapsed time in seconds since the last BGP\n UPDATE message was received from the peer.\n Each time bgpPeerInUpdates is incremented,\n the value of this object is set to zero\n (0).", "minimum": 0, "maximum": 4294967295 } } }, "example": { "BGP4-MIB:bgpPeerEntry": { "bgpPeerIdentifier": "example-string", "bgpPeerState": "up(1)", "bgpPeerAdminStatus": "up(1)", "bgpPeerNegotiatedVersion": -2147483648, "bgpPeerLocalAddr": "192.168.1.1", "bgpPeerLocalPort": -2147483648, "bgpPeerRemoteAddr": "192.168.1.1", "bgpPeerRemotePort": -2147483648, "bgpPeerRemoteAs": -2147483648, "bgpPeerInUpdates": 0, "bgpPeerOutUpdates": 0, "bgpPeerInTotalMessages": 0, "bgpPeerOutTotalMessages": 0, "bgpPeerLastError": "example-string", "bgpPeerFsmEstablishedTransitions": 0, "bgpPeerFsmEstablishedTime": 0, "bgpPeerConnectRetryInterval": -2147483648, "bgpPeerHoldTime": -2147483648, "bgpPeerKeepAlive": -2147483648, "bgpPeerHoldTimeConfigured": -2147483648, "bgpPeerKeepAliveConfigured": -2147483648, "bgpPeerMinASOriginationInterval": -2147483648, "bgpPeerMinRouteAdvertisementInterval": -2147483648, "bgpPeerInUpdateElapsedTime": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-bgpPeerEntry-2" }, "x-yang-path": "/bgpPeerTable/bgpPeerEntry={bgpPeerRemoteAddr}", "x-restconf-kind": "list-instance", "x-list-keys": [ "bgpPeerRemoteAddr" ] }, "/data/BGP4-MIB:bgpRcvdPathAttrTable": { "get": { "summary": "Get bgpRcvdPathAttrTable data", "description": "Retrieve bgpRcvdPathAttrTable operational data from MIB", "tags": [ "BGP4-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The BGP Received Path Attribute Table\n contains information about paths to\n destination networks received from all\n peers running BGP version 3 or less.", "properties": { "bgpPathAttrEntry": { "type": "array", "description": "Information about a path to a network.", "items": { "type": "object", "properties": { "bgpPathAttrPeer": { "type": "string", "description": "The IP address of the peer where the path\n information was learned.", "format": "inet:ipv4-address" }, "bgpPathAttrDestNetwork": { "type": "string", "description": "The address of the destination network.", "format": "inet:ipv4-address" }, "bgpPathAttrOrigin": { "type": "string", "description": "The ultimate origin of the path information." }, "bgpPathAttrASPath": { "type": "string", "description": "The set of ASs that must be traversed to\n reach the network. This object is\n probably best represented as SEQUENCE OF\n INTEGER. For SMI compatibility, though,\n it is represented as OCTET STRING. Each\n AS is represented as a pair of octets\n according to the following algorithm:\n \n first-byte-of-pair = ASNumber / 256;\n second-byte-of-pair = ASNumber & 255;", "format": "binary" }, "bgpPathAttrNextHop": { "type": "string", "description": "The address of the border router that\n should be used for the destination\n network.", "format": "inet:ipv4-address" }, "bgpPathAttrInterASMetric": { "type": "integer", "description": "The optional inter-AS metric. If this\n attribute has not been provided for this\n route, the value for this object is 0.", "minimum": -2147483648, "maximum": 2147483647 } } } } } }, "example": { "BGP4-MIB:bgpRcvdPathAttrTable": { "bgpPathAttrEntry": [ { "bgpPathAttrPeer": "example-string", "bgpPathAttrDestNetwork": "example-string", "bgpPathAttrOrigin": "example-string", "bgpPathAttrASPath": "example-string", "bgpPathAttrNextHop": "example-string", "bgpPathAttrInterASMetric": -2147483648 }, { "bgpPathAttrPeer": "example-string", "bgpPathAttrDestNetwork": "example-string", "bgpPathAttrOrigin": "example-string", "bgpPathAttrASPath": "example-string", "bgpPathAttrNextHop": "example-string", "bgpPathAttrInterASMetric": -2147483648 }, { "bgpPathAttrPeer": "example-string", "bgpPathAttrDestNetwork": "example-string", "bgpPathAttrOrigin": "example-string", "bgpPathAttrASPath": "example-string", "bgpPathAttrNextHop": "example-string", "bgpPathAttrInterASMetric": -2147483648 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-bgpRcvdPathAttrTable", "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": "/bgpRcvdPathAttrTable", "x-restconf-kind": "container" }, "/data/BGP4-MIB:bgpRcvdPathAttrTable/bgpPathAttrEntry": { "get": { "summary": "Get bgpPathAttrEntry list", "description": "Retrieve list of bgpPathAttrEntry entries from MIB", "tags": [ "BGP4-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about a path to a network.", "items": { "type": "object", "properties": { "bgpPathAttrPeer": { "type": "string", "description": "The IP address of the peer where the path\n information was learned.", "format": "inet:ipv4-address" }, "bgpPathAttrDestNetwork": { "type": "string", "description": "The address of the destination network.", "format": "inet:ipv4-address" }, "bgpPathAttrOrigin": { "type": "string", "description": "The ultimate origin of the path information." }, "bgpPathAttrASPath": { "type": "string", "description": "The set of ASs that must be traversed to\n reach the network. This object is\n probably best represented as SEQUENCE OF\n INTEGER. For SMI compatibility, though,\n it is represented as OCTET STRING. Each\n AS is represented as a pair of octets\n according to the following algorithm:\n \n first-byte-of-pair = ASNumber / 256;\n second-byte-of-pair = ASNumber & 255;", "format": "binary" }, "bgpPathAttrNextHop": { "type": "string", "description": "The address of the border router that\n should be used for the destination\n network.", "format": "inet:ipv4-address" }, "bgpPathAttrInterASMetric": { "type": "integer", "description": "The optional inter-AS metric. If this\n attribute has not been provided for this\n route, the value for this object is 0.", "minimum": -2147483648, "maximum": 2147483647 } } } }, "example": { "BGP4-MIB:bgpPathAttrEntry": [ { "bgpPathAttrPeer": "example-string", "bgpPathAttrDestNetwork": "example-string", "bgpPathAttrOrigin": "example-string", "bgpPathAttrASPath": "example-string", "bgpPathAttrNextHop": "example-string", "bgpPathAttrInterASMetric": -2147483648 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-bgpPathAttrEntry", "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": "/bgpRcvdPathAttrTable/bgpPathAttrEntry", "x-restconf-kind": "container" }, "/data/BGP4-MIB:bgp4PathAttrTable": { "get": { "summary": "Get bgp4PathAttrTable data", "description": "Retrieve bgp4PathAttrTable operational data from MIB", "tags": [ "BGP4-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The BGP-4 Received Path Attribute Table\n contains information about paths to\n destination networks received from all\n BGP4 peers.", "properties": { "bgp4PathAttrEntry": { "type": "array", "description": "Information about a path to a network.", "items": { "type": "object", "properties": { "bgp4PathAttrPeer": { "type": "string", "description": "The IP address of the peer where the path\n information was learned.", "format": "inet:ipv4-address" }, "bgp4PathAttrIpAddrPrefixLen": { "type": "integer", "description": "Length in bits of the IP address prefix\n in the Network Layer Reachability\n Information field.", "minimum": -2147483648, "maximum": 2147483647 }, "bgp4PathAttrIpAddrPrefix": { "type": "string", "description": "An IP address prefix in the Network Layer\n Reachability Information field. This object\n is an IP address containing the prefix with\n length specified by\n bgp4PathAttrIpAddrPrefixLen.\n Any bits beyond the length specified by\n bgp4PathAttrIpAddrPrefixLen are zeroed.", "format": "inet:ipv4-address" }, "bgp4PathAttrOrigin": { "type": "string", "description": "The ultimate origin of the path\n information." }, "bgp4PathAttrASPathSegment": { "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\n route in the UPDATE\n message has traversed\n 2 AS_SEQUENCE: ordered set of ASs\n a route in the UPDATE\n 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" }, "bgp4PathAttrNextHop": { "type": "string", "description": "The address of the border router that\n should be used for the destination\n network.", "format": "inet:ipv4-address" }, "bgp4PathAttrMultiExitDisc": { "type": "integer", "description": "This metric is used to discriminate\n between multiple exit points to an\n adjacent autonomous system. A value of -1\n indicates the absence of this attribute.", "minimum": -2147483648, "maximum": 2147483647 }, "bgp4PathAttrLocalPref": { "type": "integer", "description": "The originating BGP4 speaker's degree of\n preference for an advertised route. A\n value of -1 indicates the absence of this\n attribute.", "minimum": -2147483648, "maximum": 2147483647 }, "bgp4PathAttrAtomicAggregate": { "type": "string", "description": "Whether or not the local system has\n selected a less specific route without\n selecting a more specific route." }, "bgp4PathAttrAggregatorAS": { "type": "integer", "description": "The AS number of the last BGP4 speaker that\n performed route aggregation. A value of\n zero (0) indicates the absence of this\n attribute.", "minimum": -2147483648, "maximum": 2147483647 }, "bgp4PathAttrAggregatorAddr": { "type": "string", "description": "The IP address of the last BGP4 speaker\n that performed route aggregation. A value\n of 0.0.0.0 indicates the absence of this\n attribute.", "format": "inet:ipv4-address" }, "bgp4PathAttrCalcLocalPref": { "type": "integer", "description": "The degree of preference calculated by the\n receiving BGP4 speaker for an advertised\n route. A value of -1 indicates the\n absence of this attribute.", "minimum": -2147483648, "maximum": 2147483647 }, "bgp4PathAttrBest": { "type": "string", "description": "An indication of whether or not this route\n was chosen as the best BGP4 route." }, "bgp4PathAttrUnknown": { "type": "string", "description": "One or more path attributes not understood\n by this BGP4 speaker. Size zero (0)\n indicates the absence of such\n attribute(s). Octets beyond the maximum\n size, if any, are not recorded by this\n object.", "format": "binary" } } } } } }, "example": { "BGP4-MIB:bgp4PathAttrTable": { "bgp4PathAttrEntry": [ { "bgp4PathAttrPeer": "example-string", "bgp4PathAttrIpAddrPrefixLen": -2147483648, "bgp4PathAttrIpAddrPrefix": "192.168.1.1", "bgp4PathAttrOrigin": "example-string", "bgp4PathAttrASPathSegment": "example-string", "bgp4PathAttrNextHop": "example-string", "bgp4PathAttrMultiExitDisc": -2147483648, "bgp4PathAttrLocalPref": -2147483648, "bgp4PathAttrAtomicAggregate": "example-string", "bgp4PathAttrAggregatorAS": -2147483648, "bgp4PathAttrAggregatorAddr": "192.168.1.1", "bgp4PathAttrCalcLocalPref": -2147483648, "bgp4PathAttrBest": "example-string", "bgp4PathAttrUnknown": "example-string" }, { "bgp4PathAttrPeer": "example-string", "bgp4PathAttrIpAddrPrefixLen": -2147483648, "bgp4PathAttrIpAddrPrefix": "192.168.1.1", "bgp4PathAttrOrigin": "example-string", "bgp4PathAttrASPathSegment": "example-string", "bgp4PathAttrNextHop": "example-string", "bgp4PathAttrMultiExitDisc": -2147483648, "bgp4PathAttrLocalPref": -2147483648, "bgp4PathAttrAtomicAggregate": "example-string", "bgp4PathAttrAggregatorAS": -2147483648, "bgp4PathAttrAggregatorAddr": "192.168.1.1", "bgp4PathAttrCalcLocalPref": -2147483648, "bgp4PathAttrBest": "example-string", "bgp4PathAttrUnknown": "example-string" }, { "bgp4PathAttrPeer": "example-string", "bgp4PathAttrIpAddrPrefixLen": -2147483648, "bgp4PathAttrIpAddrPrefix": "192.168.1.1", "bgp4PathAttrOrigin": "example-string", "bgp4PathAttrASPathSegment": "example-string", "bgp4PathAttrNextHop": "example-string", "bgp4PathAttrMultiExitDisc": -2147483648, "bgp4PathAttrLocalPref": -2147483648, "bgp4PathAttrAtomicAggregate": "example-string", "bgp4PathAttrAggregatorAS": -2147483648, "bgp4PathAttrAggregatorAddr": "192.168.1.1", "bgp4PathAttrCalcLocalPref": -2147483648, "bgp4PathAttrBest": "example-string", "bgp4PathAttrUnknown": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-bgp4PathAttrTable", "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": "/bgp4PathAttrTable", "x-restconf-kind": "container" }, "/data/BGP4-MIB:bgp4PathAttrTable/bgp4PathAttrEntry": { "get": { "summary": "Get bgp4PathAttrEntry list", "description": "Retrieve list of bgp4PathAttrEntry entries from MIB", "tags": [ "BGP4-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about a path to a network.", "items": { "type": "object", "properties": { "bgp4PathAttrPeer": { "type": "string", "description": "The IP address of the peer where the path\n information was learned.", "format": "inet:ipv4-address" }, "bgp4PathAttrIpAddrPrefixLen": { "type": "integer", "description": "Length in bits of the IP address prefix\n in the Network Layer Reachability\n Information field.", "minimum": -2147483648, "maximum": 2147483647 }, "bgp4PathAttrIpAddrPrefix": { "type": "string", "description": "An IP address prefix in the Network Layer\n Reachability Information field. This object\n is an IP address containing the prefix with\n length specified by\n bgp4PathAttrIpAddrPrefixLen.\n Any bits beyond the length specified by\n bgp4PathAttrIpAddrPrefixLen are zeroed.", "format": "inet:ipv4-address" }, "bgp4PathAttrOrigin": { "type": "string", "description": "The ultimate origin of the path\n information." }, "bgp4PathAttrASPathSegment": { "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\n route in the UPDATE\n message has traversed\n 2 AS_SEQUENCE: ordered set of ASs\n a route in the UPDATE\n 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" }, "bgp4PathAttrNextHop": { "type": "string", "description": "The address of the border router that\n should be used for the destination\n network.", "format": "inet:ipv4-address" }, "bgp4PathAttrMultiExitDisc": { "type": "integer", "description": "This metric is used to discriminate\n between multiple exit points to an\n adjacent autonomous system. A value of -1\n indicates the absence of this attribute.", "minimum": -2147483648, "maximum": 2147483647 }, "bgp4PathAttrLocalPref": { "type": "integer", "description": "The originating BGP4 speaker's degree of\n preference for an advertised route. A\n value of -1 indicates the absence of this\n attribute.", "minimum": -2147483648, "maximum": 2147483647 }, "bgp4PathAttrAtomicAggregate": { "type": "string", "description": "Whether or not the local system has\n selected a less specific route without\n selecting a more specific route." }, "bgp4PathAttrAggregatorAS": { "type": "integer", "description": "The AS number of the last BGP4 speaker that\n performed route aggregation. A value of\n zero (0) indicates the absence of this\n attribute.", "minimum": -2147483648, "maximum": 2147483647 }, "bgp4PathAttrAggregatorAddr": { "type": "string", "description": "The IP address of the last BGP4 speaker\n that performed route aggregation. A value\n of 0.0.0.0 indicates the absence of this\n attribute.", "format": "inet:ipv4-address" }, "bgp4PathAttrCalcLocalPref": { "type": "integer", "description": "The degree of preference calculated by the\n receiving BGP4 speaker for an advertised\n route. A value of -1 indicates the\n absence of this attribute.", "minimum": -2147483648, "maximum": 2147483647 }, "bgp4PathAttrBest": { "type": "string", "description": "An indication of whether or not this route\n was chosen as the best BGP4 route." }, "bgp4PathAttrUnknown": { "type": "string", "description": "One or more path attributes not understood\n by this BGP4 speaker. Size zero (0)\n indicates the absence of such\n attribute(s). Octets beyond the maximum\n size, if any, are not recorded by this\n object.", "format": "binary" } } } }, "example": { "BGP4-MIB:bgp4PathAttrEntry": [ { "bgp4PathAttrPeer": "example-string", "bgp4PathAttrIpAddrPrefixLen": -2147483648, "bgp4PathAttrIpAddrPrefix": "192.168.1.1", "bgp4PathAttrOrigin": "example-string", "bgp4PathAttrASPathSegment": "example-string", "bgp4PathAttrNextHop": "example-string", "bgp4PathAttrMultiExitDisc": -2147483648, "bgp4PathAttrLocalPref": -2147483648, "bgp4PathAttrAtomicAggregate": "example-string", "bgp4PathAttrAggregatorAS": -2147483648, "bgp4PathAttrAggregatorAddr": "192.168.1.1", "bgp4PathAttrCalcLocalPref": -2147483648, "bgp4PathAttrBest": "example-string", "bgp4PathAttrUnknown": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-bgp4PathAttrEntry", "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": "/bgp4PathAttrTable/bgp4PathAttrEntry", "x-restconf-kind": "container" }, "/data/BGP4-MIB:bgpPeerEntry": { "get": { "summary": "Get bgpPeerEntry list", "description": "Retrieve list of bgpPeerEntry entries from MIB", "tags": [ "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": { "bgpPeerIdentifier": { "type": "string", "description": "The BGP Identifier of this entry's BGP\n peer.", "format": "inet:ipv4-address" }, "bgpPeerState": { "type": "string", "description": "The BGP peer connection state." }, "bgpPeerAdminStatus": { "type": "string", "description": "The desired state of the BGP connection.\n A transition from 'stop' to 'start' will\n cause the BGP Start Event to be generated.\n A transition from 'start' to 'stop' will\n cause the BGP Stop Event to be generated.\n This parameter can be used to restart BGP\n peer connections. Care should be used in\n providing write access to this object\n without adequate authentication." }, "bgpPeerNegotiatedVersion": { "type": "integer", "description": "The negotiated version of BGP running\n between the two peers.", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerLocalAddr": { "type": "string", "description": "The local IP address of this entry's BGP\n connection.", "format": "inet:ipv4-address" }, "bgpPeerLocalPort": { "type": "integer", "description": "The local port for the TCP connection\n between the BGP peers.", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerRemoteAddr": { "type": "string", "description": "The remote IP address of this entry's BGP\n peer.", "format": "inet:ipv4-address" }, "bgpPeerRemotePort": { "type": "integer", "description": "The remote port for the TCP connection\n between the BGP peers. Note that the\n objects bgpPeerLocalAddr,\n bgpPeerLocalPort, bgpPeerRemoteAddr and\n bgpPeerRemotePort provide the appropriate\n reference to the standard MIB TCP\n connection table.", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerRemoteAs": { "type": "integer", "description": "The remote autonomous system number.", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerInUpdates": { "type": "integer", "description": "The number of BGP UPDATE messages\n received on this connection. This object\n should be initialized to zero (0) when the\n connection is established.", "minimum": 0, "maximum": 4294967295 }, "bgpPeerOutUpdates": { "type": "integer", "description": "The number of BGP UPDATE messages\n transmitted on this connection. This\n object should be initialized to zero (0)\n when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "bgpPeerInTotalMessages": { "type": "integer", "description": "The total number of messages received\n from the remote peer on this connection.\n This object should be initialized to zero\n when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "bgpPeerOutTotalMessages": { "type": "integer", "description": "The total number of messages transmitted to\n the remote peer on this connection. This\n object should be initialized to zero when\n the connection is established.", "minimum": 0, "maximum": 4294967295 }, "bgpPeerLastError": { "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" }, "bgpPeerFsmEstablishedTransitions": { "type": "integer", "description": "The total number of times the BGP FSM\n transitioned into the established state.", "minimum": 0, "maximum": 4294967295 }, "bgpPeerFsmEstablishedTime": { "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 the router is\n booted.", "minimum": 0, "maximum": 4294967295 }, "bgpPeerConnectRetryInterval": { "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 }, "bgpPeerHoldTime": { "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 by using the smaller of the\n value in bgpPeerHoldTimeConfigured and the\n Hold Time received in the OPEN message.\n This value must be at lease three seconds\n if it is not zero (0) in which case the\n Hold Timer has not been established with\n the peer, or, the value of\n bgpPeerHoldTimeConfigured is zero (0).", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerKeepAlive": { "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 bgpPeerHoldTime, it has the same\n proportion as what\n bgpPeerKeepAliveConfigured has when\n compared with bgpPeerHoldTimeConfigured.\n If the value of this object is zero (0),\n it indicates that the KeepAlive timer has\n not been established with the peer, or,\n the value of bgpPeerKeepAliveConfigured is\n zero (0).", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerHoldTimeConfigured": { "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 (bgpPeerHoldTime) with the peer.\n This value must not be less than three\n seconds if it is not zero (0) in which\n case 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 }, "bgpPeerKeepAliveConfigured": { "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 bgpPeerHoldTimeConfigured; the actual\n time interval for the KEEPALIVE messages\n is indicated by bgpPeerKeepAlive. A\n reasonable maximum value for this timer\n would be configured to be one\n third of that of\n bgpPeerHoldTimeConfigured.\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 }, "bgpPeerMinASOriginationInterval": { "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 }, "bgpPeerMinRouteAdvertisementInterval": { "type": "integer", "description": "Time interval in seconds for the\n MinRouteAdvertisementInterval timer.\n The suggested value for this timer is 30\n seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerInUpdateElapsedTime": { "type": "integer", "description": "Elapsed time in seconds since the last BGP\n UPDATE message was received from the peer.\n Each time bgpPeerInUpdates is incremented,\n the value of this object is set to zero\n (0).", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "BGP4-MIB:bgpPeerEntry": [ { "bgpPeerIdentifier": "example-string", "bgpPeerState": "up(1)", "bgpPeerAdminStatus": "up(1)", "bgpPeerNegotiatedVersion": -2147483648, "bgpPeerLocalAddr": "192.168.1.1", "bgpPeerLocalPort": -2147483648, "bgpPeerRemoteAddr": "192.168.1.1", "bgpPeerRemotePort": -2147483648, "bgpPeerRemoteAs": -2147483648, "bgpPeerInUpdates": 0, "bgpPeerOutUpdates": 0, "bgpPeerInTotalMessages": 0, "bgpPeerOutTotalMessages": 0, "bgpPeerLastError": "example-string", "bgpPeerFsmEstablishedTransitions": 0, "bgpPeerFsmEstablishedTime": 0, "bgpPeerConnectRetryInterval": -2147483648, "bgpPeerHoldTime": -2147483648, "bgpPeerKeepAlive": -2147483648, "bgpPeerHoldTimeConfigured": -2147483648, "bgpPeerKeepAliveConfigured": -2147483648, "bgpPeerMinASOriginationInterval": -2147483648, "bgpPeerMinRouteAdvertisementInterval": -2147483648, "bgpPeerInUpdateElapsedTime": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-bgpPeerEntry-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": "/bgpPeerEntry", "x-restconf-kind": "container" }, "/data/BGP4-MIB:bgpPeerEntry={bgpPeerRemoteAddr}": { "get": { "summary": "Get bgpPeerEntry entry", "description": "Retrieve specific bgpPeerEntry entry by key from MIB", "tags": [ "BGP4-MIB" ], "parameters": [ { "name": "bgpPeerRemoteAddr", "in": "path", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "bgpPeerIdentifier": { "type": "string", "description": "The BGP Identifier of this entry's BGP\n peer.", "format": "inet:ipv4-address" }, "bgpPeerState": { "type": "string", "description": "The BGP peer connection state." }, "bgpPeerAdminStatus": { "type": "string", "description": "The desired state of the BGP connection.\n A transition from 'stop' to 'start' will\n cause the BGP Start Event to be generated.\n A transition from 'start' to 'stop' will\n cause the BGP Stop Event to be generated.\n This parameter can be used to restart BGP\n peer connections. Care should be used in\n providing write access to this object\n without adequate authentication." }, "bgpPeerNegotiatedVersion": { "type": "integer", "description": "The negotiated version of BGP running\n between the two peers.", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerLocalAddr": { "type": "string", "description": "The local IP address of this entry's BGP\n connection.", "format": "inet:ipv4-address" }, "bgpPeerLocalPort": { "type": "integer", "description": "The local port for the TCP connection\n between the BGP peers.", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerRemoteAddr": { "type": "string", "description": "The remote IP address of this entry's BGP\n peer.", "format": "inet:ipv4-address" }, "bgpPeerRemotePort": { "type": "integer", "description": "The remote port for the TCP connection\n between the BGP peers. Note that the\n objects bgpPeerLocalAddr,\n bgpPeerLocalPort, bgpPeerRemoteAddr and\n bgpPeerRemotePort provide the appropriate\n reference to the standard MIB TCP\n connection table.", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerRemoteAs": { "type": "integer", "description": "The remote autonomous system number.", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerInUpdates": { "type": "integer", "description": "The number of BGP UPDATE messages\n received on this connection. This object\n should be initialized to zero (0) when the\n connection is established.", "minimum": 0, "maximum": 4294967295 }, "bgpPeerOutUpdates": { "type": "integer", "description": "The number of BGP UPDATE messages\n transmitted on this connection. This\n object should be initialized to zero (0)\n when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "bgpPeerInTotalMessages": { "type": "integer", "description": "The total number of messages received\n from the remote peer on this connection.\n This object should be initialized to zero\n when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "bgpPeerOutTotalMessages": { "type": "integer", "description": "The total number of messages transmitted to\n the remote peer on this connection. This\n object should be initialized to zero when\n the connection is established.", "minimum": 0, "maximum": 4294967295 }, "bgpPeerLastError": { "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" }, "bgpPeerFsmEstablishedTransitions": { "type": "integer", "description": "The total number of times the BGP FSM\n transitioned into the established state.", "minimum": 0, "maximum": 4294967295 }, "bgpPeerFsmEstablishedTime": { "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 the router is\n booted.", "minimum": 0, "maximum": 4294967295 }, "bgpPeerConnectRetryInterval": { "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 }, "bgpPeerHoldTime": { "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 by using the smaller of the\n value in bgpPeerHoldTimeConfigured and the\n Hold Time received in the OPEN message.\n This value must be at lease three seconds\n if it is not zero (0) in which case the\n Hold Timer has not been established with\n the peer, or, the value of\n bgpPeerHoldTimeConfigured is zero (0).", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerKeepAlive": { "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 bgpPeerHoldTime, it has the same\n proportion as what\n bgpPeerKeepAliveConfigured has when\n compared with bgpPeerHoldTimeConfigured.\n If the value of this object is zero (0),\n it indicates that the KeepAlive timer has\n not been established with the peer, or,\n the value of bgpPeerKeepAliveConfigured is\n zero (0).", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerHoldTimeConfigured": { "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 (bgpPeerHoldTime) with the peer.\n This value must not be less than three\n seconds if it is not zero (0) in which\n case 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 }, "bgpPeerKeepAliveConfigured": { "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 bgpPeerHoldTimeConfigured; the actual\n time interval for the KEEPALIVE messages\n is indicated by bgpPeerKeepAlive. A\n reasonable maximum value for this timer\n would be configured to be one\n third of that of\n bgpPeerHoldTimeConfigured.\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 }, "bgpPeerMinASOriginationInterval": { "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 }, "bgpPeerMinRouteAdvertisementInterval": { "type": "integer", "description": "Time interval in seconds for the\n MinRouteAdvertisementInterval timer.\n The suggested value for this timer is 30\n seconds.", "minimum": -2147483648, "maximum": 2147483647 }, "bgpPeerInUpdateElapsedTime": { "type": "integer", "description": "Elapsed time in seconds since the last BGP\n UPDATE message was received from the peer.\n Each time bgpPeerInUpdates is incremented,\n the value of this object is set to zero\n (0).", "minimum": 0, "maximum": 4294967295 } } }, "example": { "BGP4-MIB:bgpPeerEntry": { "bgpPeerIdentifier": "example-string", "bgpPeerState": "up(1)", "bgpPeerAdminStatus": "up(1)", "bgpPeerNegotiatedVersion": -2147483648, "bgpPeerLocalAddr": "192.168.1.1", "bgpPeerLocalPort": -2147483648, "bgpPeerRemoteAddr": "192.168.1.1", "bgpPeerRemotePort": -2147483648, "bgpPeerRemoteAs": -2147483648, "bgpPeerInUpdates": 0, "bgpPeerOutUpdates": 0, "bgpPeerInTotalMessages": 0, "bgpPeerOutTotalMessages": 0, "bgpPeerLastError": "example-string", "bgpPeerFsmEstablishedTransitions": 0, "bgpPeerFsmEstablishedTime": 0, "bgpPeerConnectRetryInterval": -2147483648, "bgpPeerHoldTime": -2147483648, "bgpPeerKeepAlive": -2147483648, "bgpPeerHoldTimeConfigured": -2147483648, "bgpPeerKeepAliveConfigured": -2147483648, "bgpPeerMinASOriginationInterval": -2147483648, "bgpPeerMinRouteAdvertisementInterval": -2147483648, "bgpPeerInUpdateElapsedTime": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-bgpPeerEntry-4" }, "x-yang-path": "/bgpPeerEntry={bgpPeerRemoteAddr}", "x-restconf-kind": "list-instance", "x-list-keys": [ "bgpPeerRemoteAddr" ] }, "/data/BGP4-MIB:bgpPathAttrEntry": { "get": { "summary": "Get bgpPathAttrEntry list", "description": "Retrieve list of bgpPathAttrEntry entries from MIB", "tags": [ "BGP4-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about a path to a network.", "items": { "type": "object", "properties": { "bgpPathAttrPeer": { "type": "string", "description": "The IP address of the peer where the path\n information was learned.", "format": "inet:ipv4-address" }, "bgpPathAttrDestNetwork": { "type": "string", "description": "The address of the destination network.", "format": "inet:ipv4-address" }, "bgpPathAttrOrigin": { "type": "string", "description": "The ultimate origin of the path information." }, "bgpPathAttrASPath": { "type": "string", "description": "The set of ASs that must be traversed to\n reach the network. This object is\n probably best represented as SEQUENCE OF\n INTEGER. For SMI compatibility, though,\n it is represented as OCTET STRING. Each\n AS is represented as a pair of octets\n according to the following algorithm:\n \n first-byte-of-pair = ASNumber / 256;\n second-byte-of-pair = ASNumber & 255;", "format": "binary" }, "bgpPathAttrNextHop": { "type": "string", "description": "The address of the border router that\n should be used for the destination\n network.", "format": "inet:ipv4-address" }, "bgpPathAttrInterASMetric": { "type": "integer", "description": "The optional inter-AS metric. If this\n attribute has not been provided for this\n route, the value for this object is 0.", "minimum": -2147483648, "maximum": 2147483647 } } } }, "example": { "BGP4-MIB:bgpPathAttrEntry": [ { "bgpPathAttrPeer": "example-string", "bgpPathAttrDestNetwork": "example-string", "bgpPathAttrOrigin": "example-string", "bgpPathAttrASPath": "example-string", "bgpPathAttrNextHop": "example-string", "bgpPathAttrInterASMetric": -2147483648 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-bgpPathAttrEntry-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": "/bgpPathAttrEntry", "x-restconf-kind": "container" }, "/data/BGP4-MIB:bgp4PathAttrEntry": { "get": { "summary": "Get bgp4PathAttrEntry list", "description": "Retrieve list of bgp4PathAttrEntry entries from MIB", "tags": [ "BGP4-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about a path to a network.", "items": { "type": "object", "properties": { "bgp4PathAttrPeer": { "type": "string", "description": "The IP address of the peer where the path\n information was learned.", "format": "inet:ipv4-address" }, "bgp4PathAttrIpAddrPrefixLen": { "type": "integer", "description": "Length in bits of the IP address prefix\n in the Network Layer Reachability\n Information field.", "minimum": -2147483648, "maximum": 2147483647 }, "bgp4PathAttrIpAddrPrefix": { "type": "string", "description": "An IP address prefix in the Network Layer\n Reachability Information field. This object\n is an IP address containing the prefix with\n length specified by\n bgp4PathAttrIpAddrPrefixLen.\n Any bits beyond the length specified by\n bgp4PathAttrIpAddrPrefixLen are zeroed.", "format": "inet:ipv4-address" }, "bgp4PathAttrOrigin": { "type": "string", "description": "The ultimate origin of the path\n information." }, "bgp4PathAttrASPathSegment": { "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\n route in the UPDATE\n message has traversed\n 2 AS_SEQUENCE: ordered set of ASs\n a route in the UPDATE\n 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" }, "bgp4PathAttrNextHop": { "type": "string", "description": "The address of the border router that\n should be used for the destination\n network.", "format": "inet:ipv4-address" }, "bgp4PathAttrMultiExitDisc": { "type": "integer", "description": "This metric is used to discriminate\n between multiple exit points to an\n adjacent autonomous system. A value of -1\n indicates the absence of this attribute.", "minimum": -2147483648, "maximum": 2147483647 }, "bgp4PathAttrLocalPref": { "type": "integer", "description": "The originating BGP4 speaker's degree of\n preference for an advertised route. A\n value of -1 indicates the absence of this\n attribute.", "minimum": -2147483648, "maximum": 2147483647 }, "bgp4PathAttrAtomicAggregate": { "type": "string", "description": "Whether or not the local system has\n selected a less specific route without\n selecting a more specific route." }, "bgp4PathAttrAggregatorAS": { "type": "integer", "description": "The AS number of the last BGP4 speaker that\n performed route aggregation. A value of\n zero (0) indicates the absence of this\n attribute.", "minimum": -2147483648, "maximum": 2147483647 }, "bgp4PathAttrAggregatorAddr": { "type": "string", "description": "The IP address of the last BGP4 speaker\n that performed route aggregation. A value\n of 0.0.0.0 indicates the absence of this\n attribute.", "format": "inet:ipv4-address" }, "bgp4PathAttrCalcLocalPref": { "type": "integer", "description": "The degree of preference calculated by the\n receiving BGP4 speaker for an advertised\n route. A value of -1 indicates the\n absence of this attribute.", "minimum": -2147483648, "maximum": 2147483647 }, "bgp4PathAttrBest": { "type": "string", "description": "An indication of whether or not this route\n was chosen as the best BGP4 route." }, "bgp4PathAttrUnknown": { "type": "string", "description": "One or more path attributes not understood\n by this BGP4 speaker. Size zero (0)\n indicates the absence of such\n attribute(s). Octets beyond the maximum\n size, if any, are not recorded by this\n object.", "format": "binary" } } } }, "example": { "BGP4-MIB:bgp4PathAttrEntry": [ { "bgp4PathAttrPeer": "example-string", "bgp4PathAttrIpAddrPrefixLen": -2147483648, "bgp4PathAttrIpAddrPrefix": "192.168.1.1", "bgp4PathAttrOrigin": "example-string", "bgp4PathAttrASPathSegment": "example-string", "bgp4PathAttrNextHop": "example-string", "bgp4PathAttrMultiExitDisc": -2147483648, "bgp4PathAttrLocalPref": -2147483648, "bgp4PathAttrAtomicAggregate": "example-string", "bgp4PathAttrAggregatorAS": -2147483648, "bgp4PathAttrAggregatorAddr": "192.168.1.1", "bgp4PathAttrCalcLocalPref": -2147483648, "bgp4PathAttrBest": "example-string", "bgp4PathAttrUnknown": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-bgp4PathAttrEntry-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": "/bgp4PathAttrEntry", "x-restconf-kind": "container" }, "/data/BGP4-MIB:bgpRcvdPathAttrTable/bgpPathAttrEntry={bgpPathAttrDestNetwork},{bgpPathAttrPeer}": { "get": { "summary": "Get bgpPathAttrEntry entry", "description": "Retrieve specific bgpPathAttrEntry entry by key from MIB", "tags": [ "BGP4-MIB" ], "parameters": [ { "name": "bgpPathAttrDestNetwork", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "bgpPathAttrPeer", "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": { "bgpPathAttrPeer": { "type": "string", "description": "The IP address of the peer where the path\n information was learned.", "format": "inet:ipv4-address" }, "bgpPathAttrDestNetwork": { "type": "string", "description": "The address of the destination network.", "format": "inet:ipv4-address" }, "bgpPathAttrOrigin": { "type": "string", "description": "The ultimate origin of the path information." }, "bgpPathAttrASPath": { "type": "string", "description": "The set of ASs that must be traversed to\n reach the network. This object is\n probably best represented as SEQUENCE OF\n INTEGER. For SMI compatibility, though,\n it is represented as OCTET STRING. Each\n AS is represented as a pair of octets\n according to the following algorithm:\n \n first-byte-of-pair = ASNumber / 256;\n second-byte-of-pair = ASNumber & 255;", "format": "binary" }, "bgpPathAttrNextHop": { "type": "string", "description": "The address of the border router that\n should be used for the destination\n network.", "format": "inet:ipv4-address" }, "bgpPathAttrInterASMetric": { "type": "integer", "description": "The optional inter-AS metric. If this\n attribute has not been provided for this\n route, the value for this object is 0.", "minimum": -2147483648, "maximum": 2147483647 } } }, "example": { "BGP4-MIB:bgpPathAttrEntry": { "bgpPathAttrPeer": "example-string", "bgpPathAttrDestNetwork": "example-string", "bgpPathAttrOrigin": "example-string", "bgpPathAttrASPath": "example-string", "bgpPathAttrNextHop": "example-string", "bgpPathAttrInterASMetric": -2147483648 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-bgpPathAttrEntry-2" }, "x-yang-path": "/bgpRcvdPathAttrTable/bgpPathAttrEntry={bgpPathAttrDestNetwork bgpPathAttrPeer}", "x-restconf-kind": "list-instance", "x-list-keys": [ "bgpPathAttrDestNetwork bgpPathAttrPeer" ] }, "/data/BGP4-MIB:bgp4PathAttrTable/bgp4PathAttrEntry={bgp4PathAttrIpAddrPrefix},{bgp4PathAttrIpAddrPrefixLen},{bgp4PathAttrPeer}": { "get": { "summary": "Get bgp4PathAttrEntry entry", "description": "Retrieve specific bgp4PathAttrEntry entry by key from MIB", "tags": [ "BGP4-MIB" ], "parameters": [ { "name": "bgp4PathAttrIpAddrPrefix", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "bgp4PathAttrIpAddrPrefixLen", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "bgp4PathAttrPeer", "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": { "bgp4PathAttrPeer": { "type": "string", "description": "The IP address of the peer where the path\n information was learned.", "format": "inet:ipv4-address" }, "bgp4PathAttrIpAddrPrefixLen": { "type": "integer", "description": "Length in bits of the IP address prefix\n in the Network Layer Reachability\n Information field.", "minimum": -2147483648, "maximum": 2147483647 }, "bgp4PathAttrIpAddrPrefix": { "type": "string", "description": "An IP address prefix in the Network Layer\n Reachability Information field. This object\n is an IP address containing the prefix with\n length specified by\n bgp4PathAttrIpAddrPrefixLen.\n Any bits beyond the length specified by\n bgp4PathAttrIpAddrPrefixLen are zeroed.", "format": "inet:ipv4-address" }, "bgp4PathAttrOrigin": { "type": "string", "description": "The ultimate origin of the path\n information." }, "bgp4PathAttrASPathSegment": { "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\n route in the UPDATE\n message has traversed\n 2 AS_SEQUENCE: ordered set of ASs\n a route in the UPDATE\n 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" }, "bgp4PathAttrNextHop": { "type": "string", "description": "The address of the border router that\n should be used for the destination\n network.", "format": "inet:ipv4-address" }, "bgp4PathAttrMultiExitDisc": { "type": "integer", "description": "This metric is used to discriminate\n between multiple exit points to an\n adjacent autonomous system. A value of -1\n indicates the absence of this attribute.", "minimum": -2147483648, "maximum": 2147483647 }, "bgp4PathAttrLocalPref": { "type": "integer", "description": "The originating BGP4 speaker's degree of\n preference for an advertised route. A\n value of -1 indicates the absence of this\n attribute.", "minimum": -2147483648, "maximum": 2147483647 }, "bgp4PathAttrAtomicAggregate": { "type": "string", "description": "Whether or not the local system has\n selected a less specific route without\n selecting a more specific route." }, "bgp4PathAttrAggregatorAS": { "type": "integer", "description": "The AS number of the last BGP4 speaker that\n performed route aggregation. A value of\n zero (0) indicates the absence of this\n attribute.", "minimum": -2147483648, "maximum": 2147483647 }, "bgp4PathAttrAggregatorAddr": { "type": "string", "description": "The IP address of the last BGP4 speaker\n that performed route aggregation. A value\n of 0.0.0.0 indicates the absence of this\n attribute.", "format": "inet:ipv4-address" }, "bgp4PathAttrCalcLocalPref": { "type": "integer", "description": "The degree of preference calculated by the\n receiving BGP4 speaker for an advertised\n route. A value of -1 indicates the\n absence of this attribute.", "minimum": -2147483648, "maximum": 2147483647 }, "bgp4PathAttrBest": { "type": "string", "description": "An indication of whether or not this route\n was chosen as the best BGP4 route." }, "bgp4PathAttrUnknown": { "type": "string", "description": "One or more path attributes not understood\n by this BGP4 speaker. Size zero (0)\n indicates the absence of such\n attribute(s). Octets beyond the maximum\n size, if any, are not recorded by this\n object.", "format": "binary" } } }, "example": { "BGP4-MIB:bgp4PathAttrEntry": { "bgp4PathAttrPeer": "example-string", "bgp4PathAttrIpAddrPrefixLen": -2147483648, "bgp4PathAttrIpAddrPrefix": "192.168.1.1", "bgp4PathAttrOrigin": "example-string", "bgp4PathAttrASPathSegment": "example-string", "bgp4PathAttrNextHop": "example-string", "bgp4PathAttrMultiExitDisc": -2147483648, "bgp4PathAttrLocalPref": -2147483648, "bgp4PathAttrAtomicAggregate": "example-string", "bgp4PathAttrAggregatorAS": -2147483648, "bgp4PathAttrAggregatorAddr": "192.168.1.1", "bgp4PathAttrCalcLocalPref": -2147483648, "bgp4PathAttrBest": "example-string", "bgp4PathAttrUnknown": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-bgp4PathAttrEntry-2" }, "x-yang-path": "/bgp4PathAttrTable/bgp4PathAttrEntry={bgp4PathAttrIpAddrPrefix bgp4PathAttrIpAddrPrefixLen bgp4PathAttrPeer}", "x-restconf-kind": "list-instance", "x-list-keys": [ "bgp4PathAttrIpAddrPrefix bgp4PathAttrIpAddrPrefixLen bgp4PathAttrPeer" ] }, "/data/BGP4-MIB:bgpPathAttrEntry={bgpPathAttrDestNetwork},{bgpPathAttrPeer}": { "get": { "summary": "Get bgpPathAttrEntry entry", "description": "Retrieve specific bgpPathAttrEntry entry by key from MIB", "tags": [ "BGP4-MIB" ], "parameters": [ { "name": "bgpPathAttrDestNetwork", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "bgpPathAttrPeer", "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": { "bgpPathAttrPeer": { "type": "string", "description": "The IP address of the peer where the path\n information was learned.", "format": "inet:ipv4-address" }, "bgpPathAttrDestNetwork": { "type": "string", "description": "The address of the destination network.", "format": "inet:ipv4-address" }, "bgpPathAttrOrigin": { "type": "string", "description": "The ultimate origin of the path information." }, "bgpPathAttrASPath": { "type": "string", "description": "The set of ASs that must be traversed to\n reach the network. This object is\n probably best represented as SEQUENCE OF\n INTEGER. For SMI compatibility, though,\n it is represented as OCTET STRING. Each\n AS is represented as a pair of octets\n according to the following algorithm:\n \n first-byte-of-pair = ASNumber / 256;\n second-byte-of-pair = ASNumber & 255;", "format": "binary" }, "bgpPathAttrNextHop": { "type": "string", "description": "The address of the border router that\n should be used for the destination\n network.", "format": "inet:ipv4-address" }, "bgpPathAttrInterASMetric": { "type": "integer", "description": "The optional inter-AS metric. If this\n attribute has not been provided for this\n route, the value for this object is 0.", "minimum": -2147483648, "maximum": 2147483647 } } }, "example": { "BGP4-MIB:bgpPathAttrEntry": { "bgpPathAttrPeer": "example-string", "bgpPathAttrDestNetwork": "example-string", "bgpPathAttrOrigin": "example-string", "bgpPathAttrASPath": "example-string", "bgpPathAttrNextHop": "example-string", "bgpPathAttrInterASMetric": -2147483648 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-bgpPathAttrEntry-4" }, "x-yang-path": "/bgpPathAttrEntry={bgpPathAttrDestNetwork bgpPathAttrPeer}", "x-restconf-kind": "list-instance", "x-list-keys": [ "bgpPathAttrDestNetwork bgpPathAttrPeer" ] }, "/data/BGP4-MIB:bgp4PathAttrEntry={bgp4PathAttrIpAddrPrefix},{bgp4PathAttrIpAddrPrefixLen},{bgp4PathAttrPeer}": { "get": { "summary": "Get bgp4PathAttrEntry entry", "description": "Retrieve specific bgp4PathAttrEntry entry by key from MIB", "tags": [ "BGP4-MIB" ], "parameters": [ { "name": "bgp4PathAttrIpAddrPrefix", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "bgp4PathAttrIpAddrPrefixLen", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "bgp4PathAttrPeer", "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": { "bgp4PathAttrPeer": { "type": "string", "description": "The IP address of the peer where the path\n information was learned.", "format": "inet:ipv4-address" }, "bgp4PathAttrIpAddrPrefixLen": { "type": "integer", "description": "Length in bits of the IP address prefix\n in the Network Layer Reachability\n Information field.", "minimum": -2147483648, "maximum": 2147483647 }, "bgp4PathAttrIpAddrPrefix": { "type": "string", "description": "An IP address prefix in the Network Layer\n Reachability Information field. This object\n is an IP address containing the prefix with\n length specified by\n bgp4PathAttrIpAddrPrefixLen.\n Any bits beyond the length specified by\n bgp4PathAttrIpAddrPrefixLen are zeroed.", "format": "inet:ipv4-address" }, "bgp4PathAttrOrigin": { "type": "string", "description": "The ultimate origin of the path\n information." }, "bgp4PathAttrASPathSegment": { "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\n route in the UPDATE\n message has traversed\n 2 AS_SEQUENCE: ordered set of ASs\n a route in the UPDATE\n 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" }, "bgp4PathAttrNextHop": { "type": "string", "description": "The address of the border router that\n should be used for the destination\n network.", "format": "inet:ipv4-address" }, "bgp4PathAttrMultiExitDisc": { "type": "integer", "description": "This metric is used to discriminate\n between multiple exit points to an\n adjacent autonomous system. A value of -1\n indicates the absence of this attribute.", "minimum": -2147483648, "maximum": 2147483647 }, "bgp4PathAttrLocalPref": { "type": "integer", "description": "The originating BGP4 speaker's degree of\n preference for an advertised route. A\n value of -1 indicates the absence of this\n attribute.", "minimum": -2147483648, "maximum": 2147483647 }, "bgp4PathAttrAtomicAggregate": { "type": "string", "description": "Whether or not the local system has\n selected a less specific route without\n selecting a more specific route." }, "bgp4PathAttrAggregatorAS": { "type": "integer", "description": "The AS number of the last BGP4 speaker that\n performed route aggregation. A value of\n zero (0) indicates the absence of this\n attribute.", "minimum": -2147483648, "maximum": 2147483647 }, "bgp4PathAttrAggregatorAddr": { "type": "string", "description": "The IP address of the last BGP4 speaker\n that performed route aggregation. A value\n of 0.0.0.0 indicates the absence of this\n attribute.", "format": "inet:ipv4-address" }, "bgp4PathAttrCalcLocalPref": { "type": "integer", "description": "The degree of preference calculated by the\n receiving BGP4 speaker for an advertised\n route. A value of -1 indicates the\n absence of this attribute.", "minimum": -2147483648, "maximum": 2147483647 }, "bgp4PathAttrBest": { "type": "string", "description": "An indication of whether or not this route\n was chosen as the best BGP4 route." }, "bgp4PathAttrUnknown": { "type": "string", "description": "One or more path attributes not understood\n by this BGP4 speaker. Size zero (0)\n indicates the absence of such\n attribute(s). Octets beyond the maximum\n size, if any, are not recorded by this\n object.", "format": "binary" } } }, "example": { "BGP4-MIB:bgp4PathAttrEntry": { "bgp4PathAttrPeer": "example-string", "bgp4PathAttrIpAddrPrefixLen": -2147483648, "bgp4PathAttrIpAddrPrefix": "192.168.1.1", "bgp4PathAttrOrigin": "example-string", "bgp4PathAttrASPathSegment": "example-string", "bgp4PathAttrNextHop": "example-string", "bgp4PathAttrMultiExitDisc": -2147483648, "bgp4PathAttrLocalPref": -2147483648, "bgp4PathAttrAtomicAggregate": "example-string", "bgp4PathAttrAggregatorAS": -2147483648, "bgp4PathAttrAggregatorAddr": "192.168.1.1", "bgp4PathAttrCalcLocalPref": -2147483648, "bgp4PathAttrBest": "example-string", "bgp4PathAttrUnknown": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-bgp4PathAttrEntry-4" }, "x-yang-path": "/bgp4PathAttrEntry={bgp4PathAttrIpAddrPrefix bgp4PathAttrIpAddrPrefixLen bgp4PathAttrPeer}", "x-restconf-kind": "list-instance", "x-list-keys": [ "bgp4PathAttrIpAddrPrefix bgp4PathAttrIpAddrPrefixLen bgp4PathAttrPeer" ] } }, "components": { "schemas": { "BGP4-MIB_BGP4-MIB": { "type": "object", "description": "BGP4-MIB", "properties": { "bgpPeerEntry": { "type": "array", "description": "Entry containing information about the\n connection with a BGP peer.", "items": { "type": "object", "properties": { "bgpPeerIdentifier": { "type": "string", "description": "The BGP Identifier of this entry's BGP\n peer.", "format": "inet:ipv4-address", "readOnly": true }, "bgpPeerState": { "type": "string", "description": "The BGP peer connection state.", "readOnly": true }, "bgpPeerAdminStatus": { "type": "string", "description": "The desired state of the BGP connection.\n A transition from 'stop' to 'start' will\n cause the BGP Start Event to be generated.\n A transition from 'start' to 'stop' will\n cause the BGP Stop Event to be generated.\n This parameter can be used to restart BGP\n peer connections. Care should be used in\n providing write access to this object\n without adequate authentication.", "readOnly": true }, "bgpPeerNegotiatedVersion": { "type": "integer", "description": "The negotiated version of BGP running\n between the two peers.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgpPeerLocalAddr": { "type": "string", "description": "The local IP address of this entry's BGP\n connection.", "format": "inet:ipv4-address", "readOnly": true }, "bgpPeerLocalPort": { "type": "integer", "description": "The local port for the TCP connection\n between the BGP peers.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgpPeerRemoteAddr": { "type": "string", "description": "The remote IP address of this entry's BGP\n peer.", "format": "inet:ipv4-address", "readOnly": true }, "bgpPeerRemotePort": { "type": "integer", "description": "The remote port for the TCP connection\n between the BGP peers. Note that the\n objects bgpPeerLocalAddr,\n bgpPeerLocalPort, bgpPeerRemoteAddr and\n bgpPeerRemotePort provide the appropriate\n reference to the standard MIB TCP\n connection table.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgpPeerRemoteAs": { "type": "integer", "description": "The remote autonomous system number.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgpPeerInUpdates": { "type": "integer", "description": "The number of BGP UPDATE messages\n received on this connection. This object\n should be initialized to zero (0) when the\n connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "bgpPeerOutUpdates": { "type": "integer", "description": "The number of BGP UPDATE messages\n transmitted on this connection. This\n object should be initialized to zero (0)\n when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "bgpPeerInTotalMessages": { "type": "integer", "description": "The total number of messages received\n from the remote peer on this connection.\n This object should be initialized to zero\n when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "bgpPeerOutTotalMessages": { "type": "integer", "description": "The total number of messages transmitted to\n the remote peer on this connection. This\n object should be initialized to zero when\n the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "bgpPeerLastError": { "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 }, "bgpPeerFsmEstablishedTransitions": { "type": "integer", "description": "The total number of times the BGP FSM\n transitioned into the established state.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "bgpPeerFsmEstablishedTime": { "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 the router is\n booted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "bgpPeerConnectRetryInterval": { "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 }, "bgpPeerHoldTime": { "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 by using the smaller of the\n value in bgpPeerHoldTimeConfigured and the\n Hold Time received in the OPEN message.\n This value must be at lease three seconds\n if it is not zero (0) in which case the\n Hold Timer has not been established with\n the peer, or, the value of\n bgpPeerHoldTimeConfigured is zero (0).", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgpPeerKeepAlive": { "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 bgpPeerHoldTime, it has the same\n proportion as what\n bgpPeerKeepAliveConfigured has when\n compared with bgpPeerHoldTimeConfigured.\n If the value of this object is zero (0),\n it indicates that the KeepAlive timer has\n not been established with the peer, or,\n the value of bgpPeerKeepAliveConfigured is\n zero (0).", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgpPeerHoldTimeConfigured": { "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 (bgpPeerHoldTime) with the peer.\n This value must not be less than three\n seconds if it is not zero (0) in which\n case 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 }, "bgpPeerKeepAliveConfigured": { "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 bgpPeerHoldTimeConfigured; the actual\n time interval for the KEEPALIVE messages\n is indicated by bgpPeerKeepAlive. A\n reasonable maximum value for this timer\n would be configured to be one\n third of that of\n bgpPeerHoldTimeConfigured.\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 }, "bgpPeerMinASOriginationInterval": { "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 }, "bgpPeerMinRouteAdvertisementInterval": { "type": "integer", "description": "Time interval in seconds for the\n MinRouteAdvertisementInterval timer.\n The suggested value for this timer is 30\n seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgpPeerInUpdateElapsedTime": { "type": "integer", "description": "Elapsed time in seconds since the last BGP\n UPDATE message was received from the peer.\n Each time bgpPeerInUpdates is incremented,\n the value of this object is set to zero\n (0).", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "bgpPathAttrEntry": { "type": "array", "description": "Information about a path to a network.", "items": { "type": "object", "properties": { "bgpPathAttrPeer": { "type": "string", "description": "The IP address of the peer where the path\n information was learned.", "format": "inet:ipv4-address", "readOnly": true }, "bgpPathAttrDestNetwork": { "type": "string", "description": "The address of the destination network.", "format": "inet:ipv4-address", "readOnly": true }, "bgpPathAttrOrigin": { "type": "string", "description": "The ultimate origin of the path information.", "readOnly": true }, "bgpPathAttrASPath": { "type": "string", "description": "The set of ASs that must be traversed to\n reach the network. This object is\n probably best represented as SEQUENCE OF\n INTEGER. For SMI compatibility, though,\n it is represented as OCTET STRING. Each\n AS is represented as a pair of octets\n according to the following algorithm:\n \n first-byte-of-pair = ASNumber / 256;\n second-byte-of-pair = ASNumber & 255;", "format": "binary", "readOnly": true }, "bgpPathAttrNextHop": { "type": "string", "description": "The address of the border router that\n should be used for the destination\n network.", "format": "inet:ipv4-address", "readOnly": true }, "bgpPathAttrInterASMetric": { "type": "integer", "description": "The optional inter-AS metric. If this\n attribute has not been provided for this\n route, the value for this object is 0.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true } } }, "readOnly": true }, "bgp4PathAttrEntry": { "type": "array", "description": "Information about a path to a network.", "items": { "type": "object", "properties": { "bgp4PathAttrPeer": { "type": "string", "description": "The IP address of the peer where the path\n information was learned.", "format": "inet:ipv4-address", "readOnly": true }, "bgp4PathAttrIpAddrPrefixLen": { "type": "integer", "description": "Length in bits of the IP address prefix\n in the Network Layer Reachability\n Information field.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgp4PathAttrIpAddrPrefix": { "type": "string", "description": "An IP address prefix in the Network Layer\n Reachability Information field. This object\n is an IP address containing the prefix with\n length specified by\n bgp4PathAttrIpAddrPrefixLen.\n Any bits beyond the length specified by\n bgp4PathAttrIpAddrPrefixLen are zeroed.", "format": "inet:ipv4-address", "readOnly": true }, "bgp4PathAttrOrigin": { "type": "string", "description": "The ultimate origin of the path\n information.", "readOnly": true }, "bgp4PathAttrASPathSegment": { "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\n route in the UPDATE\n message has traversed\n 2 AS_SEQUENCE: ordered set of ASs\n a route in the UPDATE\n 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 }, "bgp4PathAttrNextHop": { "type": "string", "description": "The address of the border router that\n should be used for the destination\n network.", "format": "inet:ipv4-address", "readOnly": true }, "bgp4PathAttrMultiExitDisc": { "type": "integer", "description": "This metric is used to discriminate\n between multiple exit points to an\n adjacent autonomous system. A value of -1\n indicates the absence of this attribute.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgp4PathAttrLocalPref": { "type": "integer", "description": "The originating BGP4 speaker's degree of\n preference for an advertised route. A\n value of -1 indicates the absence of this\n attribute.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgp4PathAttrAtomicAggregate": { "type": "string", "description": "Whether or not the local system has\n selected a less specific route without\n selecting a more specific route.", "readOnly": true }, "bgp4PathAttrAggregatorAS": { "type": "integer", "description": "The AS number of the last BGP4 speaker that\n performed route aggregation. A value of\n zero (0) indicates the absence of this\n attribute.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgp4PathAttrAggregatorAddr": { "type": "string", "description": "The IP address of the last BGP4 speaker\n that performed route aggregation. A value\n of 0.0.0.0 indicates the absence of this\n attribute.", "format": "inet:ipv4-address", "readOnly": true }, "bgp4PathAttrCalcLocalPref": { "type": "integer", "description": "The degree of preference calculated by the\n receiving BGP4 speaker for an advertised\n route. A value of -1 indicates the\n absence of this attribute.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgp4PathAttrBest": { "type": "string", "description": "An indication of whether or not this route\n was chosen as the best BGP4 route.", "readOnly": true }, "bgp4PathAttrUnknown": { "type": "string", "description": "One or more path attributes not understood\n by this BGP4 speaker. Size zero (0)\n indicates the absence of such\n attribute(s). Octets beyond the maximum\n size, if any, are not recorded by this\n object.", "format": "binary", "readOnly": true } } }, "readOnly": true }, "bgp": { "type": "object", "description": "bgp", "properties": { "bgpVersion": { "type": "string", "description": "Vector of supported BGP protocol version\n numbers. Each peer negotiates the version\n from this vector. Versions are identified\n via the string of bits contained within this\n object. The first octet contains bits 0 to\n 7, the second octet contains bits 8 to 15,\n and so on, with the most significant bit\n referring to the lowest bit number in the\n octet (e.g., the MSB of the first octet\n refers to bit 0). If a bit, i, is present\n and set, then the version (i+1) of the BGP\n is supported.", "format": "binary", "readOnly": true }, "bgpLocalAs": { "type": "integer", "description": "The local autonomous system number.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgpIdentifier": { "type": "string", "description": "The BGP Identifier of local system.", "format": "inet:ipv4-address", "readOnly": true } }, "readOnly": true }, "bgpPeerTable": { "type": "object", "description": "BGP peer table. This table contains,\n one entry per BGP peer, information about\n the connections with BGP peers.", "properties": { "bgpPeerEntry": { "type": "array", "description": "Entry containing information about the\n connection with a BGP peer.", "items": { "type": "object", "properties": { "bgpPeerIdentifier": { "type": "string", "description": "The BGP Identifier of this entry's BGP\n peer.", "format": "inet:ipv4-address", "readOnly": true }, "bgpPeerState": { "type": "string", "description": "The BGP peer connection state.", "readOnly": true }, "bgpPeerAdminStatus": { "type": "string", "description": "The desired state of the BGP connection.\n A transition from 'stop' to 'start' will\n cause the BGP Start Event to be generated.\n A transition from 'start' to 'stop' will\n cause the BGP Stop Event to be generated.\n This parameter can be used to restart BGP\n peer connections. Care should be used in\n providing write access to this object\n without adequate authentication.", "readOnly": true }, "bgpPeerNegotiatedVersion": { "type": "integer", "description": "The negotiated version of BGP running\n between the two peers.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgpPeerLocalAddr": { "type": "string", "description": "The local IP address of this entry's BGP\n connection.", "format": "inet:ipv4-address", "readOnly": true }, "bgpPeerLocalPort": { "type": "integer", "description": "The local port for the TCP connection\n between the BGP peers.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgpPeerRemoteAddr": { "type": "string", "description": "The remote IP address of this entry's BGP\n peer.", "format": "inet:ipv4-address", "readOnly": true }, "bgpPeerRemotePort": { "type": "integer", "description": "The remote port for the TCP connection\n between the BGP peers. Note that the\n objects bgpPeerLocalAddr,\n bgpPeerLocalPort, bgpPeerRemoteAddr and\n bgpPeerRemotePort provide the appropriate\n reference to the standard MIB TCP\n connection table.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgpPeerRemoteAs": { "type": "integer", "description": "The remote autonomous system number.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgpPeerInUpdates": { "type": "integer", "description": "The number of BGP UPDATE messages\n received on this connection. This object\n should be initialized to zero (0) when the\n connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "bgpPeerOutUpdates": { "type": "integer", "description": "The number of BGP UPDATE messages\n transmitted on this connection. This\n object should be initialized to zero (0)\n when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "bgpPeerInTotalMessages": { "type": "integer", "description": "The total number of messages received\n from the remote peer on this connection.\n This object should be initialized to zero\n when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "bgpPeerOutTotalMessages": { "type": "integer", "description": "The total number of messages transmitted to\n the remote peer on this connection. This\n object should be initialized to zero when\n the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "bgpPeerLastError": { "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 }, "bgpPeerFsmEstablishedTransitions": { "type": "integer", "description": "The total number of times the BGP FSM\n transitioned into the established state.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "bgpPeerFsmEstablishedTime": { "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 the router is\n booted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "bgpPeerConnectRetryInterval": { "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 }, "bgpPeerHoldTime": { "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 by using the smaller of the\n value in bgpPeerHoldTimeConfigured and the\n Hold Time received in the OPEN message.\n This value must be at lease three seconds\n if it is not zero (0) in which case the\n Hold Timer has not been established with\n the peer, or, the value of\n bgpPeerHoldTimeConfigured is zero (0).", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgpPeerKeepAlive": { "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 bgpPeerHoldTime, it has the same\n proportion as what\n bgpPeerKeepAliveConfigured has when\n compared with bgpPeerHoldTimeConfigured.\n If the value of this object is zero (0),\n it indicates that the KeepAlive timer has\n not been established with the peer, or,\n the value of bgpPeerKeepAliveConfigured is\n zero (0).", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgpPeerHoldTimeConfigured": { "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 (bgpPeerHoldTime) with the peer.\n This value must not be less than three\n seconds if it is not zero (0) in which\n case 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 }, "bgpPeerKeepAliveConfigured": { "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 bgpPeerHoldTimeConfigured; the actual\n time interval for the KEEPALIVE messages\n is indicated by bgpPeerKeepAlive. A\n reasonable maximum value for this timer\n would be configured to be one\n third of that of\n bgpPeerHoldTimeConfigured.\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 }, "bgpPeerMinASOriginationInterval": { "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 }, "bgpPeerMinRouteAdvertisementInterval": { "type": "integer", "description": "Time interval in seconds for the\n MinRouteAdvertisementInterval timer.\n The suggested value for this timer is 30\n seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgpPeerInUpdateElapsedTime": { "type": "integer", "description": "Elapsed time in seconds since the last BGP\n UPDATE message was received from the peer.\n Each time bgpPeerInUpdates is incremented,\n the value of this object is set to zero\n (0).", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "bgpRcvdPathAttrTable": { "type": "object", "description": "The BGP Received Path Attribute Table\n contains information about paths to\n destination networks received from all\n peers running BGP version 3 or less.", "properties": { "bgpPathAttrEntry": { "type": "array", "description": "Information about a path to a network.", "items": { "type": "object", "properties": { "bgpPathAttrPeer": { "type": "string", "description": "The IP address of the peer where the path\n information was learned.", "format": "inet:ipv4-address", "readOnly": true }, "bgpPathAttrDestNetwork": { "type": "string", "description": "The address of the destination network.", "format": "inet:ipv4-address", "readOnly": true }, "bgpPathAttrOrigin": { "type": "string", "description": "The ultimate origin of the path information.", "readOnly": true }, "bgpPathAttrASPath": { "type": "string", "description": "The set of ASs that must be traversed to\n reach the network. This object is\n probably best represented as SEQUENCE OF\n INTEGER. For SMI compatibility, though,\n it is represented as OCTET STRING. Each\n AS is represented as a pair of octets\n according to the following algorithm:\n \n first-byte-of-pair = ASNumber / 256;\n second-byte-of-pair = ASNumber & 255;", "format": "binary", "readOnly": true }, "bgpPathAttrNextHop": { "type": "string", "description": "The address of the border router that\n should be used for the destination\n network.", "format": "inet:ipv4-address", "readOnly": true }, "bgpPathAttrInterASMetric": { "type": "integer", "description": "The optional inter-AS metric. If this\n attribute has not been provided for this\n route, the value for this object is 0.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "bgp4PathAttrTable": { "type": "object", "description": "The BGP-4 Received Path Attribute Table\n contains information about paths to\n destination networks received from all\n BGP4 peers.", "properties": { "bgp4PathAttrEntry": { "type": "array", "description": "Information about a path to a network.", "items": { "type": "object", "properties": { "bgp4PathAttrPeer": { "type": "string", "description": "The IP address of the peer where the path\n information was learned.", "format": "inet:ipv4-address", "readOnly": true }, "bgp4PathAttrIpAddrPrefixLen": { "type": "integer", "description": "Length in bits of the IP address prefix\n in the Network Layer Reachability\n Information field.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgp4PathAttrIpAddrPrefix": { "type": "string", "description": "An IP address prefix in the Network Layer\n Reachability Information field. This object\n is an IP address containing the prefix with\n length specified by\n bgp4PathAttrIpAddrPrefixLen.\n Any bits beyond the length specified by\n bgp4PathAttrIpAddrPrefixLen are zeroed.", "format": "inet:ipv4-address", "readOnly": true }, "bgp4PathAttrOrigin": { "type": "string", "description": "The ultimate origin of the path\n information.", "readOnly": true }, "bgp4PathAttrASPathSegment": { "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\n route in the UPDATE\n message has traversed\n 2 AS_SEQUENCE: ordered set of ASs\n a route in the UPDATE\n 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 }, "bgp4PathAttrNextHop": { "type": "string", "description": "The address of the border router that\n should be used for the destination\n network.", "format": "inet:ipv4-address", "readOnly": true }, "bgp4PathAttrMultiExitDisc": { "type": "integer", "description": "This metric is used to discriminate\n between multiple exit points to an\n adjacent autonomous system. A value of -1\n indicates the absence of this attribute.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgp4PathAttrLocalPref": { "type": "integer", "description": "The originating BGP4 speaker's degree of\n preference for an advertised route. A\n value of -1 indicates the absence of this\n attribute.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgp4PathAttrAtomicAggregate": { "type": "string", "description": "Whether or not the local system has\n selected a less specific route without\n selecting a more specific route.", "readOnly": true }, "bgp4PathAttrAggregatorAS": { "type": "integer", "description": "The AS number of the last BGP4 speaker that\n performed route aggregation. A value of\n zero (0) indicates the absence of this\n attribute.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgp4PathAttrAggregatorAddr": { "type": "string", "description": "The IP address of the last BGP4 speaker\n that performed route aggregation. A value\n of 0.0.0.0 indicates the absence of this\n attribute.", "format": "inet:ipv4-address", "readOnly": true }, "bgp4PathAttrCalcLocalPref": { "type": "integer", "description": "The degree of preference calculated by the\n receiving BGP4 speaker for an advertised\n route. A value of -1 indicates the\n absence of this attribute.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgp4PathAttrBest": { "type": "string", "description": "An indication of whether or not this route\n was chosen as the best BGP4 route.", "readOnly": true }, "bgp4PathAttrUnknown": { "type": "string", "description": "One or more path attributes not understood\n by this BGP4 speaker. Size zero (0)\n indicates the absence of such\n attribute(s). Octets beyond the maximum\n size, if any, are not recorded by this\n object.", "format": "binary", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "BGP4-MIB_object-1": { "type": "object", "description": "object-1", "properties": { "bgpPeerRemoteAddr": { "type": "string", "description": "bgpPeerRemoteAddr", "x-yang-type": "leafref", "readOnly": true }, "bgpPeerLastError": { "type": "string", "description": "bgpPeerLastError", "x-yang-type": "leafref", "readOnly": true } } }, "BGP4-MIB_object-2": { "type": "object", "description": "object-2", "properties": { "bgpPeerRemoteAddr": { "type": "string", "description": "bgpPeerRemoteAddr", "x-yang-type": "leafref", "readOnly": true }, "bgpPeerState": { "type": "string", "description": "bgpPeerState", "x-yang-type": "leafref", "readOnly": true } } }, "BGP4-MIB_bgpPeerEntry": { "type": "array", "description": "Entry containing information about the\n connection with a BGP peer.", "items": { "type": "object", "properties": { "bgpPeerIdentifier": { "type": "string", "description": "The BGP Identifier of this entry's BGP\n peer.", "format": "inet:ipv4-address", "readOnly": true }, "bgpPeerState": { "type": "string", "description": "The BGP peer connection state.", "readOnly": true }, "bgpPeerAdminStatus": { "type": "string", "description": "The desired state of the BGP connection.\n A transition from 'stop' to 'start' will\n cause the BGP Start Event to be generated.\n A transition from 'start' to 'stop' will\n cause the BGP Stop Event to be generated.\n This parameter can be used to restart BGP\n peer connections. Care should be used in\n providing write access to this object\n without adequate authentication.", "readOnly": true }, "bgpPeerNegotiatedVersion": { "type": "integer", "description": "The negotiated version of BGP running\n between the two peers.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgpPeerLocalAddr": { "type": "string", "description": "The local IP address of this entry's BGP\n connection.", "format": "inet:ipv4-address", "readOnly": true }, "bgpPeerLocalPort": { "type": "integer", "description": "The local port for the TCP connection\n between the BGP peers.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgpPeerRemoteAddr": { "type": "string", "description": "The remote IP address of this entry's BGP\n peer.", "format": "inet:ipv4-address", "readOnly": true }, "bgpPeerRemotePort": { "type": "integer", "description": "The remote port for the TCP connection\n between the BGP peers. Note that the\n objects bgpPeerLocalAddr,\n bgpPeerLocalPort, bgpPeerRemoteAddr and\n bgpPeerRemotePort provide the appropriate\n reference to the standard MIB TCP\n connection table.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgpPeerRemoteAs": { "type": "integer", "description": "The remote autonomous system number.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgpPeerInUpdates": { "type": "integer", "description": "The number of BGP UPDATE messages\n received on this connection. This object\n should be initialized to zero (0) when the\n connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "bgpPeerOutUpdates": { "type": "integer", "description": "The number of BGP UPDATE messages\n transmitted on this connection. This\n object should be initialized to zero (0)\n when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "bgpPeerInTotalMessages": { "type": "integer", "description": "The total number of messages received\n from the remote peer on this connection.\n This object should be initialized to zero\n when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "bgpPeerOutTotalMessages": { "type": "integer", "description": "The total number of messages transmitted to\n the remote peer on this connection. This\n object should be initialized to zero when\n the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "bgpPeerLastError": { "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 }, "bgpPeerFsmEstablishedTransitions": { "type": "integer", "description": "The total number of times the BGP FSM\n transitioned into the established state.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "bgpPeerFsmEstablishedTime": { "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 the router is\n booted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "bgpPeerConnectRetryInterval": { "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 }, "bgpPeerHoldTime": { "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 by using the smaller of the\n value in bgpPeerHoldTimeConfigured and the\n Hold Time received in the OPEN message.\n This value must be at lease three seconds\n if it is not zero (0) in which case the\n Hold Timer has not been established with\n the peer, or, the value of\n bgpPeerHoldTimeConfigured is zero (0).", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgpPeerKeepAlive": { "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 bgpPeerHoldTime, it has the same\n proportion as what\n bgpPeerKeepAliveConfigured has when\n compared with bgpPeerHoldTimeConfigured.\n If the value of this object is zero (0),\n it indicates that the KeepAlive timer has\n not been established with the peer, or,\n the value of bgpPeerKeepAliveConfigured is\n zero (0).", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgpPeerHoldTimeConfigured": { "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 (bgpPeerHoldTime) with the peer.\n This value must not be less than three\n seconds if it is not zero (0) in which\n case 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 }, "bgpPeerKeepAliveConfigured": { "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 bgpPeerHoldTimeConfigured; the actual\n time interval for the KEEPALIVE messages\n is indicated by bgpPeerKeepAlive. A\n reasonable maximum value for this timer\n would be configured to be one\n third of that of\n bgpPeerHoldTimeConfigured.\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 }, "bgpPeerMinASOriginationInterval": { "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 }, "bgpPeerMinRouteAdvertisementInterval": { "type": "integer", "description": "Time interval in seconds for the\n MinRouteAdvertisementInterval timer.\n The suggested value for this timer is 30\n seconds.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgpPeerInUpdateElapsedTime": { "type": "integer", "description": "Elapsed time in seconds since the last BGP\n UPDATE message was received from the peer.\n Each time bgpPeerInUpdates is incremented,\n the value of this object is set to zero\n (0).", "minimum": 0, "maximum": 4294967295, "readOnly": true } } } }, "BGP4-MIB_bgpPathAttrEntry": { "type": "array", "description": "Information about a path to a network.", "items": { "type": "object", "properties": { "bgpPathAttrPeer": { "type": "string", "description": "The IP address of the peer where the path\n information was learned.", "format": "inet:ipv4-address", "readOnly": true }, "bgpPathAttrDestNetwork": { "type": "string", "description": "The address of the destination network.", "format": "inet:ipv4-address", "readOnly": true }, "bgpPathAttrOrigin": { "type": "string", "description": "The ultimate origin of the path information.", "readOnly": true }, "bgpPathAttrASPath": { "type": "string", "description": "The set of ASs that must be traversed to\n reach the network. This object is\n probably best represented as SEQUENCE OF\n INTEGER. For SMI compatibility, though,\n it is represented as OCTET STRING. Each\n AS is represented as a pair of octets\n according to the following algorithm:\n \n first-byte-of-pair = ASNumber / 256;\n second-byte-of-pair = ASNumber & 255;", "format": "binary", "readOnly": true }, "bgpPathAttrNextHop": { "type": "string", "description": "The address of the border router that\n should be used for the destination\n network.", "format": "inet:ipv4-address", "readOnly": true }, "bgpPathAttrInterASMetric": { "type": "integer", "description": "The optional inter-AS metric. If this\n attribute has not been provided for this\n route, the value for this object is 0.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true } } } }, "BGP4-MIB_bgp4PathAttrEntry": { "type": "array", "description": "Information about a path to a network.", "items": { "type": "object", "properties": { "bgp4PathAttrPeer": { "type": "string", "description": "The IP address of the peer where the path\n information was learned.", "format": "inet:ipv4-address", "readOnly": true }, "bgp4PathAttrIpAddrPrefixLen": { "type": "integer", "description": "Length in bits of the IP address prefix\n in the Network Layer Reachability\n Information field.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgp4PathAttrIpAddrPrefix": { "type": "string", "description": "An IP address prefix in the Network Layer\n Reachability Information field. This object\n is an IP address containing the prefix with\n length specified by\n bgp4PathAttrIpAddrPrefixLen.\n Any bits beyond the length specified by\n bgp4PathAttrIpAddrPrefixLen are zeroed.", "format": "inet:ipv4-address", "readOnly": true }, "bgp4PathAttrOrigin": { "type": "string", "description": "The ultimate origin of the path\n information.", "readOnly": true }, "bgp4PathAttrASPathSegment": { "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\n route in the UPDATE\n message has traversed\n 2 AS_SEQUENCE: ordered set of ASs\n a route in the UPDATE\n 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 }, "bgp4PathAttrNextHop": { "type": "string", "description": "The address of the border router that\n should be used for the destination\n network.", "format": "inet:ipv4-address", "readOnly": true }, "bgp4PathAttrMultiExitDisc": { "type": "integer", "description": "This metric is used to discriminate\n between multiple exit points to an\n adjacent autonomous system. A value of -1\n indicates the absence of this attribute.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgp4PathAttrLocalPref": { "type": "integer", "description": "The originating BGP4 speaker's degree of\n preference for an advertised route. A\n value of -1 indicates the absence of this\n attribute.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgp4PathAttrAtomicAggregate": { "type": "string", "description": "Whether or not the local system has\n selected a less specific route without\n selecting a more specific route.", "readOnly": true }, "bgp4PathAttrAggregatorAS": { "type": "integer", "description": "The AS number of the last BGP4 speaker that\n performed route aggregation. A value of\n zero (0) indicates the absence of this\n attribute.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgp4PathAttrAggregatorAddr": { "type": "string", "description": "The IP address of the last BGP4 speaker\n that performed route aggregation. A value\n of 0.0.0.0 indicates the absence of this\n attribute.", "format": "inet:ipv4-address", "readOnly": true }, "bgp4PathAttrCalcLocalPref": { "type": "integer", "description": "The degree of preference calculated by the\n receiving BGP4 speaker for an advertised\n route. A value of -1 indicates the\n absence of this attribute.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "bgp4PathAttrBest": { "type": "string", "description": "An indication of whether or not this route\n was chosen as the best BGP4 route.", "readOnly": true }, "bgp4PathAttrUnknown": { "type": "string", "description": "One or more path attributes not understood\n by this BGP4 speaker. Size zero (0)\n indicates the absence of such\n attribute(s). Octets beyond the maximum\n size, if any, are not recorded by this\n object.", "format": "binary", "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": "BGP4-MIB", "description": "MIB operations for BGP4-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }