{ "openapi": "3.0.0", "info": { "title": "FRAME-RELAY-DTE-MIB MIB API", "version": "1.0.0", "description": "The MIB module to describe the use of a Frame Relay\n interface by a DTE.\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 FRAME-RELAY-DTE-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/FRAME-RELAY-DTE-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "FRAME-RELAY-DTE-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/FRAME-RELAY-DTE-MIB:frameRelayTrapControl": { "get": { "summary": "Get frameRelayTrapControl data", "description": "Retrieve frameRelayTrapControl operational data from MIB", "tags": [ "FRAME-RELAY-DTE-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This variable indicates whether the system produces\n the frDLCIStatusChange trap.", "properties": { "frTrapState": { "type": "string", "description": "This variable indicates whether the system produces\n the frDLCIStatusChange trap." }, "frTrapMaxRate": { "type": "integer", "description": "This variable indicates the number of milliseconds\n that must elapse between trap emissions. If events\n occur more rapidly, the impementation may simply fail\n to trap, or may queue traps until an appropriate time.", "minimum": -2147483648, "maximum": 2147483647 } } }, "example": { "FRAME-RELAY-DTE-MIB:frameRelayTrapControl": { "frTrapState": "up(1)", "frTrapMaxRate": -2147483648 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-frameRelayTrapControl", "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": "/frameRelayTrapControl", "x-restconf-kind": "container" }, "/data/FRAME-RELAY-DTE-MIB:frDlcmiTable": { "get": { "summary": "Get frDlcmiTable data", "description": "Retrieve frDlcmiTable operational data from MIB", "tags": [ "FRAME-RELAY-DTE-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 Connection\n Management Interface.", "items": { "type": "object", "properties": { "frDlcmiIfIndex": { "type": "string", "description": "The ifIndex value of the corresponding ifEntry.", "x-yang-type": "if-mib:InterfaceIndex" }, "frDlcmiState": { "type": "string", "description": "This variable states which Data Link Connection\n Management scheme is active (and by implication, what\n DLCI it uses) on the Frame Relay interface." }, "frDlcmiAddress": { "type": "string", "description": "This variable states which address format is in use on\n the Frame Relay interface." }, "frDlcmiAddressLen": { "type": "string", "description": "This variable states the address length in octets. In\n the case of Q922 format, the length indicates the\n entire length of the address including the control\n portion." }, "frDlcmiPollingInterval": { "type": "integer", "description": "This is the number of seconds between successive\n status enquiry messages.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiFullEnquiryInterval": { "type": "integer", "description": "Number of status enquiry intervals that pass before\n issuance of a full status enquiry message.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiErrorThreshold": { "type": "integer", "description": "This is the maximum number of unanswered Status\n Enquiries the equipment shall accept before declaring\n the interface down.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiMonitoredEvents": { "type": "integer", "description": "This is the number of status polling intervals over\n which the error threshold is counted. For example, if\n within 'MonitoredEvents' number of events the station\n receives 'ErrorThreshold' number of errors, the\n interface is marked as down.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiMaxSupportedVCs": { "type": "string", "description": "The maximum number of Virtual Circuits allowed for\n this interface. Usually dictated by the Frame Relay\n network.\n \n In response to a SET, if a value less than zero or\n higher than the agent's maximal capability is\n configured, the agent should respond badValue", "x-yang-type": "FRAME-RELAY-DTE-MIB:DLCI" }, "frDlcmiMulticast": { "type": "string", "description": "This indicates whether the Frame Relay interface is\n using a multicast service." }, "frDlcmiStatus": { "type": "string", "description": "This indicates the status of the Frame Relay interface\n as determined by the performance of the dlcmi. If no\n dlcmi is running, the Frame Relay interface will stay\n in the running state indefinitely." }, "frDlcmiRowStatus": { "type": "string", "description": "SNMP Version 2 Row Status Variable. Writable objects\n in the table may be written in any RowStatus state.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "FRAME-RELAY-DTE-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": "example-string", "frDlcmiMulticast": "example-string", "frDlcmiStatus": "up(1)", "frDlcmiRowStatus": "up(1)" }, { "frDlcmiIfIndex": "2", "frDlcmiState": "up(1)", "frDlcmiAddress": "192.168.1.1", "frDlcmiAddressLen": "192.168.1.1", "frDlcmiPollingInterval": -2147483648, "frDlcmiFullEnquiryInterval": -2147483648, "frDlcmiErrorThreshold": -2147483648, "frDlcmiMonitoredEvents": -2147483648, "frDlcmiMaxSupportedVCs": "example-string", "frDlcmiMulticast": "example-string", "frDlcmiStatus": "up(1)", "frDlcmiRowStatus": "up(1)" }, { "frDlcmiIfIndex": "3", "frDlcmiState": "up(1)", "frDlcmiAddress": "192.168.1.1", "frDlcmiAddressLen": "192.168.1.1", "frDlcmiPollingInterval": -2147483648, "frDlcmiFullEnquiryInterval": -2147483648, "frDlcmiErrorThreshold": -2147483648, "frDlcmiMonitoredEvents": -2147483648, "frDlcmiMaxSupportedVCs": "example-string", "frDlcmiMulticast": "example-string", "frDlcmiStatus": "up(1)", "frDlcmiRowStatus": "up(1)" } ] } } } } }, "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/FRAME-RELAY-DTE-MIB:frDlcmiTable/frDlcmiEntry": { "get": { "summary": "Get frDlcmiEntry list", "description": "Retrieve list of frDlcmiEntry entries from MIB", "tags": [ "FRAME-RELAY-DTE-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "The Parameters for a particular Data Link Connection\n Management Interface.", "items": { "type": "object", "properties": { "frDlcmiIfIndex": { "type": "string", "description": "The ifIndex value of the corresponding ifEntry.", "x-yang-type": "if-mib:InterfaceIndex" }, "frDlcmiState": { "type": "string", "description": "This variable states which Data Link Connection\n Management scheme is active (and by implication, what\n DLCI it uses) on the Frame Relay interface." }, "frDlcmiAddress": { "type": "string", "description": "This variable states which address format is in use on\n the Frame Relay interface." }, "frDlcmiAddressLen": { "type": "string", "description": "This variable states the address length in octets. In\n the case of Q922 format, the length indicates the\n entire length of the address including the control\n portion." }, "frDlcmiPollingInterval": { "type": "integer", "description": "This is the number of seconds between successive\n status enquiry messages.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiFullEnquiryInterval": { "type": "integer", "description": "Number of status enquiry intervals that pass before\n issuance of a full status enquiry message.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiErrorThreshold": { "type": "integer", "description": "This is the maximum number of unanswered Status\n Enquiries the equipment shall accept before declaring\n the interface down.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiMonitoredEvents": { "type": "integer", "description": "This is the number of status polling intervals over\n which the error threshold is counted. For example, if\n within 'MonitoredEvents' number of events the station\n receives 'ErrorThreshold' number of errors, the\n interface is marked as down.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiMaxSupportedVCs": { "type": "string", "description": "The maximum number of Virtual Circuits allowed for\n this interface. Usually dictated by the Frame Relay\n network.\n \n In response to a SET, if a value less than zero or\n higher than the agent's maximal capability is\n configured, the agent should respond badValue", "x-yang-type": "FRAME-RELAY-DTE-MIB:DLCI" }, "frDlcmiMulticast": { "type": "string", "description": "This indicates whether the Frame Relay interface is\n using a multicast service." }, "frDlcmiStatus": { "type": "string", "description": "This indicates the status of the Frame Relay interface\n as determined by the performance of the dlcmi. If no\n dlcmi is running, the Frame Relay interface will stay\n in the running state indefinitely." }, "frDlcmiRowStatus": { "type": "string", "description": "SNMP Version 2 Row Status Variable. Writable objects\n in the table may be written in any RowStatus state.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "FRAME-RELAY-DTE-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": "example-string", "frDlcmiMulticast": "example-string", "frDlcmiStatus": "up(1)", "frDlcmiRowStatus": "up(1)" } ] } } } }, "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/FRAME-RELAY-DTE-MIB:frDlcmiTable/frDlcmiEntry={frDlcmiIfIndex}": { "get": { "summary": "Get frDlcmiEntry entry", "description": "Retrieve specific frDlcmiEntry entry by key from MIB", "tags": [ "FRAME-RELAY-DTE-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 ifEntry.", "x-yang-type": "if-mib:InterfaceIndex" }, "frDlcmiState": { "type": "string", "description": "This variable states which Data Link Connection\n Management scheme is active (and by implication, what\n DLCI it uses) on the Frame Relay interface." }, "frDlcmiAddress": { "type": "string", "description": "This variable states which address format is in use on\n the Frame Relay interface." }, "frDlcmiAddressLen": { "type": "string", "description": "This variable states the address length in octets. In\n the case of Q922 format, the length indicates the\n entire length of the address including the control\n portion." }, "frDlcmiPollingInterval": { "type": "integer", "description": "This is the number of seconds between successive\n status enquiry messages.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiFullEnquiryInterval": { "type": "integer", "description": "Number of status enquiry intervals that pass before\n issuance of a full status enquiry message.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiErrorThreshold": { "type": "integer", "description": "This is the maximum number of unanswered Status\n Enquiries the equipment shall accept before declaring\n the interface down.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiMonitoredEvents": { "type": "integer", "description": "This is the number of status polling intervals over\n which the error threshold is counted. For example, if\n within 'MonitoredEvents' number of events the station\n receives 'ErrorThreshold' number of errors, the\n interface is marked as down.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiMaxSupportedVCs": { "type": "string", "description": "The maximum number of Virtual Circuits allowed for\n this interface. Usually dictated by the Frame Relay\n network.\n \n In response to a SET, if a value less than zero or\n higher than the agent's maximal capability is\n configured, the agent should respond badValue", "x-yang-type": "FRAME-RELAY-DTE-MIB:DLCI" }, "frDlcmiMulticast": { "type": "string", "description": "This indicates whether the Frame Relay interface is\n using a multicast service." }, "frDlcmiStatus": { "type": "string", "description": "This indicates the status of the Frame Relay interface\n as determined by the performance of the dlcmi. If no\n dlcmi is running, the Frame Relay interface will stay\n in the running state indefinitely." }, "frDlcmiRowStatus": { "type": "string", "description": "SNMP Version 2 Row Status Variable. Writable objects\n in the table may be written in any RowStatus state.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "FRAME-RELAY-DTE-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": "example-string", "frDlcmiMulticast": "example-string", "frDlcmiStatus": "up(1)", "frDlcmiRowStatus": "up(1)" } } } } }, "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/FRAME-RELAY-DTE-MIB:frCircuitTable": { "get": { "summary": "Get frCircuitTable data", "description": "Retrieve frCircuitTable operational data from MIB", "tags": [ "FRAME-RELAY-DTE-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table containing information about specific Data\n Link Connections (DLC) or virtual circuits.", "properties": { "frCircuitEntry": { "type": "array", "description": "The information regarding a single Data Link\n Connection. Discontinuities in the counters contained\n in this table are indicated by the value in\n frCircuitCreationTime.", "items": { "type": "object", "properties": { "frCircuitIfIndex": { "type": "string", "description": "The ifIndex Value of the ifEntry this virtual circuit\n is layered onto.", "x-yang-type": "if-mib:InterfaceIndex" }, "frCircuitDlci": { "type": "string", "description": "The Data Link Connection Identifier for this virtual\n circuit.", "x-yang-type": "FRAME-RELAY-DTE-MIB:DLCI" }, "frCircuitState": { "type": "string", "description": "Indicates whether the particular virtual circuit is\n operational. In the absence of a Data Link Connection\n Management Interface, virtual circuit entries (rows)\n may be created by setting virtual circuit state to\n 'active', or deleted by changing Circuit state to\n 'invalid'.\n \n Whether or not the row actually disappears is left to\n the implementation, so this object may actually read as\n 'invalid' for some arbitrary length of time. It is\n also legal to set the state of a virtual circuit to\n 'inactive' to temporarily disable a given circuit.\n \n The use of 'invalid' is deprecated in this SNMP Version\n 2 MIB, in favor of frCircuitRowStatus." }, "frCircuitReceivedFECNs": { "type": "integer", "description": "Number of frames received from the network indicating\n forward congestion since the virtual circuit was\n created. This occurs when the remote DTE sets the FECN\n flag, or when a switch in the network enqueues the\n frame to a trunk whose transmission queue is\n congested.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedBECNs": { "type": "integer", "description": "Number of frames received from the network indicating\n backward congestion since the virtual circuit was\n created. This occurs when the remote DTE sets the BECN\n flag, or when a switch in the network receives the\n frame from a trunk whose transmission queue is\n congested.", "minimum": 0, "maximum": 4294967295 }, "frCircuitSentFrames": { "type": "integer", "description": "The number of frames sent from this virtual circuit\n since it was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitSentOctets": { "type": "integer", "description": "The number of octets sent from this virtual circuit\n since it was created. Octets counted are the full\n frame relay header and the payload, but do not include\n the flag characters or CRC.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedFrames": { "type": "integer", "description": "Number of frames received over this virtual circuit\n since it was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedOctets": { "type": "integer", "description": "Number of octets received over this virtual circuit\n since it was created. Octets counted include the full\n frame relay header, but do not include the flag\n characters or the CRC.", "minimum": 0, "maximum": 4294967295 }, "frCircuitCreationTime": { "type": "string", "description": "The value of sysUpTime when the virtual circuit was\n created, whether by the Data Link Connection Management\n Interface or by a SetRequest.", "x-yang-type": "yang:timestamp" }, "frCircuitLastTimeChange": { "type": "string", "description": "The value of sysUpTime when last there was a change in\n the virtual circuit state", "x-yang-type": "yang:timestamp" }, "frCircuitCommittedBurst": { "type": "integer", "description": "This variable indicates the maximum amount of data, in\n bits, that the network agrees to transfer under normal\n conditions, during the 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 attempt to\n deliver over the measurement interval.\n \n By default, if not configured when creating the entry,\n the Excess Information Burst Size is set to the value\n of ifSpeed.", "minimum": -2147483648, "maximum": 2147483647 }, "frCircuitThroughput": { "type": "integer", "description": "Throughput is the average number of 'Frame Relay\n Information Field' bits transferred per second across a\n user network interface in one direction, measured over\n the measurement interval.\n \n If the configured committed burst rate and throughput\n are both non-zero, the measurement interval, T, is\n T=frCircuitCommittedBurst/frCircuitThroughput.\n \n If the configured committed burst rate and throughput\n are both zero, the measurement interval, T, is\n T=frCircuitExcessBurst/ifSpeed.", "minimum": -2147483648, "maximum": 2147483647 }, "frCircuitMulticast": { "type": "string", "description": "This indicates whether this VC is used as a unicast VC\n (i.e. not multicast) or the type of multicast service\n subscribed to" }, "frCircuitType": { "type": "string", "description": "Indication of whether the VC was manually created\n (static), or dynamically created (dynamic) via the data\n link control management interface." }, "frCircuitDiscards": { "type": "integer", "description": "The number of inbound frames dropped because of format\n errors, or because the VC is inactive.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedDEs": { "type": "integer", "description": "Number of frames received from the network indicating\n that they were eligible for discard since the virtual\n circuit was created. This occurs when the remote DTE\n sets the DE flag, or when in remote DTE's switch\n detects that the frame was received as Excess Burst\n data.", "minimum": 0, "maximum": 4294967295 }, "frCircuitSentDEs": { "type": "integer", "description": "Number of frames sent to the network indicating that\n they were eligible for discard since the virtual\n circuit was created. This occurs when the local DTE\n sets the DE flag, indicating that during Network\n congestion situations those frames should be discarded\n in preference of other frames sent without the DE bit\n set.", "minimum": 0, "maximum": 4294967295 }, "frCircuitLogicalIfIndex": { "type": "string", "description": "Normally the same value as frDlcmiIfIndex, but\n different when an implementation associates a virtual\n ifEntry with a DLC or set of DLCs in order to associate\n higher layer objects such as the ipAddrEntry with a\n subset of the virtual circuits on a Frame Relay\n interface. The type of such ifEntries is defined by the\n higher layer object; for example, if PPP/Frame Relay is\n implemented, the ifType of this ifEntry would be PPP.\n If it is not so defined, as would be the case with an\n ipAddrEntry, it should be of type Other.", "x-yang-type": "if-mib:InterfaceIndex" }, "frCircuitRowStatus": { "type": "string", "description": "This object is used to create a new row or modify or\n destroy an existing row in the manner described in the\n definition of the RowStatus textual convention.\n Writable objects in the table may be written in any\n RowStatus state.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "FRAME-RELAY-DTE-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, "frCircuitMulticast": "example-string", "frCircuitType": "ethernetCsmacd(6)", "frCircuitDiscards": 0, "frCircuitReceivedDEs": 0, "frCircuitSentDEs": 0, "frCircuitLogicalIfIndex": "1", "frCircuitRowStatus": "up(1)" }, { "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, "frCircuitMulticast": "example-string", "frCircuitType": "ethernetCsmacd(6)", "frCircuitDiscards": 0, "frCircuitReceivedDEs": 0, "frCircuitSentDEs": 0, "frCircuitLogicalIfIndex": "2", "frCircuitRowStatus": "up(1)" }, { "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, "frCircuitMulticast": "example-string", "frCircuitType": "ethernetCsmacd(6)", "frCircuitDiscards": 0, "frCircuitReceivedDEs": 0, "frCircuitSentDEs": 0, "frCircuitLogicalIfIndex": "3", "frCircuitRowStatus": "up(1)" } ] } } } } }, "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/FRAME-RELAY-DTE-MIB:frCircuitTable/frCircuitEntry": { "get": { "summary": "Get frCircuitEntry list", "description": "Retrieve list of frCircuitEntry entries from MIB", "tags": [ "FRAME-RELAY-DTE-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "The information regarding a single Data Link\n Connection. Discontinuities in the counters contained\n in this table are indicated by the value in\n frCircuitCreationTime.", "items": { "type": "object", "properties": { "frCircuitIfIndex": { "type": "string", "description": "The ifIndex Value of the ifEntry this virtual circuit\n is layered onto.", "x-yang-type": "if-mib:InterfaceIndex" }, "frCircuitDlci": { "type": "string", "description": "The Data Link Connection Identifier for this virtual\n circuit.", "x-yang-type": "FRAME-RELAY-DTE-MIB:DLCI" }, "frCircuitState": { "type": "string", "description": "Indicates whether the particular virtual circuit is\n operational. In the absence of a Data Link Connection\n Management Interface, virtual circuit entries (rows)\n may be created by setting virtual circuit state to\n 'active', or deleted by changing Circuit state to\n 'invalid'.\n \n Whether or not the row actually disappears is left to\n the implementation, so this object may actually read as\n 'invalid' for some arbitrary length of time. It is\n also legal to set the state of a virtual circuit to\n 'inactive' to temporarily disable a given circuit.\n \n The use of 'invalid' is deprecated in this SNMP Version\n 2 MIB, in favor of frCircuitRowStatus." }, "frCircuitReceivedFECNs": { "type": "integer", "description": "Number of frames received from the network indicating\n forward congestion since the virtual circuit was\n created. This occurs when the remote DTE sets the FECN\n flag, or when a switch in the network enqueues the\n frame to a trunk whose transmission queue is\n congested.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedBECNs": { "type": "integer", "description": "Number of frames received from the network indicating\n backward congestion since the virtual circuit was\n created. This occurs when the remote DTE sets the BECN\n flag, or when a switch in the network receives the\n frame from a trunk whose transmission queue is\n congested.", "minimum": 0, "maximum": 4294967295 }, "frCircuitSentFrames": { "type": "integer", "description": "The number of frames sent from this virtual circuit\n since it was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitSentOctets": { "type": "integer", "description": "The number of octets sent from this virtual circuit\n since it was created. Octets counted are the full\n frame relay header and the payload, but do not include\n the flag characters or CRC.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedFrames": { "type": "integer", "description": "Number of frames received over this virtual circuit\n since it was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedOctets": { "type": "integer", "description": "Number of octets received over this virtual circuit\n since it was created. Octets counted include the full\n frame relay header, but do not include the flag\n characters or the CRC.", "minimum": 0, "maximum": 4294967295 }, "frCircuitCreationTime": { "type": "string", "description": "The value of sysUpTime when the virtual circuit was\n created, whether by the Data Link Connection Management\n Interface or by a SetRequest.", "x-yang-type": "yang:timestamp" }, "frCircuitLastTimeChange": { "type": "string", "description": "The value of sysUpTime when last there was a change in\n the virtual circuit state", "x-yang-type": "yang:timestamp" }, "frCircuitCommittedBurst": { "type": "integer", "description": "This variable indicates the maximum amount of data, in\n bits, that the network agrees to transfer under normal\n conditions, during the 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 attempt to\n deliver over the measurement interval.\n \n By default, if not configured when creating the entry,\n the Excess Information Burst Size is set to the value\n of ifSpeed.", "minimum": -2147483648, "maximum": 2147483647 }, "frCircuitThroughput": { "type": "integer", "description": "Throughput is the average number of 'Frame Relay\n Information Field' bits transferred per second across a\n user network interface in one direction, measured over\n the measurement interval.\n \n If the configured committed burst rate and throughput\n are both non-zero, the measurement interval, T, is\n T=frCircuitCommittedBurst/frCircuitThroughput.\n \n If the configured committed burst rate and throughput\n are both zero, the measurement interval, T, is\n T=frCircuitExcessBurst/ifSpeed.", "minimum": -2147483648, "maximum": 2147483647 }, "frCircuitMulticast": { "type": "string", "description": "This indicates whether this VC is used as a unicast VC\n (i.e. not multicast) or the type of multicast service\n subscribed to" }, "frCircuitType": { "type": "string", "description": "Indication of whether the VC was manually created\n (static), or dynamically created (dynamic) via the data\n link control management interface." }, "frCircuitDiscards": { "type": "integer", "description": "The number of inbound frames dropped because of format\n errors, or because the VC is inactive.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedDEs": { "type": "integer", "description": "Number of frames received from the network indicating\n that they were eligible for discard since the virtual\n circuit was created. This occurs when the remote DTE\n sets the DE flag, or when in remote DTE's switch\n detects that the frame was received as Excess Burst\n data.", "minimum": 0, "maximum": 4294967295 }, "frCircuitSentDEs": { "type": "integer", "description": "Number of frames sent to the network indicating that\n they were eligible for discard since the virtual\n circuit was created. This occurs when the local DTE\n sets the DE flag, indicating that during Network\n congestion situations those frames should be discarded\n in preference of other frames sent without the DE bit\n set.", "minimum": 0, "maximum": 4294967295 }, "frCircuitLogicalIfIndex": { "type": "string", "description": "Normally the same value as frDlcmiIfIndex, but\n different when an implementation associates a virtual\n ifEntry with a DLC or set of DLCs in order to associate\n higher layer objects such as the ipAddrEntry with a\n subset of the virtual circuits on a Frame Relay\n interface. The type of such ifEntries is defined by the\n higher layer object; for example, if PPP/Frame Relay is\n implemented, the ifType of this ifEntry would be PPP.\n If it is not so defined, as would be the case with an\n ipAddrEntry, it should be of type Other.", "x-yang-type": "if-mib:InterfaceIndex" }, "frCircuitRowStatus": { "type": "string", "description": "This object is used to create a new row or modify or\n destroy an existing row in the manner described in the\n definition of the RowStatus textual convention.\n Writable objects in the table may be written in any\n RowStatus state.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "FRAME-RELAY-DTE-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, "frCircuitMulticast": "example-string", "frCircuitType": "ethernetCsmacd(6)", "frCircuitDiscards": 0, "frCircuitReceivedDEs": 0, "frCircuitSentDEs": 0, "frCircuitLogicalIfIndex": "example-string", "frCircuitRowStatus": "up(1)" } ] } } } }, "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/FRAME-RELAY-DTE-MIB:frErrTable": { "get": { "summary": "Get frErrTable data", "description": "Retrieve frErrTable operational data from MIB", "tags": [ "FRAME-RELAY-DTE-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. Discontinuities in the counters\n contained in this table are the same as apply to the\n ifEntry associated with the 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 ifEntry.", "x-yang-type": "if-mib:InterfaceIndex" }, "frErrType": { "type": "string", "description": "The type of error that was last seen on this interface:\n \n receiveShort: frame was not long enough to allow\n demultiplexing - the address field was incomplete,\n or for virtual circuits using Multiprotocol over\n Frame Relay, the protocol identifier was missing\n or incomplete.\n \n receiveLong: frame exceeded maximum length configured for this\n interface.\n \n illegalAddress: address field did not match configured format.\n \n unknownAddress: frame received on a virtual circuit which was not\n active or administratively disabled.\n \n dlcmiProtoErr: unspecified error occurred when attempting to\n interpret link maintenance frame.\n \n dlcmiUnknownIE: link maintenance frame contained an Information\n Element type which is not valid for the\n configured link maintenance protocol.\n \n dlcmiSequenceErr: link maintenance frame contained a sequence\n number other than the expected value.\n \n dlcmiUnknownRpt: link maintenance frame contained a Report Type\n Information Element whose value was not valid\n for the configured link maintenance protocol.\n \n noErrorSinceReset: no errors have been detected since the last\n cold start or warm start." }, "frErrData": { "type": "string", "description": "An octet string containing as much of the error packet\n as possible. As a minimum, it must contain the Q.922\n Address or as much as was delivered. It is desirable\n to include all header and demultiplexing information.", "format": "binary" }, "frErrTime": { "type": "string", "description": "The value of sysUpTime at which the error was\n detected.", "x-yang-type": "yang:timestamp" }, "frErrFaults": { "type": "integer", "description": "The number of times the interface has gone down since\n it was initialized.", "minimum": 0, "maximum": 4294967295 }, "frErrFaultTime": { "type": "string", "description": "The value of sysUpTime at the time when the interface\n was taken down due to excessive errors. Excessive\n errors is defined as the time when a DLCMI exceeds the\n frDlcmiErrorThreshold number of errors within\n frDlcmiMonitoredEvents. See FrDlcmiEntry for further\n details.", "x-yang-type": "yang:timestamp" } } } } } }, "example": { "FRAME-RELAY-DTE-MIB:frErrTable": { "frErrEntry": [ { "frErrIfIndex": "1", "frErrType": "ethernetCsmacd(6)", "frErrData": "example-string", "frErrTime": "example-string", "frErrFaults": 0, "frErrFaultTime": "example-string" }, { "frErrIfIndex": "2", "frErrType": "ethernetCsmacd(6)", "frErrData": "example-string", "frErrTime": "example-string", "frErrFaults": 0, "frErrFaultTime": "example-string" }, { "frErrIfIndex": "3", "frErrType": "ethernetCsmacd(6)", "frErrData": "example-string", "frErrTime": "example-string", "frErrFaults": 0, "frErrFaultTime": "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/FRAME-RELAY-DTE-MIB:frErrTable/frErrEntry": { "get": { "summary": "Get frErrEntry list", "description": "Retrieve list of frErrEntry entries from MIB", "tags": [ "FRAME-RELAY-DTE-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 ifEntry.", "x-yang-type": "if-mib:InterfaceIndex" }, "frErrType": { "type": "string", "description": "The type of error that was last seen on this interface:\n \n receiveShort: frame was not long enough to allow\n demultiplexing - the address field was incomplete,\n or for virtual circuits using Multiprotocol over\n Frame Relay, the protocol identifier was missing\n or incomplete.\n \n receiveLong: frame exceeded maximum length configured for this\n interface.\n \n illegalAddress: address field did not match configured format.\n \n unknownAddress: frame received on a virtual circuit which was not\n active or administratively disabled.\n \n dlcmiProtoErr: unspecified error occurred when attempting to\n interpret link maintenance frame.\n \n dlcmiUnknownIE: link maintenance frame contained an Information\n Element type which is not valid for the\n configured link maintenance protocol.\n \n dlcmiSequenceErr: link maintenance frame contained a sequence\n number other than the expected value.\n \n dlcmiUnknownRpt: link maintenance frame contained a Report Type\n Information Element whose value was not valid\n for the configured link maintenance protocol.\n \n noErrorSinceReset: no errors have been detected since the last\n cold start or warm start." }, "frErrData": { "type": "string", "description": "An octet string containing as much of the error packet\n as possible. As a minimum, it must contain the Q.922\n Address or as much as was delivered. It is desirable\n to include all header and demultiplexing information.", "format": "binary" }, "frErrTime": { "type": "string", "description": "The value of sysUpTime at which the error was\n detected.", "x-yang-type": "yang:timestamp" }, "frErrFaults": { "type": "integer", "description": "The number of times the interface has gone down since\n it was initialized.", "minimum": 0, "maximum": 4294967295 }, "frErrFaultTime": { "type": "string", "description": "The value of sysUpTime at the time when the interface\n was taken down due to excessive errors. Excessive\n errors is defined as the time when a DLCMI exceeds the\n frDlcmiErrorThreshold number of errors within\n frDlcmiMonitoredEvents. See FrDlcmiEntry for further\n details.", "x-yang-type": "yang:timestamp" } } } }, "example": { "FRAME-RELAY-DTE-MIB:frErrEntry": [ { "frErrIfIndex": "example-string", "frErrType": "ethernetCsmacd(6)", "frErrData": "example-string", "frErrTime": "example-string", "frErrFaults": 0, "frErrFaultTime": "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/FRAME-RELAY-DTE-MIB:frErrTable/frErrEntry={frErrIfIndex}": { "get": { "summary": "Get frErrEntry entry", "description": "Retrieve specific frErrEntry entry by key from MIB", "tags": [ "FRAME-RELAY-DTE-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 ifEntry.", "x-yang-type": "if-mib:InterfaceIndex" }, "frErrType": { "type": "string", "description": "The type of error that was last seen on this interface:\n \n receiveShort: frame was not long enough to allow\n demultiplexing - the address field was incomplete,\n or for virtual circuits using Multiprotocol over\n Frame Relay, the protocol identifier was missing\n or incomplete.\n \n receiveLong: frame exceeded maximum length configured for this\n interface.\n \n illegalAddress: address field did not match configured format.\n \n unknownAddress: frame received on a virtual circuit which was not\n active or administratively disabled.\n \n dlcmiProtoErr: unspecified error occurred when attempting to\n interpret link maintenance frame.\n \n dlcmiUnknownIE: link maintenance frame contained an Information\n Element type which is not valid for the\n configured link maintenance protocol.\n \n dlcmiSequenceErr: link maintenance frame contained a sequence\n number other than the expected value.\n \n dlcmiUnknownRpt: link maintenance frame contained a Report Type\n Information Element whose value was not valid\n for the configured link maintenance protocol.\n \n noErrorSinceReset: no errors have been detected since the last\n cold start or warm start." }, "frErrData": { "type": "string", "description": "An octet string containing as much of the error packet\n as possible. As a minimum, it must contain the Q.922\n Address or as much as was delivered. It is desirable\n to include all header and demultiplexing information.", "format": "binary" }, "frErrTime": { "type": "string", "description": "The value of sysUpTime at which the error was\n detected.", "x-yang-type": "yang:timestamp" }, "frErrFaults": { "type": "integer", "description": "The number of times the interface has gone down since\n it was initialized.", "minimum": 0, "maximum": 4294967295 }, "frErrFaultTime": { "type": "string", "description": "The value of sysUpTime at the time when the interface\n was taken down due to excessive errors. Excessive\n errors is defined as the time when a DLCMI exceeds the\n frDlcmiErrorThreshold number of errors within\n frDlcmiMonitoredEvents. See FrDlcmiEntry for further\n details.", "x-yang-type": "yang:timestamp" } } }, "example": { "FRAME-RELAY-DTE-MIB:frErrEntry": { "frErrIfIndex": "example-string", "frErrType": "ethernetCsmacd(6)", "frErrData": "example-string", "frErrTime": "example-string", "frErrFaults": 0, "frErrFaultTime": "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/FRAME-RELAY-DTE-MIB:frDlcmiEntry": { "get": { "summary": "Get frDlcmiEntry list", "description": "Retrieve list of frDlcmiEntry entries from MIB", "tags": [ "FRAME-RELAY-DTE-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "The Parameters for a particular Data Link Connection\n Management Interface.", "items": { "type": "object", "properties": { "frDlcmiIfIndex": { "type": "string", "description": "The ifIndex value of the corresponding ifEntry.", "x-yang-type": "if-mib:InterfaceIndex" }, "frDlcmiState": { "type": "string", "description": "This variable states which Data Link Connection\n Management scheme is active (and by implication, what\n DLCI it uses) on the Frame Relay interface." }, "frDlcmiAddress": { "type": "string", "description": "This variable states which address format is in use on\n the Frame Relay interface." }, "frDlcmiAddressLen": { "type": "string", "description": "This variable states the address length in octets. In\n the case of Q922 format, the length indicates the\n entire length of the address including the control\n portion." }, "frDlcmiPollingInterval": { "type": "integer", "description": "This is the number of seconds between successive\n status enquiry messages.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiFullEnquiryInterval": { "type": "integer", "description": "Number of status enquiry intervals that pass before\n issuance of a full status enquiry message.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiErrorThreshold": { "type": "integer", "description": "This is the maximum number of unanswered Status\n Enquiries the equipment shall accept before declaring\n the interface down.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiMonitoredEvents": { "type": "integer", "description": "This is the number of status polling intervals over\n which the error threshold is counted. For example, if\n within 'MonitoredEvents' number of events the station\n receives 'ErrorThreshold' number of errors, the\n interface is marked as down.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiMaxSupportedVCs": { "type": "string", "description": "The maximum number of Virtual Circuits allowed for\n this interface. Usually dictated by the Frame Relay\n network.\n \n In response to a SET, if a value less than zero or\n higher than the agent's maximal capability is\n configured, the agent should respond badValue", "x-yang-type": "FRAME-RELAY-DTE-MIB:DLCI" }, "frDlcmiMulticast": { "type": "string", "description": "This indicates whether the Frame Relay interface is\n using a multicast service." }, "frDlcmiStatus": { "type": "string", "description": "This indicates the status of the Frame Relay interface\n as determined by the performance of the dlcmi. If no\n dlcmi is running, the Frame Relay interface will stay\n in the running state indefinitely." }, "frDlcmiRowStatus": { "type": "string", "description": "SNMP Version 2 Row Status Variable. Writable objects\n in the table may be written in any RowStatus state.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "FRAME-RELAY-DTE-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": "example-string", "frDlcmiMulticast": "example-string", "frDlcmiStatus": "up(1)", "frDlcmiRowStatus": "up(1)" } ] } } } }, "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/FRAME-RELAY-DTE-MIB:frDlcmiEntry={frDlcmiIfIndex}": { "get": { "summary": "Get frDlcmiEntry entry", "description": "Retrieve specific frDlcmiEntry entry by key from MIB", "tags": [ "FRAME-RELAY-DTE-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 ifEntry.", "x-yang-type": "if-mib:InterfaceIndex" }, "frDlcmiState": { "type": "string", "description": "This variable states which Data Link Connection\n Management scheme is active (and by implication, what\n DLCI it uses) on the Frame Relay interface." }, "frDlcmiAddress": { "type": "string", "description": "This variable states which address format is in use on\n the Frame Relay interface." }, "frDlcmiAddressLen": { "type": "string", "description": "This variable states the address length in octets. In\n the case of Q922 format, the length indicates the\n entire length of the address including the control\n portion." }, "frDlcmiPollingInterval": { "type": "integer", "description": "This is the number of seconds between successive\n status enquiry messages.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiFullEnquiryInterval": { "type": "integer", "description": "Number of status enquiry intervals that pass before\n issuance of a full status enquiry message.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiErrorThreshold": { "type": "integer", "description": "This is the maximum number of unanswered Status\n Enquiries the equipment shall accept before declaring\n the interface down.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiMonitoredEvents": { "type": "integer", "description": "This is the number of status polling intervals over\n which the error threshold is counted. For example, if\n within 'MonitoredEvents' number of events the station\n receives 'ErrorThreshold' number of errors, the\n interface is marked as down.", "minimum": -2147483648, "maximum": 2147483647 }, "frDlcmiMaxSupportedVCs": { "type": "string", "description": "The maximum number of Virtual Circuits allowed for\n this interface. Usually dictated by the Frame Relay\n network.\n \n In response to a SET, if a value less than zero or\n higher than the agent's maximal capability is\n configured, the agent should respond badValue", "x-yang-type": "FRAME-RELAY-DTE-MIB:DLCI" }, "frDlcmiMulticast": { "type": "string", "description": "This indicates whether the Frame Relay interface is\n using a multicast service." }, "frDlcmiStatus": { "type": "string", "description": "This indicates the status of the Frame Relay interface\n as determined by the performance of the dlcmi. If no\n dlcmi is running, the Frame Relay interface will stay\n in the running state indefinitely." }, "frDlcmiRowStatus": { "type": "string", "description": "SNMP Version 2 Row Status Variable. Writable objects\n in the table may be written in any RowStatus state.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "FRAME-RELAY-DTE-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": "example-string", "frDlcmiMulticast": "example-string", "frDlcmiStatus": "up(1)", "frDlcmiRowStatus": "up(1)" } } } } }, "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/FRAME-RELAY-DTE-MIB:frCircuitEntry": { "get": { "summary": "Get frCircuitEntry list", "description": "Retrieve list of frCircuitEntry entries from MIB", "tags": [ "FRAME-RELAY-DTE-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "The information regarding a single Data Link\n Connection. Discontinuities in the counters contained\n in this table are indicated by the value in\n frCircuitCreationTime.", "items": { "type": "object", "properties": { "frCircuitIfIndex": { "type": "string", "description": "The ifIndex Value of the ifEntry this virtual circuit\n is layered onto.", "x-yang-type": "if-mib:InterfaceIndex" }, "frCircuitDlci": { "type": "string", "description": "The Data Link Connection Identifier for this virtual\n circuit.", "x-yang-type": "FRAME-RELAY-DTE-MIB:DLCI" }, "frCircuitState": { "type": "string", "description": "Indicates whether the particular virtual circuit is\n operational. In the absence of a Data Link Connection\n Management Interface, virtual circuit entries (rows)\n may be created by setting virtual circuit state to\n 'active', or deleted by changing Circuit state to\n 'invalid'.\n \n Whether or not the row actually disappears is left to\n the implementation, so this object may actually read as\n 'invalid' for some arbitrary length of time. It is\n also legal to set the state of a virtual circuit to\n 'inactive' to temporarily disable a given circuit.\n \n The use of 'invalid' is deprecated in this SNMP Version\n 2 MIB, in favor of frCircuitRowStatus." }, "frCircuitReceivedFECNs": { "type": "integer", "description": "Number of frames received from the network indicating\n forward congestion since the virtual circuit was\n created. This occurs when the remote DTE sets the FECN\n flag, or when a switch in the network enqueues the\n frame to a trunk whose transmission queue is\n congested.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedBECNs": { "type": "integer", "description": "Number of frames received from the network indicating\n backward congestion since the virtual circuit was\n created. This occurs when the remote DTE sets the BECN\n flag, or when a switch in the network receives the\n frame from a trunk whose transmission queue is\n congested.", "minimum": 0, "maximum": 4294967295 }, "frCircuitSentFrames": { "type": "integer", "description": "The number of frames sent from this virtual circuit\n since it was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitSentOctets": { "type": "integer", "description": "The number of octets sent from this virtual circuit\n since it was created. Octets counted are the full\n frame relay header and the payload, but do not include\n the flag characters or CRC.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedFrames": { "type": "integer", "description": "Number of frames received over this virtual circuit\n since it was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedOctets": { "type": "integer", "description": "Number of octets received over this virtual circuit\n since it was created. Octets counted include the full\n frame relay header, but do not include the flag\n characters or the CRC.", "minimum": 0, "maximum": 4294967295 }, "frCircuitCreationTime": { "type": "string", "description": "The value of sysUpTime when the virtual circuit was\n created, whether by the Data Link Connection Management\n Interface or by a SetRequest.", "x-yang-type": "yang:timestamp" }, "frCircuitLastTimeChange": { "type": "string", "description": "The value of sysUpTime when last there was a change in\n the virtual circuit state", "x-yang-type": "yang:timestamp" }, "frCircuitCommittedBurst": { "type": "integer", "description": "This variable indicates the maximum amount of data, in\n bits, that the network agrees to transfer under normal\n conditions, during the 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 attempt to\n deliver over the measurement interval.\n \n By default, if not configured when creating the entry,\n the Excess Information Burst Size is set to the value\n of ifSpeed.", "minimum": -2147483648, "maximum": 2147483647 }, "frCircuitThroughput": { "type": "integer", "description": "Throughput is the average number of 'Frame Relay\n Information Field' bits transferred per second across a\n user network interface in one direction, measured over\n the measurement interval.\n \n If the configured committed burst rate and throughput\n are both non-zero, the measurement interval, T, is\n T=frCircuitCommittedBurst/frCircuitThroughput.\n \n If the configured committed burst rate and throughput\n are both zero, the measurement interval, T, is\n T=frCircuitExcessBurst/ifSpeed.", "minimum": -2147483648, "maximum": 2147483647 }, "frCircuitMulticast": { "type": "string", "description": "This indicates whether this VC is used as a unicast VC\n (i.e. not multicast) or the type of multicast service\n subscribed to" }, "frCircuitType": { "type": "string", "description": "Indication of whether the VC was manually created\n (static), or dynamically created (dynamic) via the data\n link control management interface." }, "frCircuitDiscards": { "type": "integer", "description": "The number of inbound frames dropped because of format\n errors, or because the VC is inactive.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedDEs": { "type": "integer", "description": "Number of frames received from the network indicating\n that they were eligible for discard since the virtual\n circuit was created. This occurs when the remote DTE\n sets the DE flag, or when in remote DTE's switch\n detects that the frame was received as Excess Burst\n data.", "minimum": 0, "maximum": 4294967295 }, "frCircuitSentDEs": { "type": "integer", "description": "Number of frames sent to the network indicating that\n they were eligible for discard since the virtual\n circuit was created. This occurs when the local DTE\n sets the DE flag, indicating that during Network\n congestion situations those frames should be discarded\n in preference of other frames sent without the DE bit\n set.", "minimum": 0, "maximum": 4294967295 }, "frCircuitLogicalIfIndex": { "type": "string", "description": "Normally the same value as frDlcmiIfIndex, but\n different when an implementation associates a virtual\n ifEntry with a DLC or set of DLCs in order to associate\n higher layer objects such as the ipAddrEntry with a\n subset of the virtual circuits on a Frame Relay\n interface. The type of such ifEntries is defined by the\n higher layer object; for example, if PPP/Frame Relay is\n implemented, the ifType of this ifEntry would be PPP.\n If it is not so defined, as would be the case with an\n ipAddrEntry, it should be of type Other.", "x-yang-type": "if-mib:InterfaceIndex" }, "frCircuitRowStatus": { "type": "string", "description": "This object is used to create a new row or modify or\n destroy an existing row in the manner described in the\n definition of the RowStatus textual convention.\n Writable objects in the table may be written in any\n RowStatus state.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "FRAME-RELAY-DTE-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, "frCircuitMulticast": "example-string", "frCircuitType": "ethernetCsmacd(6)", "frCircuitDiscards": 0, "frCircuitReceivedDEs": 0, "frCircuitSentDEs": 0, "frCircuitLogicalIfIndex": "example-string", "frCircuitRowStatus": "up(1)" } ] } } } }, "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/FRAME-RELAY-DTE-MIB:frErrEntry": { "get": { "summary": "Get frErrEntry list", "description": "Retrieve list of frErrEntry entries from MIB", "tags": [ "FRAME-RELAY-DTE-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 ifEntry.", "x-yang-type": "if-mib:InterfaceIndex" }, "frErrType": { "type": "string", "description": "The type of error that was last seen on this interface:\n \n receiveShort: frame was not long enough to allow\n demultiplexing - the address field was incomplete,\n or for virtual circuits using Multiprotocol over\n Frame Relay, the protocol identifier was missing\n or incomplete.\n \n receiveLong: frame exceeded maximum length configured for this\n interface.\n \n illegalAddress: address field did not match configured format.\n \n unknownAddress: frame received on a virtual circuit which was not\n active or administratively disabled.\n \n dlcmiProtoErr: unspecified error occurred when attempting to\n interpret link maintenance frame.\n \n dlcmiUnknownIE: link maintenance frame contained an Information\n Element type which is not valid for the\n configured link maintenance protocol.\n \n dlcmiSequenceErr: link maintenance frame contained a sequence\n number other than the expected value.\n \n dlcmiUnknownRpt: link maintenance frame contained a Report Type\n Information Element whose value was not valid\n for the configured link maintenance protocol.\n \n noErrorSinceReset: no errors have been detected since the last\n cold start or warm start." }, "frErrData": { "type": "string", "description": "An octet string containing as much of the error packet\n as possible. As a minimum, it must contain the Q.922\n Address or as much as was delivered. It is desirable\n to include all header and demultiplexing information.", "format": "binary" }, "frErrTime": { "type": "string", "description": "The value of sysUpTime at which the error was\n detected.", "x-yang-type": "yang:timestamp" }, "frErrFaults": { "type": "integer", "description": "The number of times the interface has gone down since\n it was initialized.", "minimum": 0, "maximum": 4294967295 }, "frErrFaultTime": { "type": "string", "description": "The value of sysUpTime at the time when the interface\n was taken down due to excessive errors. Excessive\n errors is defined as the time when a DLCMI exceeds the\n frDlcmiErrorThreshold number of errors within\n frDlcmiMonitoredEvents. See FrDlcmiEntry for further\n details.", "x-yang-type": "yang:timestamp" } } } }, "example": { "FRAME-RELAY-DTE-MIB:frErrEntry": [ { "frErrIfIndex": "example-string", "frErrType": "ethernetCsmacd(6)", "frErrData": "example-string", "frErrTime": "example-string", "frErrFaults": 0, "frErrFaultTime": "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/FRAME-RELAY-DTE-MIB:frErrEntry={frErrIfIndex}": { "get": { "summary": "Get frErrEntry entry", "description": "Retrieve specific frErrEntry entry by key from MIB", "tags": [ "FRAME-RELAY-DTE-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 ifEntry.", "x-yang-type": "if-mib:InterfaceIndex" }, "frErrType": { "type": "string", "description": "The type of error that was last seen on this interface:\n \n receiveShort: frame was not long enough to allow\n demultiplexing - the address field was incomplete,\n or for virtual circuits using Multiprotocol over\n Frame Relay, the protocol identifier was missing\n or incomplete.\n \n receiveLong: frame exceeded maximum length configured for this\n interface.\n \n illegalAddress: address field did not match configured format.\n \n unknownAddress: frame received on a virtual circuit which was not\n active or administratively disabled.\n \n dlcmiProtoErr: unspecified error occurred when attempting to\n interpret link maintenance frame.\n \n dlcmiUnknownIE: link maintenance frame contained an Information\n Element type which is not valid for the\n configured link maintenance protocol.\n \n dlcmiSequenceErr: link maintenance frame contained a sequence\n number other than the expected value.\n \n dlcmiUnknownRpt: link maintenance frame contained a Report Type\n Information Element whose value was not valid\n for the configured link maintenance protocol.\n \n noErrorSinceReset: no errors have been detected since the last\n cold start or warm start." }, "frErrData": { "type": "string", "description": "An octet string containing as much of the error packet\n as possible. As a minimum, it must contain the Q.922\n Address or as much as was delivered. It is desirable\n to include all header and demultiplexing information.", "format": "binary" }, "frErrTime": { "type": "string", "description": "The value of sysUpTime at which the error was\n detected.", "x-yang-type": "yang:timestamp" }, "frErrFaults": { "type": "integer", "description": "The number of times the interface has gone down since\n it was initialized.", "minimum": 0, "maximum": 4294967295 }, "frErrFaultTime": { "type": "string", "description": "The value of sysUpTime at the time when the interface\n was taken down due to excessive errors. Excessive\n errors is defined as the time when a DLCMI exceeds the\n frDlcmiErrorThreshold number of errors within\n frDlcmiMonitoredEvents. See FrDlcmiEntry for further\n details.", "x-yang-type": "yang:timestamp" } } }, "example": { "FRAME-RELAY-DTE-MIB:frErrEntry": { "frErrIfIndex": "example-string", "frErrType": "ethernetCsmacd(6)", "frErrData": "example-string", "frErrTime": "example-string", "frErrFaults": 0, "frErrFaultTime": "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/FRAME-RELAY-DTE-MIB:frCircuitTable/frCircuitEntry={frCircuitIfIndex},{frCircuitDlci}": { "get": { "summary": "Get frCircuitEntry entry", "description": "Retrieve specific frCircuitEntry entry by key from MIB", "tags": [ "FRAME-RELAY-DTE-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 circuit\n is layered onto.", "x-yang-type": "if-mib:InterfaceIndex" }, "frCircuitDlci": { "type": "string", "description": "The Data Link Connection Identifier for this virtual\n circuit.", "x-yang-type": "FRAME-RELAY-DTE-MIB:DLCI" }, "frCircuitState": { "type": "string", "description": "Indicates whether the particular virtual circuit is\n operational. In the absence of a Data Link Connection\n Management Interface, virtual circuit entries (rows)\n may be created by setting virtual circuit state to\n 'active', or deleted by changing Circuit state to\n 'invalid'.\n \n Whether or not the row actually disappears is left to\n the implementation, so this object may actually read as\n 'invalid' for some arbitrary length of time. It is\n also legal to set the state of a virtual circuit to\n 'inactive' to temporarily disable a given circuit.\n \n The use of 'invalid' is deprecated in this SNMP Version\n 2 MIB, in favor of frCircuitRowStatus." }, "frCircuitReceivedFECNs": { "type": "integer", "description": "Number of frames received from the network indicating\n forward congestion since the virtual circuit was\n created. This occurs when the remote DTE sets the FECN\n flag, or when a switch in the network enqueues the\n frame to a trunk whose transmission queue is\n congested.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedBECNs": { "type": "integer", "description": "Number of frames received from the network indicating\n backward congestion since the virtual circuit was\n created. This occurs when the remote DTE sets the BECN\n flag, or when a switch in the network receives the\n frame from a trunk whose transmission queue is\n congested.", "minimum": 0, "maximum": 4294967295 }, "frCircuitSentFrames": { "type": "integer", "description": "The number of frames sent from this virtual circuit\n since it was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitSentOctets": { "type": "integer", "description": "The number of octets sent from this virtual circuit\n since it was created. Octets counted are the full\n frame relay header and the payload, but do not include\n the flag characters or CRC.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedFrames": { "type": "integer", "description": "Number of frames received over this virtual circuit\n since it was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedOctets": { "type": "integer", "description": "Number of octets received over this virtual circuit\n since it was created. Octets counted include the full\n frame relay header, but do not include the flag\n characters or the CRC.", "minimum": 0, "maximum": 4294967295 }, "frCircuitCreationTime": { "type": "string", "description": "The value of sysUpTime when the virtual circuit was\n created, whether by the Data Link Connection Management\n Interface or by a SetRequest.", "x-yang-type": "yang:timestamp" }, "frCircuitLastTimeChange": { "type": "string", "description": "The value of sysUpTime when last there was a change in\n the virtual circuit state", "x-yang-type": "yang:timestamp" }, "frCircuitCommittedBurst": { "type": "integer", "description": "This variable indicates the maximum amount of data, in\n bits, that the network agrees to transfer under normal\n conditions, during the 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 attempt to\n deliver over the measurement interval.\n \n By default, if not configured when creating the entry,\n the Excess Information Burst Size is set to the value\n of ifSpeed.", "minimum": -2147483648, "maximum": 2147483647 }, "frCircuitThroughput": { "type": "integer", "description": "Throughput is the average number of 'Frame Relay\n Information Field' bits transferred per second across a\n user network interface in one direction, measured over\n the measurement interval.\n \n If the configured committed burst rate and throughput\n are both non-zero, the measurement interval, T, is\n T=frCircuitCommittedBurst/frCircuitThroughput.\n \n If the configured committed burst rate and throughput\n are both zero, the measurement interval, T, is\n T=frCircuitExcessBurst/ifSpeed.", "minimum": -2147483648, "maximum": 2147483647 }, "frCircuitMulticast": { "type": "string", "description": "This indicates whether this VC is used as a unicast VC\n (i.e. not multicast) or the type of multicast service\n subscribed to" }, "frCircuitType": { "type": "string", "description": "Indication of whether the VC was manually created\n (static), or dynamically created (dynamic) via the data\n link control management interface." }, "frCircuitDiscards": { "type": "integer", "description": "The number of inbound frames dropped because of format\n errors, or because the VC is inactive.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedDEs": { "type": "integer", "description": "Number of frames received from the network indicating\n that they were eligible for discard since the virtual\n circuit was created. This occurs when the remote DTE\n sets the DE flag, or when in remote DTE's switch\n detects that the frame was received as Excess Burst\n data.", "minimum": 0, "maximum": 4294967295 }, "frCircuitSentDEs": { "type": "integer", "description": "Number of frames sent to the network indicating that\n they were eligible for discard since the virtual\n circuit was created. This occurs when the local DTE\n sets the DE flag, indicating that during Network\n congestion situations those frames should be discarded\n in preference of other frames sent without the DE bit\n set.", "minimum": 0, "maximum": 4294967295 }, "frCircuitLogicalIfIndex": { "type": "string", "description": "Normally the same value as frDlcmiIfIndex, but\n different when an implementation associates a virtual\n ifEntry with a DLC or set of DLCs in order to associate\n higher layer objects such as the ipAddrEntry with a\n subset of the virtual circuits on a Frame Relay\n interface. The type of such ifEntries is defined by the\n higher layer object; for example, if PPP/Frame Relay is\n implemented, the ifType of this ifEntry would be PPP.\n If it is not so defined, as would be the case with an\n ipAddrEntry, it should be of type Other.", "x-yang-type": "if-mib:InterfaceIndex" }, "frCircuitRowStatus": { "type": "string", "description": "This object is used to create a new row or modify or\n destroy an existing row in the manner described in the\n definition of the RowStatus textual convention.\n Writable objects in the table may be written in any\n RowStatus state.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "FRAME-RELAY-DTE-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, "frCircuitMulticast": "example-string", "frCircuitType": "ethernetCsmacd(6)", "frCircuitDiscards": 0, "frCircuitReceivedDEs": 0, "frCircuitSentDEs": 0, "frCircuitLogicalIfIndex": "example-string", "frCircuitRowStatus": "up(1)" } } } } }, "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/FRAME-RELAY-DTE-MIB:frCircuitEntry={frCircuitIfIndex},{frCircuitDlci}": { "get": { "summary": "Get frCircuitEntry entry", "description": "Retrieve specific frCircuitEntry entry by key from MIB", "tags": [ "FRAME-RELAY-DTE-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 circuit\n is layered onto.", "x-yang-type": "if-mib:InterfaceIndex" }, "frCircuitDlci": { "type": "string", "description": "The Data Link Connection Identifier for this virtual\n circuit.", "x-yang-type": "FRAME-RELAY-DTE-MIB:DLCI" }, "frCircuitState": { "type": "string", "description": "Indicates whether the particular virtual circuit is\n operational. In the absence of a Data Link Connection\n Management Interface, virtual circuit entries (rows)\n may be created by setting virtual circuit state to\n 'active', or deleted by changing Circuit state to\n 'invalid'.\n \n Whether or not the row actually disappears is left to\n the implementation, so this object may actually read as\n 'invalid' for some arbitrary length of time. It is\n also legal to set the state of a virtual circuit to\n 'inactive' to temporarily disable a given circuit.\n \n The use of 'invalid' is deprecated in this SNMP Version\n 2 MIB, in favor of frCircuitRowStatus." }, "frCircuitReceivedFECNs": { "type": "integer", "description": "Number of frames received from the network indicating\n forward congestion since the virtual circuit was\n created. This occurs when the remote DTE sets the FECN\n flag, or when a switch in the network enqueues the\n frame to a trunk whose transmission queue is\n congested.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedBECNs": { "type": "integer", "description": "Number of frames received from the network indicating\n backward congestion since the virtual circuit was\n created. This occurs when the remote DTE sets the BECN\n flag, or when a switch in the network receives the\n frame from a trunk whose transmission queue is\n congested.", "minimum": 0, "maximum": 4294967295 }, "frCircuitSentFrames": { "type": "integer", "description": "The number of frames sent from this virtual circuit\n since it was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitSentOctets": { "type": "integer", "description": "The number of octets sent from this virtual circuit\n since it was created. Octets counted are the full\n frame relay header and the payload, but do not include\n the flag characters or CRC.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedFrames": { "type": "integer", "description": "Number of frames received over this virtual circuit\n since it was created.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedOctets": { "type": "integer", "description": "Number of octets received over this virtual circuit\n since it was created. Octets counted include the full\n frame relay header, but do not include the flag\n characters or the CRC.", "minimum": 0, "maximum": 4294967295 }, "frCircuitCreationTime": { "type": "string", "description": "The value of sysUpTime when the virtual circuit was\n created, whether by the Data Link Connection Management\n Interface or by a SetRequest.", "x-yang-type": "yang:timestamp" }, "frCircuitLastTimeChange": { "type": "string", "description": "The value of sysUpTime when last there was a change in\n the virtual circuit state", "x-yang-type": "yang:timestamp" }, "frCircuitCommittedBurst": { "type": "integer", "description": "This variable indicates the maximum amount of data, in\n bits, that the network agrees to transfer under normal\n conditions, during the 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 attempt to\n deliver over the measurement interval.\n \n By default, if not configured when creating the entry,\n the Excess Information Burst Size is set to the value\n of ifSpeed.", "minimum": -2147483648, "maximum": 2147483647 }, "frCircuitThroughput": { "type": "integer", "description": "Throughput is the average number of 'Frame Relay\n Information Field' bits transferred per second across a\n user network interface in one direction, measured over\n the measurement interval.\n \n If the configured committed burst rate and throughput\n are both non-zero, the measurement interval, T, is\n T=frCircuitCommittedBurst/frCircuitThroughput.\n \n If the configured committed burst rate and throughput\n are both zero, the measurement interval, T, is\n T=frCircuitExcessBurst/ifSpeed.", "minimum": -2147483648, "maximum": 2147483647 }, "frCircuitMulticast": { "type": "string", "description": "This indicates whether this VC is used as a unicast VC\n (i.e. not multicast) or the type of multicast service\n subscribed to" }, "frCircuitType": { "type": "string", "description": "Indication of whether the VC was manually created\n (static), or dynamically created (dynamic) via the data\n link control management interface." }, "frCircuitDiscards": { "type": "integer", "description": "The number of inbound frames dropped because of format\n errors, or because the VC is inactive.", "minimum": 0, "maximum": 4294967295 }, "frCircuitReceivedDEs": { "type": "integer", "description": "Number of frames received from the network indicating\n that they were eligible for discard since the virtual\n circuit was created. This occurs when the remote DTE\n sets the DE flag, or when in remote DTE's switch\n detects that the frame was received as Excess Burst\n data.", "minimum": 0, "maximum": 4294967295 }, "frCircuitSentDEs": { "type": "integer", "description": "Number of frames sent to the network indicating that\n they were eligible for discard since the virtual\n circuit was created. This occurs when the local DTE\n sets the DE flag, indicating that during Network\n congestion situations those frames should be discarded\n in preference of other frames sent without the DE bit\n set.", "minimum": 0, "maximum": 4294967295 }, "frCircuitLogicalIfIndex": { "type": "string", "description": "Normally the same value as frDlcmiIfIndex, but\n different when an implementation associates a virtual\n ifEntry with a DLC or set of DLCs in order to associate\n higher layer objects such as the ipAddrEntry with a\n subset of the virtual circuits on a Frame Relay\n interface. The type of such ifEntries is defined by the\n higher layer object; for example, if PPP/Frame Relay is\n implemented, the ifType of this ifEntry would be PPP.\n If it is not so defined, as would be the case with an\n ipAddrEntry, it should be of type Other.", "x-yang-type": "if-mib:InterfaceIndex" }, "frCircuitRowStatus": { "type": "string", "description": "This object is used to create a new row or modify or\n destroy an existing row in the manner described in the\n definition of the RowStatus textual convention.\n Writable objects in the table may be written in any\n RowStatus state.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "FRAME-RELAY-DTE-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, "frCircuitMulticast": "example-string", "frCircuitType": "ethernetCsmacd(6)", "frCircuitDiscards": 0, "frCircuitReceivedDEs": 0, "frCircuitSentDEs": 0, "frCircuitLogicalIfIndex": "example-string", "frCircuitRowStatus": "up(1)" } } } } }, "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": { "FRAME-RELAY-DTE-MIB_FRAME-RELAY-DTE-MIB": { "type": "object", "description": "This variable indicates whether the system produces\n the frDLCIStatusChange trap.", "properties": { "frDlcmiEntry": { "type": "array", "description": "The Parameters for a particular Data Link Connection\n Management Interface.", "items": { "type": "object", "properties": { "frDlcmiIfIndex": { "type": "string", "description": "The ifIndex value of the corresponding ifEntry.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "frDlcmiState": { "type": "string", "description": "This variable states which Data Link Connection\n Management scheme is active (and by implication, what\n DLCI it uses) on the Frame Relay interface.", "readOnly": true }, "frDlcmiAddress": { "type": "string", "description": "This variable states which address format is in use on\n the Frame Relay interface.", "readOnly": true }, "frDlcmiAddressLen": { "type": "string", "description": "This variable states the address length in octets. In\n the case of Q922 format, the length indicates the\n entire length of the address including the control\n portion.", "readOnly": true }, "frDlcmiPollingInterval": { "type": "integer", "description": "This is the number of seconds between successive\n status enquiry messages.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frDlcmiFullEnquiryInterval": { "type": "integer", "description": "Number of status enquiry intervals that pass before\n issuance of a full status enquiry message.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frDlcmiErrorThreshold": { "type": "integer", "description": "This is the maximum number of unanswered Status\n Enquiries the equipment shall accept before declaring\n the interface down.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frDlcmiMonitoredEvents": { "type": "integer", "description": "This is the number of status polling intervals over\n which the error threshold is counted. For example, if\n within 'MonitoredEvents' number of events the station\n receives 'ErrorThreshold' number of errors, the\n interface is marked as down.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frDlcmiMaxSupportedVCs": { "type": "string", "description": "The maximum number of Virtual Circuits allowed for\n this interface. Usually dictated by the Frame Relay\n network.\n \n In response to a SET, if a value less than zero or\n higher than the agent's maximal capability is\n configured, the agent should respond badValue", "x-yang-type": "FRAME-RELAY-DTE-MIB:DLCI", "readOnly": true }, "frDlcmiMulticast": { "type": "string", "description": "This indicates whether the Frame Relay interface is\n using a multicast service.", "readOnly": true }, "frDlcmiStatus": { "type": "string", "description": "This indicates the status of the Frame Relay interface\n as determined by the performance of the dlcmi. If no\n dlcmi is running, the Frame Relay interface will stay\n in the running state indefinitely.", "readOnly": true }, "frDlcmiRowStatus": { "type": "string", "description": "SNMP Version 2 Row Status Variable. Writable objects\n in the table may be written in any RowStatus state.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "frCircuitEntry": { "type": "array", "description": "The information regarding a single Data Link\n Connection. Discontinuities in the counters contained\n in this table are indicated by the value in\n frCircuitCreationTime.", "items": { "type": "object", "properties": { "frCircuitIfIndex": { "type": "string", "description": "The ifIndex Value of the ifEntry this virtual circuit\n is layered onto.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "frCircuitDlci": { "type": "string", "description": "The Data Link Connection Identifier for this virtual\n circuit.", "x-yang-type": "FRAME-RELAY-DTE-MIB:DLCI", "readOnly": true }, "frCircuitState": { "type": "string", "description": "Indicates whether the particular virtual circuit is\n operational. In the absence of a Data Link Connection\n Management Interface, virtual circuit entries (rows)\n may be created by setting virtual circuit state to\n 'active', or deleted by changing Circuit state to\n 'invalid'.\n \n Whether or not the row actually disappears is left to\n the implementation, so this object may actually read as\n 'invalid' for some arbitrary length of time. It is\n also legal to set the state of a virtual circuit to\n 'inactive' to temporarily disable a given circuit.\n \n The use of 'invalid' is deprecated in this SNMP Version\n 2 MIB, in favor of frCircuitRowStatus.", "readOnly": true }, "frCircuitReceivedFECNs": { "type": "integer", "description": "Number of frames received from the network indicating\n forward congestion since the virtual circuit was\n created. This occurs when the remote DTE sets the FECN\n flag, or when a switch in the network enqueues the\n frame to a trunk whose transmission queue is\n congested.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitReceivedBECNs": { "type": "integer", "description": "Number of frames received from the network indicating\n backward congestion since the virtual circuit was\n created. This occurs when the remote DTE sets the BECN\n flag, or when a switch in the network receives the\n frame from a trunk whose transmission queue is\n congested.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitSentFrames": { "type": "integer", "description": "The number of frames sent from this virtual circuit\n since it was created.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitSentOctets": { "type": "integer", "description": "The number of octets sent from this virtual circuit\n since it was created. Octets counted are the full\n frame relay header and the payload, but do not include\n the flag characters or CRC.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitReceivedFrames": { "type": "integer", "description": "Number of frames received over this virtual circuit\n since it was created.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitReceivedOctets": { "type": "integer", "description": "Number of octets received over this virtual circuit\n since it was created. Octets counted include the full\n frame relay header, but do not include the flag\n characters or the CRC.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitCreationTime": { "type": "string", "description": "The value of sysUpTime when the virtual circuit was\n created, whether by the Data Link Connection Management\n Interface or by a SetRequest.", "x-yang-type": "yang:timestamp", "readOnly": true }, "frCircuitLastTimeChange": { "type": "string", "description": "The value of sysUpTime when last there was a change in\n the virtual circuit state", "x-yang-type": "yang:timestamp", "readOnly": true }, "frCircuitCommittedBurst": { "type": "integer", "description": "This variable indicates the maximum amount of data, in\n bits, that the network agrees to transfer under normal\n conditions, during the 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 attempt to\n deliver over the measurement interval.\n \n By default, if not configured when creating the entry,\n the Excess Information Burst Size is set to the value\n of ifSpeed.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frCircuitThroughput": { "type": "integer", "description": "Throughput is the average number of 'Frame Relay\n Information Field' bits transferred per second across a\n user network interface in one direction, measured over\n the measurement interval.\n \n If the configured committed burst rate and throughput\n are both non-zero, the measurement interval, T, is\n T=frCircuitCommittedBurst/frCircuitThroughput.\n \n If the configured committed burst rate and throughput\n are both zero, the measurement interval, T, is\n T=frCircuitExcessBurst/ifSpeed.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frCircuitMulticast": { "type": "string", "description": "This indicates whether this VC is used as a unicast VC\n (i.e. not multicast) or the type of multicast service\n subscribed to", "readOnly": true }, "frCircuitType": { "type": "string", "description": "Indication of whether the VC was manually created\n (static), or dynamically created (dynamic) via the data\n link control management interface.", "readOnly": true }, "frCircuitDiscards": { "type": "integer", "description": "The number of inbound frames dropped because of format\n errors, or because the VC is inactive.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitReceivedDEs": { "type": "integer", "description": "Number of frames received from the network indicating\n that they were eligible for discard since the virtual\n circuit was created. This occurs when the remote DTE\n sets the DE flag, or when in remote DTE's switch\n detects that the frame was received as Excess Burst\n data.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitSentDEs": { "type": "integer", "description": "Number of frames sent to the network indicating that\n they were eligible for discard since the virtual\n circuit was created. This occurs when the local DTE\n sets the DE flag, indicating that during Network\n congestion situations those frames should be discarded\n in preference of other frames sent without the DE bit\n set.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitLogicalIfIndex": { "type": "string", "description": "Normally the same value as frDlcmiIfIndex, but\n different when an implementation associates a virtual\n ifEntry with a DLC or set of DLCs in order to associate\n higher layer objects such as the ipAddrEntry with a\n subset of the virtual circuits on a Frame Relay\n interface. The type of such ifEntries is defined by the\n higher layer object; for example, if PPP/Frame Relay is\n implemented, the ifType of this ifEntry would be PPP.\n If it is not so defined, as would be the case with an\n ipAddrEntry, it should be of type Other.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "frCircuitRowStatus": { "type": "string", "description": "This object is used to create a new row or modify or\n destroy an existing row in the manner described in the\n definition of the RowStatus textual convention.\n Writable objects in the table may be written in any\n RowStatus state.", "x-yang-type": "snmpv2-tc:RowStatus", "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 ifEntry.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "frErrType": { "type": "string", "description": "The type of error that was last seen on this interface:\n \n receiveShort: frame was not long enough to allow\n demultiplexing - the address field was incomplete,\n or for virtual circuits using Multiprotocol over\n Frame Relay, the protocol identifier was missing\n or incomplete.\n \n receiveLong: frame exceeded maximum length configured for this\n interface.\n \n illegalAddress: address field did not match configured format.\n \n unknownAddress: frame received on a virtual circuit which was not\n active or administratively disabled.\n \n dlcmiProtoErr: unspecified error occurred when attempting to\n interpret link maintenance frame.\n \n dlcmiUnknownIE: link maintenance frame contained an Information\n Element type which is not valid for the\n configured link maintenance protocol.\n \n dlcmiSequenceErr: link maintenance frame contained a sequence\n number other than the expected value.\n \n dlcmiUnknownRpt: link maintenance frame contained a Report Type\n Information Element whose value was not valid\n for the configured link maintenance protocol.\n \n noErrorSinceReset: no errors have been detected since the last\n cold start or warm start.", "readOnly": true }, "frErrData": { "type": "string", "description": "An octet string containing as much of the error packet\n as possible. As a minimum, it must contain the Q.922\n Address or as much as was delivered. It is desirable\n to include all header and demultiplexing information.", "format": "binary", "readOnly": true }, "frErrTime": { "type": "string", "description": "The value of sysUpTime at which the error was\n detected.", "x-yang-type": "yang:timestamp", "readOnly": true }, "frErrFaults": { "type": "integer", "description": "The number of times the interface has gone down since\n it was initialized.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frErrFaultTime": { "type": "string", "description": "The value of sysUpTime at the time when the interface\n was taken down due to excessive errors. Excessive\n errors is defined as the time when a DLCMI exceeds the\n frDlcmiErrorThreshold number of errors within\n frDlcmiMonitoredEvents. See FrDlcmiEntry for further\n details.", "x-yang-type": "yang:timestamp", "readOnly": true } } }, "readOnly": true }, "frameRelayTrapControl": { "type": "object", "description": "This variable indicates whether the system produces\n the frDLCIStatusChange trap.", "properties": { "frTrapState": { "type": "string", "description": "This variable indicates whether the system produces\n the frDLCIStatusChange trap.", "readOnly": true }, "frTrapMaxRate": { "type": "integer", "description": "This variable indicates the number of milliseconds\n that must elapse between trap emissions. If events\n occur more rapidly, the impementation may simply fail\n to trap, or may queue traps until an appropriate time.", "minimum": -2147483648, "maximum": 2147483647, "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 Connection\n Management Interface.", "items": { "type": "object", "properties": { "frDlcmiIfIndex": { "type": "string", "description": "The ifIndex value of the corresponding ifEntry.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "frDlcmiState": { "type": "string", "description": "This variable states which Data Link Connection\n Management scheme is active (and by implication, what\n DLCI it uses) on the Frame Relay interface.", "readOnly": true }, "frDlcmiAddress": { "type": "string", "description": "This variable states which address format is in use on\n the Frame Relay interface.", "readOnly": true }, "frDlcmiAddressLen": { "type": "string", "description": "This variable states the address length in octets. In\n the case of Q922 format, the length indicates the\n entire length of the address including the control\n portion.", "readOnly": true }, "frDlcmiPollingInterval": { "type": "integer", "description": "This is the number of seconds between successive\n status enquiry messages.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frDlcmiFullEnquiryInterval": { "type": "integer", "description": "Number of status enquiry intervals that pass before\n issuance of a full status enquiry message.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frDlcmiErrorThreshold": { "type": "integer", "description": "This is the maximum number of unanswered Status\n Enquiries the equipment shall accept before declaring\n the interface down.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frDlcmiMonitoredEvents": { "type": "integer", "description": "This is the number of status polling intervals over\n which the error threshold is counted. For example, if\n within 'MonitoredEvents' number of events the station\n receives 'ErrorThreshold' number of errors, the\n interface is marked as down.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frDlcmiMaxSupportedVCs": { "type": "string", "description": "The maximum number of Virtual Circuits allowed for\n this interface. Usually dictated by the Frame Relay\n network.\n \n In response to a SET, if a value less than zero or\n higher than the agent's maximal capability is\n configured, the agent should respond badValue", "x-yang-type": "FRAME-RELAY-DTE-MIB:DLCI", "readOnly": true }, "frDlcmiMulticast": { "type": "string", "description": "This indicates whether the Frame Relay interface is\n using a multicast service.", "readOnly": true }, "frDlcmiStatus": { "type": "string", "description": "This indicates the status of the Frame Relay interface\n as determined by the performance of the dlcmi. If no\n dlcmi is running, the Frame Relay interface will stay\n in the running state indefinitely.", "readOnly": true }, "frDlcmiRowStatus": { "type": "string", "description": "SNMP Version 2 Row Status Variable. Writable objects\n in the table may be written in any RowStatus state.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "frCircuitTable": { "type": "object", "description": "A table containing information about specific Data\n Link Connections (DLC) or virtual circuits.", "properties": { "frCircuitEntry": { "type": "array", "description": "The information regarding a single Data Link\n Connection. Discontinuities in the counters contained\n in this table are indicated by the value in\n frCircuitCreationTime.", "items": { "type": "object", "properties": { "frCircuitIfIndex": { "type": "string", "description": "The ifIndex Value of the ifEntry this virtual circuit\n is layered onto.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "frCircuitDlci": { "type": "string", "description": "The Data Link Connection Identifier for this virtual\n circuit.", "x-yang-type": "FRAME-RELAY-DTE-MIB:DLCI", "readOnly": true }, "frCircuitState": { "type": "string", "description": "Indicates whether the particular virtual circuit is\n operational. In the absence of a Data Link Connection\n Management Interface, virtual circuit entries (rows)\n may be created by setting virtual circuit state to\n 'active', or deleted by changing Circuit state to\n 'invalid'.\n \n Whether or not the row actually disappears is left to\n the implementation, so this object may actually read as\n 'invalid' for some arbitrary length of time. It is\n also legal to set the state of a virtual circuit to\n 'inactive' to temporarily disable a given circuit.\n \n The use of 'invalid' is deprecated in this SNMP Version\n 2 MIB, in favor of frCircuitRowStatus.", "readOnly": true }, "frCircuitReceivedFECNs": { "type": "integer", "description": "Number of frames received from the network indicating\n forward congestion since the virtual circuit was\n created. This occurs when the remote DTE sets the FECN\n flag, or when a switch in the network enqueues the\n frame to a trunk whose transmission queue is\n congested.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitReceivedBECNs": { "type": "integer", "description": "Number of frames received from the network indicating\n backward congestion since the virtual circuit was\n created. This occurs when the remote DTE sets the BECN\n flag, or when a switch in the network receives the\n frame from a trunk whose transmission queue is\n congested.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitSentFrames": { "type": "integer", "description": "The number of frames sent from this virtual circuit\n since it was created.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitSentOctets": { "type": "integer", "description": "The number of octets sent from this virtual circuit\n since it was created. Octets counted are the full\n frame relay header and the payload, but do not include\n the flag characters or CRC.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitReceivedFrames": { "type": "integer", "description": "Number of frames received over this virtual circuit\n since it was created.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitReceivedOctets": { "type": "integer", "description": "Number of octets received over this virtual circuit\n since it was created. Octets counted include the full\n frame relay header, but do not include the flag\n characters or the CRC.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitCreationTime": { "type": "string", "description": "The value of sysUpTime when the virtual circuit was\n created, whether by the Data Link Connection Management\n Interface or by a SetRequest.", "x-yang-type": "yang:timestamp", "readOnly": true }, "frCircuitLastTimeChange": { "type": "string", "description": "The value of sysUpTime when last there was a change in\n the virtual circuit state", "x-yang-type": "yang:timestamp", "readOnly": true }, "frCircuitCommittedBurst": { "type": "integer", "description": "This variable indicates the maximum amount of data, in\n bits, that the network agrees to transfer under normal\n conditions, during the 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 attempt to\n deliver over the measurement interval.\n \n By default, if not configured when creating the entry,\n the Excess Information Burst Size is set to the value\n of ifSpeed.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frCircuitThroughput": { "type": "integer", "description": "Throughput is the average number of 'Frame Relay\n Information Field' bits transferred per second across a\n user network interface in one direction, measured over\n the measurement interval.\n \n If the configured committed burst rate and throughput\n are both non-zero, the measurement interval, T, is\n T=frCircuitCommittedBurst/frCircuitThroughput.\n \n If the configured committed burst rate and throughput\n are both zero, the measurement interval, T, is\n T=frCircuitExcessBurst/ifSpeed.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frCircuitMulticast": { "type": "string", "description": "This indicates whether this VC is used as a unicast VC\n (i.e. not multicast) or the type of multicast service\n subscribed to", "readOnly": true }, "frCircuitType": { "type": "string", "description": "Indication of whether the VC was manually created\n (static), or dynamically created (dynamic) via the data\n link control management interface.", "readOnly": true }, "frCircuitDiscards": { "type": "integer", "description": "The number of inbound frames dropped because of format\n errors, or because the VC is inactive.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitReceivedDEs": { "type": "integer", "description": "Number of frames received from the network indicating\n that they were eligible for discard since the virtual\n circuit was created. This occurs when the remote DTE\n sets the DE flag, or when in remote DTE's switch\n detects that the frame was received as Excess Burst\n data.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitSentDEs": { "type": "integer", "description": "Number of frames sent to the network indicating that\n they were eligible for discard since the virtual\n circuit was created. This occurs when the local DTE\n sets the DE flag, indicating that during Network\n congestion situations those frames should be discarded\n in preference of other frames sent without the DE bit\n set.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitLogicalIfIndex": { "type": "string", "description": "Normally the same value as frDlcmiIfIndex, but\n different when an implementation associates a virtual\n ifEntry with a DLC or set of DLCs in order to associate\n higher layer objects such as the ipAddrEntry with a\n subset of the virtual circuits on a Frame Relay\n interface. The type of such ifEntries is defined by the\n higher layer object; for example, if PPP/Frame Relay is\n implemented, the ifType of this ifEntry would be PPP.\n If it is not so defined, as would be the case with an\n ipAddrEntry, it should be of type Other.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "frCircuitRowStatus": { "type": "string", "description": "This object is used to create a new row or modify or\n destroy an existing row in the manner described in the\n definition of the RowStatus textual convention.\n Writable objects in the table may be written in any\n RowStatus state.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "frErrTable": { "type": "object", "description": "A table containing information about Errors on the\n Frame Relay interface. Discontinuities in the counters\n contained in this table are the same as apply to the\n ifEntry associated with the 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 ifEntry.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "frErrType": { "type": "string", "description": "The type of error that was last seen on this interface:\n \n receiveShort: frame was not long enough to allow\n demultiplexing - the address field was incomplete,\n or for virtual circuits using Multiprotocol over\n Frame Relay, the protocol identifier was missing\n or incomplete.\n \n receiveLong: frame exceeded maximum length configured for this\n interface.\n \n illegalAddress: address field did not match configured format.\n \n unknownAddress: frame received on a virtual circuit which was not\n active or administratively disabled.\n \n dlcmiProtoErr: unspecified error occurred when attempting to\n interpret link maintenance frame.\n \n dlcmiUnknownIE: link maintenance frame contained an Information\n Element type which is not valid for the\n configured link maintenance protocol.\n \n dlcmiSequenceErr: link maintenance frame contained a sequence\n number other than the expected value.\n \n dlcmiUnknownRpt: link maintenance frame contained a Report Type\n Information Element whose value was not valid\n for the configured link maintenance protocol.\n \n noErrorSinceReset: no errors have been detected since the last\n cold start or warm start.", "readOnly": true }, "frErrData": { "type": "string", "description": "An octet string containing as much of the error packet\n as possible. As a minimum, it must contain the Q.922\n Address or as much as was delivered. It is desirable\n to include all header and demultiplexing information.", "format": "binary", "readOnly": true }, "frErrTime": { "type": "string", "description": "The value of sysUpTime at which the error was\n detected.", "x-yang-type": "yang:timestamp", "readOnly": true }, "frErrFaults": { "type": "integer", "description": "The number of times the interface has gone down since\n it was initialized.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frErrFaultTime": { "type": "string", "description": "The value of sysUpTime at the time when the interface\n was taken down due to excessive errors. Excessive\n errors is defined as the time when a DLCMI exceeds the\n frDlcmiErrorThreshold number of errors within\n frDlcmiMonitoredEvents. See FrDlcmiEntry for further\n details.", "x-yang-type": "yang:timestamp", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "FRAME-RELAY-DTE-MIB_object-1": { "type": "object", "description": "object-1", "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 } } }, "FRAME-RELAY-DTE-MIB_frDlcmiEntry": { "type": "array", "description": "The Parameters for a particular Data Link Connection\n Management Interface.", "items": { "type": "object", "properties": { "frDlcmiIfIndex": { "type": "string", "description": "The ifIndex value of the corresponding ifEntry.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "frDlcmiState": { "type": "string", "description": "This variable states which Data Link Connection\n Management scheme is active (and by implication, what\n DLCI it uses) on the Frame Relay interface.", "readOnly": true }, "frDlcmiAddress": { "type": "string", "description": "This variable states which address format is in use on\n the Frame Relay interface.", "readOnly": true }, "frDlcmiAddressLen": { "type": "string", "description": "This variable states the address length in octets. In\n the case of Q922 format, the length indicates the\n entire length of the address including the control\n portion.", "readOnly": true }, "frDlcmiPollingInterval": { "type": "integer", "description": "This is the number of seconds between successive\n status enquiry messages.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frDlcmiFullEnquiryInterval": { "type": "integer", "description": "Number of status enquiry intervals that pass before\n issuance of a full status enquiry message.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frDlcmiErrorThreshold": { "type": "integer", "description": "This is the maximum number of unanswered Status\n Enquiries the equipment shall accept before declaring\n the interface down.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frDlcmiMonitoredEvents": { "type": "integer", "description": "This is the number of status polling intervals over\n which the error threshold is counted. For example, if\n within 'MonitoredEvents' number of events the station\n receives 'ErrorThreshold' number of errors, the\n interface is marked as down.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frDlcmiMaxSupportedVCs": { "type": "string", "description": "The maximum number of Virtual Circuits allowed for\n this interface. Usually dictated by the Frame Relay\n network.\n \n In response to a SET, if a value less than zero or\n higher than the agent's maximal capability is\n configured, the agent should respond badValue", "x-yang-type": "FRAME-RELAY-DTE-MIB:DLCI", "readOnly": true }, "frDlcmiMulticast": { "type": "string", "description": "This indicates whether the Frame Relay interface is\n using a multicast service.", "readOnly": true }, "frDlcmiStatus": { "type": "string", "description": "This indicates the status of the Frame Relay interface\n as determined by the performance of the dlcmi. If no\n dlcmi is running, the Frame Relay interface will stay\n in the running state indefinitely.", "readOnly": true }, "frDlcmiRowStatus": { "type": "string", "description": "SNMP Version 2 Row Status Variable. Writable objects\n in the table may be written in any RowStatus state.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } } }, "FRAME-RELAY-DTE-MIB_frCircuitEntry": { "type": "array", "description": "The information regarding a single Data Link\n Connection. Discontinuities in the counters contained\n in this table are indicated by the value in\n frCircuitCreationTime.", "items": { "type": "object", "properties": { "frCircuitIfIndex": { "type": "string", "description": "The ifIndex Value of the ifEntry this virtual circuit\n is layered onto.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "frCircuitDlci": { "type": "string", "description": "The Data Link Connection Identifier for this virtual\n circuit.", "x-yang-type": "FRAME-RELAY-DTE-MIB:DLCI", "readOnly": true }, "frCircuitState": { "type": "string", "description": "Indicates whether the particular virtual circuit is\n operational. In the absence of a Data Link Connection\n Management Interface, virtual circuit entries (rows)\n may be created by setting virtual circuit state to\n 'active', or deleted by changing Circuit state to\n 'invalid'.\n \n Whether or not the row actually disappears is left to\n the implementation, so this object may actually read as\n 'invalid' for some arbitrary length of time. It is\n also legal to set the state of a virtual circuit to\n 'inactive' to temporarily disable a given circuit.\n \n The use of 'invalid' is deprecated in this SNMP Version\n 2 MIB, in favor of frCircuitRowStatus.", "readOnly": true }, "frCircuitReceivedFECNs": { "type": "integer", "description": "Number of frames received from the network indicating\n forward congestion since the virtual circuit was\n created. This occurs when the remote DTE sets the FECN\n flag, or when a switch in the network enqueues the\n frame to a trunk whose transmission queue is\n congested.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitReceivedBECNs": { "type": "integer", "description": "Number of frames received from the network indicating\n backward congestion since the virtual circuit was\n created. This occurs when the remote DTE sets the BECN\n flag, or when a switch in the network receives the\n frame from a trunk whose transmission queue is\n congested.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitSentFrames": { "type": "integer", "description": "The number of frames sent from this virtual circuit\n since it was created.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitSentOctets": { "type": "integer", "description": "The number of octets sent from this virtual circuit\n since it was created. Octets counted are the full\n frame relay header and the payload, but do not include\n the flag characters or CRC.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitReceivedFrames": { "type": "integer", "description": "Number of frames received over this virtual circuit\n since it was created.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitReceivedOctets": { "type": "integer", "description": "Number of octets received over this virtual circuit\n since it was created. Octets counted include the full\n frame relay header, but do not include the flag\n characters or the CRC.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitCreationTime": { "type": "string", "description": "The value of sysUpTime when the virtual circuit was\n created, whether by the Data Link Connection Management\n Interface or by a SetRequest.", "x-yang-type": "yang:timestamp", "readOnly": true }, "frCircuitLastTimeChange": { "type": "string", "description": "The value of sysUpTime when last there was a change in\n the virtual circuit state", "x-yang-type": "yang:timestamp", "readOnly": true }, "frCircuitCommittedBurst": { "type": "integer", "description": "This variable indicates the maximum amount of data, in\n bits, that the network agrees to transfer under normal\n conditions, during the 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 attempt to\n deliver over the measurement interval.\n \n By default, if not configured when creating the entry,\n the Excess Information Burst Size is set to the value\n of ifSpeed.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frCircuitThroughput": { "type": "integer", "description": "Throughput is the average number of 'Frame Relay\n Information Field' bits transferred per second across a\n user network interface in one direction, measured over\n the measurement interval.\n \n If the configured committed burst rate and throughput\n are both non-zero, the measurement interval, T, is\n T=frCircuitCommittedBurst/frCircuitThroughput.\n \n If the configured committed burst rate and throughput\n are both zero, the measurement interval, T, is\n T=frCircuitExcessBurst/ifSpeed.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "frCircuitMulticast": { "type": "string", "description": "This indicates whether this VC is used as a unicast VC\n (i.e. not multicast) or the type of multicast service\n subscribed to", "readOnly": true }, "frCircuitType": { "type": "string", "description": "Indication of whether the VC was manually created\n (static), or dynamically created (dynamic) via the data\n link control management interface.", "readOnly": true }, "frCircuitDiscards": { "type": "integer", "description": "The number of inbound frames dropped because of format\n errors, or because the VC is inactive.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitReceivedDEs": { "type": "integer", "description": "Number of frames received from the network indicating\n that they were eligible for discard since the virtual\n circuit was created. This occurs when the remote DTE\n sets the DE flag, or when in remote DTE's switch\n detects that the frame was received as Excess Burst\n data.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitSentDEs": { "type": "integer", "description": "Number of frames sent to the network indicating that\n they were eligible for discard since the virtual\n circuit was created. This occurs when the local DTE\n sets the DE flag, indicating that during Network\n congestion situations those frames should be discarded\n in preference of other frames sent without the DE bit\n set.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frCircuitLogicalIfIndex": { "type": "string", "description": "Normally the same value as frDlcmiIfIndex, but\n different when an implementation associates a virtual\n ifEntry with a DLC or set of DLCs in order to associate\n higher layer objects such as the ipAddrEntry with a\n subset of the virtual circuits on a Frame Relay\n interface. The type of such ifEntries is defined by the\n higher layer object; for example, if PPP/Frame Relay is\n implemented, the ifType of this ifEntry would be PPP.\n If it is not so defined, as would be the case with an\n ipAddrEntry, it should be of type Other.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "frCircuitRowStatus": { "type": "string", "description": "This object is used to create a new row or modify or\n destroy an existing row in the manner described in the\n definition of the RowStatus textual convention.\n Writable objects in the table may be written in any\n RowStatus state.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } } }, "FRAME-RELAY-DTE-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 ifEntry.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "frErrType": { "type": "string", "description": "The type of error that was last seen on this interface:\n \n receiveShort: frame was not long enough to allow\n demultiplexing - the address field was incomplete,\n or for virtual circuits using Multiprotocol over\n Frame Relay, the protocol identifier was missing\n or incomplete.\n \n receiveLong: frame exceeded maximum length configured for this\n interface.\n \n illegalAddress: address field did not match configured format.\n \n unknownAddress: frame received on a virtual circuit which was not\n active or administratively disabled.\n \n dlcmiProtoErr: unspecified error occurred when attempting to\n interpret link maintenance frame.\n \n dlcmiUnknownIE: link maintenance frame contained an Information\n Element type which is not valid for the\n configured link maintenance protocol.\n \n dlcmiSequenceErr: link maintenance frame contained a sequence\n number other than the expected value.\n \n dlcmiUnknownRpt: link maintenance frame contained a Report Type\n Information Element whose value was not valid\n for the configured link maintenance protocol.\n \n noErrorSinceReset: no errors have been detected since the last\n cold start or warm start.", "readOnly": true }, "frErrData": { "type": "string", "description": "An octet string containing as much of the error packet\n as possible. As a minimum, it must contain the Q.922\n Address or as much as was delivered. It is desirable\n to include all header and demultiplexing information.", "format": "binary", "readOnly": true }, "frErrTime": { "type": "string", "description": "The value of sysUpTime at which the error was\n detected.", "x-yang-type": "yang:timestamp", "readOnly": true }, "frErrFaults": { "type": "integer", "description": "The number of times the interface has gone down since\n it was initialized.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "frErrFaultTime": { "type": "string", "description": "The value of sysUpTime at the time when the interface\n was taken down due to excessive errors. Excessive\n errors is defined as the time when a DLCMI exceeds the\n frDlcmiErrorThreshold number of errors within\n frDlcmiMonitoredEvents. See FrDlcmiEntry for further\n details.", "x-yang-type": "yang:timestamp", "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": "FRAME-RELAY-DTE-MIB", "description": "MIB operations for FRAME-RELAY-DTE-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }