{ "openapi": "3.0.0", "info": { "title": "RFC1315-MIB MIB API", "version": "1.0.0", "description": "This variable indicates whether the system\n produces the frDLCIStatusChange trap.\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 RFC1315-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/RFC1315-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "RFC1315-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/RFC1315-MIB:frame-relay-globals": { "get": { "summary": "Get frame-relay-globals data", "description": "Retrieve frame-relay-globals operational data from MIB", "tags": [ "RFC1315-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This variable indicates whether the system\n produces the frDLCIStatusChange trap.", "properties": { "frTrapState": { "type": "string", "description": "This variable indicates whether the system\n produces the frDLCIStatusChange trap." } } }, "example": { "RFC1315-MIB:frame-relay-globals": { "frTrapState": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-frame-relay-globals", "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": "/frame-relay-globals", "x-restconf-kind": "container" }, "/data/RFC1315-MIB:frDlcmiTable": { "get": { "summary": "Get frDlcmiTable data", "description": "Retrieve frDlcmiTable operational data from MIB", "tags": [ "RFC1315-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The Parameters for the Data Link Connection Management\n Interface for the frame relay service on this\n interface.", "properties": { "frDlcmiEntry": { "type": "array", "description": "The Parameters for a particular Data Link Con-\n nection Management Interface.", "items": { "type": "object", "properties": { "frDlcmiIfIndex": { "type": "string", "description": "The ifIndex value of the corresponding ifEn-\n try.", "x-yang-type": "RFC1315-MIB:Index" }, "frDlcmiState": { "type": "string", "description": "This variable states which Data Link Connec-\n tion Management scheme is active (and by impli-\n cation, what DLCI it uses) on the Frame Relay\n interface." }, "frDlcmiAddress": { "type": "string", "description": "This variable states which address format is\n in use on the Frame Relay interface." }, "frDlcmiAddressLen": { "type": "string", "description": "This variable states which address length in\n octets. In the case of Q922 format, the length\n indicates the entire length of the address in-\n cluding the control portion." }, "frDlcmiPollingInterval": { "type": "integer", "description": "This is the number of seconds between succes-\n sive status enquiry messages.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiFullEnquiryInterval": { "type": "integer", "description": "Number of status enquiry intervals that pass\n before issuance of a full status enquiry mes-\n sage.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiErrorThreshold": { "type": "integer", "description": "This is the maximum number of unanswered\n Status Enquiries the equipment shall accept be-\n fore declaring the interface down.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiMonitoredEvents": { "type": "integer", "description": "This is the number of status polling intervals\n over which the error threshold is counted. For\n example, if within 'MonitoredEvents' number of\n events the station receives 'ErrorThreshold'\n number of errors, the interface is marked as\n down.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiMaxSupportedVCs": { "type": "integer", "description": "The maximum number of Virtual Circuits allowed\n for this interface. Usually dictated by the\n Frame Relay network.\n \n In response to a SET, if a value less than zero\n or higher than the agent's maximal capability\n is configured, the agent should respond bad-\n Value", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiMulticast": { "type": "string", "description": "This indicates whether the Frame Relay inter-\n face is using a multicast service." } } } } } }, "example": { "RFC1315-MIB:frDlcmiTable": { "frDlcmiEntry": [ { "frDlcmiIfIndex": "1", "frDlcmiState": "up(1)", "frDlcmiAddress": "192.168.1.1", "frDlcmiAddressLen": "192.168.1.1", "frDlcmiPollingInterval": -2147483648, "frDlcmiFullEnquiryInterval": -2147483648, "frDlcmiErrorThreshold": -2147483648, "frDlcmiMonitoredEvents": -2147483648, "frDlcmiMaxSupportedVCs": -2147483648, "frDlcmiMulticast": "example-string" }, { "frDlcmiIfIndex": "2", "frDlcmiState": "up(1)", "frDlcmiAddress": "192.168.1.1", "frDlcmiAddressLen": "192.168.1.1", "frDlcmiPollingInterval": -2147483648, "frDlcmiFullEnquiryInterval": -2147483648, "frDlcmiErrorThreshold": -2147483648, "frDlcmiMonitoredEvents": -2147483648, "frDlcmiMaxSupportedVCs": -2147483648, "frDlcmiMulticast": "example-string" }, { "frDlcmiIfIndex": "3", "frDlcmiState": "up(1)", "frDlcmiAddress": "192.168.1.1", "frDlcmiAddressLen": "192.168.1.1", "frDlcmiPollingInterval": -2147483648, "frDlcmiFullEnquiryInterval": -2147483648, "frDlcmiErrorThreshold": -2147483648, "frDlcmiMonitoredEvents": -2147483648, "frDlcmiMaxSupportedVCs": -2147483648, "frDlcmiMulticast": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-frDlcmiTable", "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": "/frDlcmiTable", "x-restconf-kind": "container" }, "/data/RFC1315-MIB:frDlcmiTable/frDlcmiEntry": { "get": { "summary": "Get frDlcmiEntry list", "description": "Retrieve list of frDlcmiEntry entries from MIB", "tags": [ "RFC1315-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "The Parameters for a particular Data Link Con-\n nection Management Interface.", "items": { "type": "object", "properties": { "frDlcmiIfIndex": { "type": "string", "description": "The ifIndex value of the corresponding ifEn-\n try.", "x-yang-type": "RFC1315-MIB:Index" }, "frDlcmiState": { "type": "string", "description": "This variable states which Data Link Connec-\n tion Management scheme is active (and by impli-\n cation, what DLCI it uses) on the Frame Relay\n interface." }, "frDlcmiAddress": { "type": "string", "description": "This variable states which address format is\n in use on the Frame Relay interface." }, "frDlcmiAddressLen": { "type": "string", "description": "This variable states which address length in\n octets. In the case of Q922 format, the length\n indicates the entire length of the address in-\n cluding the control portion." }, "frDlcmiPollingInterval": { "type": "integer", "description": "This is the number of seconds between succes-\n sive status enquiry messages.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiFullEnquiryInterval": { "type": "integer", "description": "Number of status enquiry intervals that pass\n before issuance of a full status enquiry mes-\n sage.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiErrorThreshold": { "type": "integer", "description": "This is the maximum number of unanswered\n Status Enquiries the equipment shall accept be-\n fore declaring the interface down.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiMonitoredEvents": { "type": "integer", "description": "This is the number of status polling intervals\n over which the error threshold is counted. For\n example, if within 'MonitoredEvents' number of\n events the station receives 'ErrorThreshold'\n number of errors, the interface is marked as\n down.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiMaxSupportedVCs": { "type": "integer", "description": "The maximum number of Virtual Circuits allowed\n for this interface. Usually dictated by the\n Frame Relay network.\n \n In response to a SET, if a value less than zero\n or higher than the agent's maximal capability\n is configured, the agent should respond bad-\n Value", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiMulticast": { "type": "string", "description": "This indicates whether the Frame Relay inter-\n face is using a multicast service." } } } }, "example": { "RFC1315-MIB:frDlcmiEntry": [ { "frDlcmiIfIndex": "example-string", "frDlcmiState": "up(1)", "frDlcmiAddress": "192.168.1.1", "frDlcmiAddressLen": "192.168.1.1", "frDlcmiPollingInterval": -2147483648, "frDlcmiFullEnquiryInterval": -2147483648, "frDlcmiErrorThreshold": -2147483648, "frDlcmiMonitoredEvents": -2147483648, "frDlcmiMaxSupportedVCs": -2147483648, "frDlcmiMulticast": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-frDlcmiEntry", "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": "/frDlcmiTable/frDlcmiEntry", "x-restconf-kind": "container" }, "/data/RFC1315-MIB:frDlcmiTable/frDlcmiEntry={frDlcmiIfIndex}": { "get": { "summary": "Get frDlcmiEntry entry", "description": "Retrieve specific frDlcmiEntry entry by key from MIB", "tags": [ "RFC1315-MIB" ], "parameters": [ { "name": "frDlcmiIfIndex", "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": { "frDlcmiIfIndex": { "type": "string", "description": "The ifIndex value of the corresponding ifEn-\n try.", "x-yang-type": "RFC1315-MIB:Index" }, "frDlcmiState": { "type": "string", "description": "This variable states which Data Link Connec-\n tion Management scheme is active (and by impli-\n cation, what DLCI it uses) on the Frame Relay\n interface." }, "frDlcmiAddress": { "type": "string", "description": "This variable states which address format is\n in use on the Frame Relay interface." }, "frDlcmiAddressLen": { "type": "string", "description": "This variable states which address length in\n octets. In the case of Q922 format, the length\n indicates the entire length of the address in-\n cluding the control portion." }, "frDlcmiPollingInterval": { "type": "integer", "description": "This is the number of seconds between succes-\n sive status enquiry messages.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiFullEnquiryInterval": { "type": "integer", "description": "Number of status enquiry intervals that pass\n before issuance of a full status enquiry mes-\n sage.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiErrorThreshold": { "type": "integer", "description": "This is the maximum number of unanswered\n Status Enquiries the equipment shall accept be-\n fore declaring the interface down.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiMonitoredEvents": { "type": "integer", "description": "This is the number of status polling intervals\n over which the error threshold is counted. For\n example, if within 'MonitoredEvents' number of\n events the station receives 'ErrorThreshold'\n number of errors, the interface is marked as\n down.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiMaxSupportedVCs": { "type": "integer", "description": "The maximum number of Virtual Circuits allowed\n for this interface. Usually dictated by the\n Frame Relay network.\n \n In response to a SET, if a value less than zero\n or higher than the agent's maximal capability\n is configured, the agent should respond bad-\n Value", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiMulticast": { "type": "string", "description": "This indicates whether the Frame Relay inter-\n face is using a multicast service." } } }, "example": { "RFC1315-MIB:frDlcmiEntry": { "frDlcmiIfIndex": "example-string", "frDlcmiState": "up(1)", "frDlcmiAddress": "192.168.1.1", "frDlcmiAddressLen": "192.168.1.1", "frDlcmiPollingInterval": -2147483648, "frDlcmiFullEnquiryInterval": -2147483648, "frDlcmiErrorThreshold": -2147483648, "frDlcmiMonitoredEvents": -2147483648, "frDlcmiMaxSupportedVCs": -2147483648, "frDlcmiMulticast": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-frDlcmiEntry-2" }, "x-yang-path": "/frDlcmiTable/frDlcmiEntry={frDlcmiIfIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "frDlcmiIfIndex" ] }, "/data/RFC1315-MIB:frCircuitTable": { "get": { "summary": "Get frCircuitTable data", "description": "Retrieve frCircuitTable operational data from MIB", "tags": [ "RFC1315-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table containing information about specific Data\n Link Connection Identifiers and corresponding virtual\n circuits.", "properties": { "frCircuitEntry": { "type": "array", "description": "The information regarding a single Data Link\n Connection Identifier.", "items": { "type": "object", "properties": { "frCircuitIfIndex": { "type": "string", "description": "The ifIndex Value of the ifEntry this virtual\n circuit is layered onto.", "x-yang-type": "RFC1315-MIB:Index" }, "frCircuitDlci": { "type": "string", "description": "The Data Link Connection Identifier for this\n virtual circuit.", "x-yang-type": "RFC1315-MIB:DLCI" }, "frCircuitState": { "type": "string", "description": "Indicates whether the particular virtual cir-\n cuit is operational. In the absence of a Data\n Link Connection Management Interface, virtual\n circuit entries (rows) may be created by set-\n ting virtual circuit state to 'active', or\n deleted by changing Circuit state to 'invalid'.\n Whether or not the row actually disappears is\n left to the implementation, so this object may\n actually read as 'invalid' for some arbitrary\n length of time. It is also legal to set the\n state of a virtual circuit to 'inactive' to\n temporarily disable a given circuit." }, "frCircuitReceivedFECNs": { "type": "integer", "description": "Number of frames received from the network in-\n dicating forward congestion since the virtual\n circuit was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedBECNs": { "type": "integer", "description": "Number of frames received from the network in-\n dicating backward congestion since the virtual\n circuit was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitSentFrames": { "type": "integer", "description": "The number of frames sent from this virtual\n circuit since it was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitSentOctets": { "type": "integer", "description": "The number of octets sent from this virtual\n circuit since it was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedFrames": { "type": "integer", "description": "Number of frames received over this virtual\n circuit since it was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedOctets": { "type": "integer", "description": "Number of octets received over this virtual\n circuit since it was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitCreationTime": { "type": "string", "description": "The value of sysUpTime when the virtual cir-\n cuit was created, whether by the Data Link Con-\n nection Management Interface or by a SetRe-\n quest.", "x-yang-type": "yang:timeticks" }, "frCircuitLastTimeChange": { "type": "string", "description": "The value of sysUpTime when last there was a\n change in the virtual circuit state", "x-yang-type": "yang:timeticks" }, "frCircuitCommittedBurst": { "type": "integer", "description": "This variable indicates the maximum amount of\n data, in bits, that the network agrees to\n transfer under normal conditions, during the\n measurement interval.", "minimum": -2147483648, "maximum": 2147483647 }, "frCircuitExcessBurst": { "type": "integer", "description": "This variable indicates the maximum amount of\n uncommitted data bits that the network will at-\n tempt to deliver over the measurement interval.\n \n By default, if not configured when creating the\n entry, the Excess Information Burst Size is set\n to the value of ifSpeed.", "minimum": -2147483648, "maximum": 2147483647 }, "frCircuitThroughput": { "type": "integer", "description": "Throughput is the average number of 'Frame Re-\n lay Information Field' bits transferred per\n second across a user network interface in one\n direction, measured over the measurement inter-\n val.\n \n If the configured committed burst rate and\n throughput are both non-zero, the measurement\n interval\n T=frCircuitCommittedBurst/frCircuitThroughput.\n \n If the configured committed burst rate and\n throughput are both zero, the measurement in-\n terval\n T=frCircuitExcessBurst/ifSpeed.", "minimum": -2147483648, "maximum": 2147483647 } } } } } }, "example": { "RFC1315-MIB:frCircuitTable": { "frCircuitEntry": [ { "frCircuitIfIndex": "1", "frCircuitDlci": "example-string", "frCircuitState": "up(1)", "frCircuitReceivedFECNs": 0, "frCircuitReceivedBECNs": 0, "frCircuitSentFrames": 0, "frCircuitSentOctets": 1234567890, "frCircuitReceivedFrames": 0, "frCircuitReceivedOctets": 1234567890, "frCircuitCreationTime": "example-string", "frCircuitLastTimeChange": "example-string", "frCircuitCommittedBurst": -2147483648, "frCircuitExcessBurst": -2147483648, "frCircuitThroughput": -2147483648 }, { "frCircuitIfIndex": "2", "frCircuitDlci": "example-string", "frCircuitState": "up(1)", "frCircuitReceivedFECNs": 0, "frCircuitReceivedBECNs": 0, "frCircuitSentFrames": 0, "frCircuitSentOctets": 1234567890, "frCircuitReceivedFrames": 0, "frCircuitReceivedOctets": 1234567890, "frCircuitCreationTime": "example-string", "frCircuitLastTimeChange": "example-string", "frCircuitCommittedBurst": -2147483648, "frCircuitExcessBurst": -2147483648, "frCircuitThroughput": -2147483648 }, { "frCircuitIfIndex": "3", "frCircuitDlci": "example-string", "frCircuitState": "up(1)", "frCircuitReceivedFECNs": 0, "frCircuitReceivedBECNs": 0, "frCircuitSentFrames": 0, "frCircuitSentOctets": 1234567890, "frCircuitReceivedFrames": 0, "frCircuitReceivedOctets": 1234567890, "frCircuitCreationTime": "example-string", "frCircuitLastTimeChange": "example-string", "frCircuitCommittedBurst": -2147483648, "frCircuitExcessBurst": -2147483648, "frCircuitThroughput": -2147483648 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-frCircuitTable", "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": "/frCircuitTable", "x-restconf-kind": "container" }, "/data/RFC1315-MIB:frCircuitTable/frCircuitEntry": { "get": { "summary": "Get frCircuitEntry list", "description": "Retrieve list of frCircuitEntry entries from MIB", "tags": [ "RFC1315-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "The information regarding a single Data Link\n Connection Identifier.", "items": { "type": "object", "properties": { "frCircuitIfIndex": { "type": "string", "description": "The ifIndex Value of the ifEntry this virtual\n circuit is layered onto.", "x-yang-type": "RFC1315-MIB:Index" }, "frCircuitDlci": { "type": "string", "description": "The Data Link Connection Identifier for this\n virtual circuit.", "x-yang-type": "RFC1315-MIB:DLCI" }, "frCircuitState": { "type": "string", "description": "Indicates whether the particular virtual cir-\n cuit is operational. In the absence of a Data\n Link Connection Management Interface, virtual\n circuit entries (rows) may be created by set-\n ting virtual circuit state to 'active', or\n deleted by changing Circuit state to 'invalid'.\n Whether or not the row actually disappears is\n left to the implementation, so this object may\n actually read as 'invalid' for some arbitrary\n length of time. It is also legal to set the\n state of a virtual circuit to 'inactive' to\n temporarily disable a given circuit." }, "frCircuitReceivedFECNs": { "type": "integer", "description": "Number of frames received from the network in-\n dicating forward congestion since the virtual\n circuit was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedBECNs": { "type": "integer", "description": "Number of frames received from the network in-\n dicating backward congestion since the virtual\n circuit was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitSentFrames": { "type": "integer", "description": "The number of frames sent from this virtual\n circuit since it was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitSentOctets": { "type": "integer", "description": "The number of octets sent from this virtual\n circuit since it was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedFrames": { "type": "integer", "description": "Number of frames received over this virtual\n circuit since it was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedOctets": { "type": "integer", "description": "Number of octets received over this virtual\n circuit since it was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitCreationTime": { "type": "string", "description": "The value of sysUpTime when the virtual cir-\n cuit was created, whether by the Data Link Con-\n nection Management Interface or by a SetRe-\n quest.", "x-yang-type": "yang:timeticks" }, "frCircuitLastTimeChange": { "type": "string", "description": "The value of sysUpTime when last there was a\n change in the virtual circuit state", "x-yang-type": "yang:timeticks" }, "frCircuitCommittedBurst": { "type": "integer", "description": "This variable indicates the maximum amount of\n data, in bits, that the network agrees to\n transfer under normal conditions, during the\n measurement interval.", "minimum": -2147483648, "maximum": 2147483647 }, "frCircuitExcessBurst": { "type": "integer", "description": "This variable indicates the maximum amount of\n uncommitted data bits that the network will at-\n tempt to deliver over the measurement interval.\n \n By default, if not configured when creating the\n entry, the Excess Information Burst Size is set\n to the value of ifSpeed.", "minimum": -2147483648, "maximum": 2147483647 }, "frCircuitThroughput": { "type": "integer", "description": "Throughput is the average number of 'Frame Re-\n lay Information Field' bits transferred per\n second across a user network interface in one\n direction, measured over the measurement inter-\n val.\n \n If the configured committed burst rate and\n throughput are both non-zero, the measurement\n interval\n T=frCircuitCommittedBurst/frCircuitThroughput.\n \n If the configured committed burst rate and\n throughput are both zero, the measurement in-\n terval\n T=frCircuitExcessBurst/ifSpeed.", "minimum": -2147483648, "maximum": 2147483647 } } } }, "example": { "RFC1315-MIB:frCircuitEntry": [ { "frCircuitIfIndex": "example-string", "frCircuitDlci": "example-string", "frCircuitState": "up(1)", "frCircuitReceivedFECNs": 0, "frCircuitReceivedBECNs": 0, "frCircuitSentFrames": 0, "frCircuitSentOctets": 1234567890, "frCircuitReceivedFrames": 0, "frCircuitReceivedOctets": 1234567890, "frCircuitCreationTime": "example-string", "frCircuitLastTimeChange": "example-string", "frCircuitCommittedBurst": -2147483648, "frCircuitExcessBurst": -2147483648, "frCircuitThroughput": -2147483648 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-frCircuitEntry", "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": "/frCircuitTable/frCircuitEntry", "x-restconf-kind": "container" }, "/data/RFC1315-MIB:frErrTable": { "get": { "summary": "Get frErrTable data", "description": "Retrieve frErrTable operational data from MIB", "tags": [ "RFC1315-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table containing information about Errors on the\n Frame Relay interface.", "properties": { "frErrEntry": { "type": "array", "description": "The error information for a single frame relay\n interface.", "items": { "type": "object", "properties": { "frErrIfIndex": { "type": "string", "description": "The ifIndex Value of the corresponding ifEn-\n try.", "x-yang-type": "RFC1315-MIB:Index" }, "frErrType": { "type": "string", "description": "The type of error that was last seen on this\n interface." }, "frErrData": { "type": "string", "description": "An octet string containing as much of the er-\n ror packet as possible. As a minimum, it must\n contain the Q.922 Address or as much as was\n delivered. It is desirable to include all in-\n formation up to the PDU.", "format": "binary" }, "frErrTime": { "type": "string", "description": "The value of sysUpTime at which the error was\n detected.", "x-yang-type": "yang:timeticks" } } } } } }, "example": { "RFC1315-MIB:frErrTable": { "frErrEntry": [ { "frErrIfIndex": "1", "frErrType": "ethernetCsmacd(6)", "frErrData": "example-string", "frErrTime": "example-string" }, { "frErrIfIndex": "2", "frErrType": "ethernetCsmacd(6)", "frErrData": "example-string", "frErrTime": "example-string" }, { "frErrIfIndex": "3", "frErrType": "ethernetCsmacd(6)", "frErrData": "example-string", "frErrTime": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-frErrTable", "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": "/frErrTable", "x-restconf-kind": "container" }, "/data/RFC1315-MIB:frErrTable/frErrEntry": { "get": { "summary": "Get frErrEntry list", "description": "Retrieve list of frErrEntry entries from MIB", "tags": [ "RFC1315-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "The error information for a single frame relay\n interface.", "items": { "type": "object", "properties": { "frErrIfIndex": { "type": "string", "description": "The ifIndex Value of the corresponding ifEn-\n try.", "x-yang-type": "RFC1315-MIB:Index" }, "frErrType": { "type": "string", "description": "The type of error that was last seen on this\n interface." }, "frErrData": { "type": "string", "description": "An octet string containing as much of the er-\n ror packet as possible. As a minimum, it must\n contain the Q.922 Address or as much as was\n delivered. It is desirable to include all in-\n formation up to the PDU.", "format": "binary" }, "frErrTime": { "type": "string", "description": "The value of sysUpTime at which the error was\n detected.", "x-yang-type": "yang:timeticks" } } } }, "example": { "RFC1315-MIB:frErrEntry": [ { "frErrIfIndex": "example-string", "frErrType": "ethernetCsmacd(6)", "frErrData": "example-string", "frErrTime": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-frErrEntry", "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": "/frErrTable/frErrEntry", "x-restconf-kind": "container" }, "/data/RFC1315-MIB:frErrTable/frErrEntry={frErrIfIndex}": { "get": { "summary": "Get frErrEntry entry", "description": "Retrieve specific frErrEntry entry by key from MIB", "tags": [ "RFC1315-MIB" ], "parameters": [ { "name": "frErrIfIndex", "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": { "frErrIfIndex": { "type": "string", "description": "The ifIndex Value of the corresponding ifEn-\n try.", "x-yang-type": "RFC1315-MIB:Index" }, "frErrType": { "type": "string", "description": "The type of error that was last seen on this\n interface." }, "frErrData": { "type": "string", "description": "An octet string containing as much of the er-\n ror packet as possible. As a minimum, it must\n contain the Q.922 Address or as much as was\n delivered. It is desirable to include all in-\n formation up to the PDU.", "format": "binary" }, "frErrTime": { "type": "string", "description": "The value of sysUpTime at which the error was\n detected.", "x-yang-type": "yang:timeticks" } } }, "example": { "RFC1315-MIB:frErrEntry": { "frErrIfIndex": "example-string", "frErrType": "ethernetCsmacd(6)", "frErrData": "example-string", "frErrTime": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-frErrEntry-2" }, "x-yang-path": "/frErrTable/frErrEntry={frErrIfIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "frErrIfIndex" ] }, "/data/RFC1315-MIB:frDlcmiEntry": { "get": { "summary": "Get frDlcmiEntry list", "description": "Retrieve list of frDlcmiEntry entries from MIB", "tags": [ "RFC1315-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "The Parameters for a particular Data Link Con-\n nection Management Interface.", "items": { "type": "object", "properties": { "frDlcmiIfIndex": { "type": "string", "description": "The ifIndex value of the corresponding ifEn-\n try.", "x-yang-type": "RFC1315-MIB:Index" }, "frDlcmiState": { "type": "string", "description": "This variable states which Data Link Connec-\n tion Management scheme is active (and by impli-\n cation, what DLCI it uses) on the Frame Relay\n interface." }, "frDlcmiAddress": { "type": "string", "description": "This variable states which address format is\n in use on the Frame Relay interface." }, "frDlcmiAddressLen": { "type": "string", "description": "This variable states which address length in\n octets. In the case of Q922 format, the length\n indicates the entire length of the address in-\n cluding the control portion." }, "frDlcmiPollingInterval": { "type": "integer", "description": "This is the number of seconds between succes-\n sive status enquiry messages.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiFullEnquiryInterval": { "type": "integer", "description": "Number of status enquiry intervals that pass\n before issuance of a full status enquiry mes-\n sage.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiErrorThreshold": { "type": "integer", "description": "This is the maximum number of unanswered\n Status Enquiries the equipment shall accept be-\n fore declaring the interface down.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiMonitoredEvents": { "type": "integer", "description": "This is the number of status polling intervals\n over which the error threshold is counted. For\n example, if within 'MonitoredEvents' number of\n events the station receives 'ErrorThreshold'\n number of errors, the interface is marked as\n down.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiMaxSupportedVCs": { "type": "integer", "description": "The maximum number of Virtual Circuits allowed\n for this interface. Usually dictated by the\n Frame Relay network.\n \n In response to a SET, if a value less than zero\n or higher than the agent's maximal capability\n is configured, the agent should respond bad-\n Value", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiMulticast": { "type": "string", "description": "This indicates whether the Frame Relay inter-\n face is using a multicast service." } } } }, "example": { "RFC1315-MIB:frDlcmiEntry": [ { "frDlcmiIfIndex": "example-string", "frDlcmiState": "up(1)", "frDlcmiAddress": "192.168.1.1", "frDlcmiAddressLen": "192.168.1.1", "frDlcmiPollingInterval": -2147483648, "frDlcmiFullEnquiryInterval": -2147483648, "frDlcmiErrorThreshold": -2147483648, "frDlcmiMonitoredEvents": -2147483648, "frDlcmiMaxSupportedVCs": -2147483648, "frDlcmiMulticast": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-frDlcmiEntry-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": "/frDlcmiEntry", "x-restconf-kind": "container" }, "/data/RFC1315-MIB:frDlcmiEntry={frDlcmiIfIndex}": { "get": { "summary": "Get frDlcmiEntry entry", "description": "Retrieve specific frDlcmiEntry entry by key from MIB", "tags": [ "RFC1315-MIB" ], "parameters": [ { "name": "frDlcmiIfIndex", "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": { "frDlcmiIfIndex": { "type": "string", "description": "The ifIndex value of the corresponding ifEn-\n try.", "x-yang-type": "RFC1315-MIB:Index" }, "frDlcmiState": { "type": "string", "description": "This variable states which Data Link Connec-\n tion Management scheme is active (and by impli-\n cation, what DLCI it uses) on the Frame Relay\n interface." }, "frDlcmiAddress": { "type": "string", "description": "This variable states which address format is\n in use on the Frame Relay interface." }, "frDlcmiAddressLen": { "type": "string", "description": "This variable states which address length in\n octets. In the case of Q922 format, the length\n indicates the entire length of the address in-\n cluding the control portion." }, "frDlcmiPollingInterval": { "type": "integer", "description": "This is the number of seconds between succes-\n sive status enquiry messages.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiFullEnquiryInterval": { "type": "integer", "description": "Number of status enquiry intervals that pass\n before issuance of a full status enquiry mes-\n sage.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiErrorThreshold": { "type": "integer", "description": "This is the maximum number of unanswered\n Status Enquiries the equipment shall accept be-\n fore declaring the interface down.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiMonitoredEvents": { "type": "integer", "description": "This is the number of status polling intervals\n over which the error threshold is counted. For\n example, if within 'MonitoredEvents' number of\n events the station receives 'ErrorThreshold'\n number of errors, the interface is marked as\n down.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiMaxSupportedVCs": { "type": "integer", "description": "The maximum number of Virtual Circuits allowed\n for this interface. Usually dictated by the\n Frame Relay network.\n \n In response to a SET, if a value less than zero\n or higher than the agent's maximal capability\n is configured, the agent should respond bad-\n Value", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiMulticast": { "type": "string", "description": "This indicates whether the Frame Relay inter-\n face is using a multicast service." } } }, "example": { "RFC1315-MIB:frDlcmiEntry": { "frDlcmiIfIndex": "example-string", "frDlcmiState": "up(1)", "frDlcmiAddress": "192.168.1.1", "frDlcmiAddressLen": "192.168.1.1", "frDlcmiPollingInterval": -2147483648, "frDlcmiFullEnquiryInterval": -2147483648, "frDlcmiErrorThreshold": -2147483648, "frDlcmiMonitoredEvents": -2147483648, "frDlcmiMaxSupportedVCs": -2147483648, "frDlcmiMulticast": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-frDlcmiEntry-4" }, "x-yang-path": "/frDlcmiEntry={frDlcmiIfIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "frDlcmiIfIndex" ] }, "/data/RFC1315-MIB:frCircuitEntry": { "get": { "summary": "Get frCircuitEntry list", "description": "Retrieve list of frCircuitEntry entries from MIB", "tags": [ "RFC1315-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "The information regarding a single Data Link\n Connection Identifier.", "items": { "type": "object", "properties": { "frCircuitIfIndex": { "type": "string", "description": "The ifIndex Value of the ifEntry this virtual\n circuit is layered onto.", "x-yang-type": "RFC1315-MIB:Index" }, "frCircuitDlci": { "type": "string", "description": "The Data Link Connection Identifier for this\n virtual circuit.", "x-yang-type": "RFC1315-MIB:DLCI" }, "frCircuitState": { "type": "string", "description": "Indicates whether the particular virtual cir-\n cuit is operational. In the absence of a Data\n Link Connection Management Interface, virtual\n circuit entries (rows) may be created by set-\n ting virtual circuit state to 'active', or\n deleted by changing Circuit state to 'invalid'.\n Whether or not the row actually disappears is\n left to the implementation, so this object may\n actually read as 'invalid' for some arbitrary\n length of time. It is also legal to set the\n state of a virtual circuit to 'inactive' to\n temporarily disable a given circuit." }, "frCircuitReceivedFECNs": { "type": "integer", "description": "Number of frames received from the network in-\n dicating forward congestion since the virtual\n circuit was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedBECNs": { "type": "integer", "description": "Number of frames received from the network in-\n dicating backward congestion since the virtual\n circuit was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitSentFrames": { "type": "integer", "description": "The number of frames sent from this virtual\n circuit since it was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitSentOctets": { "type": "integer", "description": "The number of octets sent from this virtual\n circuit since it was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedFrames": { "type": "integer", "description": "Number of frames received over this virtual\n circuit since it was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedOctets": { "type": "integer", "description": "Number of octets received over this virtual\n circuit since it was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitCreationTime": { "type": "string", "description": "The value of sysUpTime when the virtual cir-\n cuit was created, whether by the Data Link Con-\n nection Management Interface or by a SetRe-\n quest.", "x-yang-type": "yang:timeticks" }, "frCircuitLastTimeChange": { "type": "string", "description": "The value of sysUpTime when last there was a\n change in the virtual circuit state", "x-yang-type": "yang:timeticks" }, "frCircuitCommittedBurst": { "type": "integer", "description": "This variable indicates the maximum amount of\n data, in bits, that the network agrees to\n transfer under normal conditions, during the\n measurement interval.", "minimum": -2147483648, "maximum": 2147483647 }, "frCircuitExcessBurst": { "type": "integer", "description": "This variable indicates the maximum amount of\n uncommitted data bits that the network will at-\n tempt to deliver over the measurement interval.\n \n By default, if not configured when creating the\n entry, the Excess Information Burst Size is set\n to the value of ifSpeed.", "minimum": -2147483648, "maximum": 2147483647 }, "frCircuitThroughput": { "type": "integer", "description": "Throughput is the average number of 'Frame Re-\n lay Information Field' bits transferred per\n second across a user network interface in one\n direction, measured over the measurement inter-\n val.\n \n If the configured committed burst rate and\n throughput are both non-zero, the measurement\n interval\n T=frCircuitCommittedBurst/frCircuitThroughput.\n \n If the configured committed burst rate and\n throughput are both zero, the measurement in-\n terval\n T=frCircuitExcessBurst/ifSpeed.", "minimum": -2147483648, "maximum": 2147483647 } } } }, "example": { "RFC1315-MIB:frCircuitEntry": [ { "frCircuitIfIndex": "example-string", "frCircuitDlci": "example-string", "frCircuitState": "up(1)", "frCircuitReceivedFECNs": 0, "frCircuitReceivedBECNs": 0, "frCircuitSentFrames": 0, "frCircuitSentOctets": 1234567890, "frCircuitReceivedFrames": 0, "frCircuitReceivedOctets": 1234567890, "frCircuitCreationTime": "example-string", "frCircuitLastTimeChange": "example-string", "frCircuitCommittedBurst": -2147483648, "frCircuitExcessBurst": -2147483648, "frCircuitThroughput": -2147483648 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-frCircuitEntry-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": "/frCircuitEntry", "x-restconf-kind": "container" }, "/data/RFC1315-MIB:frErrEntry": { "get": { "summary": "Get frErrEntry list", "description": "Retrieve list of frErrEntry entries from MIB", "tags": [ "RFC1315-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "The error information for a single frame relay\n interface.", "items": { "type": "object", "properties": { "frErrIfIndex": { "type": "string", "description": "The ifIndex Value of the corresponding ifEn-\n try.", "x-yang-type": "RFC1315-MIB:Index" }, "frErrType": { "type": "string", "description": "The type of error that was last seen on this\n interface." }, "frErrData": { "type": "string", "description": "An octet string containing as much of the er-\n ror packet as possible. As a minimum, it must\n contain the Q.922 Address or as much as was\n delivered. It is desirable to include all in-\n formation up to the PDU.", "format": "binary" }, "frErrTime": { "type": "string", "description": "The value of sysUpTime at which the error was\n detected.", "x-yang-type": "yang:timeticks" } } } }, "example": { "RFC1315-MIB:frErrEntry": [ { "frErrIfIndex": "example-string", "frErrType": "ethernetCsmacd(6)", "frErrData": "example-string", "frErrTime": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-frErrEntry-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": "/frErrEntry", "x-restconf-kind": "container" }, "/data/RFC1315-MIB:frErrEntry={frErrIfIndex}": { "get": { "summary": "Get frErrEntry entry", "description": "Retrieve specific frErrEntry entry by key from MIB", "tags": [ "RFC1315-MIB" ], "parameters": [ { "name": "frErrIfIndex", "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": { "frErrIfIndex": { "type": "string", "description": "The ifIndex Value of the corresponding ifEn-\n try.", "x-yang-type": "RFC1315-MIB:Index" }, "frErrType": { "type": "string", "description": "The type of error that was last seen on this\n interface." }, "frErrData": { "type": "string", "description": "An octet string containing as much of the er-\n ror packet as possible. As a minimum, it must\n contain the Q.922 Address or as much as was\n delivered. It is desirable to include all in-\n formation up to the PDU.", "format": "binary" }, "frErrTime": { "type": "string", "description": "The value of sysUpTime at which the error was\n detected.", "x-yang-type": "yang:timeticks" } } }, "example": { "RFC1315-MIB:frErrEntry": { "frErrIfIndex": "example-string", "frErrType": "ethernetCsmacd(6)", "frErrData": "example-string", "frErrTime": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-frErrEntry-4" }, "x-yang-path": "/frErrEntry={frErrIfIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "frErrIfIndex" ] }, "/data/RFC1315-MIB:frCircuitTable/frCircuitEntry={frCircuitIfIndex},{frCircuitDlci}": { "get": { "summary": "Get frCircuitEntry entry", "description": "Retrieve specific frCircuitEntry entry by key from MIB", "tags": [ "RFC1315-MIB" ], "parameters": [ { "name": "frCircuitIfIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "frCircuitDlci", "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": { "frCircuitIfIndex": { "type": "string", "description": "The ifIndex Value of the ifEntry this virtual\n circuit is layered onto.", "x-yang-type": "RFC1315-MIB:Index" }, "frCircuitDlci": { "type": "string", "description": "The Data Link Connection Identifier for this\n virtual circuit.", "x-yang-type": "RFC1315-MIB:DLCI" }, "frCircuitState": { "type": "string", "description": "Indicates whether the particular virtual cir-\n cuit is operational. In the absence of a Data\n Link Connection Management Interface, virtual\n circuit entries (rows) may be created by set-\n ting virtual circuit state to 'active', or\n deleted by changing Circuit state to 'invalid'.\n Whether or not the row actually disappears is\n left to the implementation, so this object may\n actually read as 'invalid' for some arbitrary\n length of time. It is also legal to set the\n state of a virtual circuit to 'inactive' to\n temporarily disable a given circuit." }, "frCircuitReceivedFECNs": { "type": "integer", "description": "Number of frames received from the network in-\n dicating forward congestion since the virtual\n circuit was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedBECNs": { "type": "integer", "description": "Number of frames received from the network in-\n dicating backward congestion since the virtual\n circuit was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitSentFrames": { "type": "integer", "description": "The number of frames sent from this virtual\n circuit since it was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitSentOctets": { "type": "integer", "description": "The number of octets sent from this virtual\n circuit since it was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedFrames": { "type": "integer", "description": "Number of frames received over this virtual\n circuit since it was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedOctets": { "type": "integer", "description": "Number of octets received over this virtual\n circuit since it was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitCreationTime": { "type": "string", "description": "The value of sysUpTime when the virtual cir-\n cuit was created, whether by the Data Link Con-\n nection Management Interface or by a SetRe-\n quest.", "x-yang-type": "yang:timeticks" }, "frCircuitLastTimeChange": { "type": "string", "description": "The value of sysUpTime when last there was a\n change in the virtual circuit state", "x-yang-type": "yang:timeticks" }, "frCircuitCommittedBurst": { "type": "integer", "description": "This variable indicates the maximum amount of\n data, in bits, that the network agrees to\n transfer under normal conditions, during the\n measurement interval.", "minimum": -2147483648, "maximum": 2147483647 }, "frCircuitExcessBurst": { "type": "integer", "description": "This variable indicates the maximum amount of\n uncommitted data bits that the network will at-\n tempt to deliver over the measurement interval.\n \n By default, if not configured when creating the\n entry, the Excess Information Burst Size is set\n to the value of ifSpeed.", "minimum": -2147483648, "maximum": 2147483647 }, "frCircuitThroughput": { "type": "integer", "description": "Throughput is the average number of 'Frame Re-\n lay Information Field' bits transferred per\n second across a user network interface in one\n direction, measured over the measurement inter-\n val.\n \n If the configured committed burst rate and\n throughput are both non-zero, the measurement\n interval\n T=frCircuitCommittedBurst/frCircuitThroughput.\n \n If the configured committed burst rate and\n throughput are both zero, the measurement in-\n terval\n T=frCircuitExcessBurst/ifSpeed.", "minimum": -2147483648, "maximum": 2147483647 } } }, "example": { "RFC1315-MIB:frCircuitEntry": { "frCircuitIfIndex": "example-string", "frCircuitDlci": "example-string", "frCircuitState": "up(1)", "frCircuitReceivedFECNs": 0, "frCircuitReceivedBECNs": 0, "frCircuitSentFrames": 0, "frCircuitSentOctets": 1234567890, "frCircuitReceivedFrames": 0, "frCircuitReceivedOctets": 1234567890, "frCircuitCreationTime": "example-string", "frCircuitLastTimeChange": "example-string", "frCircuitCommittedBurst": -2147483648, "frCircuitExcessBurst": -2147483648, "frCircuitThroughput": -2147483648 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-frCircuitEntry-2" }, "x-yang-path": "/frCircuitTable/frCircuitEntry={frCircuitIfIndex frCircuitDlci}", "x-restconf-kind": "list-instance", "x-list-keys": [ "frCircuitIfIndex frCircuitDlci" ] }, "/data/RFC1315-MIB:frCircuitEntry={frCircuitIfIndex},{frCircuitDlci}": { "get": { "summary": "Get frCircuitEntry entry", "description": "Retrieve specific frCircuitEntry entry by key from MIB", "tags": [ "RFC1315-MIB" ], "parameters": [ { "name": "frCircuitIfIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "frCircuitDlci", "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": { "frCircuitIfIndex": { "type": "string", "description": "The ifIndex Value of the ifEntry this virtual\n circuit is layered onto.", "x-yang-type": "RFC1315-MIB:Index" }, "frCircuitDlci": { "type": "string", "description": "The Data Link Connection Identifier for this\n virtual circuit.", "x-yang-type": "RFC1315-MIB:DLCI" }, "frCircuitState": { "type": "string", "description": "Indicates whether the particular virtual cir-\n cuit is operational. In the absence of a Data\n Link Connection Management Interface, virtual\n circuit entries (rows) may be created by set-\n ting virtual circuit state to 'active', or\n deleted by changing Circuit state to 'invalid'.\n Whether or not the row actually disappears is\n left to the implementation, so this object may\n actually read as 'invalid' for some arbitrary\n length of time. It is also legal to set the\n state of a virtual circuit to 'inactive' to\n temporarily disable a given circuit." }, "frCircuitReceivedFECNs": { "type": "integer", "description": "Number of frames received from the network in-\n dicating forward congestion since the virtual\n circuit was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedBECNs": { "type": "integer", "description": "Number of frames received from the network in-\n dicating backward congestion since the virtual\n circuit was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitSentFrames": { "type": "integer", "description": "The number of frames sent from this virtual\n circuit since it was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitSentOctets": { "type": "integer", "description": "The number of octets sent from this virtual\n circuit since it was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedFrames": { "type": "integer", "description": "Number of frames received over this virtual\n circuit since it was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedOctets": { "type": "integer", "description": "Number of octets received over this virtual\n circuit since it was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitCreationTime": { "type": "string", "description": "The value of sysUpTime when the virtual cir-\n cuit was created, whether by the Data Link Con-\n nection Management Interface or by a SetRe-\n quest.", "x-yang-type": "yang:timeticks" }, "frCircuitLastTimeChange": { "type": "string", "description": "The value of sysUpTime when last there was a\n change in the virtual circuit state", "x-yang-type": "yang:timeticks" }, "frCircuitCommittedBurst": { "type": "integer", "description": "This variable indicates the maximum amount of\n data, in bits, that the network agrees to\n transfer under normal conditions, during the\n measurement interval.", "minimum": -2147483648, "maximum": 2147483647 }, "frCircuitExcessBurst": { "type": "integer", "description": "This variable indicates the maximum amount of\n uncommitted data bits that the network will at-\n tempt to deliver over the measurement interval.\n \n By default, if not configured when creating the\n entry, the Excess Information Burst Size is set\n to the value of ifSpeed.", "minimum": -2147483648, "maximum": 2147483647 }, "frCircuitThroughput": { "type": "integer", "description": "Throughput is the average number of 'Frame Re-\n lay Information Field' bits transferred per\n second across a user network interface in one\n direction, measured over the measurement inter-\n val.\n \n If the configured committed burst rate and\n throughput are both non-zero, the measurement\n interval\n T=frCircuitCommittedBurst/frCircuitThroughput.\n \n If the configured committed burst rate and\n throughput are both zero, the measurement in-\n terval\n T=frCircuitExcessBurst/ifSpeed.", "minimum": -2147483648, "maximum": 2147483647 } } }, "example": { "RFC1315-MIB:frCircuitEntry": { "frCircuitIfIndex": "example-string", "frCircuitDlci": "example-string", "frCircuitState": "up(1)", "frCircuitReceivedFECNs": 0, "frCircuitReceivedBECNs": 0, "frCircuitSentFrames": 0, "frCircuitSentOctets": 1234567890, "frCircuitReceivedFrames": 0, "frCircuitReceivedOctets": 1234567890, "frCircuitCreationTime": "example-string", "frCircuitLastTimeChange": "example-string", "frCircuitCommittedBurst": -2147483648, "frCircuitExcessBurst": -2147483648, "frCircuitThroughput": -2147483648 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-frCircuitEntry-4" }, "x-yang-path": "/frCircuitEntry={frCircuitIfIndex frCircuitDlci}", "x-restconf-kind": "list-instance", "x-list-keys": [ "frCircuitIfIndex frCircuitDlci" ] } }, "components": { "schemas": { "RFC1315-MIB_RFC1315-MIB": { "type": "object", "description": "This variable indicates whether the system\n produces the frDLCIStatusChange trap.", "properties": { "frDlcmiEntry": { "type": "array", "description": "The Parameters for a particular Data Link Con-\n nection Management Interface.", "items": { "type": "object", "properties": { "frDlcmiIfIndex": { "type": "string", "description": "The ifIndex value of the corresponding ifEn-\n try.", "x-yang-type": "RFC1315-MIB:Index", "readOnly": true }, "frDlcmiState": { "type": "string", "description": "This variable states which Data Link Connec-\n tion Management scheme is active (and by impli-\n cation, what DLCI it uses) on the Frame Relay\n interface.", "readOnly": true }, "frDlcmiAddress": { "type": "string", "description": "This variable states which address format is\n in use on the Frame Relay interface.", "readOnly": true }, "frDlcmiAddressLen": { "type": "string", "description": "This variable states which address length in\n octets. In the case of Q922 format, the length\n indicates the entire length of the address in-\n cluding the control portion.", "readOnly": true }, "frDlcmiPollingInterval": { "type": "integer", "description": "This is the number of seconds between succes-\n sive status enquiry messages.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frDlcmiFullEnquiryInterval": { "type": "integer", "description": "Number of status enquiry intervals that pass\n before issuance of a full status enquiry mes-\n sage.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frDlcmiErrorThreshold": { "type": "integer", "description": "This is the maximum number of unanswered\n Status Enquiries the equipment shall accept be-\n fore declaring the interface down.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frDlcmiMonitoredEvents": { "type": "integer", "description": "This is the number of status polling intervals\n over which the error threshold is counted. For\n example, if within 'MonitoredEvents' number of\n events the station receives 'ErrorThreshold'\n number of errors, the interface is marked as\n down.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frDlcmiMaxSupportedVCs": { "type": "integer", "description": "The maximum number of Virtual Circuits allowed\n for this interface. Usually dictated by the\n Frame Relay network.\n \n In response to a SET, if a value less than zero\n or higher than the agent's maximal capability\n is configured, the agent should respond bad-\n Value", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frDlcmiMulticast": { "type": "string", "description": "This indicates whether the Frame Relay inter-\n face is using a multicast service.", "readOnly": true } } }, "readOnly": true }, "frCircuitEntry": { "type": "array", "description": "The information regarding a single Data Link\n Connection Identifier.", "items": { "type": "object", "properties": { "frCircuitIfIndex": { "type": "string", "description": "The ifIndex Value of the ifEntry this virtual\n circuit is layered onto.", "x-yang-type": "RFC1315-MIB:Index", "readOnly": true }, "frCircuitDlci": { "type": "string", "description": "The Data Link Connection Identifier for this\n virtual circuit.", "x-yang-type": "RFC1315-MIB:DLCI", "readOnly": true }, "frCircuitState": { "type": "string", "description": "Indicates whether the particular virtual cir-\n cuit is operational. In the absence of a Data\n Link Connection Management Interface, virtual\n circuit entries (rows) may be created by set-\n ting virtual circuit state to 'active', or\n deleted by changing Circuit state to 'invalid'.\n Whether or not the row actually disappears is\n left to the implementation, so this object may\n actually read as 'invalid' for some arbitrary\n length of time. It is also legal to set the\n state of a virtual circuit to 'inactive' to\n temporarily disable a given circuit.", "readOnly": true }, "frCircuitReceivedFECNs": { "type": "integer", "description": "Number of frames received from the network in-\n dicating forward congestion since the virtual\n circuit was created.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitReceivedBECNs": { "type": "integer", "description": "Number of frames received from the network in-\n dicating backward congestion since the virtual\n circuit was created.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitSentFrames": { "type": "integer", "description": "The number of frames sent from this virtual\n circuit since it was created.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitSentOctets": { "type": "integer", "description": "The number of octets sent from this virtual\n circuit since it was created.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitReceivedFrames": { "type": "integer", "description": "Number of frames received over this virtual\n circuit since it was created.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitReceivedOctets": { "type": "integer", "description": "Number of octets received over this virtual\n circuit since it was created.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitCreationTime": { "type": "string", "description": "The value of sysUpTime when the virtual cir-\n cuit was created, whether by the Data Link Con-\n nection Management Interface or by a SetRe-\n quest.", "x-yang-type": "yang:timeticks", "readOnly": true }, "frCircuitLastTimeChange": { "type": "string", "description": "The value of sysUpTime when last there was a\n change in the virtual circuit state", "x-yang-type": "yang:timeticks", "readOnly": true }, "frCircuitCommittedBurst": { "type": "integer", "description": "This variable indicates the maximum amount of\n data, in bits, that the network agrees to\n transfer under normal conditions, during the\n measurement interval.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frCircuitExcessBurst": { "type": "integer", "description": "This variable indicates the maximum amount of\n uncommitted data bits that the network will at-\n tempt to deliver over the measurement interval.\n \n By default, if not configured when creating the\n entry, the Excess Information Burst Size is set\n to the value of ifSpeed.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frCircuitThroughput": { "type": "integer", "description": "Throughput is the average number of 'Frame Re-\n lay Information Field' bits transferred per\n second across a user network interface in one\n direction, measured over the measurement inter-\n val.\n \n If the configured committed burst rate and\n throughput are both non-zero, the measurement\n interval\n T=frCircuitCommittedBurst/frCircuitThroughput.\n \n If the configured committed burst rate and\n throughput are both zero, the measurement in-\n terval\n T=frCircuitExcessBurst/ifSpeed.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true } } }, "readOnly": true }, "frErrEntry": { "type": "array", "description": "The error information for a single frame relay\n interface.", "items": { "type": "object", "properties": { "frErrIfIndex": { "type": "string", "description": "The ifIndex Value of the corresponding ifEn-\n try.", "x-yang-type": "RFC1315-MIB:Index", "readOnly": true }, "frErrType": { "type": "string", "description": "The type of error that was last seen on this\n interface.", "readOnly": true }, "frErrData": { "type": "string", "description": "An octet string containing as much of the er-\n ror packet as possible. As a minimum, it must\n contain the Q.922 Address or as much as was\n delivered. It is desirable to include all in-\n formation up to the PDU.", "format": "binary", "readOnly": true }, "frErrTime": { "type": "string", "description": "The value of sysUpTime at which the error was\n detected.", "x-yang-type": "yang:timeticks", "readOnly": true } } }, "readOnly": true }, "frame-relay-globals": { "type": "object", "description": "This variable indicates whether the system\n produces the frDLCIStatusChange trap.", "properties": { "frTrapState": { "type": "string", "description": "This variable indicates whether the system\n produces the frDLCIStatusChange trap.", "readOnly": true } }, "readOnly": true }, "frDlcmiTable": { "type": "object", "description": "The Parameters for the Data Link Connection Management\n Interface for the frame relay service on this\n interface.", "properties": { "frDlcmiEntry": { "type": "array", "description": "The Parameters for a particular Data Link Con-\n nection Management Interface.", "items": { "type": "object", "properties": { "frDlcmiIfIndex": { "type": "string", "description": "The ifIndex value of the corresponding ifEn-\n try.", "x-yang-type": "RFC1315-MIB:Index", "readOnly": true }, "frDlcmiState": { "type": "string", "description": "This variable states which Data Link Connec-\n tion Management scheme is active (and by impli-\n cation, what DLCI it uses) on the Frame Relay\n interface.", "readOnly": true }, "frDlcmiAddress": { "type": "string", "description": "This variable states which address format is\n in use on the Frame Relay interface.", "readOnly": true }, "frDlcmiAddressLen": { "type": "string", "description": "This variable states which address length in\n octets. In the case of Q922 format, the length\n indicates the entire length of the address in-\n cluding the control portion.", "readOnly": true }, "frDlcmiPollingInterval": { "type": "integer", "description": "This is the number of seconds between succes-\n sive status enquiry messages.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frDlcmiFullEnquiryInterval": { "type": "integer", "description": "Number of status enquiry intervals that pass\n before issuance of a full status enquiry mes-\n sage.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frDlcmiErrorThreshold": { "type": "integer", "description": "This is the maximum number of unanswered\n Status Enquiries the equipment shall accept be-\n fore declaring the interface down.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frDlcmiMonitoredEvents": { "type": "integer", "description": "This is the number of status polling intervals\n over which the error threshold is counted. For\n example, if within 'MonitoredEvents' number of\n events the station receives 'ErrorThreshold'\n number of errors, the interface is marked as\n down.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frDlcmiMaxSupportedVCs": { "type": "integer", "description": "The maximum number of Virtual Circuits allowed\n for this interface. Usually dictated by the\n Frame Relay network.\n \n In response to a SET, if a value less than zero\n or higher than the agent's maximal capability\n is configured, the agent should respond bad-\n Value", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frDlcmiMulticast": { "type": "string", "description": "This indicates whether the Frame Relay inter-\n face is using a multicast service.", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "frCircuitTable": { "type": "object", "description": "A table containing information about specific Data\n Link Connection Identifiers and corresponding virtual\n circuits.", "properties": { "frCircuitEntry": { "type": "array", "description": "The information regarding a single Data Link\n Connection Identifier.", "items": { "type": "object", "properties": { "frCircuitIfIndex": { "type": "string", "description": "The ifIndex Value of the ifEntry this virtual\n circuit is layered onto.", "x-yang-type": "RFC1315-MIB:Index", "readOnly": true }, "frCircuitDlci": { "type": "string", "description": "The Data Link Connection Identifier for this\n virtual circuit.", "x-yang-type": "RFC1315-MIB:DLCI", "readOnly": true }, "frCircuitState": { "type": "string", "description": "Indicates whether the particular virtual cir-\n cuit is operational. In the absence of a Data\n Link Connection Management Interface, virtual\n circuit entries (rows) may be created by set-\n ting virtual circuit state to 'active', or\n deleted by changing Circuit state to 'invalid'.\n Whether or not the row actually disappears is\n left to the implementation, so this object may\n actually read as 'invalid' for some arbitrary\n length of time. It is also legal to set the\n state of a virtual circuit to 'inactive' to\n temporarily disable a given circuit.", "readOnly": true }, "frCircuitReceivedFECNs": { "type": "integer", "description": "Number of frames received from the network in-\n dicating forward congestion since the virtual\n circuit was created.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitReceivedBECNs": { "type": "integer", "description": "Number of frames received from the network in-\n dicating backward congestion since the virtual\n circuit was created.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitSentFrames": { "type": "integer", "description": "The number of frames sent from this virtual\n circuit since it was created.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitSentOctets": { "type": "integer", "description": "The number of octets sent from this virtual\n circuit since it was created.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitReceivedFrames": { "type": "integer", "description": "Number of frames received over this virtual\n circuit since it was created.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitReceivedOctets": { "type": "integer", "description": "Number of octets received over this virtual\n circuit since it was created.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitCreationTime": { "type": "string", "description": "The value of sysUpTime when the virtual cir-\n cuit was created, whether by the Data Link Con-\n nection Management Interface or by a SetRe-\n quest.", "x-yang-type": "yang:timeticks", "readOnly": true }, "frCircuitLastTimeChange": { "type": "string", "description": "The value of sysUpTime when last there was a\n change in the virtual circuit state", "x-yang-type": "yang:timeticks", "readOnly": true }, "frCircuitCommittedBurst": { "type": "integer", "description": "This variable indicates the maximum amount of\n data, in bits, that the network agrees to\n transfer under normal conditions, during the\n measurement interval.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frCircuitExcessBurst": { "type": "integer", "description": "This variable indicates the maximum amount of\n uncommitted data bits that the network will at-\n tempt to deliver over the measurement interval.\n \n By default, if not configured when creating the\n entry, the Excess Information Burst Size is set\n to the value of ifSpeed.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frCircuitThroughput": { "type": "integer", "description": "Throughput is the average number of 'Frame Re-\n lay Information Field' bits transferred per\n second across a user network interface in one\n direction, measured over the measurement inter-\n val.\n \n If the configured committed burst rate and\n throughput are both non-zero, the measurement\n interval\n T=frCircuitCommittedBurst/frCircuitThroughput.\n \n If the configured committed burst rate and\n throughput are both zero, the measurement in-\n terval\n T=frCircuitExcessBurst/ifSpeed.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "frErrTable": { "type": "object", "description": "A table containing information about Errors on the\n Frame Relay interface.", "properties": { "frErrEntry": { "type": "array", "description": "The error information for a single frame relay\n interface.", "items": { "type": "object", "properties": { "frErrIfIndex": { "type": "string", "description": "The ifIndex Value of the corresponding ifEn-\n try.", "x-yang-type": "RFC1315-MIB:Index", "readOnly": true }, "frErrType": { "type": "string", "description": "The type of error that was last seen on this\n interface.", "readOnly": true }, "frErrData": { "type": "string", "description": "An octet string containing as much of the er-\n ror packet as possible. As a minimum, it must\n contain the Q.922 Address or as much as was\n delivered. It is desirable to include all in-\n formation up to the PDU.", "format": "binary", "readOnly": true }, "frErrTime": { "type": "string", "description": "The value of sysUpTime at which the error was\n detected.", "x-yang-type": "yang:timeticks", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "RFC1315-MIB_object-1": { "type": "object", "description": "object-1", "properties": { "frCircuitDlci": { "type": "string", "description": "frCircuitDlci", "x-yang-type": "leafref", "readOnly": true }, "frCircuitIfIndex": { "type": "string", "description": "frCircuitIfIndex", "x-yang-type": "leafref", "readOnly": true } } }, "RFC1315-MIB_object-2": { "type": "object", "description": "object-2", "properties": { "frCircuitIfIndex": { "type": "string", "description": "frCircuitIfIndex", "x-yang-type": "leafref", "readOnly": true }, "frCircuitDlci": { "type": "string", "description": "frCircuitDlci", "x-yang-type": "leafref", "readOnly": true } } }, "RFC1315-MIB_object-3": { "type": "object", "description": "object-3", "properties": { "frCircuitIfIndex": { "type": "string", "description": "frCircuitIfIndex", "x-yang-type": "leafref", "readOnly": true }, "frCircuitDlci": { "type": "string", "description": "frCircuitDlci", "x-yang-type": "leafref", "readOnly": true }, "frCircuitState": { "type": "string", "description": "frCircuitState", "x-yang-type": "leafref", "readOnly": true } } }, "RFC1315-MIB_frDlcmiEntry": { "type": "array", "description": "The Parameters for a particular Data Link Con-\n nection Management Interface.", "items": { "type": "object", "properties": { "frDlcmiIfIndex": { "type": "string", "description": "The ifIndex value of the corresponding ifEn-\n try.", "x-yang-type": "RFC1315-MIB:Index", "readOnly": true }, "frDlcmiState": { "type": "string", "description": "This variable states which Data Link Connec-\n tion Management scheme is active (and by impli-\n cation, what DLCI it uses) on the Frame Relay\n interface.", "readOnly": true }, "frDlcmiAddress": { "type": "string", "description": "This variable states which address format is\n in use on the Frame Relay interface.", "readOnly": true }, "frDlcmiAddressLen": { "type": "string", "description": "This variable states which address length in\n octets. In the case of Q922 format, the length\n indicates the entire length of the address in-\n cluding the control portion.", "readOnly": true }, "frDlcmiPollingInterval": { "type": "integer", "description": "This is the number of seconds between succes-\n sive status enquiry messages.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frDlcmiFullEnquiryInterval": { "type": "integer", "description": "Number of status enquiry intervals that pass\n before issuance of a full status enquiry mes-\n sage.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frDlcmiErrorThreshold": { "type": "integer", "description": "This is the maximum number of unanswered\n Status Enquiries the equipment shall accept be-\n fore declaring the interface down.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frDlcmiMonitoredEvents": { "type": "integer", "description": "This is the number of status polling intervals\n over which the error threshold is counted. For\n example, if within 'MonitoredEvents' number of\n events the station receives 'ErrorThreshold'\n number of errors, the interface is marked as\n down.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frDlcmiMaxSupportedVCs": { "type": "integer", "description": "The maximum number of Virtual Circuits allowed\n for this interface. Usually dictated by the\n Frame Relay network.\n \n In response to a SET, if a value less than zero\n or higher than the agent's maximal capability\n is configured, the agent should respond bad-\n Value", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frDlcmiMulticast": { "type": "string", "description": "This indicates whether the Frame Relay inter-\n face is using a multicast service.", "readOnly": true } } } }, "RFC1315-MIB_frCircuitEntry": { "type": "array", "description": "The information regarding a single Data Link\n Connection Identifier.", "items": { "type": "object", "properties": { "frCircuitIfIndex": { "type": "string", "description": "The ifIndex Value of the ifEntry this virtual\n circuit is layered onto.", "x-yang-type": "RFC1315-MIB:Index", "readOnly": true }, "frCircuitDlci": { "type": "string", "description": "The Data Link Connection Identifier for this\n virtual circuit.", "x-yang-type": "RFC1315-MIB:DLCI", "readOnly": true }, "frCircuitState": { "type": "string", "description": "Indicates whether the particular virtual cir-\n cuit is operational. In the absence of a Data\n Link Connection Management Interface, virtual\n circuit entries (rows) may be created by set-\n ting virtual circuit state to 'active', or\n deleted by changing Circuit state to 'invalid'.\n Whether or not the row actually disappears is\n left to the implementation, so this object may\n actually read as 'invalid' for some arbitrary\n length of time. It is also legal to set the\n state of a virtual circuit to 'inactive' to\n temporarily disable a given circuit.", "readOnly": true }, "frCircuitReceivedFECNs": { "type": "integer", "description": "Number of frames received from the network in-\n dicating forward congestion since the virtual\n circuit was created.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitReceivedBECNs": { "type": "integer", "description": "Number of frames received from the network in-\n dicating backward congestion since the virtual\n circuit was created.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitSentFrames": { "type": "integer", "description": "The number of frames sent from this virtual\n circuit since it was created.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitSentOctets": { "type": "integer", "description": "The number of octets sent from this virtual\n circuit since it was created.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitReceivedFrames": { "type": "integer", "description": "Number of frames received over this virtual\n circuit since it was created.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitReceivedOctets": { "type": "integer", "description": "Number of octets received over this virtual\n circuit since it was created.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitCreationTime": { "type": "string", "description": "The value of sysUpTime when the virtual cir-\n cuit was created, whether by the Data Link Con-\n nection Management Interface or by a SetRe-\n quest.", "x-yang-type": "yang:timeticks", "readOnly": true }, "frCircuitLastTimeChange": { "type": "string", "description": "The value of sysUpTime when last there was a\n change in the virtual circuit state", "x-yang-type": "yang:timeticks", "readOnly": true }, "frCircuitCommittedBurst": { "type": "integer", "description": "This variable indicates the maximum amount of\n data, in bits, that the network agrees to\n transfer under normal conditions, during the\n measurement interval.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frCircuitExcessBurst": { "type": "integer", "description": "This variable indicates the maximum amount of\n uncommitted data bits that the network will at-\n tempt to deliver over the measurement interval.\n \n By default, if not configured when creating the\n entry, the Excess Information Burst Size is set\n to the value of ifSpeed.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frCircuitThroughput": { "type": "integer", "description": "Throughput is the average number of 'Frame Re-\n lay Information Field' bits transferred per\n second across a user network interface in one\n direction, measured over the measurement inter-\n val.\n \n If the configured committed burst rate and\n throughput are both non-zero, the measurement\n interval\n T=frCircuitCommittedBurst/frCircuitThroughput.\n \n If the configured committed burst rate and\n throughput are both zero, the measurement in-\n terval\n T=frCircuitExcessBurst/ifSpeed.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true } } } }, "RFC1315-MIB_frErrEntry": { "type": "array", "description": "The error information for a single frame relay\n interface.", "items": { "type": "object", "properties": { "frErrIfIndex": { "type": "string", "description": "The ifIndex Value of the corresponding ifEn-\n try.", "x-yang-type": "RFC1315-MIB:Index", "readOnly": true }, "frErrType": { "type": "string", "description": "The type of error that was last seen on this\n interface.", "readOnly": true }, "frErrData": { "type": "string", "description": "An octet string containing as much of the er-\n ror packet as possible. As a minimum, it must\n contain the Q.922 Address or as much as was\n delivered. It is desirable to include all in-\n formation up to the PDU.", "format": "binary", "readOnly": true }, "frErrTime": { "type": "string", "description": "The value of sysUpTime at which the error was\n detected.", "x-yang-type": "yang:timeticks", "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": "RFC1315-MIB", "description": "MIB operations for RFC1315-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }