{ "openapi": "3.0.0", "info": { "title": "CISCO-DOT3-OAM-MIB MIB API", "version": "1.0.0", "description": "SNMP MIB translated to YANG data model\n\nāš ļø **IMPORTANT - MIB DATA ACCESS**:\nThis YANG model exists for SMIv2-to-YANG translation purposes, but MIB data on IOS-XE devices is primarily accessed via **SNMP protocol**, not RESTCONF.\n\n**RESTCONF Limitation**: Many MIB paths may return 404 errors via RESTCONF `/data` endpoints because the device exposes MIB data through SNMP, not the YANG datastore.\n\n**Recommended Access Methods**:\n- Use SNMP (v2c/v3) to query MIB data directly\n- Use NETCONF `` operations for devices supporting YANG-modeled MIB access\n- Check device capabilities: some newer IOS-XE versions may support limited RESTCONF access to specific MIBs\n\n**YANG Model Purpose**: These YANG models define the structure of SNMP MIBs in YANG format for tooling compatibility, but do not guarantee RESTCONF data availability.\n\n\n**šŸ“Š YANG Tree:** [View CISCO-DOT3-OAM-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/CISCO-DOT3-OAM-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "CISCO-DOT3-OAM-MIB", "x-model-type": "mib" }, "servers": [ { "url": "https://{device}/restconf", "description": "RESTCONF server", "variables": { "device": { "default": "10.1.1.1", "description": "Device hostname or IP address" } } } ], "paths": { "/data/CISCO-DOT3-OAM-MIB:cdot3OamTable": { "get": { "summary": "Get cdot3OamTable data", "description": "Retrieve cdot3OamTable operational data from MIB", "tags": [ "CISCO-DOT3-OAM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains the primary controls and status for the\n OAM capabilities of an Ethernet like interface. There will be\n one row in this table for each Ethernet like interface in the\n system that supports the OAM functions defined in [802.3ah].", "properties": { "cdot3OamEntry": { "type": "array", "description": "An entry in the table, containing information on the Ethernet\n OAM function for a single Ethernet like interface. Entries in\n the table are created automatically for each interface\n supporting Ethernet OAM. The status of the row entry can be\n determined from cdot3OamOperStatus. \n \n A cdot3OamEntry is indexed in the cdot3OamTable by the ifIndex\n object of the Interfaces MIB.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cdot3OamAdminState": { "type": "string", "description": "This object is used to provision the default administrative\n OAM mode for this interface. This object represents the\n desired state of OAM for this interface. \n \n The cdot3OamAdminState always starts in the disabled(1) state\n until an explicit management action or configuration\n information retained by the system causes a transition to the\n enabled(2) state. When enabled(2), Ethernet OAM will attempt\n to operate over this interface." }, "cdot3OamOperStatus": { "type": "string", "description": "At initialization and failure conditions, two OAM entities on\n the same full-duplex Ethernet link begin a discovery phase to\n determine what OAM capabilities may be used on that link. The\n progress of this initialization is controlled by the OAM\n sublayer. \n \n This value is always disabled(1) if OAM is disabled on this\n interface via the cdot3OamAdminState. \n \n If the link has detected a fault and is transmitting OAMPDUs\n with a link fault indication, the value is linkFault(2). Also,\n if the interface is not operational (ifOperStatus is not \n up(1)), linkFault(2) is returned. Note that the object \n ifOperStatus may not be up(1) as a result of link failure or\n administrative action (ifAdminState being down(2) or\n testing(3)). \n \n The passiveWait(3) state is returned only by OAM entities in\n passive mode (cdot3OamMode) and reflects the state in which the\n OAM entity is waiting to see if the peer device is OAM\n capable. The activeSendLocal(4) value is used by active mode\n devices (cdot3OamMode) and reflects the OAM entity actively\n trying to discover whether the peer has OAM capability but has\n not yet made that determination. \n \n The state sendLocalAndRemote(5) reflects that the local OAM\n entity has discovered the peer but has not yet accepted or\n rejected the configuration of the peer. The local device can,\n for whatever reason, decide that the peer device is\n unacceptable and decline OAM peering. If the local OAM entity\n rejects the peer OAM entity, the state becomes\n oamPeeringLocallyRejected(7). If the OAM peering is allowed\n by the local device, the state moves to\n sendLocalAndRemoteOk(6). Note that both the\n sendLocalAndRemote(5) and oamPeeringLocallyRejected(7) states\n fall within the state SEND_LOCAL_REMOTE of the Discovery state\n diagram [802.3ah, Figure 57-5], with the difference being\n whether the local OAM client has actively rejected the peering\n or has just not indicated any decision yet. Whether a peering\n decision has been made is indicated via the local flags field\n in the OAMPDU (reflected in the aOAMLocalFlagsField of\n 30.3.6.1.10). \n \n If the remote OAM entity rejects the peering, the state\n becomes oamPeeringRemotelyRejected(8). Note that both the\n sendLocalAndRemoteOk(6) and oamPeeringRemotelyRejected(8)\n states fall within the state SEND_LOCAL_REMOTE_OK of the\n Discovery state diagram [802.3ah, Figure 57-5], with the\n difference being whether the remote OAM client has rejected\n the peering or has just not yet decided. This is indicated\n via the remote flags field in the OAM PDU (reflected in the\n aOAMRemoteFlagsField of 30.3.6.1.11). \n \n When the local OAM entity learns that both it and the remote\n OAM entity have accepted the peering, the state moves to\n operational(9) corresponding to the SEND_ANY state of the\n Discovery state diagram [802.3ah, Figure 57-5]. \n \n Since Ethernet OAM functions are not designed to work\n completely over half-duplex interfaces, the value\n nonOperHalfDuplex(10) is returned whenever Ethernet OAM is\n enabled (cdot3OamAdminState is enabled(1)) but the interface is\n in half-duplex operation." }, "cdot3OamMode": { "type": "string", "description": "This object configures the mode of OAM operation for this\n Ethernet like interface. OAM on Ethernet interfaces may be in\n 'active' mode or 'passive' mode. These two modes differ in\n that active mode provides additional capabilities to initiate\n monitoring activities with the remote OAM peer entity, while\n passive mode generally waits for the peer to initiate OAM\n actions with it. As an example, an active OAM entity can put\n the remote OAM entity in a loopback state, where a passive OAM\n entity cannot. \n \n The default value of cdot3OamMode is dependent on the type of\n system on which this Ethernet like interface resides. The\n default value should be 'active(1)' unless it is known that\n this system should take on a subservient role to the other\n device connected over this interface. \n \n Changing this value results in incrementing the configuration\n revision field of locally generated OAMPDUs (30.3.6.1.12) and\n potentially re-doing the OAM discovery process if the\n cdot3OamOperStatus was already operational(9)." }, "cdot3OamMaxOamPduSize": { "type": "integer", "description": "The largest OAMPDU that the OAM entity supports. OAM\n entities exchange maximum OAMPDU sizes and negotiate to use\n the smaller of the two maximum OAMPDU sizes between the peers.\n This value is determined by the local implementation.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamConfigRevision": { "type": "integer", "description": "The configuration revision of the OAM entity as reflected in\n the latest OAMPDU sent by the OAM entity. The config revision\n is used by OAM entities to indicate configuration changes have\n occurred which might require the peer OAM entity to\n re-evaluate whether OAM peering is allowed.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamFunctionsSupported": { "type": "string", "description": "The OAM functions supported on this Ethernet like interface.\n OAM consists of separate functional sets beyond the basic\n discovery process which is always required. These functional\n groups can be supported independently by any implementation.\n These values are communicated to the peer via the local\n configuration field of Information OAMPDUs. \n \n Setting 'unidirectionalSupport(0)' indicates that the OAM\n entity supports the transmission of OAMPDUs on links that are\n operating in unidirectional mode (traffic flowing in one\n direction only). Setting 'loopbackSupport(1)' indicates the\n OAM entity can initiate and respond to loopback commands.\n Setting 'eventSupport(2)' indicates the OAM entity can send\n and receive Event Notification OAMPDUs. Setting\n 'variableSupport(3)' indicates the OAM entity can send and\n receive Variable Request and Response OAMPDUs." } } } } } }, "example": { "CISCO-DOT3-OAM-MIB:cdot3OamTable": { "cdot3OamEntry": [ { "ifIndex": "1", "cdot3OamAdminState": "up(1)", "cdot3OamOperStatus": "up(1)", "cdot3OamMode": "example-string", "cdot3OamMaxOamPduSize": 0, "cdot3OamConfigRevision": 0, "cdot3OamFunctionsSupported": "example-string" }, { "ifIndex": "2", "cdot3OamAdminState": "up(1)", "cdot3OamOperStatus": "up(1)", "cdot3OamMode": "example-string", "cdot3OamMaxOamPduSize": 0, "cdot3OamConfigRevision": 0, "cdot3OamFunctionsSupported": "example-string" }, { "ifIndex": "3", "cdot3OamAdminState": "up(1)", "cdot3OamOperStatus": "up(1)", "cdot3OamMode": "example-string", "cdot3OamMaxOamPduSize": 0, "cdot3OamConfigRevision": 0, "cdot3OamFunctionsSupported": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdot3OamTable", "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": "/cdot3OamTable", "x-restconf-kind": "container" }, "/data/CISCO-DOT3-OAM-MIB:cdot3OamTable/cdot3OamEntry": { "get": { "summary": "Get cdot3OamEntry list", "description": "Retrieve list of cdot3OamEntry entries from MIB", "tags": [ "CISCO-DOT3-OAM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the table, containing information on the Ethernet\n OAM function for a single Ethernet like interface. Entries in\n the table are created automatically for each interface\n supporting Ethernet OAM. The status of the row entry can be\n determined from cdot3OamOperStatus. \n \n A cdot3OamEntry is indexed in the cdot3OamTable by the ifIndex\n object of the Interfaces MIB.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cdot3OamAdminState": { "type": "string", "description": "This object is used to provision the default administrative\n OAM mode for this interface. This object represents the\n desired state of OAM for this interface. \n \n The cdot3OamAdminState always starts in the disabled(1) state\n until an explicit management action or configuration\n information retained by the system causes a transition to the\n enabled(2) state. When enabled(2), Ethernet OAM will attempt\n to operate over this interface." }, "cdot3OamOperStatus": { "type": "string", "description": "At initialization and failure conditions, two OAM entities on\n the same full-duplex Ethernet link begin a discovery phase to\n determine what OAM capabilities may be used on that link. The\n progress of this initialization is controlled by the OAM\n sublayer. \n \n This value is always disabled(1) if OAM is disabled on this\n interface via the cdot3OamAdminState. \n \n If the link has detected a fault and is transmitting OAMPDUs\n with a link fault indication, the value is linkFault(2). Also,\n if the interface is not operational (ifOperStatus is not \n up(1)), linkFault(2) is returned. Note that the object \n ifOperStatus may not be up(1) as a result of link failure or\n administrative action (ifAdminState being down(2) or\n testing(3)). \n \n The passiveWait(3) state is returned only by OAM entities in\n passive mode (cdot3OamMode) and reflects the state in which the\n OAM entity is waiting to see if the peer device is OAM\n capable. The activeSendLocal(4) value is used by active mode\n devices (cdot3OamMode) and reflects the OAM entity actively\n trying to discover whether the peer has OAM capability but has\n not yet made that determination. \n \n The state sendLocalAndRemote(5) reflects that the local OAM\n entity has discovered the peer but has not yet accepted or\n rejected the configuration of the peer. The local device can,\n for whatever reason, decide that the peer device is\n unacceptable and decline OAM peering. If the local OAM entity\n rejects the peer OAM entity, the state becomes\n oamPeeringLocallyRejected(7). If the OAM peering is allowed\n by the local device, the state moves to\n sendLocalAndRemoteOk(6). Note that both the\n sendLocalAndRemote(5) and oamPeeringLocallyRejected(7) states\n fall within the state SEND_LOCAL_REMOTE of the Discovery state\n diagram [802.3ah, Figure 57-5], with the difference being\n whether the local OAM client has actively rejected the peering\n or has just not indicated any decision yet. Whether a peering\n decision has been made is indicated via the local flags field\n in the OAMPDU (reflected in the aOAMLocalFlagsField of\n 30.3.6.1.10). \n \n If the remote OAM entity rejects the peering, the state\n becomes oamPeeringRemotelyRejected(8). Note that both the\n sendLocalAndRemoteOk(6) and oamPeeringRemotelyRejected(8)\n states fall within the state SEND_LOCAL_REMOTE_OK of the\n Discovery state diagram [802.3ah, Figure 57-5], with the\n difference being whether the remote OAM client has rejected\n the peering or has just not yet decided. This is indicated\n via the remote flags field in the OAM PDU (reflected in the\n aOAMRemoteFlagsField of 30.3.6.1.11). \n \n When the local OAM entity learns that both it and the remote\n OAM entity have accepted the peering, the state moves to\n operational(9) corresponding to the SEND_ANY state of the\n Discovery state diagram [802.3ah, Figure 57-5]. \n \n Since Ethernet OAM functions are not designed to work\n completely over half-duplex interfaces, the value\n nonOperHalfDuplex(10) is returned whenever Ethernet OAM is\n enabled (cdot3OamAdminState is enabled(1)) but the interface is\n in half-duplex operation." }, "cdot3OamMode": { "type": "string", "description": "This object configures the mode of OAM operation for this\n Ethernet like interface. OAM on Ethernet interfaces may be in\n 'active' mode or 'passive' mode. These two modes differ in\n that active mode provides additional capabilities to initiate\n monitoring activities with the remote OAM peer entity, while\n passive mode generally waits for the peer to initiate OAM\n actions with it. As an example, an active OAM entity can put\n the remote OAM entity in a loopback state, where a passive OAM\n entity cannot. \n \n The default value of cdot3OamMode is dependent on the type of\n system on which this Ethernet like interface resides. The\n default value should be 'active(1)' unless it is known that\n this system should take on a subservient role to the other\n device connected over this interface. \n \n Changing this value results in incrementing the configuration\n revision field of locally generated OAMPDUs (30.3.6.1.12) and\n potentially re-doing the OAM discovery process if the\n cdot3OamOperStatus was already operational(9)." }, "cdot3OamMaxOamPduSize": { "type": "integer", "description": "The largest OAMPDU that the OAM entity supports. OAM\n entities exchange maximum OAMPDU sizes and negotiate to use\n the smaller of the two maximum OAMPDU sizes between the peers.\n This value is determined by the local implementation.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamConfigRevision": { "type": "integer", "description": "The configuration revision of the OAM entity as reflected in\n the latest OAMPDU sent by the OAM entity. The config revision\n is used by OAM entities to indicate configuration changes have\n occurred which might require the peer OAM entity to\n re-evaluate whether OAM peering is allowed.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamFunctionsSupported": { "type": "string", "description": "The OAM functions supported on this Ethernet like interface.\n OAM consists of separate functional sets beyond the basic\n discovery process which is always required. These functional\n groups can be supported independently by any implementation.\n These values are communicated to the peer via the local\n configuration field of Information OAMPDUs. \n \n Setting 'unidirectionalSupport(0)' indicates that the OAM\n entity supports the transmission of OAMPDUs on links that are\n operating in unidirectional mode (traffic flowing in one\n direction only). Setting 'loopbackSupport(1)' indicates the\n OAM entity can initiate and respond to loopback commands.\n Setting 'eventSupport(2)' indicates the OAM entity can send\n and receive Event Notification OAMPDUs. Setting\n 'variableSupport(3)' indicates the OAM entity can send and\n receive Variable Request and Response OAMPDUs." } } } }, "example": { "CISCO-DOT3-OAM-MIB:cdot3OamEntry": [ { "ifIndex": "example-string", "cdot3OamAdminState": "up(1)", "cdot3OamOperStatus": "up(1)", "cdot3OamMode": "example-string", "cdot3OamMaxOamPduSize": 0, "cdot3OamConfigRevision": 0, "cdot3OamFunctionsSupported": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdot3OamEntry", "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": "/cdot3OamTable/cdot3OamEntry", "x-restconf-kind": "container" }, "/data/CISCO-DOT3-OAM-MIB:cdot3OamTable/cdot3OamEntry={ifIndex}": { "get": { "summary": "Get cdot3OamEntry entry", "description": "Retrieve specific cdot3OamEntry entry by key from MIB", "tags": [ "CISCO-DOT3-OAM-MIB" ], "parameters": [ { "name": "ifIndex", "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": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cdot3OamAdminState": { "type": "string", "description": "This object is used to provision the default administrative\n OAM mode for this interface. This object represents the\n desired state of OAM for this interface. \n \n The cdot3OamAdminState always starts in the disabled(1) state\n until an explicit management action or configuration\n information retained by the system causes a transition to the\n enabled(2) state. When enabled(2), Ethernet OAM will attempt\n to operate over this interface." }, "cdot3OamOperStatus": { "type": "string", "description": "At initialization and failure conditions, two OAM entities on\n the same full-duplex Ethernet link begin a discovery phase to\n determine what OAM capabilities may be used on that link. The\n progress of this initialization is controlled by the OAM\n sublayer. \n \n This value is always disabled(1) if OAM is disabled on this\n interface via the cdot3OamAdminState. \n \n If the link has detected a fault and is transmitting OAMPDUs\n with a link fault indication, the value is linkFault(2). Also,\n if the interface is not operational (ifOperStatus is not \n up(1)), linkFault(2) is returned. Note that the object \n ifOperStatus may not be up(1) as a result of link failure or\n administrative action (ifAdminState being down(2) or\n testing(3)). \n \n The passiveWait(3) state is returned only by OAM entities in\n passive mode (cdot3OamMode) and reflects the state in which the\n OAM entity is waiting to see if the peer device is OAM\n capable. The activeSendLocal(4) value is used by active mode\n devices (cdot3OamMode) and reflects the OAM entity actively\n trying to discover whether the peer has OAM capability but has\n not yet made that determination. \n \n The state sendLocalAndRemote(5) reflects that the local OAM\n entity has discovered the peer but has not yet accepted or\n rejected the configuration of the peer. The local device can,\n for whatever reason, decide that the peer device is\n unacceptable and decline OAM peering. If the local OAM entity\n rejects the peer OAM entity, the state becomes\n oamPeeringLocallyRejected(7). If the OAM peering is allowed\n by the local device, the state moves to\n sendLocalAndRemoteOk(6). Note that both the\n sendLocalAndRemote(5) and oamPeeringLocallyRejected(7) states\n fall within the state SEND_LOCAL_REMOTE of the Discovery state\n diagram [802.3ah, Figure 57-5], with the difference being\n whether the local OAM client has actively rejected the peering\n or has just not indicated any decision yet. Whether a peering\n decision has been made is indicated via the local flags field\n in the OAMPDU (reflected in the aOAMLocalFlagsField of\n 30.3.6.1.10). \n \n If the remote OAM entity rejects the peering, the state\n becomes oamPeeringRemotelyRejected(8). Note that both the\n sendLocalAndRemoteOk(6) and oamPeeringRemotelyRejected(8)\n states fall within the state SEND_LOCAL_REMOTE_OK of the\n Discovery state diagram [802.3ah, Figure 57-5], with the\n difference being whether the remote OAM client has rejected\n the peering or has just not yet decided. This is indicated\n via the remote flags field in the OAM PDU (reflected in the\n aOAMRemoteFlagsField of 30.3.6.1.11). \n \n When the local OAM entity learns that both it and the remote\n OAM entity have accepted the peering, the state moves to\n operational(9) corresponding to the SEND_ANY state of the\n Discovery state diagram [802.3ah, Figure 57-5]. \n \n Since Ethernet OAM functions are not designed to work\n completely over half-duplex interfaces, the value\n nonOperHalfDuplex(10) is returned whenever Ethernet OAM is\n enabled (cdot3OamAdminState is enabled(1)) but the interface is\n in half-duplex operation." }, "cdot3OamMode": { "type": "string", "description": "This object configures the mode of OAM operation for this\n Ethernet like interface. OAM on Ethernet interfaces may be in\n 'active' mode or 'passive' mode. These two modes differ in\n that active mode provides additional capabilities to initiate\n monitoring activities with the remote OAM peer entity, while\n passive mode generally waits for the peer to initiate OAM\n actions with it. As an example, an active OAM entity can put\n the remote OAM entity in a loopback state, where a passive OAM\n entity cannot. \n \n The default value of cdot3OamMode is dependent on the type of\n system on which this Ethernet like interface resides. The\n default value should be 'active(1)' unless it is known that\n this system should take on a subservient role to the other\n device connected over this interface. \n \n Changing this value results in incrementing the configuration\n revision field of locally generated OAMPDUs (30.3.6.1.12) and\n potentially re-doing the OAM discovery process if the\n cdot3OamOperStatus was already operational(9)." }, "cdot3OamMaxOamPduSize": { "type": "integer", "description": "The largest OAMPDU that the OAM entity supports. OAM\n entities exchange maximum OAMPDU sizes and negotiate to use\n the smaller of the two maximum OAMPDU sizes between the peers.\n This value is determined by the local implementation.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamConfigRevision": { "type": "integer", "description": "The configuration revision of the OAM entity as reflected in\n the latest OAMPDU sent by the OAM entity. The config revision\n is used by OAM entities to indicate configuration changes have\n occurred which might require the peer OAM entity to\n re-evaluate whether OAM peering is allowed.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamFunctionsSupported": { "type": "string", "description": "The OAM functions supported on this Ethernet like interface.\n OAM consists of separate functional sets beyond the basic\n discovery process which is always required. These functional\n groups can be supported independently by any implementation.\n These values are communicated to the peer via the local\n configuration field of Information OAMPDUs. \n \n Setting 'unidirectionalSupport(0)' indicates that the OAM\n entity supports the transmission of OAMPDUs on links that are\n operating in unidirectional mode (traffic flowing in one\n direction only). Setting 'loopbackSupport(1)' indicates the\n OAM entity can initiate and respond to loopback commands.\n Setting 'eventSupport(2)' indicates the OAM entity can send\n and receive Event Notification OAMPDUs. Setting\n 'variableSupport(3)' indicates the OAM entity can send and\n receive Variable Request and Response OAMPDUs." } } }, "example": { "CISCO-DOT3-OAM-MIB:cdot3OamEntry": { "ifIndex": "example-string", "cdot3OamAdminState": "up(1)", "cdot3OamOperStatus": "up(1)", "cdot3OamMode": "example-string", "cdot3OamMaxOamPduSize": 0, "cdot3OamConfigRevision": 0, "cdot3OamFunctionsSupported": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdot3OamEntry-2" }, "x-yang-path": "/cdot3OamTable/cdot3OamEntry={ifIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex" ] }, "/data/CISCO-DOT3-OAM-MIB:cdot3OamPeerTable": { "get": { "summary": "Get cdot3OamPeerTable data", "description": "Retrieve cdot3OamPeerTable operational data from MIB", "tags": [ "CISCO-DOT3-OAM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains information about the OAM peer for a\n particular Ethernet like interface. OAM entities communicate\n with a single OAM peer entity on Ethernet links on which OAM\n is enabled and operating properly. There is one entry in this\n table for each entry in the cdot3OamTable for which information\n on the peer OAM entity is available.", "properties": { "cdot3OamPeerEntry": { "type": "array", "description": "cdot3OamPeerEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cdot3OamPeerMacAddress": { "type": "string", "description": "The MAC address of the peer OAM entity. The MAC address is\n derived from the most recently received OAMPDU.", "x-yang-type": "yang:mac-address" }, "cdot3OamPeerVendorOui": { "type": "string", "description": "The OUI of the OAM peer as reflected in the latest\n Information OAMPDU received with a Local Information TLV. The\n OUI can be used to identify the vendor of the remote OAM\n entity. This value is initialized to zero before any Local\n Information TLV is received.", "x-yang-type": "CISCO-DOT3-OAM-MIB:Cdot3Oui" }, "cdot3OamPeerVendorInfo": { "type": "integer", "description": "The Vendor Info of the OAM peer as reflected in the latest\n Information OAMPDU received with a Local Information TLV. The\n vendor information field is within the Local Information TLV,\n and can be used to determine additional information about the\n peer entity. The format of the vendor information is\n unspecified within the 32-bit field. This value is\n initialized to zero before any Local Information TLV is\n received.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamPeerMode": { "type": "string", "description": "The mode of the OAM peer as reflected in the latest\n Information OAMPDU received with a Local Information TLV. The\n mode of the peer can be determined from the Configuration\n field in the Local Information TLV of the last Information\n OAMPDU received from the peer. The value is unknown(3)\n whenever no Local Information TLV has been received. The\n values of active(1) and passive(2) are returned when a Local\n Information TLV has been received indicating the peer is in\n active or passive mode, respectively." }, "cdot3OamPeerMaxOamPduSize": { "type": "integer", "description": "The maximum size of OAMPDU supported by the peer as reflected\n in the latest Information OAMPDU received with a Local\n Information TLV. Ethernet OAM on this interface must not use\n OAMPDUs that exceed this size. The maximum OAMPDU size can be\n determined from the PDU Configuration field of the Local\n Information TLV of the last Information OAMPDU received from\n the peer. A value of zero is returned if no Local Information\n TLV has been received. Otherwise, the value of the OAM peer's\n maximum OAMPDU size is returned in this value. \n Note that the values 1..63 are invalid sizes for Ethernet\n frames and should never appear.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamPeerConfigRevision": { "type": "integer", "description": "The configuration revision of the OAM peer as reflected in\n the latest OAMPDU. This attribute is changed by the peer\n whenever it has a local configuration change for Ethernet OAM\n this interface. The configuration revision can be determined\n from the Revision field of the Local Information TLV of the\n most recently received Information OAMPDU with a Local\n Information TLV. A value of zero is returned if no Local\n Information TLV has been received.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamPeerFunctionsSupported": { "type": "string", "description": "The OAM functions supported on this Ethernet like interface.\n OAM consists of separate functionality sets above the basic\n discovery process. This value indicates the capabilities of\n the peer OAM entity with respect to these functions. This\n value is initialized so all bits are clear. \n \n If unidirectionalSupport(0) is set, then the peer OAM entity\n supports sending OAM frames on Ethernet interfaces when the\n receive path is known to be inoperable. If\n loopbackSupport(1) is set, then the peer OAM entity can send\n and receive OAM loopback commands. If eventSupport(2) is set,\n then the peer OAM entity can send and receive event OAMPDUs to\n signal various error conditions. If variableSupport(3) is set,\n then the peer OAM entity can send and receive variable\n requests to monitor attribute value as described in Clause 57\n of [802.3ah]. \n \n The capabilities of the OAM peer can be determined from the\n configuration field of the Local Information TLV of the most\n recently received Information OAMPDU with a Local Information\n TLV. All zeros are returned if no Local Information TLV has\n yet been received." } } } } } }, "example": { "CISCO-DOT3-OAM-MIB:cdot3OamPeerTable": { "cdot3OamPeerEntry": [ { "ifIndex": "1", "cdot3OamPeerMacAddress": "00:11:22:33:44:55", "cdot3OamPeerVendorOui": "example-string", "cdot3OamPeerVendorInfo": 0, "cdot3OamPeerMode": "example-string", "cdot3OamPeerMaxOamPduSize": 0, "cdot3OamPeerConfigRevision": 0, "cdot3OamPeerFunctionsSupported": "example-string" }, { "ifIndex": "2", "cdot3OamPeerMacAddress": "00:11:22:33:44:55", "cdot3OamPeerVendorOui": "example-string", "cdot3OamPeerVendorInfo": 0, "cdot3OamPeerMode": "example-string", "cdot3OamPeerMaxOamPduSize": 0, "cdot3OamPeerConfigRevision": 0, "cdot3OamPeerFunctionsSupported": "example-string" }, { "ifIndex": "3", "cdot3OamPeerMacAddress": "00:11:22:33:44:55", "cdot3OamPeerVendorOui": "example-string", "cdot3OamPeerVendorInfo": 0, "cdot3OamPeerMode": "example-string", "cdot3OamPeerMaxOamPduSize": 0, "cdot3OamPeerConfigRevision": 0, "cdot3OamPeerFunctionsSupported": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdot3OamPeerTable", "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": "/cdot3OamPeerTable", "x-restconf-kind": "container" }, "/data/CISCO-DOT3-OAM-MIB:cdot3OamPeerTable/cdot3OamPeerEntry": { "get": { "summary": "Get cdot3OamPeerEntry list", "description": "Retrieve list of cdot3OamPeerEntry entries from MIB", "tags": [ "CISCO-DOT3-OAM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cdot3OamPeerEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cdot3OamPeerMacAddress": { "type": "string", "description": "The MAC address of the peer OAM entity. The MAC address is\n derived from the most recently received OAMPDU.", "x-yang-type": "yang:mac-address" }, "cdot3OamPeerVendorOui": { "type": "string", "description": "The OUI of the OAM peer as reflected in the latest\n Information OAMPDU received with a Local Information TLV. The\n OUI can be used to identify the vendor of the remote OAM\n entity. This value is initialized to zero before any Local\n Information TLV is received.", "x-yang-type": "CISCO-DOT3-OAM-MIB:Cdot3Oui" }, "cdot3OamPeerVendorInfo": { "type": "integer", "description": "The Vendor Info of the OAM peer as reflected in the latest\n Information OAMPDU received with a Local Information TLV. The\n vendor information field is within the Local Information TLV,\n and can be used to determine additional information about the\n peer entity. The format of the vendor information is\n unspecified within the 32-bit field. This value is\n initialized to zero before any Local Information TLV is\n received.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamPeerMode": { "type": "string", "description": "The mode of the OAM peer as reflected in the latest\n Information OAMPDU received with a Local Information TLV. The\n mode of the peer can be determined from the Configuration\n field in the Local Information TLV of the last Information\n OAMPDU received from the peer. The value is unknown(3)\n whenever no Local Information TLV has been received. The\n values of active(1) and passive(2) are returned when a Local\n Information TLV has been received indicating the peer is in\n active or passive mode, respectively." }, "cdot3OamPeerMaxOamPduSize": { "type": "integer", "description": "The maximum size of OAMPDU supported by the peer as reflected\n in the latest Information OAMPDU received with a Local\n Information TLV. Ethernet OAM on this interface must not use\n OAMPDUs that exceed this size. The maximum OAMPDU size can be\n determined from the PDU Configuration field of the Local\n Information TLV of the last Information OAMPDU received from\n the peer. A value of zero is returned if no Local Information\n TLV has been received. Otherwise, the value of the OAM peer's\n maximum OAMPDU size is returned in this value. \n Note that the values 1..63 are invalid sizes for Ethernet\n frames and should never appear.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamPeerConfigRevision": { "type": "integer", "description": "The configuration revision of the OAM peer as reflected in\n the latest OAMPDU. This attribute is changed by the peer\n whenever it has a local configuration change for Ethernet OAM\n this interface. The configuration revision can be determined\n from the Revision field of the Local Information TLV of the\n most recently received Information OAMPDU with a Local\n Information TLV. A value of zero is returned if no Local\n Information TLV has been received.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamPeerFunctionsSupported": { "type": "string", "description": "The OAM functions supported on this Ethernet like interface.\n OAM consists of separate functionality sets above the basic\n discovery process. This value indicates the capabilities of\n the peer OAM entity with respect to these functions. This\n value is initialized so all bits are clear. \n \n If unidirectionalSupport(0) is set, then the peer OAM entity\n supports sending OAM frames on Ethernet interfaces when the\n receive path is known to be inoperable. If\n loopbackSupport(1) is set, then the peer OAM entity can send\n and receive OAM loopback commands. If eventSupport(2) is set,\n then the peer OAM entity can send and receive event OAMPDUs to\n signal various error conditions. If variableSupport(3) is set,\n then the peer OAM entity can send and receive variable\n requests to monitor attribute value as described in Clause 57\n of [802.3ah]. \n \n The capabilities of the OAM peer can be determined from the\n configuration field of the Local Information TLV of the most\n recently received Information OAMPDU with a Local Information\n TLV. All zeros are returned if no Local Information TLV has\n yet been received." } } } }, "example": { "CISCO-DOT3-OAM-MIB:cdot3OamPeerEntry": [ { "ifIndex": "example-string", "cdot3OamPeerMacAddress": "00:11:22:33:44:55", "cdot3OamPeerVendorOui": "example-string", "cdot3OamPeerVendorInfo": 0, "cdot3OamPeerMode": "example-string", "cdot3OamPeerMaxOamPduSize": 0, "cdot3OamPeerConfigRevision": 0, "cdot3OamPeerFunctionsSupported": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdot3OamPeerEntry", "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": "/cdot3OamPeerTable/cdot3OamPeerEntry", "x-restconf-kind": "container" }, "/data/CISCO-DOT3-OAM-MIB:cdot3OamPeerTable/cdot3OamPeerEntry={ifIndex}": { "get": { "summary": "Get cdot3OamPeerEntry entry", "description": "Retrieve specific cdot3OamPeerEntry entry by key from MIB", "tags": [ "CISCO-DOT3-OAM-MIB" ], "parameters": [ { "name": "ifIndex", "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": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cdot3OamPeerMacAddress": { "type": "string", "description": "The MAC address of the peer OAM entity. The MAC address is\n derived from the most recently received OAMPDU.", "x-yang-type": "yang:mac-address" }, "cdot3OamPeerVendorOui": { "type": "string", "description": "The OUI of the OAM peer as reflected in the latest\n Information OAMPDU received with a Local Information TLV. The\n OUI can be used to identify the vendor of the remote OAM\n entity. This value is initialized to zero before any Local\n Information TLV is received.", "x-yang-type": "CISCO-DOT3-OAM-MIB:Cdot3Oui" }, "cdot3OamPeerVendorInfo": { "type": "integer", "description": "The Vendor Info of the OAM peer as reflected in the latest\n Information OAMPDU received with a Local Information TLV. The\n vendor information field is within the Local Information TLV,\n and can be used to determine additional information about the\n peer entity. The format of the vendor information is\n unspecified within the 32-bit field. This value is\n initialized to zero before any Local Information TLV is\n received.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamPeerMode": { "type": "string", "description": "The mode of the OAM peer as reflected in the latest\n Information OAMPDU received with a Local Information TLV. The\n mode of the peer can be determined from the Configuration\n field in the Local Information TLV of the last Information\n OAMPDU received from the peer. The value is unknown(3)\n whenever no Local Information TLV has been received. The\n values of active(1) and passive(2) are returned when a Local\n Information TLV has been received indicating the peer is in\n active or passive mode, respectively." }, "cdot3OamPeerMaxOamPduSize": { "type": "integer", "description": "The maximum size of OAMPDU supported by the peer as reflected\n in the latest Information OAMPDU received with a Local\n Information TLV. Ethernet OAM on this interface must not use\n OAMPDUs that exceed this size. The maximum OAMPDU size can be\n determined from the PDU Configuration field of the Local\n Information TLV of the last Information OAMPDU received from\n the peer. A value of zero is returned if no Local Information\n TLV has been received. Otherwise, the value of the OAM peer's\n maximum OAMPDU size is returned in this value. \n Note that the values 1..63 are invalid sizes for Ethernet\n frames and should never appear.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamPeerConfigRevision": { "type": "integer", "description": "The configuration revision of the OAM peer as reflected in\n the latest OAMPDU. This attribute is changed by the peer\n whenever it has a local configuration change for Ethernet OAM\n this interface. The configuration revision can be determined\n from the Revision field of the Local Information TLV of the\n most recently received Information OAMPDU with a Local\n Information TLV. A value of zero is returned if no Local\n Information TLV has been received.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamPeerFunctionsSupported": { "type": "string", "description": "The OAM functions supported on this Ethernet like interface.\n OAM consists of separate functionality sets above the basic\n discovery process. This value indicates the capabilities of\n the peer OAM entity with respect to these functions. This\n value is initialized so all bits are clear. \n \n If unidirectionalSupport(0) is set, then the peer OAM entity\n supports sending OAM frames on Ethernet interfaces when the\n receive path is known to be inoperable. If\n loopbackSupport(1) is set, then the peer OAM entity can send\n and receive OAM loopback commands. If eventSupport(2) is set,\n then the peer OAM entity can send and receive event OAMPDUs to\n signal various error conditions. If variableSupport(3) is set,\n then the peer OAM entity can send and receive variable\n requests to monitor attribute value as described in Clause 57\n of [802.3ah]. \n \n The capabilities of the OAM peer can be determined from the\n configuration field of the Local Information TLV of the most\n recently received Information OAMPDU with a Local Information\n TLV. All zeros are returned if no Local Information TLV has\n yet been received." } } }, "example": { "CISCO-DOT3-OAM-MIB:cdot3OamPeerEntry": { "ifIndex": "example-string", "cdot3OamPeerMacAddress": "00:11:22:33:44:55", "cdot3OamPeerVendorOui": "example-string", "cdot3OamPeerVendorInfo": 0, "cdot3OamPeerMode": "example-string", "cdot3OamPeerMaxOamPduSize": 0, "cdot3OamPeerConfigRevision": 0, "cdot3OamPeerFunctionsSupported": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdot3OamPeerEntry-2" }, "x-yang-path": "/cdot3OamPeerTable/cdot3OamPeerEntry={ifIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex" ] }, "/data/CISCO-DOT3-OAM-MIB:cdot3OamLoopbackTable": { "get": { "summary": "Get cdot3OamLoopbackTable data", "description": "Retrieve cdot3OamLoopbackTable operational data from MIB", "tags": [ "CISCO-DOT3-OAM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "cdot3OamLoopbackTable", "properties": { "cdot3OamLoopbackEntry": { "type": "array", "description": "An entry in the table, containing information on the loopback\n status for a single Ethernet like interface. Entries in the\n table are automatically created whenever the local OAM entity\n supports loopback capabilities. The loopback status on the\n interface can be determined from the cdot3OamLoopbackStatus\n object.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cdot3OamLoopbackStatus": { "type": "string", "description": "The loopback status of the OAM entity. This status is\n determined by a combination of the local parser and\n multiplexer states, the remote parser and multiplexer states,\n as well as by the actions of the local OAM client. When\n operating in normal mode with no loopback in progress, the\n status reads noLoopback(1). \n \n The values initiatingLooopback(2) and terminatingLoopback(4)\n can be read or written. The other values can only be read -\n they can never be written. Writing initiatingLoopback causes\n the local OAM entity to start the loopback process with its\n peer. This value can only be written when the status is\n noLoopback(1). Writing the value initiatingLoopback(2) in any\n other state has no effect. When in remoteLoopback(3), writing\n terminatingLoopback(4) causes the local OAM entity to initiate\n the termination of the loopback state. Writing\n terminatingLoopack(4) in any other state has no effect. \n If the OAM client initiates a looopback and has sent an\n Loopback OAMPDU and is waiting for a response, where the local\n parser and multiplexer states are DISCARD (see [802.3ah,\n 57.2.11.1]), the status is 'initiatingLoopback'. In this\n case, the local OAM entity has yet to receive any\n acknowledgement that the remote OAM entity has received its\n loopback command request. \n \n If the local OAM client knows that the remote OAM entity is in\n loopback mode (via the remote state information as described\n in [802.3ah, 57.2.11.1, 30.3.6.1.15]), the status is\n remoteLoopback(3). If the local OAM client is in the process\n of terminating the remote loopback [802.3ah, 57.2.11.3,\n 30.3.6.1.14], with its local multiplexer and parser states in\n DISCARD, the status is terminatingLoopback(4). If the remote\n OAM client has put the local OAM entity in loopback mode as\n indicated by its local parser state, the status is\n localLoopback(5). \n \n The unknown(6) status indicates the parser and multiplexer\n combination is unexpected. This status may be returned if the\n OAM loopback is in a transition state but should not persist. \n \n The values of this attribute correspond to the following\n values of the local and remote parser and multiplexer states. \n \n value LclPrsr LclMux RmtPrsr RmtMux\n noLoopback FWD FWD FWD FWD \n initLoopback DISCARD DISCARD FWD FWD \n rmtLoopback DISCARD FWD LPBK DISCARD\n tmtngLoopback DISCARD DISCARD LPBK DISCARD\n lclLoopback LPBK DISCARD DISCARD FWD\n unknown *** any other combination ***" }, "cdot3OamLoopbackIgnoreRx": { "type": "string", "description": "Since OAM loopback is a disruptive operation (user traffic\n does not pass), this attribute provides a mechanism to provide\n controls over whether received OAM loopback commands are\n processed or ignored. When the value is ignore(1), received\n loopback commands are ignored. When the value is process(2),\n OAM loopback commands are processed. The default value is to\n ignore loopback commands (ignore(1))." } } } } } }, "example": { "CISCO-DOT3-OAM-MIB:cdot3OamLoopbackTable": { "cdot3OamLoopbackEntry": [ { "ifIndex": "1", "cdot3OamLoopbackStatus": "up(1)", "cdot3OamLoopbackIgnoreRx": "example-string" }, { "ifIndex": "2", "cdot3OamLoopbackStatus": "up(1)", "cdot3OamLoopbackIgnoreRx": "example-string" }, { "ifIndex": "3", "cdot3OamLoopbackStatus": "up(1)", "cdot3OamLoopbackIgnoreRx": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdot3OamLoopbackTable", "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": "/cdot3OamLoopbackTable", "x-restconf-kind": "container" }, "/data/CISCO-DOT3-OAM-MIB:cdot3OamLoopbackTable/cdot3OamLoopbackEntry": { "get": { "summary": "Get cdot3OamLoopbackEntry list", "description": "Retrieve list of cdot3OamLoopbackEntry entries from MIB", "tags": [ "CISCO-DOT3-OAM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the table, containing information on the loopback\n status for a single Ethernet like interface. Entries in the\n table are automatically created whenever the local OAM entity\n supports loopback capabilities. The loopback status on the\n interface can be determined from the cdot3OamLoopbackStatus\n object.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cdot3OamLoopbackStatus": { "type": "string", "description": "The loopback status of the OAM entity. This status is\n determined by a combination of the local parser and\n multiplexer states, the remote parser and multiplexer states,\n as well as by the actions of the local OAM client. When\n operating in normal mode with no loopback in progress, the\n status reads noLoopback(1). \n \n The values initiatingLooopback(2) and terminatingLoopback(4)\n can be read or written. The other values can only be read -\n they can never be written. Writing initiatingLoopback causes\n the local OAM entity to start the loopback process with its\n peer. This value can only be written when the status is\n noLoopback(1). Writing the value initiatingLoopback(2) in any\n other state has no effect. When in remoteLoopback(3), writing\n terminatingLoopback(4) causes the local OAM entity to initiate\n the termination of the loopback state. Writing\n terminatingLoopack(4) in any other state has no effect. \n If the OAM client initiates a looopback and has sent an\n Loopback OAMPDU and is waiting for a response, where the local\n parser and multiplexer states are DISCARD (see [802.3ah,\n 57.2.11.1]), the status is 'initiatingLoopback'. In this\n case, the local OAM entity has yet to receive any\n acknowledgement that the remote OAM entity has received its\n loopback command request. \n \n If the local OAM client knows that the remote OAM entity is in\n loopback mode (via the remote state information as described\n in [802.3ah, 57.2.11.1, 30.3.6.1.15]), the status is\n remoteLoopback(3). If the local OAM client is in the process\n of terminating the remote loopback [802.3ah, 57.2.11.3,\n 30.3.6.1.14], with its local multiplexer and parser states in\n DISCARD, the status is terminatingLoopback(4). If the remote\n OAM client has put the local OAM entity in loopback mode as\n indicated by its local parser state, the status is\n localLoopback(5). \n \n The unknown(6) status indicates the parser and multiplexer\n combination is unexpected. This status may be returned if the\n OAM loopback is in a transition state but should not persist. \n \n The values of this attribute correspond to the following\n values of the local and remote parser and multiplexer states. \n \n value LclPrsr LclMux RmtPrsr RmtMux\n noLoopback FWD FWD FWD FWD \n initLoopback DISCARD DISCARD FWD FWD \n rmtLoopback DISCARD FWD LPBK DISCARD\n tmtngLoopback DISCARD DISCARD LPBK DISCARD\n lclLoopback LPBK DISCARD DISCARD FWD\n unknown *** any other combination ***" }, "cdot3OamLoopbackIgnoreRx": { "type": "string", "description": "Since OAM loopback is a disruptive operation (user traffic\n does not pass), this attribute provides a mechanism to provide\n controls over whether received OAM loopback commands are\n processed or ignored. When the value is ignore(1), received\n loopback commands are ignored. When the value is process(2),\n OAM loopback commands are processed. The default value is to\n ignore loopback commands (ignore(1))." } } } }, "example": { "CISCO-DOT3-OAM-MIB:cdot3OamLoopbackEntry": [ { "ifIndex": "example-string", "cdot3OamLoopbackStatus": "up(1)", "cdot3OamLoopbackIgnoreRx": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdot3OamLoopbackEntry", "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": "/cdot3OamLoopbackTable/cdot3OamLoopbackEntry", "x-restconf-kind": "container" }, "/data/CISCO-DOT3-OAM-MIB:cdot3OamLoopbackTable/cdot3OamLoopbackEntry={ifIndex}": { "get": { "summary": "Get cdot3OamLoopbackEntry entry", "description": "Retrieve specific cdot3OamLoopbackEntry entry by key from MIB", "tags": [ "CISCO-DOT3-OAM-MIB" ], "parameters": [ { "name": "ifIndex", "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": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cdot3OamLoopbackStatus": { "type": "string", "description": "The loopback status of the OAM entity. This status is\n determined by a combination of the local parser and\n multiplexer states, the remote parser and multiplexer states,\n as well as by the actions of the local OAM client. When\n operating in normal mode with no loopback in progress, the\n status reads noLoopback(1). \n \n The values initiatingLooopback(2) and terminatingLoopback(4)\n can be read or written. The other values can only be read -\n they can never be written. Writing initiatingLoopback causes\n the local OAM entity to start the loopback process with its\n peer. This value can only be written when the status is\n noLoopback(1). Writing the value initiatingLoopback(2) in any\n other state has no effect. When in remoteLoopback(3), writing\n terminatingLoopback(4) causes the local OAM entity to initiate\n the termination of the loopback state. Writing\n terminatingLoopack(4) in any other state has no effect. \n If the OAM client initiates a looopback and has sent an\n Loopback OAMPDU and is waiting for a response, where the local\n parser and multiplexer states are DISCARD (see [802.3ah,\n 57.2.11.1]), the status is 'initiatingLoopback'. In this\n case, the local OAM entity has yet to receive any\n acknowledgement that the remote OAM entity has received its\n loopback command request. \n \n If the local OAM client knows that the remote OAM entity is in\n loopback mode (via the remote state information as described\n in [802.3ah, 57.2.11.1, 30.3.6.1.15]), the status is\n remoteLoopback(3). If the local OAM client is in the process\n of terminating the remote loopback [802.3ah, 57.2.11.3,\n 30.3.6.1.14], with its local multiplexer and parser states in\n DISCARD, the status is terminatingLoopback(4). If the remote\n OAM client has put the local OAM entity in loopback mode as\n indicated by its local parser state, the status is\n localLoopback(5). \n \n The unknown(6) status indicates the parser and multiplexer\n combination is unexpected. This status may be returned if the\n OAM loopback is in a transition state but should not persist. \n \n The values of this attribute correspond to the following\n values of the local and remote parser and multiplexer states. \n \n value LclPrsr LclMux RmtPrsr RmtMux\n noLoopback FWD FWD FWD FWD \n initLoopback DISCARD DISCARD FWD FWD \n rmtLoopback DISCARD FWD LPBK DISCARD\n tmtngLoopback DISCARD DISCARD LPBK DISCARD\n lclLoopback LPBK DISCARD DISCARD FWD\n unknown *** any other combination ***" }, "cdot3OamLoopbackIgnoreRx": { "type": "string", "description": "Since OAM loopback is a disruptive operation (user traffic\n does not pass), this attribute provides a mechanism to provide\n controls over whether received OAM loopback commands are\n processed or ignored. When the value is ignore(1), received\n loopback commands are ignored. When the value is process(2),\n OAM loopback commands are processed. The default value is to\n ignore loopback commands (ignore(1))." } } }, "example": { "CISCO-DOT3-OAM-MIB:cdot3OamLoopbackEntry": { "ifIndex": "example-string", "cdot3OamLoopbackStatus": "up(1)", "cdot3OamLoopbackIgnoreRx": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdot3OamLoopbackEntry-2" }, "x-yang-path": "/cdot3OamLoopbackTable/cdot3OamLoopbackEntry={ifIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex" ] }, "/data/CISCO-DOT3-OAM-MIB:cdot3OamStatsTable": { "get": { "summary": "Get cdot3OamStatsTable data", "description": "Retrieve cdot3OamStatsTable operational data from MIB", "tags": [ "CISCO-DOT3-OAM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains statistics for the OAM function on a\n particular Ethernet like interface. There is an entry in the\n table for every entry in the cdot3OamTable. \n \n The counters in this table are defined as 32-bit entries to\n match the counter size as defined in [802.3ah]. Given the OAM\n protocol is a slow protocol, the counters increment at a slow\n rate.", "properties": { "cdot3OamStatsEntry": { "type": "array", "description": "An entry in the table, containing statistics information on\n the Ethernet OAM function for a single Ethernet like\n interface. Entries are automatically created for every entry\n in the cdot3OamTable. Counters are maintained across\n transitions in cdot3OamOperStatus.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cdot3OamInformationTx": { "type": "integer", "description": "A count of the number of Information OAMPDUs transmitted on\n this interface.\n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamInformationRx": { "type": "integer", "description": "A count of the number of Information OAMPDUs received on this\n interface.\n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamUniqueEventNotificationTx": { "type": "integer", "description": "A count of the number of unique Event OAMPDUs transmitted on\n this interface. Event notifications may be sent in duplicate\n to increase the probability of successfully being received,\n given the possibility that a frame may be lost in transit.\n Duplicate Event Notification transmissions are counted by\n cdot3OamDuplicateEventNotificationTx. \n \n A unique Event Notification OAMPDU is indicated as an Event\n Notification OAMPDU with a Sequence Number field that is\n distinct from the previously transmitted Event Notification\n OAMPDU Sequence Number. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamUniqueEventNotificationRx": { "type": "integer", "description": "A count of the number of unique Event OAMPDUs received on\n this interface. Event notification OAMPDUs may be sent in\n duplicate to increase the probability of successfully being\n received, given the possibility that a frame may be lost in\n transit. Duplicate Event Notification receptions are counted\n by cdot3OamDuplicateEventNotificationRx. \n \n A unique Event Notification OAMPDU is indicated as an Event\n Notification OAMPDU with a Sequence Number field that is\n distinct from the previously received Event Notification\n OAMPDU Sequence Number. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamDuplicateEventNotificationTx": { "type": "integer", "description": "A count of the number of duplicate Event OAMPDUs transmitted\n on this interface. Event notification OAMPDUs may be sent in\n duplicate to increase the probability of successfully being\n received, given the possibility that a frame may be lost in\n transit. \n \n A duplicate Event Notification OAMPDU is indicated as an Event\n Notification OAMPDU with a Sequence Number field that is\n identical to the previously transmitted Event Notification\n OAMPDU Sequence Number. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamDuplicateEventNotificationRx": { "type": "integer", "description": "A count of the number of duplicate Event OAMPDUs received on\n this interface. Event notification OAMPDUs may be sent in\n duplicate to increase the probability of successfully being\n received, given the possibility that a frame may be lost in\n transit. \n \n A duplicate Event Notification OAMPDU is indicated as an Event\n Notification OAMPDU with a Sequence Number field that is\n identical to the previously received Event Notification OAMPDU\n Sequence Number. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamLoopbackControlTx": { "type": "integer", "description": "A count of the number of Loopback Control OAMPDUs transmitted\n on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamLoopbackControlRx": { "type": "integer", "description": "A count of the number of Loopback Control OAMPDUs received\n on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamVariableRequestTx": { "type": "integer", "description": "A count of the number of Variable Request OAMPDUs transmitted\n on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamVariableRequestRx": { "type": "integer", "description": "A count of the number of Variable Request OAMPDUs received on\n this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamVariableResponseTx": { "type": "integer", "description": "A count of the number of Variable Response OAMPDUs\n transmitted on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamVariableResponseRx": { "type": "integer", "description": "A count of the number of Variable Response OAMPDUs received\n on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamOrgSpecificTx": { "type": "integer", "description": "A count of the number of Organization Specific OAMPDUs\n transmitted on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamOrgSpecificRx": { "type": "integer", "description": "A count of the number of Organization Specific OAMPDUs\n received on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamUnsupportedCodesTx": { "type": "integer", "description": "A count of the number of OAMPDUs transmitted on this\n interface with an unsupported op-code. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamUnsupportedCodesRx": { "type": "integer", "description": "A count of the number of OAMPDUs received on this interface\n with an unsupported op-code. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamFramesLostDueToOam": { "type": "integer", "description": "A count of the number of frames that were dropped by the OAM\n multiplexer. Since the OAM multiplexer has multiple inputs\n and a single output, there may be cases where frames are\n dropped due to transmit resource contention. This counter is\n incremented whenever a frame is dropped by the OAM layer.\n Note that any Ethernet frame, not just OAMPDUs, may be dropped\n by the OAM layer. This can occur when an OAMPDU takes\n precedence over a 'normal' frame resulting in the 'normal'\n frame being dropped. \n \n When this counter is incremented, no other counters in this\n MIB are incremented. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "CISCO-DOT3-OAM-MIB:cdot3OamStatsTable": { "cdot3OamStatsEntry": [ { "ifIndex": "1", "cdot3OamInformationTx": 0, "cdot3OamInformationRx": 0, "cdot3OamUniqueEventNotificationTx": 0, "cdot3OamUniqueEventNotificationRx": 0, "cdot3OamDuplicateEventNotificationTx": 0, "cdot3OamDuplicateEventNotificationRx": 0, "cdot3OamLoopbackControlTx": 0, "cdot3OamLoopbackControlRx": 0, "cdot3OamVariableRequestTx": 0, "cdot3OamVariableRequestRx": 0, "cdot3OamVariableResponseTx": 0, "cdot3OamVariableResponseRx": 0, "cdot3OamOrgSpecificTx": 0, "cdot3OamOrgSpecificRx": 0, "cdot3OamUnsupportedCodesTx": 0, "cdot3OamUnsupportedCodesRx": 0, "cdot3OamFramesLostDueToOam": 0 }, { "ifIndex": "2", "cdot3OamInformationTx": 0, "cdot3OamInformationRx": 0, "cdot3OamUniqueEventNotificationTx": 0, "cdot3OamUniqueEventNotificationRx": 0, "cdot3OamDuplicateEventNotificationTx": 0, "cdot3OamDuplicateEventNotificationRx": 0, "cdot3OamLoopbackControlTx": 0, "cdot3OamLoopbackControlRx": 0, "cdot3OamVariableRequestTx": 0, "cdot3OamVariableRequestRx": 0, "cdot3OamVariableResponseTx": 0, "cdot3OamVariableResponseRx": 0, "cdot3OamOrgSpecificTx": 0, "cdot3OamOrgSpecificRx": 0, "cdot3OamUnsupportedCodesTx": 0, "cdot3OamUnsupportedCodesRx": 0, "cdot3OamFramesLostDueToOam": 0 }, { "ifIndex": "3", "cdot3OamInformationTx": 0, "cdot3OamInformationRx": 0, "cdot3OamUniqueEventNotificationTx": 0, "cdot3OamUniqueEventNotificationRx": 0, "cdot3OamDuplicateEventNotificationTx": 0, "cdot3OamDuplicateEventNotificationRx": 0, "cdot3OamLoopbackControlTx": 0, "cdot3OamLoopbackControlRx": 0, "cdot3OamVariableRequestTx": 0, "cdot3OamVariableRequestRx": 0, "cdot3OamVariableResponseTx": 0, "cdot3OamVariableResponseRx": 0, "cdot3OamOrgSpecificTx": 0, "cdot3OamOrgSpecificRx": 0, "cdot3OamUnsupportedCodesTx": 0, "cdot3OamUnsupportedCodesRx": 0, "cdot3OamFramesLostDueToOam": 0 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdot3OamStatsTable", "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": "/cdot3OamStatsTable", "x-restconf-kind": "container" }, "/data/CISCO-DOT3-OAM-MIB:cdot3OamStatsTable/cdot3OamStatsEntry": { "get": { "summary": "Get cdot3OamStatsEntry list", "description": "Retrieve list of cdot3OamStatsEntry entries from MIB", "tags": [ "CISCO-DOT3-OAM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the table, containing statistics information on\n the Ethernet OAM function for a single Ethernet like\n interface. Entries are automatically created for every entry\n in the cdot3OamTable. Counters are maintained across\n transitions in cdot3OamOperStatus.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cdot3OamInformationTx": { "type": "integer", "description": "A count of the number of Information OAMPDUs transmitted on\n this interface.\n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamInformationRx": { "type": "integer", "description": "A count of the number of Information OAMPDUs received on this\n interface.\n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamUniqueEventNotificationTx": { "type": "integer", "description": "A count of the number of unique Event OAMPDUs transmitted on\n this interface. Event notifications may be sent in duplicate\n to increase the probability of successfully being received,\n given the possibility that a frame may be lost in transit.\n Duplicate Event Notification transmissions are counted by\n cdot3OamDuplicateEventNotificationTx. \n \n A unique Event Notification OAMPDU is indicated as an Event\n Notification OAMPDU with a Sequence Number field that is\n distinct from the previously transmitted Event Notification\n OAMPDU Sequence Number. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamUniqueEventNotificationRx": { "type": "integer", "description": "A count of the number of unique Event OAMPDUs received on\n this interface. Event notification OAMPDUs may be sent in\n duplicate to increase the probability of successfully being\n received, given the possibility that a frame may be lost in\n transit. Duplicate Event Notification receptions are counted\n by cdot3OamDuplicateEventNotificationRx. \n \n A unique Event Notification OAMPDU is indicated as an Event\n Notification OAMPDU with a Sequence Number field that is\n distinct from the previously received Event Notification\n OAMPDU Sequence Number. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamDuplicateEventNotificationTx": { "type": "integer", "description": "A count of the number of duplicate Event OAMPDUs transmitted\n on this interface. Event notification OAMPDUs may be sent in\n duplicate to increase the probability of successfully being\n received, given the possibility that a frame may be lost in\n transit. \n \n A duplicate Event Notification OAMPDU is indicated as an Event\n Notification OAMPDU with a Sequence Number field that is\n identical to the previously transmitted Event Notification\n OAMPDU Sequence Number. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamDuplicateEventNotificationRx": { "type": "integer", "description": "A count of the number of duplicate Event OAMPDUs received on\n this interface. Event notification OAMPDUs may be sent in\n duplicate to increase the probability of successfully being\n received, given the possibility that a frame may be lost in\n transit. \n \n A duplicate Event Notification OAMPDU is indicated as an Event\n Notification OAMPDU with a Sequence Number field that is\n identical to the previously received Event Notification OAMPDU\n Sequence Number. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamLoopbackControlTx": { "type": "integer", "description": "A count of the number of Loopback Control OAMPDUs transmitted\n on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamLoopbackControlRx": { "type": "integer", "description": "A count of the number of Loopback Control OAMPDUs received\n on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamVariableRequestTx": { "type": "integer", "description": "A count of the number of Variable Request OAMPDUs transmitted\n on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamVariableRequestRx": { "type": "integer", "description": "A count of the number of Variable Request OAMPDUs received on\n this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamVariableResponseTx": { "type": "integer", "description": "A count of the number of Variable Response OAMPDUs\n transmitted on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamVariableResponseRx": { "type": "integer", "description": "A count of the number of Variable Response OAMPDUs received\n on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamOrgSpecificTx": { "type": "integer", "description": "A count of the number of Organization Specific OAMPDUs\n transmitted on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamOrgSpecificRx": { "type": "integer", "description": "A count of the number of Organization Specific OAMPDUs\n received on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamUnsupportedCodesTx": { "type": "integer", "description": "A count of the number of OAMPDUs transmitted on this\n interface with an unsupported op-code. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamUnsupportedCodesRx": { "type": "integer", "description": "A count of the number of OAMPDUs received on this interface\n with an unsupported op-code. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamFramesLostDueToOam": { "type": "integer", "description": "A count of the number of frames that were dropped by the OAM\n multiplexer. Since the OAM multiplexer has multiple inputs\n and a single output, there may be cases where frames are\n dropped due to transmit resource contention. This counter is\n incremented whenever a frame is dropped by the OAM layer.\n Note that any Ethernet frame, not just OAMPDUs, may be dropped\n by the OAM layer. This can occur when an OAMPDU takes\n precedence over a 'normal' frame resulting in the 'normal'\n frame being dropped. \n \n When this counter is incremented, no other counters in this\n MIB are incremented. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-DOT3-OAM-MIB:cdot3OamStatsEntry": [ { "ifIndex": "example-string", "cdot3OamInformationTx": 0, "cdot3OamInformationRx": 0, "cdot3OamUniqueEventNotificationTx": 0, "cdot3OamUniqueEventNotificationRx": 0, "cdot3OamDuplicateEventNotificationTx": 0, "cdot3OamDuplicateEventNotificationRx": 0, "cdot3OamLoopbackControlTx": 0, "cdot3OamLoopbackControlRx": 0, "cdot3OamVariableRequestTx": 0, "cdot3OamVariableRequestRx": 0, "cdot3OamVariableResponseTx": 0, "cdot3OamVariableResponseRx": 0, "cdot3OamOrgSpecificTx": 0, "cdot3OamOrgSpecificRx": 0, "cdot3OamUnsupportedCodesTx": 0, "cdot3OamUnsupportedCodesRx": 0, "cdot3OamFramesLostDueToOam": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdot3OamStatsEntry", "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": "/cdot3OamStatsTable/cdot3OamStatsEntry", "x-restconf-kind": "container" }, "/data/CISCO-DOT3-OAM-MIB:cdot3OamStatsTable/cdot3OamStatsEntry={ifIndex}": { "get": { "summary": "Get cdot3OamStatsEntry entry", "description": "Retrieve specific cdot3OamStatsEntry entry by key from MIB", "tags": [ "CISCO-DOT3-OAM-MIB" ], "parameters": [ { "name": "ifIndex", "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": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cdot3OamInformationTx": { "type": "integer", "description": "A count of the number of Information OAMPDUs transmitted on\n this interface.\n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamInformationRx": { "type": "integer", "description": "A count of the number of Information OAMPDUs received on this\n interface.\n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamUniqueEventNotificationTx": { "type": "integer", "description": "A count of the number of unique Event OAMPDUs transmitted on\n this interface. Event notifications may be sent in duplicate\n to increase the probability of successfully being received,\n given the possibility that a frame may be lost in transit.\n Duplicate Event Notification transmissions are counted by\n cdot3OamDuplicateEventNotificationTx. \n \n A unique Event Notification OAMPDU is indicated as an Event\n Notification OAMPDU with a Sequence Number field that is\n distinct from the previously transmitted Event Notification\n OAMPDU Sequence Number. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamUniqueEventNotificationRx": { "type": "integer", "description": "A count of the number of unique Event OAMPDUs received on\n this interface. Event notification OAMPDUs may be sent in\n duplicate to increase the probability of successfully being\n received, given the possibility that a frame may be lost in\n transit. Duplicate Event Notification receptions are counted\n by cdot3OamDuplicateEventNotificationRx. \n \n A unique Event Notification OAMPDU is indicated as an Event\n Notification OAMPDU with a Sequence Number field that is\n distinct from the previously received Event Notification\n OAMPDU Sequence Number. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamDuplicateEventNotificationTx": { "type": "integer", "description": "A count of the number of duplicate Event OAMPDUs transmitted\n on this interface. Event notification OAMPDUs may be sent in\n duplicate to increase the probability of successfully being\n received, given the possibility that a frame may be lost in\n transit. \n \n A duplicate Event Notification OAMPDU is indicated as an Event\n Notification OAMPDU with a Sequence Number field that is\n identical to the previously transmitted Event Notification\n OAMPDU Sequence Number. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamDuplicateEventNotificationRx": { "type": "integer", "description": "A count of the number of duplicate Event OAMPDUs received on\n this interface. Event notification OAMPDUs may be sent in\n duplicate to increase the probability of successfully being\n received, given the possibility that a frame may be lost in\n transit. \n \n A duplicate Event Notification OAMPDU is indicated as an Event\n Notification OAMPDU with a Sequence Number field that is\n identical to the previously received Event Notification OAMPDU\n Sequence Number. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamLoopbackControlTx": { "type": "integer", "description": "A count of the number of Loopback Control OAMPDUs transmitted\n on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamLoopbackControlRx": { "type": "integer", "description": "A count of the number of Loopback Control OAMPDUs received\n on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamVariableRequestTx": { "type": "integer", "description": "A count of the number of Variable Request OAMPDUs transmitted\n on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamVariableRequestRx": { "type": "integer", "description": "A count of the number of Variable Request OAMPDUs received on\n this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamVariableResponseTx": { "type": "integer", "description": "A count of the number of Variable Response OAMPDUs\n transmitted on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamVariableResponseRx": { "type": "integer", "description": "A count of the number of Variable Response OAMPDUs received\n on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamOrgSpecificTx": { "type": "integer", "description": "A count of the number of Organization Specific OAMPDUs\n transmitted on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamOrgSpecificRx": { "type": "integer", "description": "A count of the number of Organization Specific OAMPDUs\n received on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamUnsupportedCodesTx": { "type": "integer", "description": "A count of the number of OAMPDUs transmitted on this\n interface with an unsupported op-code. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamUnsupportedCodesRx": { "type": "integer", "description": "A count of the number of OAMPDUs received on this interface\n with an unsupported op-code. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamFramesLostDueToOam": { "type": "integer", "description": "A count of the number of frames that were dropped by the OAM\n multiplexer. Since the OAM multiplexer has multiple inputs\n and a single output, there may be cases where frames are\n dropped due to transmit resource contention. This counter is\n incremented whenever a frame is dropped by the OAM layer.\n Note that any Ethernet frame, not just OAMPDUs, may be dropped\n by the OAM layer. This can occur when an OAMPDU takes\n precedence over a 'normal' frame resulting in the 'normal'\n frame being dropped. \n \n When this counter is incremented, no other counters in this\n MIB are incremented. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-DOT3-OAM-MIB:cdot3OamStatsEntry": { "ifIndex": "example-string", "cdot3OamInformationTx": 0, "cdot3OamInformationRx": 0, "cdot3OamUniqueEventNotificationTx": 0, "cdot3OamUniqueEventNotificationRx": 0, "cdot3OamDuplicateEventNotificationTx": 0, "cdot3OamDuplicateEventNotificationRx": 0, "cdot3OamLoopbackControlTx": 0, "cdot3OamLoopbackControlRx": 0, "cdot3OamVariableRequestTx": 0, "cdot3OamVariableRequestRx": 0, "cdot3OamVariableResponseTx": 0, "cdot3OamVariableResponseRx": 0, "cdot3OamOrgSpecificTx": 0, "cdot3OamOrgSpecificRx": 0, "cdot3OamUnsupportedCodesTx": 0, "cdot3OamUnsupportedCodesRx": 0, "cdot3OamFramesLostDueToOam": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdot3OamStatsEntry-2" }, "x-yang-path": "/cdot3OamStatsTable/cdot3OamStatsEntry={ifIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex" ] }, "/data/CISCO-DOT3-OAM-MIB:cdot3OamEventConfigTable": { "get": { "summary": "Get cdot3OamEventConfigTable data", "description": "Retrieve cdot3OamEventConfigTable operational data from MIB", "tags": [ "CISCO-DOT3-OAM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "cdot3OamEventConfigTable", "properties": { "cdot3OamEventConfigEntry": { "type": "array", "description": "cdot3OamEventConfigEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cdot3OamErrSymPeriodWindowHi": { "type": "integer", "description": "The two objects cdot3OamErrSymPeriodWindowHi and\n cdot3OamErrSymPeriodLo together form an unsigned 64-bit\n integer representing the number of symbols over which this\n threshold event is defined. This is defined as\n \n cdot3OamErrSymPeriodWindow = ((2^32)*cdot3OamErrSymPeriodWindowHi)\n + cdot3OamErrSymPeriodWindowLo\n \n If cdot3OamErrSymPeriodThreshold symbol errors occur within a\n window of cdot3OamErrSymPeriodWindow symbols, an Event\n Notification OAMPDU should be generated with an Errored Symbol\n Period Event TLV indicating the threshold has been crossed in\n this window. \n \n The default value for cdot3OamErrSymPeriodWindow is the number\n of symbols in one second for the underlying physical layer.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrSymPeriodWindowLo": { "type": "integer", "description": "The two objects cdot3OamErrSymPeriodWindowHi and\n cdot3OamErrSymPeriodWindowLo together form an unsigned 64-bit\n integer representing the number of symbols over which this\n threshold event is defined. This is defined as\n \n cdot3OamErrSymPeriodWindow = ((2^32)*cdot3OamErrSymPeriodWindowHi)\n + cdot3OamErrSymPeriodWindowLo\n \n If cdot3OamErrSymPeriodThreshold symbol errors occur within a\n window of cdot3OamErrSymPeriodWindow symbols, an Event\n Notification OAMPDU should be generated with an Errored Symbol\n Period Event TLV indicating the threshold has been crossed in\n this window. \n \n The default value for cdot3OamErrSymPeriodWindow is the number\n of symbols in one second for the underlying physical layer.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrSymPeriodThresholdHi": { "type": "integer", "description": "The two objects cdot3OamErrSymPeriodThresholdHi and\n cdot3OamErrSymPeriodThresholdLo together form an unsigned\n 64-bit integer representing the number of symbol errors that\n must occur within a given window to cause this event. \n \n This is defined as\n \n cdot3OamErrSymPeriodThreshold =\n ((2^32) * cdot3OamErrSymPeriodThresholdHi)\n + cdot3OamErrSymPeriodThresholdLo\n \n If cdot3OamErrSymPeriodThreshold symbol errors occur within a\n window of cdot3OamErrSymPeriodWindow symbols, an Event\n Notification OAMPDU should be generated with an Errored Symbol\n Period Event TLV indicating the threshold has been crossed in\n this window. \n \n The default value for cdot3OamErrSymPeriodThreshold is one\n symbol errors. If the threshold value is zero, then an Event\n Notification OAMPDU is sent periodically (at the end of every\n window). This can be used as an asynchronous notification to\n the peer OAM entity of the statistics related to this\n threshold crossing alarm.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrSymPeriodThresholdLo": { "type": "integer", "description": "The two objects cdot3OamErrSymPeriodThresholdHi and\n cdot3OamErrSymPeriodThresholdLo together form an unsigned\n 64-bit integer representing the number of symbol errors that\n must occur within a given window to cause this event. \n \n This is defined as\n \n cdot3OamErrSymPeriodThreshold =\n ((2^32) * cdot3OamErrSymPeriodThresholdHi)\n + cdot3OamErrSymPeriodThresholdLo\n \n If cdot3OamErrSymPeriodThreshold symbol errors occur within a\n window of cdot3OamErrSymPeriodWindow symbols, an Event\n Notification OAMPDU should be generated with an Errored Symbol\n Period Event TLV indicating the threshold has been crossed in\n this window. \n \n The default value for cdot3OamErrSymPeriodThreshold is one\n symbol error. If the threshold value is zero, then an Event\n Notification OAMPDU is sent periodically (at the end of every\n window). This can be used as an asynchronous notification to\n the peer OAM entity of the statistics related to this\n threshold crossing alarm.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrSymPeriodEvNotifEnable": { "type": "boolean", "description": "If true, the OAM entity should send an Event Notification\n OAMPDU when an Errored Symbol Period Event occurs. \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored." }, "cdot3OamErrFramePeriodWindow": { "type": "integer", "description": "The number of frames over which the threshold is defined.\n The default value of the window is the number of minimum size\n Ethernet frames that can be received over the physical layer\n in one second. \n \n If cdot3OamErrFramePeriodThreshold frame errors occur within a\n window of cdot3OamErrFramePeriodWindow frames, an Event\n Notification OAMPDU should be generated with an Errored Frame\n Period Event TLV indicating the threshold has been crossed in\n this window.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrFramePeriodThreshold": { "type": "integer", "description": "The number of frame errors that must occur for this event to\n be triggered. The default value is one frame error. If the\n threshold value is zero, then an Event Notification OAMPDU is\n sent periodically (at the end of every window). This can be\n used as an asynchronous notification to the peer OAM entity of\n the statistics related to this threshold crossing alarm.\n \n If cdot3OamErrFramePeriodThreshold frame errors occur within a\n window of cdot3OamErrFramePeriodWindow frames, an Event\n Notification OAMPDU should be generated with an Errored Frame\n Period Event TLV indicating the threshold has been crossed in\n this window.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrFramePeriodEvNotifEnable": { "type": "boolean", "description": "If true, the OAM entity should send an Event Notification\n OAMPDU when an Errored Frame Period Event occurs. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored." }, "cdot3OamErrFrameWindow": { "type": "integer", "description": "The amount of time (in 100ms increments) over which the\n threshold is defined. The default value is 10 (1 second). \n \n If cdot3OamErrFrameThreshold frame errors occur within a window\n of cdot3OamErrFrameWindow seconds (measured in tenths of\n seconds), an Event Notification OAMPDU should be generated\n with an Errored Frame Event TLV indicating the threshold has\n been crossed in this window.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrFrameThreshold": { "type": "integer", "description": "The number of frame errors that must occur for this event to\n be triggered. The default value is one frame error. If the\n threshold value is zero, then an Event Notification OAMPDU is\n sent periodically (at the end of every window). This can be\n used as an asynchronous notification to the peer OAM entity of\n the statistics related to this threshold crossing alarm. \n \n If cdot3OamErrFrameThreshold frame errors occur within a window\n of cdot3OamErrFrameWindow (in tenths of seconds), an Event\n Notification OAMPDU should be generated with an Errored Frame\n Event TLV indicating the threshold has been crossed in this\n window.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrFrameEvNotifEnable": { "type": "boolean", "description": "If true, the OAM entity should send an Event Notification\n OAMPDU when an Errored Frame Event occurs. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored." }, "cdot3OamErrFrameSecsSummaryWindow": { "type": "integer", "description": "The amount of time (in 100ms intervals) over which the\n threshold is defined. The default value is 100 (10 seconds). \n \n If cdot3OamErrFrameSecsSummaryThreshold frame errors occur\n within a window of cdot3OamErrFrameSecsSummaryWindow (in tenths\n of seconds), an Event Notification OAMPDU should be generated\n with an Errored Frame Seconds Summary Event TLV indicating the\n threshold has been crossed in this window.", "minimum": -2147483648, "maximum": 2147483647 }, "cdot3OamErrFrameSecsSummaryThreshold": { "type": "integer", "description": "The number of errored frame seconds that must occur for this\n event to be triggered. The default value is one errored frame\n second. If the threshold value is zero, then an Event\n Notification OAMPDU is sent periodically (at the end of every\n window). This can be used as an asynchronous notification to\n the peer OAM entity of the statistics related to this\n threshold crossing alarm. \n \n If cdot3OamErrFrameSecsSummaryThreshold frame errors occur\n within a window of cdot3OamErrFrameSecsSummaryWindow (in tenths\n of seconds), an Event Notification OAMPDU should be generated\n with an Errored Frame Seconds Summary Event TLV indicating the\n threshold has been crossed in this window.", "minimum": -2147483648, "maximum": 2147483647 }, "cdot3OamErrFrameSecsEvNotifEnable": { "type": "boolean", "description": "If true, the local OAM entity should send an Event\n Notification OAMPDU when an Errored Frame Seconds Event\n occurs. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored." }, "cdot3OamDyingGaspEnable": { "type": "boolean", "description": "If true, the local OAM entity should attempt to indicate a\n dying gasp via the OAMPDU flags field to its peer OAM entity\n when a dying gasp event occurs. The exact definition of a\n dying gasp event is implementation dependent. If the system\n does not support dying gasp capability, setting this object\n has no effect, and reading the object should always result in\n 'false'. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored." }, "cdot3OamCriticalEventEnable": { "type": "boolean", "description": "If true, the local OAM entity should attempt to indicate a\n critical event via the OAMPDU flags to its peer OAM entity\n when a critical event occurs. The exact definition of a\n critical event is implementation dependent. If the system\n does not support critical event capability, setting this\n object has no effect, and reading the object should always\n result in 'false'. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored." } } } } } }, "example": { "CISCO-DOT3-OAM-MIB:cdot3OamEventConfigTable": { "cdot3OamEventConfigEntry": [ { "ifIndex": "1", "cdot3OamErrSymPeriodWindowHi": 0, "cdot3OamErrSymPeriodWindowLo": 0, "cdot3OamErrSymPeriodThresholdHi": 0, "cdot3OamErrSymPeriodThresholdLo": 0, "cdot3OamErrSymPeriodEvNotifEnable": true, "cdot3OamErrFramePeriodWindow": 0, "cdot3OamErrFramePeriodThreshold": 0, "cdot3OamErrFramePeriodEvNotifEnable": true, "cdot3OamErrFrameWindow": 0, "cdot3OamErrFrameThreshold": 0, "cdot3OamErrFrameEvNotifEnable": true, "cdot3OamErrFrameSecsSummaryWindow": -2147483648, "cdot3OamErrFrameSecsSummaryThreshold": -2147483648, "cdot3OamErrFrameSecsEvNotifEnable": true, "cdot3OamDyingGaspEnable": true, "cdot3OamCriticalEventEnable": true }, { "ifIndex": "2", "cdot3OamErrSymPeriodWindowHi": 0, "cdot3OamErrSymPeriodWindowLo": 0, "cdot3OamErrSymPeriodThresholdHi": 0, "cdot3OamErrSymPeriodThresholdLo": 0, "cdot3OamErrSymPeriodEvNotifEnable": true, "cdot3OamErrFramePeriodWindow": 0, "cdot3OamErrFramePeriodThreshold": 0, "cdot3OamErrFramePeriodEvNotifEnable": true, "cdot3OamErrFrameWindow": 0, "cdot3OamErrFrameThreshold": 0, "cdot3OamErrFrameEvNotifEnable": true, "cdot3OamErrFrameSecsSummaryWindow": -2147483648, "cdot3OamErrFrameSecsSummaryThreshold": -2147483648, "cdot3OamErrFrameSecsEvNotifEnable": true, "cdot3OamDyingGaspEnable": true, "cdot3OamCriticalEventEnable": true }, { "ifIndex": "3", "cdot3OamErrSymPeriodWindowHi": 0, "cdot3OamErrSymPeriodWindowLo": 0, "cdot3OamErrSymPeriodThresholdHi": 0, "cdot3OamErrSymPeriodThresholdLo": 0, "cdot3OamErrSymPeriodEvNotifEnable": true, "cdot3OamErrFramePeriodWindow": 0, "cdot3OamErrFramePeriodThreshold": 0, "cdot3OamErrFramePeriodEvNotifEnable": true, "cdot3OamErrFrameWindow": 0, "cdot3OamErrFrameThreshold": 0, "cdot3OamErrFrameEvNotifEnable": true, "cdot3OamErrFrameSecsSummaryWindow": -2147483648, "cdot3OamErrFrameSecsSummaryThreshold": -2147483648, "cdot3OamErrFrameSecsEvNotifEnable": true, "cdot3OamDyingGaspEnable": true, "cdot3OamCriticalEventEnable": true } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdot3OamEventConfigTable", "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": "/cdot3OamEventConfigTable", "x-restconf-kind": "container" }, "/data/CISCO-DOT3-OAM-MIB:cdot3OamEventConfigTable/cdot3OamEventConfigEntry": { "get": { "summary": "Get cdot3OamEventConfigEntry list", "description": "Retrieve list of cdot3OamEventConfigEntry entries from MIB", "tags": [ "CISCO-DOT3-OAM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cdot3OamEventConfigEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cdot3OamErrSymPeriodWindowHi": { "type": "integer", "description": "The two objects cdot3OamErrSymPeriodWindowHi and\n cdot3OamErrSymPeriodLo together form an unsigned 64-bit\n integer representing the number of symbols over which this\n threshold event is defined. This is defined as\n \n cdot3OamErrSymPeriodWindow = ((2^32)*cdot3OamErrSymPeriodWindowHi)\n + cdot3OamErrSymPeriodWindowLo\n \n If cdot3OamErrSymPeriodThreshold symbol errors occur within a\n window of cdot3OamErrSymPeriodWindow symbols, an Event\n Notification OAMPDU should be generated with an Errored Symbol\n Period Event TLV indicating the threshold has been crossed in\n this window. \n \n The default value for cdot3OamErrSymPeriodWindow is the number\n of symbols in one second for the underlying physical layer.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrSymPeriodWindowLo": { "type": "integer", "description": "The two objects cdot3OamErrSymPeriodWindowHi and\n cdot3OamErrSymPeriodWindowLo together form an unsigned 64-bit\n integer representing the number of symbols over which this\n threshold event is defined. This is defined as\n \n cdot3OamErrSymPeriodWindow = ((2^32)*cdot3OamErrSymPeriodWindowHi)\n + cdot3OamErrSymPeriodWindowLo\n \n If cdot3OamErrSymPeriodThreshold symbol errors occur within a\n window of cdot3OamErrSymPeriodWindow symbols, an Event\n Notification OAMPDU should be generated with an Errored Symbol\n Period Event TLV indicating the threshold has been crossed in\n this window. \n \n The default value for cdot3OamErrSymPeriodWindow is the number\n of symbols in one second for the underlying physical layer.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrSymPeriodThresholdHi": { "type": "integer", "description": "The two objects cdot3OamErrSymPeriodThresholdHi and\n cdot3OamErrSymPeriodThresholdLo together form an unsigned\n 64-bit integer representing the number of symbol errors that\n must occur within a given window to cause this event. \n \n This is defined as\n \n cdot3OamErrSymPeriodThreshold =\n ((2^32) * cdot3OamErrSymPeriodThresholdHi)\n + cdot3OamErrSymPeriodThresholdLo\n \n If cdot3OamErrSymPeriodThreshold symbol errors occur within a\n window of cdot3OamErrSymPeriodWindow symbols, an Event\n Notification OAMPDU should be generated with an Errored Symbol\n Period Event TLV indicating the threshold has been crossed in\n this window. \n \n The default value for cdot3OamErrSymPeriodThreshold is one\n symbol errors. If the threshold value is zero, then an Event\n Notification OAMPDU is sent periodically (at the end of every\n window). This can be used as an asynchronous notification to\n the peer OAM entity of the statistics related to this\n threshold crossing alarm.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrSymPeriodThresholdLo": { "type": "integer", "description": "The two objects cdot3OamErrSymPeriodThresholdHi and\n cdot3OamErrSymPeriodThresholdLo together form an unsigned\n 64-bit integer representing the number of symbol errors that\n must occur within a given window to cause this event. \n \n This is defined as\n \n cdot3OamErrSymPeriodThreshold =\n ((2^32) * cdot3OamErrSymPeriodThresholdHi)\n + cdot3OamErrSymPeriodThresholdLo\n \n If cdot3OamErrSymPeriodThreshold symbol errors occur within a\n window of cdot3OamErrSymPeriodWindow symbols, an Event\n Notification OAMPDU should be generated with an Errored Symbol\n Period Event TLV indicating the threshold has been crossed in\n this window. \n \n The default value for cdot3OamErrSymPeriodThreshold is one\n symbol error. If the threshold value is zero, then an Event\n Notification OAMPDU is sent periodically (at the end of every\n window). This can be used as an asynchronous notification to\n the peer OAM entity of the statistics related to this\n threshold crossing alarm.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrSymPeriodEvNotifEnable": { "type": "boolean", "description": "If true, the OAM entity should send an Event Notification\n OAMPDU when an Errored Symbol Period Event occurs. \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored." }, "cdot3OamErrFramePeriodWindow": { "type": "integer", "description": "The number of frames over which the threshold is defined.\n The default value of the window is the number of minimum size\n Ethernet frames that can be received over the physical layer\n in one second. \n \n If cdot3OamErrFramePeriodThreshold frame errors occur within a\n window of cdot3OamErrFramePeriodWindow frames, an Event\n Notification OAMPDU should be generated with an Errored Frame\n Period Event TLV indicating the threshold has been crossed in\n this window.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrFramePeriodThreshold": { "type": "integer", "description": "The number of frame errors that must occur for this event to\n be triggered. The default value is one frame error. If the\n threshold value is zero, then an Event Notification OAMPDU is\n sent periodically (at the end of every window). This can be\n used as an asynchronous notification to the peer OAM entity of\n the statistics related to this threshold crossing alarm.\n \n If cdot3OamErrFramePeriodThreshold frame errors occur within a\n window of cdot3OamErrFramePeriodWindow frames, an Event\n Notification OAMPDU should be generated with an Errored Frame\n Period Event TLV indicating the threshold has been crossed in\n this window.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrFramePeriodEvNotifEnable": { "type": "boolean", "description": "If true, the OAM entity should send an Event Notification\n OAMPDU when an Errored Frame Period Event occurs. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored." }, "cdot3OamErrFrameWindow": { "type": "integer", "description": "The amount of time (in 100ms increments) over which the\n threshold is defined. The default value is 10 (1 second). \n \n If cdot3OamErrFrameThreshold frame errors occur within a window\n of cdot3OamErrFrameWindow seconds (measured in tenths of\n seconds), an Event Notification OAMPDU should be generated\n with an Errored Frame Event TLV indicating the threshold has\n been crossed in this window.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrFrameThreshold": { "type": "integer", "description": "The number of frame errors that must occur for this event to\n be triggered. The default value is one frame error. If the\n threshold value is zero, then an Event Notification OAMPDU is\n sent periodically (at the end of every window). This can be\n used as an asynchronous notification to the peer OAM entity of\n the statistics related to this threshold crossing alarm. \n \n If cdot3OamErrFrameThreshold frame errors occur within a window\n of cdot3OamErrFrameWindow (in tenths of seconds), an Event\n Notification OAMPDU should be generated with an Errored Frame\n Event TLV indicating the threshold has been crossed in this\n window.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrFrameEvNotifEnable": { "type": "boolean", "description": "If true, the OAM entity should send an Event Notification\n OAMPDU when an Errored Frame Event occurs. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored." }, "cdot3OamErrFrameSecsSummaryWindow": { "type": "integer", "description": "The amount of time (in 100ms intervals) over which the\n threshold is defined. The default value is 100 (10 seconds). \n \n If cdot3OamErrFrameSecsSummaryThreshold frame errors occur\n within a window of cdot3OamErrFrameSecsSummaryWindow (in tenths\n of seconds), an Event Notification OAMPDU should be generated\n with an Errored Frame Seconds Summary Event TLV indicating the\n threshold has been crossed in this window.", "minimum": -2147483648, "maximum": 2147483647 }, "cdot3OamErrFrameSecsSummaryThreshold": { "type": "integer", "description": "The number of errored frame seconds that must occur for this\n event to be triggered. The default value is one errored frame\n second. If the threshold value is zero, then an Event\n Notification OAMPDU is sent periodically (at the end of every\n window). This can be used as an asynchronous notification to\n the peer OAM entity of the statistics related to this\n threshold crossing alarm. \n \n If cdot3OamErrFrameSecsSummaryThreshold frame errors occur\n within a window of cdot3OamErrFrameSecsSummaryWindow (in tenths\n of seconds), an Event Notification OAMPDU should be generated\n with an Errored Frame Seconds Summary Event TLV indicating the\n threshold has been crossed in this window.", "minimum": -2147483648, "maximum": 2147483647 }, "cdot3OamErrFrameSecsEvNotifEnable": { "type": "boolean", "description": "If true, the local OAM entity should send an Event\n Notification OAMPDU when an Errored Frame Seconds Event\n occurs. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored." }, "cdot3OamDyingGaspEnable": { "type": "boolean", "description": "If true, the local OAM entity should attempt to indicate a\n dying gasp via the OAMPDU flags field to its peer OAM entity\n when a dying gasp event occurs. The exact definition of a\n dying gasp event is implementation dependent. If the system\n does not support dying gasp capability, setting this object\n has no effect, and reading the object should always result in\n 'false'. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored." }, "cdot3OamCriticalEventEnable": { "type": "boolean", "description": "If true, the local OAM entity should attempt to indicate a\n critical event via the OAMPDU flags to its peer OAM entity\n when a critical event occurs. The exact definition of a\n critical event is implementation dependent. If the system\n does not support critical event capability, setting this\n object has no effect, and reading the object should always\n result in 'false'. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored." } } } }, "example": { "CISCO-DOT3-OAM-MIB:cdot3OamEventConfigEntry": [ { "ifIndex": "example-string", "cdot3OamErrSymPeriodWindowHi": 0, "cdot3OamErrSymPeriodWindowLo": 0, "cdot3OamErrSymPeriodThresholdHi": 0, "cdot3OamErrSymPeriodThresholdLo": 0, "cdot3OamErrSymPeriodEvNotifEnable": true, "cdot3OamErrFramePeriodWindow": 0, "cdot3OamErrFramePeriodThreshold": 0, "cdot3OamErrFramePeriodEvNotifEnable": true, "cdot3OamErrFrameWindow": 0, "cdot3OamErrFrameThreshold": 0, "cdot3OamErrFrameEvNotifEnable": true, "cdot3OamErrFrameSecsSummaryWindow": -2147483648, "cdot3OamErrFrameSecsSummaryThreshold": -2147483648, "cdot3OamErrFrameSecsEvNotifEnable": true, "cdot3OamDyingGaspEnable": true, "cdot3OamCriticalEventEnable": true } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdot3OamEventConfigEntry", "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": "/cdot3OamEventConfigTable/cdot3OamEventConfigEntry", "x-restconf-kind": "container" }, "/data/CISCO-DOT3-OAM-MIB:cdot3OamEventConfigTable/cdot3OamEventConfigEntry={ifIndex}": { "get": { "summary": "Get cdot3OamEventConfigEntry entry", "description": "Retrieve specific cdot3OamEventConfigEntry entry by key from MIB", "tags": [ "CISCO-DOT3-OAM-MIB" ], "parameters": [ { "name": "ifIndex", "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": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cdot3OamErrSymPeriodWindowHi": { "type": "integer", "description": "The two objects cdot3OamErrSymPeriodWindowHi and\n cdot3OamErrSymPeriodLo together form an unsigned 64-bit\n integer representing the number of symbols over which this\n threshold event is defined. This is defined as\n \n cdot3OamErrSymPeriodWindow = ((2^32)*cdot3OamErrSymPeriodWindowHi)\n + cdot3OamErrSymPeriodWindowLo\n \n If cdot3OamErrSymPeriodThreshold symbol errors occur within a\n window of cdot3OamErrSymPeriodWindow symbols, an Event\n Notification OAMPDU should be generated with an Errored Symbol\n Period Event TLV indicating the threshold has been crossed in\n this window. \n \n The default value for cdot3OamErrSymPeriodWindow is the number\n of symbols in one second for the underlying physical layer.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrSymPeriodWindowLo": { "type": "integer", "description": "The two objects cdot3OamErrSymPeriodWindowHi and\n cdot3OamErrSymPeriodWindowLo together form an unsigned 64-bit\n integer representing the number of symbols over which this\n threshold event is defined. This is defined as\n \n cdot3OamErrSymPeriodWindow = ((2^32)*cdot3OamErrSymPeriodWindowHi)\n + cdot3OamErrSymPeriodWindowLo\n \n If cdot3OamErrSymPeriodThreshold symbol errors occur within a\n window of cdot3OamErrSymPeriodWindow symbols, an Event\n Notification OAMPDU should be generated with an Errored Symbol\n Period Event TLV indicating the threshold has been crossed in\n this window. \n \n The default value for cdot3OamErrSymPeriodWindow is the number\n of symbols in one second for the underlying physical layer.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrSymPeriodThresholdHi": { "type": "integer", "description": "The two objects cdot3OamErrSymPeriodThresholdHi and\n cdot3OamErrSymPeriodThresholdLo together form an unsigned\n 64-bit integer representing the number of symbol errors that\n must occur within a given window to cause this event. \n \n This is defined as\n \n cdot3OamErrSymPeriodThreshold =\n ((2^32) * cdot3OamErrSymPeriodThresholdHi)\n + cdot3OamErrSymPeriodThresholdLo\n \n If cdot3OamErrSymPeriodThreshold symbol errors occur within a\n window of cdot3OamErrSymPeriodWindow symbols, an Event\n Notification OAMPDU should be generated with an Errored Symbol\n Period Event TLV indicating the threshold has been crossed in\n this window. \n \n The default value for cdot3OamErrSymPeriodThreshold is one\n symbol errors. If the threshold value is zero, then an Event\n Notification OAMPDU is sent periodically (at the end of every\n window). This can be used as an asynchronous notification to\n the peer OAM entity of the statistics related to this\n threshold crossing alarm.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrSymPeriodThresholdLo": { "type": "integer", "description": "The two objects cdot3OamErrSymPeriodThresholdHi and\n cdot3OamErrSymPeriodThresholdLo together form an unsigned\n 64-bit integer representing the number of symbol errors that\n must occur within a given window to cause this event. \n \n This is defined as\n \n cdot3OamErrSymPeriodThreshold =\n ((2^32) * cdot3OamErrSymPeriodThresholdHi)\n + cdot3OamErrSymPeriodThresholdLo\n \n If cdot3OamErrSymPeriodThreshold symbol errors occur within a\n window of cdot3OamErrSymPeriodWindow symbols, an Event\n Notification OAMPDU should be generated with an Errored Symbol\n Period Event TLV indicating the threshold has been crossed in\n this window. \n \n The default value for cdot3OamErrSymPeriodThreshold is one\n symbol error. If the threshold value is zero, then an Event\n Notification OAMPDU is sent periodically (at the end of every\n window). This can be used as an asynchronous notification to\n the peer OAM entity of the statistics related to this\n threshold crossing alarm.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrSymPeriodEvNotifEnable": { "type": "boolean", "description": "If true, the OAM entity should send an Event Notification\n OAMPDU when an Errored Symbol Period Event occurs. \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored." }, "cdot3OamErrFramePeriodWindow": { "type": "integer", "description": "The number of frames over which the threshold is defined.\n The default value of the window is the number of minimum size\n Ethernet frames that can be received over the physical layer\n in one second. \n \n If cdot3OamErrFramePeriodThreshold frame errors occur within a\n window of cdot3OamErrFramePeriodWindow frames, an Event\n Notification OAMPDU should be generated with an Errored Frame\n Period Event TLV indicating the threshold has been crossed in\n this window.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrFramePeriodThreshold": { "type": "integer", "description": "The number of frame errors that must occur for this event to\n be triggered. The default value is one frame error. If the\n threshold value is zero, then an Event Notification OAMPDU is\n sent periodically (at the end of every window). This can be\n used as an asynchronous notification to the peer OAM entity of\n the statistics related to this threshold crossing alarm.\n \n If cdot3OamErrFramePeriodThreshold frame errors occur within a\n window of cdot3OamErrFramePeriodWindow frames, an Event\n Notification OAMPDU should be generated with an Errored Frame\n Period Event TLV indicating the threshold has been crossed in\n this window.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrFramePeriodEvNotifEnable": { "type": "boolean", "description": "If true, the OAM entity should send an Event Notification\n OAMPDU when an Errored Frame Period Event occurs. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored." }, "cdot3OamErrFrameWindow": { "type": "integer", "description": "The amount of time (in 100ms increments) over which the\n threshold is defined. The default value is 10 (1 second). \n \n If cdot3OamErrFrameThreshold frame errors occur within a window\n of cdot3OamErrFrameWindow seconds (measured in tenths of\n seconds), an Event Notification OAMPDU should be generated\n with an Errored Frame Event TLV indicating the threshold has\n been crossed in this window.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrFrameThreshold": { "type": "integer", "description": "The number of frame errors that must occur for this event to\n be triggered. The default value is one frame error. If the\n threshold value is zero, then an Event Notification OAMPDU is\n sent periodically (at the end of every window). This can be\n used as an asynchronous notification to the peer OAM entity of\n the statistics related to this threshold crossing alarm. \n \n If cdot3OamErrFrameThreshold frame errors occur within a window\n of cdot3OamErrFrameWindow (in tenths of seconds), an Event\n Notification OAMPDU should be generated with an Errored Frame\n Event TLV indicating the threshold has been crossed in this\n window.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrFrameEvNotifEnable": { "type": "boolean", "description": "If true, the OAM entity should send an Event Notification\n OAMPDU when an Errored Frame Event occurs. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored." }, "cdot3OamErrFrameSecsSummaryWindow": { "type": "integer", "description": "The amount of time (in 100ms intervals) over which the\n threshold is defined. The default value is 100 (10 seconds). \n \n If cdot3OamErrFrameSecsSummaryThreshold frame errors occur\n within a window of cdot3OamErrFrameSecsSummaryWindow (in tenths\n of seconds), an Event Notification OAMPDU should be generated\n with an Errored Frame Seconds Summary Event TLV indicating the\n threshold has been crossed in this window.", "minimum": -2147483648, "maximum": 2147483647 }, "cdot3OamErrFrameSecsSummaryThreshold": { "type": "integer", "description": "The number of errored frame seconds that must occur for this\n event to be triggered. The default value is one errored frame\n second. If the threshold value is zero, then an Event\n Notification OAMPDU is sent periodically (at the end of every\n window). This can be used as an asynchronous notification to\n the peer OAM entity of the statistics related to this\n threshold crossing alarm. \n \n If cdot3OamErrFrameSecsSummaryThreshold frame errors occur\n within a window of cdot3OamErrFrameSecsSummaryWindow (in tenths\n of seconds), an Event Notification OAMPDU should be generated\n with an Errored Frame Seconds Summary Event TLV indicating the\n threshold has been crossed in this window.", "minimum": -2147483648, "maximum": 2147483647 }, "cdot3OamErrFrameSecsEvNotifEnable": { "type": "boolean", "description": "If true, the local OAM entity should send an Event\n Notification OAMPDU when an Errored Frame Seconds Event\n occurs. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored." }, "cdot3OamDyingGaspEnable": { "type": "boolean", "description": "If true, the local OAM entity should attempt to indicate a\n dying gasp via the OAMPDU flags field to its peer OAM entity\n when a dying gasp event occurs. The exact definition of a\n dying gasp event is implementation dependent. If the system\n does not support dying gasp capability, setting this object\n has no effect, and reading the object should always result in\n 'false'. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored." }, "cdot3OamCriticalEventEnable": { "type": "boolean", "description": "If true, the local OAM entity should attempt to indicate a\n critical event via the OAMPDU flags to its peer OAM entity\n when a critical event occurs. The exact definition of a\n critical event is implementation dependent. If the system\n does not support critical event capability, setting this\n object has no effect, and reading the object should always\n result in 'false'. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored." } } }, "example": { "CISCO-DOT3-OAM-MIB:cdot3OamEventConfigEntry": { "ifIndex": "example-string", "cdot3OamErrSymPeriodWindowHi": 0, "cdot3OamErrSymPeriodWindowLo": 0, "cdot3OamErrSymPeriodThresholdHi": 0, "cdot3OamErrSymPeriodThresholdLo": 0, "cdot3OamErrSymPeriodEvNotifEnable": true, "cdot3OamErrFramePeriodWindow": 0, "cdot3OamErrFramePeriodThreshold": 0, "cdot3OamErrFramePeriodEvNotifEnable": true, "cdot3OamErrFrameWindow": 0, "cdot3OamErrFrameThreshold": 0, "cdot3OamErrFrameEvNotifEnable": true, "cdot3OamErrFrameSecsSummaryWindow": -2147483648, "cdot3OamErrFrameSecsSummaryThreshold": -2147483648, "cdot3OamErrFrameSecsEvNotifEnable": true, "cdot3OamDyingGaspEnable": true, "cdot3OamCriticalEventEnable": true } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdot3OamEventConfigEntry-2" }, "x-yang-path": "/cdot3OamEventConfigTable/cdot3OamEventConfigEntry={ifIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex" ] }, "/data/CISCO-DOT3-OAM-MIB:cdot3OamEventLogTable": { "get": { "summary": "Get cdot3OamEventLogTable data", "description": "Retrieve cdot3OamEventLogTable operational data from MIB", "tags": [ "CISCO-DOT3-OAM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "cdot3OamEventLogTable", "properties": { "cdot3OamEventLogEntry": { "type": "array", "description": "cdot3OamEventLogEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cdot3OamEventLogIndex": { "type": "integer", "description": "An arbitrary integer for identifying individual events\n within the event log.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamEventLogTimestamp": { "type": "string", "description": "The value of sysUpTime at the time of the logged event. For\n locally generated events, the time of the event can be\n accurately retrieved from sysUpTime. For remotely generated\n events, the time of the event is indicated by the reception of\n the Event Notification OAMPDU indicating the event occurred on\n the peer. A system may attempt to adjust the timestamp value\n to more accurately reflect the time of the event at the peer\n OAM entity by using other information, such as that found in\n the timestamp found of the Event Notification TLVs, which\n provides an indication of the relative time between events at\n the peer entity.", "x-yang-type": "yang:timestamp" }, "cdot3OamEventLogOui": { "type": "string", "description": "The OUI of the entity defining the object type. All IEEE\n 802.3 defined events (as appearing in [802.3ah] except for the\n Organizationally Unique Event TLVs) use the IEEE 802.3 OUI of\n 0x0180C2. Organizations defining their own Event Notification\n TLVs include their OUI in the Event Notification TLV which\n gets reflected here.", "x-yang-type": "CISCO-DOT3-OAM-MIB:Cdot3Oui" }, "cdot3OamEventLogType": { "type": "integer", "description": "The type of event that generated this entry in the event log.\n \n When the OUI is the IEEE 802.3 OUI of 0x0180C2, the following\n event types are defined:\n erroredSymbolEvent(1), \n erroredFramePeriodEvent (2), \n erroredFrameEvent(3),\n erroredFrameSecondsEvent(4), \n linkFault(256), \n dyingGaspEvent(257),\n criticalLinkEvent(258)\n The first four are considered threshold crossing events as\n they are generated when a metric exceeds a given value within\n a specified window. The other three are not threshold\n crossing events. \n \n When the OUI is not 71874 (0x0180C2 in hex), then some other\n organization has defined the event space. If event subtyping\n is known to the implementation, it may be reflected here.\n Otherwise, this value should return all Fs (2^32 - 1).", "minimum": 0, "maximum": 4294967295 }, "cdot3OamEventLogLocation": { "type": "string", "description": "Whether this event occurred locally (local(1)), or was \n received from the OAM peer via Ethernet OAM (remote(2))." }, "cdot3OamEventLogWindowHi": { "type": "integer", "description": "If the event represents a threshold crossing event, the two\n objects cdot3OamEventWindowHi and cdot3OamEventWindowLo form an\n unsigned 64-bit integer yielding the window over which the\n value was measured for the threshold crossing event (for\n example, 5, when 11 occurrences happened in 5 seconds while\n the threshold was 10). The two objects are combined as:\n \n cdot3OamEventLogWindow = ((2^32) * cdot3OamEventLogWindowHi)\n + cdot3OamEventLogWindowLo\n \n \n Otherwise, this value is returned as all F's (2^32 - 1) and \n adds no useful information.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamEventLogWindowLo": { "type": "integer", "description": "If the event represents a threshold crossing event, the two\n objects cdot3OamEventWindowHi and cdot3OamEventWindowLo form an\n unsigned 64-bit integer yielding the window over which the\n value was measured for the threshold crossing event (for\n example, 5, when 11 occurrences happened in 5 seconds while\n the threshold was 10). The two objects are combined as:\n \n cdot3OamEventLogWindow = ((2^32) * cdot3OamEventLogWindowHi)\n + cdot3OamEventLogWindowLo\n \n Otherwise, this value is returned as all F's (2^32 - 1) and \n adds no useful information.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamEventLogThresholdHi": { "type": "integer", "description": "If the event represents a threshold crossing event, the two\n objects cdot3OamEventThresholdHi and cdot3OamEventThresholdLo\n form an unsigned 64-bit integer yielding the value that was\n crossed for the threshold crossing event (for example, 10,\n when 11 occurrences happened in 5 seconds while the threshold\n was 10). The two objects are combined as:\n \n cdot3OamEventLogThreshold = ((2^32) * cdot3OamEventLogThresholdHi)\n + cdot3OamEventLogThresholdLo\n \n Otherwise, this value is returned as all F's (2^32 -1) and \n adds no useful information.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamEventLogThresholdLo": { "type": "integer", "description": "If the event represents a threshold crossing event, the two\n objects cdot3OamEventThresholdHi and cdot3OamEventThresholdLo\n form an unsigned 64-bit integer yielding the value that was\n crossed for the threshold crossing event (for example, 10,\n when 11 occurrences happened in 5 seconds while the threshold\n was 10). The two objects are combined as:\n \n cdot3OamEventLogThreshold = ((2^32) * cdot3OamEventLogThresholdHi)\n + cdot3OamEventLogThresholdLo\n \n Otherwise, this value is returned as all F's (2^32 - 1) and\n adds no useful information.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamEventLogValue": { "type": "integer", "description": "If the event represents a threshold crossing event, this\n value indicates the value of the parameter within the given\n window that generated this event (for example, 11, when 11\n occurrences happened in 5 seconds while the threshold was 10). \n \n Otherwise, this value is returned as all F's \n (2^64 - 1) and adds no useful information.", "minimum": 0 }, "cdot3OamEventLogRunningTotal": { "type": "integer", "description": "Each Event Notification TLV contains a running total of the\n number of times an event has occurred, as well as the number\n of times an Event Notification for the event has been\n transmitted. For non-threshold crossing events, the number of\n events (cdot3OamLogRunningTotal) and the number of resultant\n Event Notifications (cdot3OamLogEventTotal) should be\n identical. \n \n For threshold crossing events, since multiple occurrences may\n be required to cross the threshold, these values are likely\n different. This value represents the total number of times\n this event has happened since the last reset (for example,\n 3253, when 3253 symbol errors have occurred since the last\n reset, which has resulted in 51 symbol error threshold\n crossing events since the last reset).", "minimum": 0 }, "cdot3OamEventLogEventTotal": { "type": "integer", "description": "Each Event Notification TLV contains a running total of the\n number of times an event has occurred, as well as the number\n of times an Event Notification for the event has been\n transmitted. For non-threshold crossing events, the number of\n events (cdot3OamLogRunningTotal) and the number of resultant\n Event Notifications (cdot3OamLogEventTotal) should be\n identical. \n \n For threshold crossing events, since multiple occurrences may\n be required to cross the threshold, these values are likely\n different. This value represents the total number of times\n one or more of these occurrences have resulted in an Event\n Notification (for example, 51 when 3253 symbol errors have\n occurred since the last reset, which has resulted in 51 symbol\n error threshold crossing events since the last reset).", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "CISCO-DOT3-OAM-MIB:cdot3OamEventLogTable": { "cdot3OamEventLogEntry": [ { "ifIndex": "1", "cdot3OamEventLogIndex": 1, "cdot3OamEventLogTimestamp": "example-string", "cdot3OamEventLogOui": "example-string", "cdot3OamEventLogType": 0, "cdot3OamEventLogLocation": "example-string", "cdot3OamEventLogWindowHi": 0, "cdot3OamEventLogWindowLo": 0, "cdot3OamEventLogThresholdHi": 0, "cdot3OamEventLogThresholdLo": 0, "cdot3OamEventLogValue": 0, "cdot3OamEventLogRunningTotal": 0, "cdot3OamEventLogEventTotal": 0 }, { "ifIndex": "2", "cdot3OamEventLogIndex": 2, "cdot3OamEventLogTimestamp": "example-string", "cdot3OamEventLogOui": "example-string", "cdot3OamEventLogType": 0, "cdot3OamEventLogLocation": "example-string", "cdot3OamEventLogWindowHi": 0, "cdot3OamEventLogWindowLo": 0, "cdot3OamEventLogThresholdHi": 0, "cdot3OamEventLogThresholdLo": 0, "cdot3OamEventLogValue": 0, "cdot3OamEventLogRunningTotal": 0, "cdot3OamEventLogEventTotal": 0 }, { "ifIndex": "3", "cdot3OamEventLogIndex": 3, "cdot3OamEventLogTimestamp": "example-string", "cdot3OamEventLogOui": "example-string", "cdot3OamEventLogType": 0, "cdot3OamEventLogLocation": "example-string", "cdot3OamEventLogWindowHi": 0, "cdot3OamEventLogWindowLo": 0, "cdot3OamEventLogThresholdHi": 0, "cdot3OamEventLogThresholdLo": 0, "cdot3OamEventLogValue": 0, "cdot3OamEventLogRunningTotal": 0, "cdot3OamEventLogEventTotal": 0 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdot3OamEventLogTable", "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": "/cdot3OamEventLogTable", "x-restconf-kind": "container" }, "/data/CISCO-DOT3-OAM-MIB:cdot3OamEventLogTable/cdot3OamEventLogEntry": { "get": { "summary": "Get cdot3OamEventLogEntry list", "description": "Retrieve list of cdot3OamEventLogEntry entries from MIB", "tags": [ "CISCO-DOT3-OAM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cdot3OamEventLogEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cdot3OamEventLogIndex": { "type": "integer", "description": "An arbitrary integer for identifying individual events\n within the event log.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamEventLogTimestamp": { "type": "string", "description": "The value of sysUpTime at the time of the logged event. For\n locally generated events, the time of the event can be\n accurately retrieved from sysUpTime. For remotely generated\n events, the time of the event is indicated by the reception of\n the Event Notification OAMPDU indicating the event occurred on\n the peer. A system may attempt to adjust the timestamp value\n to more accurately reflect the time of the event at the peer\n OAM entity by using other information, such as that found in\n the timestamp found of the Event Notification TLVs, which\n provides an indication of the relative time between events at\n the peer entity.", "x-yang-type": "yang:timestamp" }, "cdot3OamEventLogOui": { "type": "string", "description": "The OUI of the entity defining the object type. All IEEE\n 802.3 defined events (as appearing in [802.3ah] except for the\n Organizationally Unique Event TLVs) use the IEEE 802.3 OUI of\n 0x0180C2. Organizations defining their own Event Notification\n TLVs include their OUI in the Event Notification TLV which\n gets reflected here.", "x-yang-type": "CISCO-DOT3-OAM-MIB:Cdot3Oui" }, "cdot3OamEventLogType": { "type": "integer", "description": "The type of event that generated this entry in the event log.\n \n When the OUI is the IEEE 802.3 OUI of 0x0180C2, the following\n event types are defined:\n erroredSymbolEvent(1), \n erroredFramePeriodEvent (2), \n erroredFrameEvent(3),\n erroredFrameSecondsEvent(4), \n linkFault(256), \n dyingGaspEvent(257),\n criticalLinkEvent(258)\n The first four are considered threshold crossing events as\n they are generated when a metric exceeds a given value within\n a specified window. The other three are not threshold\n crossing events. \n \n When the OUI is not 71874 (0x0180C2 in hex), then some other\n organization has defined the event space. If event subtyping\n is known to the implementation, it may be reflected here.\n Otherwise, this value should return all Fs (2^32 - 1).", "minimum": 0, "maximum": 4294967295 }, "cdot3OamEventLogLocation": { "type": "string", "description": "Whether this event occurred locally (local(1)), or was \n received from the OAM peer via Ethernet OAM (remote(2))." }, "cdot3OamEventLogWindowHi": { "type": "integer", "description": "If the event represents a threshold crossing event, the two\n objects cdot3OamEventWindowHi and cdot3OamEventWindowLo form an\n unsigned 64-bit integer yielding the window over which the\n value was measured for the threshold crossing event (for\n example, 5, when 11 occurrences happened in 5 seconds while\n the threshold was 10). The two objects are combined as:\n \n cdot3OamEventLogWindow = ((2^32) * cdot3OamEventLogWindowHi)\n + cdot3OamEventLogWindowLo\n \n \n Otherwise, this value is returned as all F's (2^32 - 1) and \n adds no useful information.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamEventLogWindowLo": { "type": "integer", "description": "If the event represents a threshold crossing event, the two\n objects cdot3OamEventWindowHi and cdot3OamEventWindowLo form an\n unsigned 64-bit integer yielding the window over which the\n value was measured for the threshold crossing event (for\n example, 5, when 11 occurrences happened in 5 seconds while\n the threshold was 10). The two objects are combined as:\n \n cdot3OamEventLogWindow = ((2^32) * cdot3OamEventLogWindowHi)\n + cdot3OamEventLogWindowLo\n \n Otherwise, this value is returned as all F's (2^32 - 1) and \n adds no useful information.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamEventLogThresholdHi": { "type": "integer", "description": "If the event represents a threshold crossing event, the two\n objects cdot3OamEventThresholdHi and cdot3OamEventThresholdLo\n form an unsigned 64-bit integer yielding the value that was\n crossed for the threshold crossing event (for example, 10,\n when 11 occurrences happened in 5 seconds while the threshold\n was 10). The two objects are combined as:\n \n cdot3OamEventLogThreshold = ((2^32) * cdot3OamEventLogThresholdHi)\n + cdot3OamEventLogThresholdLo\n \n Otherwise, this value is returned as all F's (2^32 -1) and \n adds no useful information.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamEventLogThresholdLo": { "type": "integer", "description": "If the event represents a threshold crossing event, the two\n objects cdot3OamEventThresholdHi and cdot3OamEventThresholdLo\n form an unsigned 64-bit integer yielding the value that was\n crossed for the threshold crossing event (for example, 10,\n when 11 occurrences happened in 5 seconds while the threshold\n was 10). The two objects are combined as:\n \n cdot3OamEventLogThreshold = ((2^32) * cdot3OamEventLogThresholdHi)\n + cdot3OamEventLogThresholdLo\n \n Otherwise, this value is returned as all F's (2^32 - 1) and\n adds no useful information.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamEventLogValue": { "type": "integer", "description": "If the event represents a threshold crossing event, this\n value indicates the value of the parameter within the given\n window that generated this event (for example, 11, when 11\n occurrences happened in 5 seconds while the threshold was 10). \n \n Otherwise, this value is returned as all F's \n (2^64 - 1) and adds no useful information.", "minimum": 0 }, "cdot3OamEventLogRunningTotal": { "type": "integer", "description": "Each Event Notification TLV contains a running total of the\n number of times an event has occurred, as well as the number\n of times an Event Notification for the event has been\n transmitted. For non-threshold crossing events, the number of\n events (cdot3OamLogRunningTotal) and the number of resultant\n Event Notifications (cdot3OamLogEventTotal) should be\n identical. \n \n For threshold crossing events, since multiple occurrences may\n be required to cross the threshold, these values are likely\n different. This value represents the total number of times\n this event has happened since the last reset (for example,\n 3253, when 3253 symbol errors have occurred since the last\n reset, which has resulted in 51 symbol error threshold\n crossing events since the last reset).", "minimum": 0 }, "cdot3OamEventLogEventTotal": { "type": "integer", "description": "Each Event Notification TLV contains a running total of the\n number of times an event has occurred, as well as the number\n of times an Event Notification for the event has been\n transmitted. For non-threshold crossing events, the number of\n events (cdot3OamLogRunningTotal) and the number of resultant\n Event Notifications (cdot3OamLogEventTotal) should be\n identical. \n \n For threshold crossing events, since multiple occurrences may\n be required to cross the threshold, these values are likely\n different. This value represents the total number of times\n one or more of these occurrences have resulted in an Event\n Notification (for example, 51 when 3253 symbol errors have\n occurred since the last reset, which has resulted in 51 symbol\n error threshold crossing events since the last reset).", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-DOT3-OAM-MIB:cdot3OamEventLogEntry": [ { "ifIndex": "example-string", "cdot3OamEventLogIndex": 1, "cdot3OamEventLogTimestamp": "example-string", "cdot3OamEventLogOui": "example-string", "cdot3OamEventLogType": 0, "cdot3OamEventLogLocation": "example-string", "cdot3OamEventLogWindowHi": 0, "cdot3OamEventLogWindowLo": 0, "cdot3OamEventLogThresholdHi": 0, "cdot3OamEventLogThresholdLo": 0, "cdot3OamEventLogValue": 0, "cdot3OamEventLogRunningTotal": 0, "cdot3OamEventLogEventTotal": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdot3OamEventLogEntry", "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": "/cdot3OamEventLogTable/cdot3OamEventLogEntry", "x-restconf-kind": "container" }, "/data/CISCO-DOT3-OAM-MIB:cdot3OamEntry": { "get": { "summary": "Get cdot3OamEntry list", "description": "Retrieve list of cdot3OamEntry entries from MIB", "tags": [ "CISCO-DOT3-OAM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the table, containing information on the Ethernet\n OAM function for a single Ethernet like interface. Entries in\n the table are created automatically for each interface\n supporting Ethernet OAM. The status of the row entry can be\n determined from cdot3OamOperStatus. \n \n A cdot3OamEntry is indexed in the cdot3OamTable by the ifIndex\n object of the Interfaces MIB.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cdot3OamAdminState": { "type": "string", "description": "This object is used to provision the default administrative\n OAM mode for this interface. This object represents the\n desired state of OAM for this interface. \n \n The cdot3OamAdminState always starts in the disabled(1) state\n until an explicit management action or configuration\n information retained by the system causes a transition to the\n enabled(2) state. When enabled(2), Ethernet OAM will attempt\n to operate over this interface." }, "cdot3OamOperStatus": { "type": "string", "description": "At initialization and failure conditions, two OAM entities on\n the same full-duplex Ethernet link begin a discovery phase to\n determine what OAM capabilities may be used on that link. The\n progress of this initialization is controlled by the OAM\n sublayer. \n \n This value is always disabled(1) if OAM is disabled on this\n interface via the cdot3OamAdminState. \n \n If the link has detected a fault and is transmitting OAMPDUs\n with a link fault indication, the value is linkFault(2). Also,\n if the interface is not operational (ifOperStatus is not \n up(1)), linkFault(2) is returned. Note that the object \n ifOperStatus may not be up(1) as a result of link failure or\n administrative action (ifAdminState being down(2) or\n testing(3)). \n \n The passiveWait(3) state is returned only by OAM entities in\n passive mode (cdot3OamMode) and reflects the state in which the\n OAM entity is waiting to see if the peer device is OAM\n capable. The activeSendLocal(4) value is used by active mode\n devices (cdot3OamMode) and reflects the OAM entity actively\n trying to discover whether the peer has OAM capability but has\n not yet made that determination. \n \n The state sendLocalAndRemote(5) reflects that the local OAM\n entity has discovered the peer but has not yet accepted or\n rejected the configuration of the peer. The local device can,\n for whatever reason, decide that the peer device is\n unacceptable and decline OAM peering. If the local OAM entity\n rejects the peer OAM entity, the state becomes\n oamPeeringLocallyRejected(7). If the OAM peering is allowed\n by the local device, the state moves to\n sendLocalAndRemoteOk(6). Note that both the\n sendLocalAndRemote(5) and oamPeeringLocallyRejected(7) states\n fall within the state SEND_LOCAL_REMOTE of the Discovery state\n diagram [802.3ah, Figure 57-5], with the difference being\n whether the local OAM client has actively rejected the peering\n or has just not indicated any decision yet. Whether a peering\n decision has been made is indicated via the local flags field\n in the OAMPDU (reflected in the aOAMLocalFlagsField of\n 30.3.6.1.10). \n \n If the remote OAM entity rejects the peering, the state\n becomes oamPeeringRemotelyRejected(8). Note that both the\n sendLocalAndRemoteOk(6) and oamPeeringRemotelyRejected(8)\n states fall within the state SEND_LOCAL_REMOTE_OK of the\n Discovery state diagram [802.3ah, Figure 57-5], with the\n difference being whether the remote OAM client has rejected\n the peering or has just not yet decided. This is indicated\n via the remote flags field in the OAM PDU (reflected in the\n aOAMRemoteFlagsField of 30.3.6.1.11). \n \n When the local OAM entity learns that both it and the remote\n OAM entity have accepted the peering, the state moves to\n operational(9) corresponding to the SEND_ANY state of the\n Discovery state diagram [802.3ah, Figure 57-5]. \n \n Since Ethernet OAM functions are not designed to work\n completely over half-duplex interfaces, the value\n nonOperHalfDuplex(10) is returned whenever Ethernet OAM is\n enabled (cdot3OamAdminState is enabled(1)) but the interface is\n in half-duplex operation." }, "cdot3OamMode": { "type": "string", "description": "This object configures the mode of OAM operation for this\n Ethernet like interface. OAM on Ethernet interfaces may be in\n 'active' mode or 'passive' mode. These two modes differ in\n that active mode provides additional capabilities to initiate\n monitoring activities with the remote OAM peer entity, while\n passive mode generally waits for the peer to initiate OAM\n actions with it. As an example, an active OAM entity can put\n the remote OAM entity in a loopback state, where a passive OAM\n entity cannot. \n \n The default value of cdot3OamMode is dependent on the type of\n system on which this Ethernet like interface resides. The\n default value should be 'active(1)' unless it is known that\n this system should take on a subservient role to the other\n device connected over this interface. \n \n Changing this value results in incrementing the configuration\n revision field of locally generated OAMPDUs (30.3.6.1.12) and\n potentially re-doing the OAM discovery process if the\n cdot3OamOperStatus was already operational(9)." }, "cdot3OamMaxOamPduSize": { "type": "integer", "description": "The largest OAMPDU that the OAM entity supports. OAM\n entities exchange maximum OAMPDU sizes and negotiate to use\n the smaller of the two maximum OAMPDU sizes between the peers.\n This value is determined by the local implementation.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamConfigRevision": { "type": "integer", "description": "The configuration revision of the OAM entity as reflected in\n the latest OAMPDU sent by the OAM entity. The config revision\n is used by OAM entities to indicate configuration changes have\n occurred which might require the peer OAM entity to\n re-evaluate whether OAM peering is allowed.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamFunctionsSupported": { "type": "string", "description": "The OAM functions supported on this Ethernet like interface.\n OAM consists of separate functional sets beyond the basic\n discovery process which is always required. These functional\n groups can be supported independently by any implementation.\n These values are communicated to the peer via the local\n configuration field of Information OAMPDUs. \n \n Setting 'unidirectionalSupport(0)' indicates that the OAM\n entity supports the transmission of OAMPDUs on links that are\n operating in unidirectional mode (traffic flowing in one\n direction only). Setting 'loopbackSupport(1)' indicates the\n OAM entity can initiate and respond to loopback commands.\n Setting 'eventSupport(2)' indicates the OAM entity can send\n and receive Event Notification OAMPDUs. Setting\n 'variableSupport(3)' indicates the OAM entity can send and\n receive Variable Request and Response OAMPDUs." } } } }, "example": { "CISCO-DOT3-OAM-MIB:cdot3OamEntry": [ { "ifIndex": "example-string", "cdot3OamAdminState": "up(1)", "cdot3OamOperStatus": "up(1)", "cdot3OamMode": "example-string", "cdot3OamMaxOamPduSize": 0, "cdot3OamConfigRevision": 0, "cdot3OamFunctionsSupported": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdot3OamEntry-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": "/cdot3OamEntry", "x-restconf-kind": "container" }, "/data/CISCO-DOT3-OAM-MIB:cdot3OamEntry={ifIndex}": { "get": { "summary": "Get cdot3OamEntry entry", "description": "Retrieve specific cdot3OamEntry entry by key from MIB", "tags": [ "CISCO-DOT3-OAM-MIB" ], "parameters": [ { "name": "ifIndex", "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": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cdot3OamAdminState": { "type": "string", "description": "This object is used to provision the default administrative\n OAM mode for this interface. This object represents the\n desired state of OAM for this interface. \n \n The cdot3OamAdminState always starts in the disabled(1) state\n until an explicit management action or configuration\n information retained by the system causes a transition to the\n enabled(2) state. When enabled(2), Ethernet OAM will attempt\n to operate over this interface." }, "cdot3OamOperStatus": { "type": "string", "description": "At initialization and failure conditions, two OAM entities on\n the same full-duplex Ethernet link begin a discovery phase to\n determine what OAM capabilities may be used on that link. The\n progress of this initialization is controlled by the OAM\n sublayer. \n \n This value is always disabled(1) if OAM is disabled on this\n interface via the cdot3OamAdminState. \n \n If the link has detected a fault and is transmitting OAMPDUs\n with a link fault indication, the value is linkFault(2). Also,\n if the interface is not operational (ifOperStatus is not \n up(1)), linkFault(2) is returned. Note that the object \n ifOperStatus may not be up(1) as a result of link failure or\n administrative action (ifAdminState being down(2) or\n testing(3)). \n \n The passiveWait(3) state is returned only by OAM entities in\n passive mode (cdot3OamMode) and reflects the state in which the\n OAM entity is waiting to see if the peer device is OAM\n capable. The activeSendLocal(4) value is used by active mode\n devices (cdot3OamMode) and reflects the OAM entity actively\n trying to discover whether the peer has OAM capability but has\n not yet made that determination. \n \n The state sendLocalAndRemote(5) reflects that the local OAM\n entity has discovered the peer but has not yet accepted or\n rejected the configuration of the peer. The local device can,\n for whatever reason, decide that the peer device is\n unacceptable and decline OAM peering. If the local OAM entity\n rejects the peer OAM entity, the state becomes\n oamPeeringLocallyRejected(7). If the OAM peering is allowed\n by the local device, the state moves to\n sendLocalAndRemoteOk(6). Note that both the\n sendLocalAndRemote(5) and oamPeeringLocallyRejected(7) states\n fall within the state SEND_LOCAL_REMOTE of the Discovery state\n diagram [802.3ah, Figure 57-5], with the difference being\n whether the local OAM client has actively rejected the peering\n or has just not indicated any decision yet. Whether a peering\n decision has been made is indicated via the local flags field\n in the OAMPDU (reflected in the aOAMLocalFlagsField of\n 30.3.6.1.10). \n \n If the remote OAM entity rejects the peering, the state\n becomes oamPeeringRemotelyRejected(8). Note that both the\n sendLocalAndRemoteOk(6) and oamPeeringRemotelyRejected(8)\n states fall within the state SEND_LOCAL_REMOTE_OK of the\n Discovery state diagram [802.3ah, Figure 57-5], with the\n difference being whether the remote OAM client has rejected\n the peering or has just not yet decided. This is indicated\n via the remote flags field in the OAM PDU (reflected in the\n aOAMRemoteFlagsField of 30.3.6.1.11). \n \n When the local OAM entity learns that both it and the remote\n OAM entity have accepted the peering, the state moves to\n operational(9) corresponding to the SEND_ANY state of the\n Discovery state diagram [802.3ah, Figure 57-5]. \n \n Since Ethernet OAM functions are not designed to work\n completely over half-duplex interfaces, the value\n nonOperHalfDuplex(10) is returned whenever Ethernet OAM is\n enabled (cdot3OamAdminState is enabled(1)) but the interface is\n in half-duplex operation." }, "cdot3OamMode": { "type": "string", "description": "This object configures the mode of OAM operation for this\n Ethernet like interface. OAM on Ethernet interfaces may be in\n 'active' mode or 'passive' mode. These two modes differ in\n that active mode provides additional capabilities to initiate\n monitoring activities with the remote OAM peer entity, while\n passive mode generally waits for the peer to initiate OAM\n actions with it. As an example, an active OAM entity can put\n the remote OAM entity in a loopback state, where a passive OAM\n entity cannot. \n \n The default value of cdot3OamMode is dependent on the type of\n system on which this Ethernet like interface resides. The\n default value should be 'active(1)' unless it is known that\n this system should take on a subservient role to the other\n device connected over this interface. \n \n Changing this value results in incrementing the configuration\n revision field of locally generated OAMPDUs (30.3.6.1.12) and\n potentially re-doing the OAM discovery process if the\n cdot3OamOperStatus was already operational(9)." }, "cdot3OamMaxOamPduSize": { "type": "integer", "description": "The largest OAMPDU that the OAM entity supports. OAM\n entities exchange maximum OAMPDU sizes and negotiate to use\n the smaller of the two maximum OAMPDU sizes between the peers.\n This value is determined by the local implementation.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamConfigRevision": { "type": "integer", "description": "The configuration revision of the OAM entity as reflected in\n the latest OAMPDU sent by the OAM entity. The config revision\n is used by OAM entities to indicate configuration changes have\n occurred which might require the peer OAM entity to\n re-evaluate whether OAM peering is allowed.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamFunctionsSupported": { "type": "string", "description": "The OAM functions supported on this Ethernet like interface.\n OAM consists of separate functional sets beyond the basic\n discovery process which is always required. These functional\n groups can be supported independently by any implementation.\n These values are communicated to the peer via the local\n configuration field of Information OAMPDUs. \n \n Setting 'unidirectionalSupport(0)' indicates that the OAM\n entity supports the transmission of OAMPDUs on links that are\n operating in unidirectional mode (traffic flowing in one\n direction only). Setting 'loopbackSupport(1)' indicates the\n OAM entity can initiate and respond to loopback commands.\n Setting 'eventSupport(2)' indicates the OAM entity can send\n and receive Event Notification OAMPDUs. Setting\n 'variableSupport(3)' indicates the OAM entity can send and\n receive Variable Request and Response OAMPDUs." } } }, "example": { "CISCO-DOT3-OAM-MIB:cdot3OamEntry": { "ifIndex": "example-string", "cdot3OamAdminState": "up(1)", "cdot3OamOperStatus": "up(1)", "cdot3OamMode": "example-string", "cdot3OamMaxOamPduSize": 0, "cdot3OamConfigRevision": 0, "cdot3OamFunctionsSupported": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdot3OamEntry-4" }, "x-yang-path": "/cdot3OamEntry={ifIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex" ] }, "/data/CISCO-DOT3-OAM-MIB:cdot3OamPeerEntry": { "get": { "summary": "Get cdot3OamPeerEntry list", "description": "Retrieve list of cdot3OamPeerEntry entries from MIB", "tags": [ "CISCO-DOT3-OAM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cdot3OamPeerEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cdot3OamPeerMacAddress": { "type": "string", "description": "The MAC address of the peer OAM entity. The MAC address is\n derived from the most recently received OAMPDU.", "x-yang-type": "yang:mac-address" }, "cdot3OamPeerVendorOui": { "type": "string", "description": "The OUI of the OAM peer as reflected in the latest\n Information OAMPDU received with a Local Information TLV. The\n OUI can be used to identify the vendor of the remote OAM\n entity. This value is initialized to zero before any Local\n Information TLV is received.", "x-yang-type": "CISCO-DOT3-OAM-MIB:Cdot3Oui" }, "cdot3OamPeerVendorInfo": { "type": "integer", "description": "The Vendor Info of the OAM peer as reflected in the latest\n Information OAMPDU received with a Local Information TLV. The\n vendor information field is within the Local Information TLV,\n and can be used to determine additional information about the\n peer entity. The format of the vendor information is\n unspecified within the 32-bit field. This value is\n initialized to zero before any Local Information TLV is\n received.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamPeerMode": { "type": "string", "description": "The mode of the OAM peer as reflected in the latest\n Information OAMPDU received with a Local Information TLV. The\n mode of the peer can be determined from the Configuration\n field in the Local Information TLV of the last Information\n OAMPDU received from the peer. The value is unknown(3)\n whenever no Local Information TLV has been received. The\n values of active(1) and passive(2) are returned when a Local\n Information TLV has been received indicating the peer is in\n active or passive mode, respectively." }, "cdot3OamPeerMaxOamPduSize": { "type": "integer", "description": "The maximum size of OAMPDU supported by the peer as reflected\n in the latest Information OAMPDU received with a Local\n Information TLV. Ethernet OAM on this interface must not use\n OAMPDUs that exceed this size. The maximum OAMPDU size can be\n determined from the PDU Configuration field of the Local\n Information TLV of the last Information OAMPDU received from\n the peer. A value of zero is returned if no Local Information\n TLV has been received. Otherwise, the value of the OAM peer's\n maximum OAMPDU size is returned in this value. \n Note that the values 1..63 are invalid sizes for Ethernet\n frames and should never appear.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamPeerConfigRevision": { "type": "integer", "description": "The configuration revision of the OAM peer as reflected in\n the latest OAMPDU. This attribute is changed by the peer\n whenever it has a local configuration change for Ethernet OAM\n this interface. The configuration revision can be determined\n from the Revision field of the Local Information TLV of the\n most recently received Information OAMPDU with a Local\n Information TLV. A value of zero is returned if no Local\n Information TLV has been received.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamPeerFunctionsSupported": { "type": "string", "description": "The OAM functions supported on this Ethernet like interface.\n OAM consists of separate functionality sets above the basic\n discovery process. This value indicates the capabilities of\n the peer OAM entity with respect to these functions. This\n value is initialized so all bits are clear. \n \n If unidirectionalSupport(0) is set, then the peer OAM entity\n supports sending OAM frames on Ethernet interfaces when the\n receive path is known to be inoperable. If\n loopbackSupport(1) is set, then the peer OAM entity can send\n and receive OAM loopback commands. If eventSupport(2) is set,\n then the peer OAM entity can send and receive event OAMPDUs to\n signal various error conditions. If variableSupport(3) is set,\n then the peer OAM entity can send and receive variable\n requests to monitor attribute value as described in Clause 57\n of [802.3ah]. \n \n The capabilities of the OAM peer can be determined from the\n configuration field of the Local Information TLV of the most\n recently received Information OAMPDU with a Local Information\n TLV. All zeros are returned if no Local Information TLV has\n yet been received." } } } }, "example": { "CISCO-DOT3-OAM-MIB:cdot3OamPeerEntry": [ { "ifIndex": "example-string", "cdot3OamPeerMacAddress": "00:11:22:33:44:55", "cdot3OamPeerVendorOui": "example-string", "cdot3OamPeerVendorInfo": 0, "cdot3OamPeerMode": "example-string", "cdot3OamPeerMaxOamPduSize": 0, "cdot3OamPeerConfigRevision": 0, "cdot3OamPeerFunctionsSupported": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdot3OamPeerEntry-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": "/cdot3OamPeerEntry", "x-restconf-kind": "container" }, "/data/CISCO-DOT3-OAM-MIB:cdot3OamPeerEntry={ifIndex}": { "get": { "summary": "Get cdot3OamPeerEntry entry", "description": "Retrieve specific cdot3OamPeerEntry entry by key from MIB", "tags": [ "CISCO-DOT3-OAM-MIB" ], "parameters": [ { "name": "ifIndex", "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": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cdot3OamPeerMacAddress": { "type": "string", "description": "The MAC address of the peer OAM entity. The MAC address is\n derived from the most recently received OAMPDU.", "x-yang-type": "yang:mac-address" }, "cdot3OamPeerVendorOui": { "type": "string", "description": "The OUI of the OAM peer as reflected in the latest\n Information OAMPDU received with a Local Information TLV. The\n OUI can be used to identify the vendor of the remote OAM\n entity. This value is initialized to zero before any Local\n Information TLV is received.", "x-yang-type": "CISCO-DOT3-OAM-MIB:Cdot3Oui" }, "cdot3OamPeerVendorInfo": { "type": "integer", "description": "The Vendor Info of the OAM peer as reflected in the latest\n Information OAMPDU received with a Local Information TLV. The\n vendor information field is within the Local Information TLV,\n and can be used to determine additional information about the\n peer entity. The format of the vendor information is\n unspecified within the 32-bit field. This value is\n initialized to zero before any Local Information TLV is\n received.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamPeerMode": { "type": "string", "description": "The mode of the OAM peer as reflected in the latest\n Information OAMPDU received with a Local Information TLV. The\n mode of the peer can be determined from the Configuration\n field in the Local Information TLV of the last Information\n OAMPDU received from the peer. The value is unknown(3)\n whenever no Local Information TLV has been received. The\n values of active(1) and passive(2) are returned when a Local\n Information TLV has been received indicating the peer is in\n active or passive mode, respectively." }, "cdot3OamPeerMaxOamPduSize": { "type": "integer", "description": "The maximum size of OAMPDU supported by the peer as reflected\n in the latest Information OAMPDU received with a Local\n Information TLV. Ethernet OAM on this interface must not use\n OAMPDUs that exceed this size. The maximum OAMPDU size can be\n determined from the PDU Configuration field of the Local\n Information TLV of the last Information OAMPDU received from\n the peer. A value of zero is returned if no Local Information\n TLV has been received. Otherwise, the value of the OAM peer's\n maximum OAMPDU size is returned in this value. \n Note that the values 1..63 are invalid sizes for Ethernet\n frames and should never appear.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamPeerConfigRevision": { "type": "integer", "description": "The configuration revision of the OAM peer as reflected in\n the latest OAMPDU. This attribute is changed by the peer\n whenever it has a local configuration change for Ethernet OAM\n this interface. The configuration revision can be determined\n from the Revision field of the Local Information TLV of the\n most recently received Information OAMPDU with a Local\n Information TLV. A value of zero is returned if no Local\n Information TLV has been received.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamPeerFunctionsSupported": { "type": "string", "description": "The OAM functions supported on this Ethernet like interface.\n OAM consists of separate functionality sets above the basic\n discovery process. This value indicates the capabilities of\n the peer OAM entity with respect to these functions. This\n value is initialized so all bits are clear. \n \n If unidirectionalSupport(0) is set, then the peer OAM entity\n supports sending OAM frames on Ethernet interfaces when the\n receive path is known to be inoperable. If\n loopbackSupport(1) is set, then the peer OAM entity can send\n and receive OAM loopback commands. If eventSupport(2) is set,\n then the peer OAM entity can send and receive event OAMPDUs to\n signal various error conditions. If variableSupport(3) is set,\n then the peer OAM entity can send and receive variable\n requests to monitor attribute value as described in Clause 57\n of [802.3ah]. \n \n The capabilities of the OAM peer can be determined from the\n configuration field of the Local Information TLV of the most\n recently received Information OAMPDU with a Local Information\n TLV. All zeros are returned if no Local Information TLV has\n yet been received." } } }, "example": { "CISCO-DOT3-OAM-MIB:cdot3OamPeerEntry": { "ifIndex": "example-string", "cdot3OamPeerMacAddress": "00:11:22:33:44:55", "cdot3OamPeerVendorOui": "example-string", "cdot3OamPeerVendorInfo": 0, "cdot3OamPeerMode": "example-string", "cdot3OamPeerMaxOamPduSize": 0, "cdot3OamPeerConfigRevision": 0, "cdot3OamPeerFunctionsSupported": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdot3OamPeerEntry-4" }, "x-yang-path": "/cdot3OamPeerEntry={ifIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex" ] }, "/data/CISCO-DOT3-OAM-MIB:cdot3OamLoopbackEntry": { "get": { "summary": "Get cdot3OamLoopbackEntry list", "description": "Retrieve list of cdot3OamLoopbackEntry entries from MIB", "tags": [ "CISCO-DOT3-OAM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the table, containing information on the loopback\n status for a single Ethernet like interface. Entries in the\n table are automatically created whenever the local OAM entity\n supports loopback capabilities. The loopback status on the\n interface can be determined from the cdot3OamLoopbackStatus\n object.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cdot3OamLoopbackStatus": { "type": "string", "description": "The loopback status of the OAM entity. This status is\n determined by a combination of the local parser and\n multiplexer states, the remote parser and multiplexer states,\n as well as by the actions of the local OAM client. When\n operating in normal mode with no loopback in progress, the\n status reads noLoopback(1). \n \n The values initiatingLooopback(2) and terminatingLoopback(4)\n can be read or written. The other values can only be read -\n they can never be written. Writing initiatingLoopback causes\n the local OAM entity to start the loopback process with its\n peer. This value can only be written when the status is\n noLoopback(1). Writing the value initiatingLoopback(2) in any\n other state has no effect. When in remoteLoopback(3), writing\n terminatingLoopback(4) causes the local OAM entity to initiate\n the termination of the loopback state. Writing\n terminatingLoopack(4) in any other state has no effect. \n If the OAM client initiates a looopback and has sent an\n Loopback OAMPDU and is waiting for a response, where the local\n parser and multiplexer states are DISCARD (see [802.3ah,\n 57.2.11.1]), the status is 'initiatingLoopback'. In this\n case, the local OAM entity has yet to receive any\n acknowledgement that the remote OAM entity has received its\n loopback command request. \n \n If the local OAM client knows that the remote OAM entity is in\n loopback mode (via the remote state information as described\n in [802.3ah, 57.2.11.1, 30.3.6.1.15]), the status is\n remoteLoopback(3). If the local OAM client is in the process\n of terminating the remote loopback [802.3ah, 57.2.11.3,\n 30.3.6.1.14], with its local multiplexer and parser states in\n DISCARD, the status is terminatingLoopback(4). If the remote\n OAM client has put the local OAM entity in loopback mode as\n indicated by its local parser state, the status is\n localLoopback(5). \n \n The unknown(6) status indicates the parser and multiplexer\n combination is unexpected. This status may be returned if the\n OAM loopback is in a transition state but should not persist. \n \n The values of this attribute correspond to the following\n values of the local and remote parser and multiplexer states. \n \n value LclPrsr LclMux RmtPrsr RmtMux\n noLoopback FWD FWD FWD FWD \n initLoopback DISCARD DISCARD FWD FWD \n rmtLoopback DISCARD FWD LPBK DISCARD\n tmtngLoopback DISCARD DISCARD LPBK DISCARD\n lclLoopback LPBK DISCARD DISCARD FWD\n unknown *** any other combination ***" }, "cdot3OamLoopbackIgnoreRx": { "type": "string", "description": "Since OAM loopback is a disruptive operation (user traffic\n does not pass), this attribute provides a mechanism to provide\n controls over whether received OAM loopback commands are\n processed or ignored. When the value is ignore(1), received\n loopback commands are ignored. When the value is process(2),\n OAM loopback commands are processed. The default value is to\n ignore loopback commands (ignore(1))." } } } }, "example": { "CISCO-DOT3-OAM-MIB:cdot3OamLoopbackEntry": [ { "ifIndex": "example-string", "cdot3OamLoopbackStatus": "up(1)", "cdot3OamLoopbackIgnoreRx": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdot3OamLoopbackEntry-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": "/cdot3OamLoopbackEntry", "x-restconf-kind": "container" }, "/data/CISCO-DOT3-OAM-MIB:cdot3OamLoopbackEntry={ifIndex}": { "get": { "summary": "Get cdot3OamLoopbackEntry entry", "description": "Retrieve specific cdot3OamLoopbackEntry entry by key from MIB", "tags": [ "CISCO-DOT3-OAM-MIB" ], "parameters": [ { "name": "ifIndex", "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": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cdot3OamLoopbackStatus": { "type": "string", "description": "The loopback status of the OAM entity. This status is\n determined by a combination of the local parser and\n multiplexer states, the remote parser and multiplexer states,\n as well as by the actions of the local OAM client. When\n operating in normal mode with no loopback in progress, the\n status reads noLoopback(1). \n \n The values initiatingLooopback(2) and terminatingLoopback(4)\n can be read or written. The other values can only be read -\n they can never be written. Writing initiatingLoopback causes\n the local OAM entity to start the loopback process with its\n peer. This value can only be written when the status is\n noLoopback(1). Writing the value initiatingLoopback(2) in any\n other state has no effect. When in remoteLoopback(3), writing\n terminatingLoopback(4) causes the local OAM entity to initiate\n the termination of the loopback state. Writing\n terminatingLoopack(4) in any other state has no effect. \n If the OAM client initiates a looopback and has sent an\n Loopback OAMPDU and is waiting for a response, where the local\n parser and multiplexer states are DISCARD (see [802.3ah,\n 57.2.11.1]), the status is 'initiatingLoopback'. In this\n case, the local OAM entity has yet to receive any\n acknowledgement that the remote OAM entity has received its\n loopback command request. \n \n If the local OAM client knows that the remote OAM entity is in\n loopback mode (via the remote state information as described\n in [802.3ah, 57.2.11.1, 30.3.6.1.15]), the status is\n remoteLoopback(3). If the local OAM client is in the process\n of terminating the remote loopback [802.3ah, 57.2.11.3,\n 30.3.6.1.14], with its local multiplexer and parser states in\n DISCARD, the status is terminatingLoopback(4). If the remote\n OAM client has put the local OAM entity in loopback mode as\n indicated by its local parser state, the status is\n localLoopback(5). \n \n The unknown(6) status indicates the parser and multiplexer\n combination is unexpected. This status may be returned if the\n OAM loopback is in a transition state but should not persist. \n \n The values of this attribute correspond to the following\n values of the local and remote parser and multiplexer states. \n \n value LclPrsr LclMux RmtPrsr RmtMux\n noLoopback FWD FWD FWD FWD \n initLoopback DISCARD DISCARD FWD FWD \n rmtLoopback DISCARD FWD LPBK DISCARD\n tmtngLoopback DISCARD DISCARD LPBK DISCARD\n lclLoopback LPBK DISCARD DISCARD FWD\n unknown *** any other combination ***" }, "cdot3OamLoopbackIgnoreRx": { "type": "string", "description": "Since OAM loopback is a disruptive operation (user traffic\n does not pass), this attribute provides a mechanism to provide\n controls over whether received OAM loopback commands are\n processed or ignored. When the value is ignore(1), received\n loopback commands are ignored. When the value is process(2),\n OAM loopback commands are processed. The default value is to\n ignore loopback commands (ignore(1))." } } }, "example": { "CISCO-DOT3-OAM-MIB:cdot3OamLoopbackEntry": { "ifIndex": "example-string", "cdot3OamLoopbackStatus": "up(1)", "cdot3OamLoopbackIgnoreRx": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdot3OamLoopbackEntry-4" }, "x-yang-path": "/cdot3OamLoopbackEntry={ifIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex" ] }, "/data/CISCO-DOT3-OAM-MIB:cdot3OamStatsEntry": { "get": { "summary": "Get cdot3OamStatsEntry list", "description": "Retrieve list of cdot3OamStatsEntry entries from MIB", "tags": [ "CISCO-DOT3-OAM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the table, containing statistics information on\n the Ethernet OAM function for a single Ethernet like\n interface. Entries are automatically created for every entry\n in the cdot3OamTable. Counters are maintained across\n transitions in cdot3OamOperStatus.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cdot3OamInformationTx": { "type": "integer", "description": "A count of the number of Information OAMPDUs transmitted on\n this interface.\n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamInformationRx": { "type": "integer", "description": "A count of the number of Information OAMPDUs received on this\n interface.\n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamUniqueEventNotificationTx": { "type": "integer", "description": "A count of the number of unique Event OAMPDUs transmitted on\n this interface. Event notifications may be sent in duplicate\n to increase the probability of successfully being received,\n given the possibility that a frame may be lost in transit.\n Duplicate Event Notification transmissions are counted by\n cdot3OamDuplicateEventNotificationTx. \n \n A unique Event Notification OAMPDU is indicated as an Event\n Notification OAMPDU with a Sequence Number field that is\n distinct from the previously transmitted Event Notification\n OAMPDU Sequence Number. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamUniqueEventNotificationRx": { "type": "integer", "description": "A count of the number of unique Event OAMPDUs received on\n this interface. Event notification OAMPDUs may be sent in\n duplicate to increase the probability of successfully being\n received, given the possibility that a frame may be lost in\n transit. Duplicate Event Notification receptions are counted\n by cdot3OamDuplicateEventNotificationRx. \n \n A unique Event Notification OAMPDU is indicated as an Event\n Notification OAMPDU with a Sequence Number field that is\n distinct from the previously received Event Notification\n OAMPDU Sequence Number. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamDuplicateEventNotificationTx": { "type": "integer", "description": "A count of the number of duplicate Event OAMPDUs transmitted\n on this interface. Event notification OAMPDUs may be sent in\n duplicate to increase the probability of successfully being\n received, given the possibility that a frame may be lost in\n transit. \n \n A duplicate Event Notification OAMPDU is indicated as an Event\n Notification OAMPDU with a Sequence Number field that is\n identical to the previously transmitted Event Notification\n OAMPDU Sequence Number. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamDuplicateEventNotificationRx": { "type": "integer", "description": "A count of the number of duplicate Event OAMPDUs received on\n this interface. Event notification OAMPDUs may be sent in\n duplicate to increase the probability of successfully being\n received, given the possibility that a frame may be lost in\n transit. \n \n A duplicate Event Notification OAMPDU is indicated as an Event\n Notification OAMPDU with a Sequence Number field that is\n identical to the previously received Event Notification OAMPDU\n Sequence Number. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamLoopbackControlTx": { "type": "integer", "description": "A count of the number of Loopback Control OAMPDUs transmitted\n on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamLoopbackControlRx": { "type": "integer", "description": "A count of the number of Loopback Control OAMPDUs received\n on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamVariableRequestTx": { "type": "integer", "description": "A count of the number of Variable Request OAMPDUs transmitted\n on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamVariableRequestRx": { "type": "integer", "description": "A count of the number of Variable Request OAMPDUs received on\n this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamVariableResponseTx": { "type": "integer", "description": "A count of the number of Variable Response OAMPDUs\n transmitted on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamVariableResponseRx": { "type": "integer", "description": "A count of the number of Variable Response OAMPDUs received\n on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamOrgSpecificTx": { "type": "integer", "description": "A count of the number of Organization Specific OAMPDUs\n transmitted on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamOrgSpecificRx": { "type": "integer", "description": "A count of the number of Organization Specific OAMPDUs\n received on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamUnsupportedCodesTx": { "type": "integer", "description": "A count of the number of OAMPDUs transmitted on this\n interface with an unsupported op-code. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamUnsupportedCodesRx": { "type": "integer", "description": "A count of the number of OAMPDUs received on this interface\n with an unsupported op-code. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamFramesLostDueToOam": { "type": "integer", "description": "A count of the number of frames that were dropped by the OAM\n multiplexer. Since the OAM multiplexer has multiple inputs\n and a single output, there may be cases where frames are\n dropped due to transmit resource contention. This counter is\n incremented whenever a frame is dropped by the OAM layer.\n Note that any Ethernet frame, not just OAMPDUs, may be dropped\n by the OAM layer. This can occur when an OAMPDU takes\n precedence over a 'normal' frame resulting in the 'normal'\n frame being dropped. \n \n When this counter is incremented, no other counters in this\n MIB are incremented. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-DOT3-OAM-MIB:cdot3OamStatsEntry": [ { "ifIndex": "example-string", "cdot3OamInformationTx": 0, "cdot3OamInformationRx": 0, "cdot3OamUniqueEventNotificationTx": 0, "cdot3OamUniqueEventNotificationRx": 0, "cdot3OamDuplicateEventNotificationTx": 0, "cdot3OamDuplicateEventNotificationRx": 0, "cdot3OamLoopbackControlTx": 0, "cdot3OamLoopbackControlRx": 0, "cdot3OamVariableRequestTx": 0, "cdot3OamVariableRequestRx": 0, "cdot3OamVariableResponseTx": 0, "cdot3OamVariableResponseRx": 0, "cdot3OamOrgSpecificTx": 0, "cdot3OamOrgSpecificRx": 0, "cdot3OamUnsupportedCodesTx": 0, "cdot3OamUnsupportedCodesRx": 0, "cdot3OamFramesLostDueToOam": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdot3OamStatsEntry-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": "/cdot3OamStatsEntry", "x-restconf-kind": "container" }, "/data/CISCO-DOT3-OAM-MIB:cdot3OamStatsEntry={ifIndex}": { "get": { "summary": "Get cdot3OamStatsEntry entry", "description": "Retrieve specific cdot3OamStatsEntry entry by key from MIB", "tags": [ "CISCO-DOT3-OAM-MIB" ], "parameters": [ { "name": "ifIndex", "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": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cdot3OamInformationTx": { "type": "integer", "description": "A count of the number of Information OAMPDUs transmitted on\n this interface.\n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamInformationRx": { "type": "integer", "description": "A count of the number of Information OAMPDUs received on this\n interface.\n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamUniqueEventNotificationTx": { "type": "integer", "description": "A count of the number of unique Event OAMPDUs transmitted on\n this interface. Event notifications may be sent in duplicate\n to increase the probability of successfully being received,\n given the possibility that a frame may be lost in transit.\n Duplicate Event Notification transmissions are counted by\n cdot3OamDuplicateEventNotificationTx. \n \n A unique Event Notification OAMPDU is indicated as an Event\n Notification OAMPDU with a Sequence Number field that is\n distinct from the previously transmitted Event Notification\n OAMPDU Sequence Number. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamUniqueEventNotificationRx": { "type": "integer", "description": "A count of the number of unique Event OAMPDUs received on\n this interface. Event notification OAMPDUs may be sent in\n duplicate to increase the probability of successfully being\n received, given the possibility that a frame may be lost in\n transit. Duplicate Event Notification receptions are counted\n by cdot3OamDuplicateEventNotificationRx. \n \n A unique Event Notification OAMPDU is indicated as an Event\n Notification OAMPDU with a Sequence Number field that is\n distinct from the previously received Event Notification\n OAMPDU Sequence Number. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamDuplicateEventNotificationTx": { "type": "integer", "description": "A count of the number of duplicate Event OAMPDUs transmitted\n on this interface. Event notification OAMPDUs may be sent in\n duplicate to increase the probability of successfully being\n received, given the possibility that a frame may be lost in\n transit. \n \n A duplicate Event Notification OAMPDU is indicated as an Event\n Notification OAMPDU with a Sequence Number field that is\n identical to the previously transmitted Event Notification\n OAMPDU Sequence Number. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamDuplicateEventNotificationRx": { "type": "integer", "description": "A count of the number of duplicate Event OAMPDUs received on\n this interface. Event notification OAMPDUs may be sent in\n duplicate to increase the probability of successfully being\n received, given the possibility that a frame may be lost in\n transit. \n \n A duplicate Event Notification OAMPDU is indicated as an Event\n Notification OAMPDU with a Sequence Number field that is\n identical to the previously received Event Notification OAMPDU\n Sequence Number. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamLoopbackControlTx": { "type": "integer", "description": "A count of the number of Loopback Control OAMPDUs transmitted\n on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamLoopbackControlRx": { "type": "integer", "description": "A count of the number of Loopback Control OAMPDUs received\n on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamVariableRequestTx": { "type": "integer", "description": "A count of the number of Variable Request OAMPDUs transmitted\n on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamVariableRequestRx": { "type": "integer", "description": "A count of the number of Variable Request OAMPDUs received on\n this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamVariableResponseTx": { "type": "integer", "description": "A count of the number of Variable Response OAMPDUs\n transmitted on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamVariableResponseRx": { "type": "integer", "description": "A count of the number of Variable Response OAMPDUs received\n on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamOrgSpecificTx": { "type": "integer", "description": "A count of the number of Organization Specific OAMPDUs\n transmitted on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamOrgSpecificRx": { "type": "integer", "description": "A count of the number of Organization Specific OAMPDUs\n received on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamUnsupportedCodesTx": { "type": "integer", "description": "A count of the number of OAMPDUs transmitted on this\n interface with an unsupported op-code. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamUnsupportedCodesRx": { "type": "integer", "description": "A count of the number of OAMPDUs received on this interface\n with an unsupported op-code. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamFramesLostDueToOam": { "type": "integer", "description": "A count of the number of frames that were dropped by the OAM\n multiplexer. Since the OAM multiplexer has multiple inputs\n and a single output, there may be cases where frames are\n dropped due to transmit resource contention. This counter is\n incremented whenever a frame is dropped by the OAM layer.\n Note that any Ethernet frame, not just OAMPDUs, may be dropped\n by the OAM layer. This can occur when an OAMPDU takes\n precedence over a 'normal' frame resulting in the 'normal'\n frame being dropped. \n \n When this counter is incremented, no other counters in this\n MIB are incremented. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-DOT3-OAM-MIB:cdot3OamStatsEntry": { "ifIndex": "example-string", "cdot3OamInformationTx": 0, "cdot3OamInformationRx": 0, "cdot3OamUniqueEventNotificationTx": 0, "cdot3OamUniqueEventNotificationRx": 0, "cdot3OamDuplicateEventNotificationTx": 0, "cdot3OamDuplicateEventNotificationRx": 0, "cdot3OamLoopbackControlTx": 0, "cdot3OamLoopbackControlRx": 0, "cdot3OamVariableRequestTx": 0, "cdot3OamVariableRequestRx": 0, "cdot3OamVariableResponseTx": 0, "cdot3OamVariableResponseRx": 0, "cdot3OamOrgSpecificTx": 0, "cdot3OamOrgSpecificRx": 0, "cdot3OamUnsupportedCodesTx": 0, "cdot3OamUnsupportedCodesRx": 0, "cdot3OamFramesLostDueToOam": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdot3OamStatsEntry-4" }, "x-yang-path": "/cdot3OamStatsEntry={ifIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex" ] }, "/data/CISCO-DOT3-OAM-MIB:cdot3OamEventConfigEntry": { "get": { "summary": "Get cdot3OamEventConfigEntry list", "description": "Retrieve list of cdot3OamEventConfigEntry entries from MIB", "tags": [ "CISCO-DOT3-OAM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cdot3OamEventConfigEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cdot3OamErrSymPeriodWindowHi": { "type": "integer", "description": "The two objects cdot3OamErrSymPeriodWindowHi and\n cdot3OamErrSymPeriodLo together form an unsigned 64-bit\n integer representing the number of symbols over which this\n threshold event is defined. This is defined as\n \n cdot3OamErrSymPeriodWindow = ((2^32)*cdot3OamErrSymPeriodWindowHi)\n + cdot3OamErrSymPeriodWindowLo\n \n If cdot3OamErrSymPeriodThreshold symbol errors occur within a\n window of cdot3OamErrSymPeriodWindow symbols, an Event\n Notification OAMPDU should be generated with an Errored Symbol\n Period Event TLV indicating the threshold has been crossed in\n this window. \n \n The default value for cdot3OamErrSymPeriodWindow is the number\n of symbols in one second for the underlying physical layer.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrSymPeriodWindowLo": { "type": "integer", "description": "The two objects cdot3OamErrSymPeriodWindowHi and\n cdot3OamErrSymPeriodWindowLo together form an unsigned 64-bit\n integer representing the number of symbols over which this\n threshold event is defined. This is defined as\n \n cdot3OamErrSymPeriodWindow = ((2^32)*cdot3OamErrSymPeriodWindowHi)\n + cdot3OamErrSymPeriodWindowLo\n \n If cdot3OamErrSymPeriodThreshold symbol errors occur within a\n window of cdot3OamErrSymPeriodWindow symbols, an Event\n Notification OAMPDU should be generated with an Errored Symbol\n Period Event TLV indicating the threshold has been crossed in\n this window. \n \n The default value for cdot3OamErrSymPeriodWindow is the number\n of symbols in one second for the underlying physical layer.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrSymPeriodThresholdHi": { "type": "integer", "description": "The two objects cdot3OamErrSymPeriodThresholdHi and\n cdot3OamErrSymPeriodThresholdLo together form an unsigned\n 64-bit integer representing the number of symbol errors that\n must occur within a given window to cause this event. \n \n This is defined as\n \n cdot3OamErrSymPeriodThreshold =\n ((2^32) * cdot3OamErrSymPeriodThresholdHi)\n + cdot3OamErrSymPeriodThresholdLo\n \n If cdot3OamErrSymPeriodThreshold symbol errors occur within a\n window of cdot3OamErrSymPeriodWindow symbols, an Event\n Notification OAMPDU should be generated with an Errored Symbol\n Period Event TLV indicating the threshold has been crossed in\n this window. \n \n The default value for cdot3OamErrSymPeriodThreshold is one\n symbol errors. If the threshold value is zero, then an Event\n Notification OAMPDU is sent periodically (at the end of every\n window). This can be used as an asynchronous notification to\n the peer OAM entity of the statistics related to this\n threshold crossing alarm.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrSymPeriodThresholdLo": { "type": "integer", "description": "The two objects cdot3OamErrSymPeriodThresholdHi and\n cdot3OamErrSymPeriodThresholdLo together form an unsigned\n 64-bit integer representing the number of symbol errors that\n must occur within a given window to cause this event. \n \n This is defined as\n \n cdot3OamErrSymPeriodThreshold =\n ((2^32) * cdot3OamErrSymPeriodThresholdHi)\n + cdot3OamErrSymPeriodThresholdLo\n \n If cdot3OamErrSymPeriodThreshold symbol errors occur within a\n window of cdot3OamErrSymPeriodWindow symbols, an Event\n Notification OAMPDU should be generated with an Errored Symbol\n Period Event TLV indicating the threshold has been crossed in\n this window. \n \n The default value for cdot3OamErrSymPeriodThreshold is one\n symbol error. If the threshold value is zero, then an Event\n Notification OAMPDU is sent periodically (at the end of every\n window). This can be used as an asynchronous notification to\n the peer OAM entity of the statistics related to this\n threshold crossing alarm.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrSymPeriodEvNotifEnable": { "type": "boolean", "description": "If true, the OAM entity should send an Event Notification\n OAMPDU when an Errored Symbol Period Event occurs. \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored." }, "cdot3OamErrFramePeriodWindow": { "type": "integer", "description": "The number of frames over which the threshold is defined.\n The default value of the window is the number of minimum size\n Ethernet frames that can be received over the physical layer\n in one second. \n \n If cdot3OamErrFramePeriodThreshold frame errors occur within a\n window of cdot3OamErrFramePeriodWindow frames, an Event\n Notification OAMPDU should be generated with an Errored Frame\n Period Event TLV indicating the threshold has been crossed in\n this window.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrFramePeriodThreshold": { "type": "integer", "description": "The number of frame errors that must occur for this event to\n be triggered. The default value is one frame error. If the\n threshold value is zero, then an Event Notification OAMPDU is\n sent periodically (at the end of every window). This can be\n used as an asynchronous notification to the peer OAM entity of\n the statistics related to this threshold crossing alarm.\n \n If cdot3OamErrFramePeriodThreshold frame errors occur within a\n window of cdot3OamErrFramePeriodWindow frames, an Event\n Notification OAMPDU should be generated with an Errored Frame\n Period Event TLV indicating the threshold has been crossed in\n this window.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrFramePeriodEvNotifEnable": { "type": "boolean", "description": "If true, the OAM entity should send an Event Notification\n OAMPDU when an Errored Frame Period Event occurs. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored." }, "cdot3OamErrFrameWindow": { "type": "integer", "description": "The amount of time (in 100ms increments) over which the\n threshold is defined. The default value is 10 (1 second). \n \n If cdot3OamErrFrameThreshold frame errors occur within a window\n of cdot3OamErrFrameWindow seconds (measured in tenths of\n seconds), an Event Notification OAMPDU should be generated\n with an Errored Frame Event TLV indicating the threshold has\n been crossed in this window.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrFrameThreshold": { "type": "integer", "description": "The number of frame errors that must occur for this event to\n be triggered. The default value is one frame error. If the\n threshold value is zero, then an Event Notification OAMPDU is\n sent periodically (at the end of every window). This can be\n used as an asynchronous notification to the peer OAM entity of\n the statistics related to this threshold crossing alarm. \n \n If cdot3OamErrFrameThreshold frame errors occur within a window\n of cdot3OamErrFrameWindow (in tenths of seconds), an Event\n Notification OAMPDU should be generated with an Errored Frame\n Event TLV indicating the threshold has been crossed in this\n window.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrFrameEvNotifEnable": { "type": "boolean", "description": "If true, the OAM entity should send an Event Notification\n OAMPDU when an Errored Frame Event occurs. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored." }, "cdot3OamErrFrameSecsSummaryWindow": { "type": "integer", "description": "The amount of time (in 100ms intervals) over which the\n threshold is defined. The default value is 100 (10 seconds). \n \n If cdot3OamErrFrameSecsSummaryThreshold frame errors occur\n within a window of cdot3OamErrFrameSecsSummaryWindow (in tenths\n of seconds), an Event Notification OAMPDU should be generated\n with an Errored Frame Seconds Summary Event TLV indicating the\n threshold has been crossed in this window.", "minimum": -2147483648, "maximum": 2147483647 }, "cdot3OamErrFrameSecsSummaryThreshold": { "type": "integer", "description": "The number of errored frame seconds that must occur for this\n event to be triggered. The default value is one errored frame\n second. If the threshold value is zero, then an Event\n Notification OAMPDU is sent periodically (at the end of every\n window). This can be used as an asynchronous notification to\n the peer OAM entity of the statistics related to this\n threshold crossing alarm. \n \n If cdot3OamErrFrameSecsSummaryThreshold frame errors occur\n within a window of cdot3OamErrFrameSecsSummaryWindow (in tenths\n of seconds), an Event Notification OAMPDU should be generated\n with an Errored Frame Seconds Summary Event TLV indicating the\n threshold has been crossed in this window.", "minimum": -2147483648, "maximum": 2147483647 }, "cdot3OamErrFrameSecsEvNotifEnable": { "type": "boolean", "description": "If true, the local OAM entity should send an Event\n Notification OAMPDU when an Errored Frame Seconds Event\n occurs. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored." }, "cdot3OamDyingGaspEnable": { "type": "boolean", "description": "If true, the local OAM entity should attempt to indicate a\n dying gasp via the OAMPDU flags field to its peer OAM entity\n when a dying gasp event occurs. The exact definition of a\n dying gasp event is implementation dependent. If the system\n does not support dying gasp capability, setting this object\n has no effect, and reading the object should always result in\n 'false'. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored." }, "cdot3OamCriticalEventEnable": { "type": "boolean", "description": "If true, the local OAM entity should attempt to indicate a\n critical event via the OAMPDU flags to its peer OAM entity\n when a critical event occurs. The exact definition of a\n critical event is implementation dependent. If the system\n does not support critical event capability, setting this\n object has no effect, and reading the object should always\n result in 'false'. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored." } } } }, "example": { "CISCO-DOT3-OAM-MIB:cdot3OamEventConfigEntry": [ { "ifIndex": "example-string", "cdot3OamErrSymPeriodWindowHi": 0, "cdot3OamErrSymPeriodWindowLo": 0, "cdot3OamErrSymPeriodThresholdHi": 0, "cdot3OamErrSymPeriodThresholdLo": 0, "cdot3OamErrSymPeriodEvNotifEnable": true, "cdot3OamErrFramePeriodWindow": 0, "cdot3OamErrFramePeriodThreshold": 0, "cdot3OamErrFramePeriodEvNotifEnable": true, "cdot3OamErrFrameWindow": 0, "cdot3OamErrFrameThreshold": 0, "cdot3OamErrFrameEvNotifEnable": true, "cdot3OamErrFrameSecsSummaryWindow": -2147483648, "cdot3OamErrFrameSecsSummaryThreshold": -2147483648, "cdot3OamErrFrameSecsEvNotifEnable": true, "cdot3OamDyingGaspEnable": true, "cdot3OamCriticalEventEnable": true } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdot3OamEventConfigEntry-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": "/cdot3OamEventConfigEntry", "x-restconf-kind": "container" }, "/data/CISCO-DOT3-OAM-MIB:cdot3OamEventConfigEntry={ifIndex}": { "get": { "summary": "Get cdot3OamEventConfigEntry entry", "description": "Retrieve specific cdot3OamEventConfigEntry entry by key from MIB", "tags": [ "CISCO-DOT3-OAM-MIB" ], "parameters": [ { "name": "ifIndex", "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": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cdot3OamErrSymPeriodWindowHi": { "type": "integer", "description": "The two objects cdot3OamErrSymPeriodWindowHi and\n cdot3OamErrSymPeriodLo together form an unsigned 64-bit\n integer representing the number of symbols over which this\n threshold event is defined. This is defined as\n \n cdot3OamErrSymPeriodWindow = ((2^32)*cdot3OamErrSymPeriodWindowHi)\n + cdot3OamErrSymPeriodWindowLo\n \n If cdot3OamErrSymPeriodThreshold symbol errors occur within a\n window of cdot3OamErrSymPeriodWindow symbols, an Event\n Notification OAMPDU should be generated with an Errored Symbol\n Period Event TLV indicating the threshold has been crossed in\n this window. \n \n The default value for cdot3OamErrSymPeriodWindow is the number\n of symbols in one second for the underlying physical layer.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrSymPeriodWindowLo": { "type": "integer", "description": "The two objects cdot3OamErrSymPeriodWindowHi and\n cdot3OamErrSymPeriodWindowLo together form an unsigned 64-bit\n integer representing the number of symbols over which this\n threshold event is defined. This is defined as\n \n cdot3OamErrSymPeriodWindow = ((2^32)*cdot3OamErrSymPeriodWindowHi)\n + cdot3OamErrSymPeriodWindowLo\n \n If cdot3OamErrSymPeriodThreshold symbol errors occur within a\n window of cdot3OamErrSymPeriodWindow symbols, an Event\n Notification OAMPDU should be generated with an Errored Symbol\n Period Event TLV indicating the threshold has been crossed in\n this window. \n \n The default value for cdot3OamErrSymPeriodWindow is the number\n of symbols in one second for the underlying physical layer.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrSymPeriodThresholdHi": { "type": "integer", "description": "The two objects cdot3OamErrSymPeriodThresholdHi and\n cdot3OamErrSymPeriodThresholdLo together form an unsigned\n 64-bit integer representing the number of symbol errors that\n must occur within a given window to cause this event. \n \n This is defined as\n \n cdot3OamErrSymPeriodThreshold =\n ((2^32) * cdot3OamErrSymPeriodThresholdHi)\n + cdot3OamErrSymPeriodThresholdLo\n \n If cdot3OamErrSymPeriodThreshold symbol errors occur within a\n window of cdot3OamErrSymPeriodWindow symbols, an Event\n Notification OAMPDU should be generated with an Errored Symbol\n Period Event TLV indicating the threshold has been crossed in\n this window. \n \n The default value for cdot3OamErrSymPeriodThreshold is one\n symbol errors. If the threshold value is zero, then an Event\n Notification OAMPDU is sent periodically (at the end of every\n window). This can be used as an asynchronous notification to\n the peer OAM entity of the statistics related to this\n threshold crossing alarm.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrSymPeriodThresholdLo": { "type": "integer", "description": "The two objects cdot3OamErrSymPeriodThresholdHi and\n cdot3OamErrSymPeriodThresholdLo together form an unsigned\n 64-bit integer representing the number of symbol errors that\n must occur within a given window to cause this event. \n \n This is defined as\n \n cdot3OamErrSymPeriodThreshold =\n ((2^32) * cdot3OamErrSymPeriodThresholdHi)\n + cdot3OamErrSymPeriodThresholdLo\n \n If cdot3OamErrSymPeriodThreshold symbol errors occur within a\n window of cdot3OamErrSymPeriodWindow symbols, an Event\n Notification OAMPDU should be generated with an Errored Symbol\n Period Event TLV indicating the threshold has been crossed in\n this window. \n \n The default value for cdot3OamErrSymPeriodThreshold is one\n symbol error. If the threshold value is zero, then an Event\n Notification OAMPDU is sent periodically (at the end of every\n window). This can be used as an asynchronous notification to\n the peer OAM entity of the statistics related to this\n threshold crossing alarm.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrSymPeriodEvNotifEnable": { "type": "boolean", "description": "If true, the OAM entity should send an Event Notification\n OAMPDU when an Errored Symbol Period Event occurs. \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored." }, "cdot3OamErrFramePeriodWindow": { "type": "integer", "description": "The number of frames over which the threshold is defined.\n The default value of the window is the number of minimum size\n Ethernet frames that can be received over the physical layer\n in one second. \n \n If cdot3OamErrFramePeriodThreshold frame errors occur within a\n window of cdot3OamErrFramePeriodWindow frames, an Event\n Notification OAMPDU should be generated with an Errored Frame\n Period Event TLV indicating the threshold has been crossed in\n this window.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrFramePeriodThreshold": { "type": "integer", "description": "The number of frame errors that must occur for this event to\n be triggered. The default value is one frame error. If the\n threshold value is zero, then an Event Notification OAMPDU is\n sent periodically (at the end of every window). This can be\n used as an asynchronous notification to the peer OAM entity of\n the statistics related to this threshold crossing alarm.\n \n If cdot3OamErrFramePeriodThreshold frame errors occur within a\n window of cdot3OamErrFramePeriodWindow frames, an Event\n Notification OAMPDU should be generated with an Errored Frame\n Period Event TLV indicating the threshold has been crossed in\n this window.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrFramePeriodEvNotifEnable": { "type": "boolean", "description": "If true, the OAM entity should send an Event Notification\n OAMPDU when an Errored Frame Period Event occurs. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored." }, "cdot3OamErrFrameWindow": { "type": "integer", "description": "The amount of time (in 100ms increments) over which the\n threshold is defined. The default value is 10 (1 second). \n \n If cdot3OamErrFrameThreshold frame errors occur within a window\n of cdot3OamErrFrameWindow seconds (measured in tenths of\n seconds), an Event Notification OAMPDU should be generated\n with an Errored Frame Event TLV indicating the threshold has\n been crossed in this window.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrFrameThreshold": { "type": "integer", "description": "The number of frame errors that must occur for this event to\n be triggered. The default value is one frame error. If the\n threshold value is zero, then an Event Notification OAMPDU is\n sent periodically (at the end of every window). This can be\n used as an asynchronous notification to the peer OAM entity of\n the statistics related to this threshold crossing alarm. \n \n If cdot3OamErrFrameThreshold frame errors occur within a window\n of cdot3OamErrFrameWindow (in tenths of seconds), an Event\n Notification OAMPDU should be generated with an Errored Frame\n Event TLV indicating the threshold has been crossed in this\n window.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamErrFrameEvNotifEnable": { "type": "boolean", "description": "If true, the OAM entity should send an Event Notification\n OAMPDU when an Errored Frame Event occurs. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored." }, "cdot3OamErrFrameSecsSummaryWindow": { "type": "integer", "description": "The amount of time (in 100ms intervals) over which the\n threshold is defined. The default value is 100 (10 seconds). \n \n If cdot3OamErrFrameSecsSummaryThreshold frame errors occur\n within a window of cdot3OamErrFrameSecsSummaryWindow (in tenths\n of seconds), an Event Notification OAMPDU should be generated\n with an Errored Frame Seconds Summary Event TLV indicating the\n threshold has been crossed in this window.", "minimum": -2147483648, "maximum": 2147483647 }, "cdot3OamErrFrameSecsSummaryThreshold": { "type": "integer", "description": "The number of errored frame seconds that must occur for this\n event to be triggered. The default value is one errored frame\n second. If the threshold value is zero, then an Event\n Notification OAMPDU is sent periodically (at the end of every\n window). This can be used as an asynchronous notification to\n the peer OAM entity of the statistics related to this\n threshold crossing alarm. \n \n If cdot3OamErrFrameSecsSummaryThreshold frame errors occur\n within a window of cdot3OamErrFrameSecsSummaryWindow (in tenths\n of seconds), an Event Notification OAMPDU should be generated\n with an Errored Frame Seconds Summary Event TLV indicating the\n threshold has been crossed in this window.", "minimum": -2147483648, "maximum": 2147483647 }, "cdot3OamErrFrameSecsEvNotifEnable": { "type": "boolean", "description": "If true, the local OAM entity should send an Event\n Notification OAMPDU when an Errored Frame Seconds Event\n occurs. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored." }, "cdot3OamDyingGaspEnable": { "type": "boolean", "description": "If true, the local OAM entity should attempt to indicate a\n dying gasp via the OAMPDU flags field to its peer OAM entity\n when a dying gasp event occurs. The exact definition of a\n dying gasp event is implementation dependent. If the system\n does not support dying gasp capability, setting this object\n has no effect, and reading the object should always result in\n 'false'. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored." }, "cdot3OamCriticalEventEnable": { "type": "boolean", "description": "If true, the local OAM entity should attempt to indicate a\n critical event via the OAMPDU flags to its peer OAM entity\n when a critical event occurs. The exact definition of a\n critical event is implementation dependent. If the system\n does not support critical event capability, setting this\n object has no effect, and reading the object should always\n result in 'false'. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored." } } }, "example": { "CISCO-DOT3-OAM-MIB:cdot3OamEventConfigEntry": { "ifIndex": "example-string", "cdot3OamErrSymPeriodWindowHi": 0, "cdot3OamErrSymPeriodWindowLo": 0, "cdot3OamErrSymPeriodThresholdHi": 0, "cdot3OamErrSymPeriodThresholdLo": 0, "cdot3OamErrSymPeriodEvNotifEnable": true, "cdot3OamErrFramePeriodWindow": 0, "cdot3OamErrFramePeriodThreshold": 0, "cdot3OamErrFramePeriodEvNotifEnable": true, "cdot3OamErrFrameWindow": 0, "cdot3OamErrFrameThreshold": 0, "cdot3OamErrFrameEvNotifEnable": true, "cdot3OamErrFrameSecsSummaryWindow": -2147483648, "cdot3OamErrFrameSecsSummaryThreshold": -2147483648, "cdot3OamErrFrameSecsEvNotifEnable": true, "cdot3OamDyingGaspEnable": true, "cdot3OamCriticalEventEnable": true } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdot3OamEventConfigEntry-4" }, "x-yang-path": "/cdot3OamEventConfigEntry={ifIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex" ] }, "/data/CISCO-DOT3-OAM-MIB:cdot3OamEventLogEntry": { "get": { "summary": "Get cdot3OamEventLogEntry list", "description": "Retrieve list of cdot3OamEventLogEntry entries from MIB", "tags": [ "CISCO-DOT3-OAM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cdot3OamEventLogEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cdot3OamEventLogIndex": { "type": "integer", "description": "An arbitrary integer for identifying individual events\n within the event log.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamEventLogTimestamp": { "type": "string", "description": "The value of sysUpTime at the time of the logged event. For\n locally generated events, the time of the event can be\n accurately retrieved from sysUpTime. For remotely generated\n events, the time of the event is indicated by the reception of\n the Event Notification OAMPDU indicating the event occurred on\n the peer. A system may attempt to adjust the timestamp value\n to more accurately reflect the time of the event at the peer\n OAM entity by using other information, such as that found in\n the timestamp found of the Event Notification TLVs, which\n provides an indication of the relative time between events at\n the peer entity.", "x-yang-type": "yang:timestamp" }, "cdot3OamEventLogOui": { "type": "string", "description": "The OUI of the entity defining the object type. All IEEE\n 802.3 defined events (as appearing in [802.3ah] except for the\n Organizationally Unique Event TLVs) use the IEEE 802.3 OUI of\n 0x0180C2. Organizations defining their own Event Notification\n TLVs include their OUI in the Event Notification TLV which\n gets reflected here.", "x-yang-type": "CISCO-DOT3-OAM-MIB:Cdot3Oui" }, "cdot3OamEventLogType": { "type": "integer", "description": "The type of event that generated this entry in the event log.\n \n When the OUI is the IEEE 802.3 OUI of 0x0180C2, the following\n event types are defined:\n erroredSymbolEvent(1), \n erroredFramePeriodEvent (2), \n erroredFrameEvent(3),\n erroredFrameSecondsEvent(4), \n linkFault(256), \n dyingGaspEvent(257),\n criticalLinkEvent(258)\n The first four are considered threshold crossing events as\n they are generated when a metric exceeds a given value within\n a specified window. The other three are not threshold\n crossing events. \n \n When the OUI is not 71874 (0x0180C2 in hex), then some other\n organization has defined the event space. If event subtyping\n is known to the implementation, it may be reflected here.\n Otherwise, this value should return all Fs (2^32 - 1).", "minimum": 0, "maximum": 4294967295 }, "cdot3OamEventLogLocation": { "type": "string", "description": "Whether this event occurred locally (local(1)), or was \n received from the OAM peer via Ethernet OAM (remote(2))." }, "cdot3OamEventLogWindowHi": { "type": "integer", "description": "If the event represents a threshold crossing event, the two\n objects cdot3OamEventWindowHi and cdot3OamEventWindowLo form an\n unsigned 64-bit integer yielding the window over which the\n value was measured for the threshold crossing event (for\n example, 5, when 11 occurrences happened in 5 seconds while\n the threshold was 10). The two objects are combined as:\n \n cdot3OamEventLogWindow = ((2^32) * cdot3OamEventLogWindowHi)\n + cdot3OamEventLogWindowLo\n \n \n Otherwise, this value is returned as all F's (2^32 - 1) and \n adds no useful information.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamEventLogWindowLo": { "type": "integer", "description": "If the event represents a threshold crossing event, the two\n objects cdot3OamEventWindowHi and cdot3OamEventWindowLo form an\n unsigned 64-bit integer yielding the window over which the\n value was measured for the threshold crossing event (for\n example, 5, when 11 occurrences happened in 5 seconds while\n the threshold was 10). The two objects are combined as:\n \n cdot3OamEventLogWindow = ((2^32) * cdot3OamEventLogWindowHi)\n + cdot3OamEventLogWindowLo\n \n Otherwise, this value is returned as all F's (2^32 - 1) and \n adds no useful information.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamEventLogThresholdHi": { "type": "integer", "description": "If the event represents a threshold crossing event, the two\n objects cdot3OamEventThresholdHi and cdot3OamEventThresholdLo\n form an unsigned 64-bit integer yielding the value that was\n crossed for the threshold crossing event (for example, 10,\n when 11 occurrences happened in 5 seconds while the threshold\n was 10). The two objects are combined as:\n \n cdot3OamEventLogThreshold = ((2^32) * cdot3OamEventLogThresholdHi)\n + cdot3OamEventLogThresholdLo\n \n Otherwise, this value is returned as all F's (2^32 -1) and \n adds no useful information.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamEventLogThresholdLo": { "type": "integer", "description": "If the event represents a threshold crossing event, the two\n objects cdot3OamEventThresholdHi and cdot3OamEventThresholdLo\n form an unsigned 64-bit integer yielding the value that was\n crossed for the threshold crossing event (for example, 10,\n when 11 occurrences happened in 5 seconds while the threshold\n was 10). The two objects are combined as:\n \n cdot3OamEventLogThreshold = ((2^32) * cdot3OamEventLogThresholdHi)\n + cdot3OamEventLogThresholdLo\n \n Otherwise, this value is returned as all F's (2^32 - 1) and\n adds no useful information.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamEventLogValue": { "type": "integer", "description": "If the event represents a threshold crossing event, this\n value indicates the value of the parameter within the given\n window that generated this event (for example, 11, when 11\n occurrences happened in 5 seconds while the threshold was 10). \n \n Otherwise, this value is returned as all F's \n (2^64 - 1) and adds no useful information.", "minimum": 0 }, "cdot3OamEventLogRunningTotal": { "type": "integer", "description": "Each Event Notification TLV contains a running total of the\n number of times an event has occurred, as well as the number\n of times an Event Notification for the event has been\n transmitted. For non-threshold crossing events, the number of\n events (cdot3OamLogRunningTotal) and the number of resultant\n Event Notifications (cdot3OamLogEventTotal) should be\n identical. \n \n For threshold crossing events, since multiple occurrences may\n be required to cross the threshold, these values are likely\n different. This value represents the total number of times\n this event has happened since the last reset (for example,\n 3253, when 3253 symbol errors have occurred since the last\n reset, which has resulted in 51 symbol error threshold\n crossing events since the last reset).", "minimum": 0 }, "cdot3OamEventLogEventTotal": { "type": "integer", "description": "Each Event Notification TLV contains a running total of the\n number of times an event has occurred, as well as the number\n of times an Event Notification for the event has been\n transmitted. For non-threshold crossing events, the number of\n events (cdot3OamLogRunningTotal) and the number of resultant\n Event Notifications (cdot3OamLogEventTotal) should be\n identical. \n \n For threshold crossing events, since multiple occurrences may\n be required to cross the threshold, these values are likely\n different. This value represents the total number of times\n one or more of these occurrences have resulted in an Event\n Notification (for example, 51 when 3253 symbol errors have\n occurred since the last reset, which has resulted in 51 symbol\n error threshold crossing events since the last reset).", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-DOT3-OAM-MIB:cdot3OamEventLogEntry": [ { "ifIndex": "example-string", "cdot3OamEventLogIndex": 1, "cdot3OamEventLogTimestamp": "example-string", "cdot3OamEventLogOui": "example-string", "cdot3OamEventLogType": 0, "cdot3OamEventLogLocation": "example-string", "cdot3OamEventLogWindowHi": 0, "cdot3OamEventLogWindowLo": 0, "cdot3OamEventLogThresholdHi": 0, "cdot3OamEventLogThresholdLo": 0, "cdot3OamEventLogValue": 0, "cdot3OamEventLogRunningTotal": 0, "cdot3OamEventLogEventTotal": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdot3OamEventLogEntry-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": "/cdot3OamEventLogEntry", "x-restconf-kind": "container" }, "/data/CISCO-DOT3-OAM-MIB:cdot3OamEventLogTable/cdot3OamEventLogEntry={ifIndex},{cdot3OamEventLogIndex}": { "get": { "summary": "Get cdot3OamEventLogEntry entry", "description": "Retrieve specific cdot3OamEventLogEntry entry by key from MIB", "tags": [ "CISCO-DOT3-OAM-MIB" ], "parameters": [ { "name": "ifIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cdot3OamEventLogIndex", "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": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cdot3OamEventLogIndex": { "type": "integer", "description": "An arbitrary integer for identifying individual events\n within the event log.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamEventLogTimestamp": { "type": "string", "description": "The value of sysUpTime at the time of the logged event. For\n locally generated events, the time of the event can be\n accurately retrieved from sysUpTime. For remotely generated\n events, the time of the event is indicated by the reception of\n the Event Notification OAMPDU indicating the event occurred on\n the peer. A system may attempt to adjust the timestamp value\n to more accurately reflect the time of the event at the peer\n OAM entity by using other information, such as that found in\n the timestamp found of the Event Notification TLVs, which\n provides an indication of the relative time between events at\n the peer entity.", "x-yang-type": "yang:timestamp" }, "cdot3OamEventLogOui": { "type": "string", "description": "The OUI of the entity defining the object type. All IEEE\n 802.3 defined events (as appearing in [802.3ah] except for the\n Organizationally Unique Event TLVs) use the IEEE 802.3 OUI of\n 0x0180C2. Organizations defining their own Event Notification\n TLVs include their OUI in the Event Notification TLV which\n gets reflected here.", "x-yang-type": "CISCO-DOT3-OAM-MIB:Cdot3Oui" }, "cdot3OamEventLogType": { "type": "integer", "description": "The type of event that generated this entry in the event log.\n \n When the OUI is the IEEE 802.3 OUI of 0x0180C2, the following\n event types are defined:\n erroredSymbolEvent(1), \n erroredFramePeriodEvent (2), \n erroredFrameEvent(3),\n erroredFrameSecondsEvent(4), \n linkFault(256), \n dyingGaspEvent(257),\n criticalLinkEvent(258)\n The first four are considered threshold crossing events as\n they are generated when a metric exceeds a given value within\n a specified window. The other three are not threshold\n crossing events. \n \n When the OUI is not 71874 (0x0180C2 in hex), then some other\n organization has defined the event space. If event subtyping\n is known to the implementation, it may be reflected here.\n Otherwise, this value should return all Fs (2^32 - 1).", "minimum": 0, "maximum": 4294967295 }, "cdot3OamEventLogLocation": { "type": "string", "description": "Whether this event occurred locally (local(1)), or was \n received from the OAM peer via Ethernet OAM (remote(2))." }, "cdot3OamEventLogWindowHi": { "type": "integer", "description": "If the event represents a threshold crossing event, the two\n objects cdot3OamEventWindowHi and cdot3OamEventWindowLo form an\n unsigned 64-bit integer yielding the window over which the\n value was measured for the threshold crossing event (for\n example, 5, when 11 occurrences happened in 5 seconds while\n the threshold was 10). The two objects are combined as:\n \n cdot3OamEventLogWindow = ((2^32) * cdot3OamEventLogWindowHi)\n + cdot3OamEventLogWindowLo\n \n \n Otherwise, this value is returned as all F's (2^32 - 1) and \n adds no useful information.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamEventLogWindowLo": { "type": "integer", "description": "If the event represents a threshold crossing event, the two\n objects cdot3OamEventWindowHi and cdot3OamEventWindowLo form an\n unsigned 64-bit integer yielding the window over which the\n value was measured for the threshold crossing event (for\n example, 5, when 11 occurrences happened in 5 seconds while\n the threshold was 10). The two objects are combined as:\n \n cdot3OamEventLogWindow = ((2^32) * cdot3OamEventLogWindowHi)\n + cdot3OamEventLogWindowLo\n \n Otherwise, this value is returned as all F's (2^32 - 1) and \n adds no useful information.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamEventLogThresholdHi": { "type": "integer", "description": "If the event represents a threshold crossing event, the two\n objects cdot3OamEventThresholdHi and cdot3OamEventThresholdLo\n form an unsigned 64-bit integer yielding the value that was\n crossed for the threshold crossing event (for example, 10,\n when 11 occurrences happened in 5 seconds while the threshold\n was 10). The two objects are combined as:\n \n cdot3OamEventLogThreshold = ((2^32) * cdot3OamEventLogThresholdHi)\n + cdot3OamEventLogThresholdLo\n \n Otherwise, this value is returned as all F's (2^32 -1) and \n adds no useful information.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamEventLogThresholdLo": { "type": "integer", "description": "If the event represents a threshold crossing event, the two\n objects cdot3OamEventThresholdHi and cdot3OamEventThresholdLo\n form an unsigned 64-bit integer yielding the value that was\n crossed for the threshold crossing event (for example, 10,\n when 11 occurrences happened in 5 seconds while the threshold\n was 10). The two objects are combined as:\n \n cdot3OamEventLogThreshold = ((2^32) * cdot3OamEventLogThresholdHi)\n + cdot3OamEventLogThresholdLo\n \n Otherwise, this value is returned as all F's (2^32 - 1) and\n adds no useful information.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamEventLogValue": { "type": "integer", "description": "If the event represents a threshold crossing event, this\n value indicates the value of the parameter within the given\n window that generated this event (for example, 11, when 11\n occurrences happened in 5 seconds while the threshold was 10). \n \n Otherwise, this value is returned as all F's \n (2^64 - 1) and adds no useful information.", "minimum": 0 }, "cdot3OamEventLogRunningTotal": { "type": "integer", "description": "Each Event Notification TLV contains a running total of the\n number of times an event has occurred, as well as the number\n of times an Event Notification for the event has been\n transmitted. For non-threshold crossing events, the number of\n events (cdot3OamLogRunningTotal) and the number of resultant\n Event Notifications (cdot3OamLogEventTotal) should be\n identical. \n \n For threshold crossing events, since multiple occurrences may\n be required to cross the threshold, these values are likely\n different. This value represents the total number of times\n this event has happened since the last reset (for example,\n 3253, when 3253 symbol errors have occurred since the last\n reset, which has resulted in 51 symbol error threshold\n crossing events since the last reset).", "minimum": 0 }, "cdot3OamEventLogEventTotal": { "type": "integer", "description": "Each Event Notification TLV contains a running total of the\n number of times an event has occurred, as well as the number\n of times an Event Notification for the event has been\n transmitted. For non-threshold crossing events, the number of\n events (cdot3OamLogRunningTotal) and the number of resultant\n Event Notifications (cdot3OamLogEventTotal) should be\n identical. \n \n For threshold crossing events, since multiple occurrences may\n be required to cross the threshold, these values are likely\n different. This value represents the total number of times\n one or more of these occurrences have resulted in an Event\n Notification (for example, 51 when 3253 symbol errors have\n occurred since the last reset, which has resulted in 51 symbol\n error threshold crossing events since the last reset).", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-DOT3-OAM-MIB:cdot3OamEventLogEntry": { "ifIndex": "example-string", "cdot3OamEventLogIndex": 1, "cdot3OamEventLogTimestamp": "example-string", "cdot3OamEventLogOui": "example-string", "cdot3OamEventLogType": 0, "cdot3OamEventLogLocation": "example-string", "cdot3OamEventLogWindowHi": 0, "cdot3OamEventLogWindowLo": 0, "cdot3OamEventLogThresholdHi": 0, "cdot3OamEventLogThresholdLo": 0, "cdot3OamEventLogValue": 0, "cdot3OamEventLogRunningTotal": 0, "cdot3OamEventLogEventTotal": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdot3OamEventLogEntry-2" }, "x-yang-path": "/cdot3OamEventLogTable/cdot3OamEventLogEntry={ifIndex cdot3OamEventLogIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex cdot3OamEventLogIndex" ] }, "/data/CISCO-DOT3-OAM-MIB:cdot3OamEventLogEntry={ifIndex},{cdot3OamEventLogIndex}": { "get": { "summary": "Get cdot3OamEventLogEntry entry", "description": "Retrieve specific cdot3OamEventLogEntry entry by key from MIB", "tags": [ "CISCO-DOT3-OAM-MIB" ], "parameters": [ { "name": "ifIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cdot3OamEventLogIndex", "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": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cdot3OamEventLogIndex": { "type": "integer", "description": "An arbitrary integer for identifying individual events\n within the event log.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamEventLogTimestamp": { "type": "string", "description": "The value of sysUpTime at the time of the logged event. For\n locally generated events, the time of the event can be\n accurately retrieved from sysUpTime. For remotely generated\n events, the time of the event is indicated by the reception of\n the Event Notification OAMPDU indicating the event occurred on\n the peer. A system may attempt to adjust the timestamp value\n to more accurately reflect the time of the event at the peer\n OAM entity by using other information, such as that found in\n the timestamp found of the Event Notification TLVs, which\n provides an indication of the relative time between events at\n the peer entity.", "x-yang-type": "yang:timestamp" }, "cdot3OamEventLogOui": { "type": "string", "description": "The OUI of the entity defining the object type. All IEEE\n 802.3 defined events (as appearing in [802.3ah] except for the\n Organizationally Unique Event TLVs) use the IEEE 802.3 OUI of\n 0x0180C2. Organizations defining their own Event Notification\n TLVs include their OUI in the Event Notification TLV which\n gets reflected here.", "x-yang-type": "CISCO-DOT3-OAM-MIB:Cdot3Oui" }, "cdot3OamEventLogType": { "type": "integer", "description": "The type of event that generated this entry in the event log.\n \n When the OUI is the IEEE 802.3 OUI of 0x0180C2, the following\n event types are defined:\n erroredSymbolEvent(1), \n erroredFramePeriodEvent (2), \n erroredFrameEvent(3),\n erroredFrameSecondsEvent(4), \n linkFault(256), \n dyingGaspEvent(257),\n criticalLinkEvent(258)\n The first four are considered threshold crossing events as\n they are generated when a metric exceeds a given value within\n a specified window. The other three are not threshold\n crossing events. \n \n When the OUI is not 71874 (0x0180C2 in hex), then some other\n organization has defined the event space. If event subtyping\n is known to the implementation, it may be reflected here.\n Otherwise, this value should return all Fs (2^32 - 1).", "minimum": 0, "maximum": 4294967295 }, "cdot3OamEventLogLocation": { "type": "string", "description": "Whether this event occurred locally (local(1)), or was \n received from the OAM peer via Ethernet OAM (remote(2))." }, "cdot3OamEventLogWindowHi": { "type": "integer", "description": "If the event represents a threshold crossing event, the two\n objects cdot3OamEventWindowHi and cdot3OamEventWindowLo form an\n unsigned 64-bit integer yielding the window over which the\n value was measured for the threshold crossing event (for\n example, 5, when 11 occurrences happened in 5 seconds while\n the threshold was 10). The two objects are combined as:\n \n cdot3OamEventLogWindow = ((2^32) * cdot3OamEventLogWindowHi)\n + cdot3OamEventLogWindowLo\n \n \n Otherwise, this value is returned as all F's (2^32 - 1) and \n adds no useful information.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamEventLogWindowLo": { "type": "integer", "description": "If the event represents a threshold crossing event, the two\n objects cdot3OamEventWindowHi and cdot3OamEventWindowLo form an\n unsigned 64-bit integer yielding the window over which the\n value was measured for the threshold crossing event (for\n example, 5, when 11 occurrences happened in 5 seconds while\n the threshold was 10). The two objects are combined as:\n \n cdot3OamEventLogWindow = ((2^32) * cdot3OamEventLogWindowHi)\n + cdot3OamEventLogWindowLo\n \n Otherwise, this value is returned as all F's (2^32 - 1) and \n adds no useful information.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamEventLogThresholdHi": { "type": "integer", "description": "If the event represents a threshold crossing event, the two\n objects cdot3OamEventThresholdHi and cdot3OamEventThresholdLo\n form an unsigned 64-bit integer yielding the value that was\n crossed for the threshold crossing event (for example, 10,\n when 11 occurrences happened in 5 seconds while the threshold\n was 10). The two objects are combined as:\n \n cdot3OamEventLogThreshold = ((2^32) * cdot3OamEventLogThresholdHi)\n + cdot3OamEventLogThresholdLo\n \n Otherwise, this value is returned as all F's (2^32 -1) and \n adds no useful information.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamEventLogThresholdLo": { "type": "integer", "description": "If the event represents a threshold crossing event, the two\n objects cdot3OamEventThresholdHi and cdot3OamEventThresholdLo\n form an unsigned 64-bit integer yielding the value that was\n crossed for the threshold crossing event (for example, 10,\n when 11 occurrences happened in 5 seconds while the threshold\n was 10). The two objects are combined as:\n \n cdot3OamEventLogThreshold = ((2^32) * cdot3OamEventLogThresholdHi)\n + cdot3OamEventLogThresholdLo\n \n Otherwise, this value is returned as all F's (2^32 - 1) and\n adds no useful information.", "minimum": 0, "maximum": 4294967295 }, "cdot3OamEventLogValue": { "type": "integer", "description": "If the event represents a threshold crossing event, this\n value indicates the value of the parameter within the given\n window that generated this event (for example, 11, when 11\n occurrences happened in 5 seconds while the threshold was 10). \n \n Otherwise, this value is returned as all F's \n (2^64 - 1) and adds no useful information.", "minimum": 0 }, "cdot3OamEventLogRunningTotal": { "type": "integer", "description": "Each Event Notification TLV contains a running total of the\n number of times an event has occurred, as well as the number\n of times an Event Notification for the event has been\n transmitted. For non-threshold crossing events, the number of\n events (cdot3OamLogRunningTotal) and the number of resultant\n Event Notifications (cdot3OamLogEventTotal) should be\n identical. \n \n For threshold crossing events, since multiple occurrences may\n be required to cross the threshold, these values are likely\n different. This value represents the total number of times\n this event has happened since the last reset (for example,\n 3253, when 3253 symbol errors have occurred since the last\n reset, which has resulted in 51 symbol error threshold\n crossing events since the last reset).", "minimum": 0 }, "cdot3OamEventLogEventTotal": { "type": "integer", "description": "Each Event Notification TLV contains a running total of the\n number of times an event has occurred, as well as the number\n of times an Event Notification for the event has been\n transmitted. For non-threshold crossing events, the number of\n events (cdot3OamLogRunningTotal) and the number of resultant\n Event Notifications (cdot3OamLogEventTotal) should be\n identical. \n \n For threshold crossing events, since multiple occurrences may\n be required to cross the threshold, these values are likely\n different. This value represents the total number of times\n one or more of these occurrences have resulted in an Event\n Notification (for example, 51 when 3253 symbol errors have\n occurred since the last reset, which has resulted in 51 symbol\n error threshold crossing events since the last reset).", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-DOT3-OAM-MIB:cdot3OamEventLogEntry": { "ifIndex": "example-string", "cdot3OamEventLogIndex": 1, "cdot3OamEventLogTimestamp": "example-string", "cdot3OamEventLogOui": "example-string", "cdot3OamEventLogType": 0, "cdot3OamEventLogLocation": "example-string", "cdot3OamEventLogWindowHi": 0, "cdot3OamEventLogWindowLo": 0, "cdot3OamEventLogThresholdHi": 0, "cdot3OamEventLogThresholdLo": 0, "cdot3OamEventLogValue": 0, "cdot3OamEventLogRunningTotal": 0, "cdot3OamEventLogEventTotal": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdot3OamEventLogEntry-4" }, "x-yang-path": "/cdot3OamEventLogEntry={ifIndex cdot3OamEventLogIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex cdot3OamEventLogIndex" ] } }, "components": { "schemas": { "CISCO-DOT3-OAM-MIB_CISCO-DOT3-OAM-MIB": { "type": "object", "description": "This table contains the primary controls and status for the\n OAM capabilities of an Ethernet like interface. There will be\n one row in this table for each Ethernet like interface in the\n system that supports the OAM functions defined in [802.3ah].", "properties": { "cdot3OamEntry": { "type": "array", "description": "An entry in the table, containing information on the Ethernet\n OAM function for a single Ethernet like interface. Entries in\n the table are created automatically for each interface\n supporting Ethernet OAM. The status of the row entry can be\n determined from cdot3OamOperStatus. \n \n A cdot3OamEntry is indexed in the cdot3OamTable by the ifIndex\n object of the Interfaces MIB.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamAdminState": { "type": "string", "description": "This object is used to provision the default administrative\n OAM mode for this interface. This object represents the\n desired state of OAM for this interface. \n \n The cdot3OamAdminState always starts in the disabled(1) state\n until an explicit management action or configuration\n information retained by the system causes a transition to the\n enabled(2) state. When enabled(2), Ethernet OAM will attempt\n to operate over this interface.", "readOnly": true }, "cdot3OamOperStatus": { "type": "string", "description": "At initialization and failure conditions, two OAM entities on\n the same full-duplex Ethernet link begin a discovery phase to\n determine what OAM capabilities may be used on that link. The\n progress of this initialization is controlled by the OAM\n sublayer. \n \n This value is always disabled(1) if OAM is disabled on this\n interface via the cdot3OamAdminState. \n \n If the link has detected a fault and is transmitting OAMPDUs\n with a link fault indication, the value is linkFault(2). Also,\n if the interface is not operational (ifOperStatus is not \n up(1)), linkFault(2) is returned. Note that the object \n ifOperStatus may not be up(1) as a result of link failure or\n administrative action (ifAdminState being down(2) or\n testing(3)). \n \n The passiveWait(3) state is returned only by OAM entities in\n passive mode (cdot3OamMode) and reflects the state in which the\n OAM entity is waiting to see if the peer device is OAM\n capable. The activeSendLocal(4) value is used by active mode\n devices (cdot3OamMode) and reflects the OAM entity actively\n trying to discover whether the peer has OAM capability but has\n not yet made that determination. \n \n The state sendLocalAndRemote(5) reflects that the local OAM\n entity has discovered the peer but has not yet accepted or\n rejected the configuration of the peer. The local device can,\n for whatever reason, decide that the peer device is\n unacceptable and decline OAM peering. If the local OAM entity\n rejects the peer OAM entity, the state becomes\n oamPeeringLocallyRejected(7). If the OAM peering is allowed\n by the local device, the state moves to\n sendLocalAndRemoteOk(6). Note that both the\n sendLocalAndRemote(5) and oamPeeringLocallyRejected(7) states\n fall within the state SEND_LOCAL_REMOTE of the Discovery state\n diagram [802.3ah, Figure 57-5], with the difference being\n whether the local OAM client has actively rejected the peering\n or has just not indicated any decision yet. Whether a peering\n decision has been made is indicated via the local flags field\n in the OAMPDU (reflected in the aOAMLocalFlagsField of\n 30.3.6.1.10). \n \n If the remote OAM entity rejects the peering, the state\n becomes oamPeeringRemotelyRejected(8). Note that both the\n sendLocalAndRemoteOk(6) and oamPeeringRemotelyRejected(8)\n states fall within the state SEND_LOCAL_REMOTE_OK of the\n Discovery state diagram [802.3ah, Figure 57-5], with the\n difference being whether the remote OAM client has rejected\n the peering or has just not yet decided. This is indicated\n via the remote flags field in the OAM PDU (reflected in the\n aOAMRemoteFlagsField of 30.3.6.1.11). \n \n When the local OAM entity learns that both it and the remote\n OAM entity have accepted the peering, the state moves to\n operational(9) corresponding to the SEND_ANY state of the\n Discovery state diagram [802.3ah, Figure 57-5]. \n \n Since Ethernet OAM functions are not designed to work\n completely over half-duplex interfaces, the value\n nonOperHalfDuplex(10) is returned whenever Ethernet OAM is\n enabled (cdot3OamAdminState is enabled(1)) but the interface is\n in half-duplex operation.", "readOnly": true }, "cdot3OamMode": { "type": "string", "description": "This object configures the mode of OAM operation for this\n Ethernet like interface. OAM on Ethernet interfaces may be in\n 'active' mode or 'passive' mode. These two modes differ in\n that active mode provides additional capabilities to initiate\n monitoring activities with the remote OAM peer entity, while\n passive mode generally waits for the peer to initiate OAM\n actions with it. As an example, an active OAM entity can put\n the remote OAM entity in a loopback state, where a passive OAM\n entity cannot. \n \n The default value of cdot3OamMode is dependent on the type of\n system on which this Ethernet like interface resides. The\n default value should be 'active(1)' unless it is known that\n this system should take on a subservient role to the other\n device connected over this interface. \n \n Changing this value results in incrementing the configuration\n revision field of locally generated OAMPDUs (30.3.6.1.12) and\n potentially re-doing the OAM discovery process if the\n cdot3OamOperStatus was already operational(9).", "readOnly": true }, "cdot3OamMaxOamPduSize": { "type": "integer", "description": "The largest OAMPDU that the OAM entity supports. OAM\n entities exchange maximum OAMPDU sizes and negotiate to use\n the smaller of the two maximum OAMPDU sizes between the peers.\n This value is determined by the local implementation.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamConfigRevision": { "type": "integer", "description": "The configuration revision of the OAM entity as reflected in\n the latest OAMPDU sent by the OAM entity. The config revision\n is used by OAM entities to indicate configuration changes have\n occurred which might require the peer OAM entity to\n re-evaluate whether OAM peering is allowed.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamFunctionsSupported": { "type": "string", "description": "The OAM functions supported on this Ethernet like interface.\n OAM consists of separate functional sets beyond the basic\n discovery process which is always required. These functional\n groups can be supported independently by any implementation.\n These values are communicated to the peer via the local\n configuration field of Information OAMPDUs. \n \n Setting 'unidirectionalSupport(0)' indicates that the OAM\n entity supports the transmission of OAMPDUs on links that are\n operating in unidirectional mode (traffic flowing in one\n direction only). Setting 'loopbackSupport(1)' indicates the\n OAM entity can initiate and respond to loopback commands.\n Setting 'eventSupport(2)' indicates the OAM entity can send\n and receive Event Notification OAMPDUs. Setting\n 'variableSupport(3)' indicates the OAM entity can send and\n receive Variable Request and Response OAMPDUs.", "readOnly": true } } }, "readOnly": true }, "cdot3OamPeerEntry": { "type": "array", "description": "cdot3OamPeerEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamPeerMacAddress": { "type": "string", "description": "The MAC address of the peer OAM entity. The MAC address is\n derived from the most recently received OAMPDU.", "x-yang-type": "yang:mac-address", "readOnly": true }, "cdot3OamPeerVendorOui": { "type": "string", "description": "The OUI of the OAM peer as reflected in the latest\n Information OAMPDU received with a Local Information TLV. The\n OUI can be used to identify the vendor of the remote OAM\n entity. This value is initialized to zero before any Local\n Information TLV is received.", "x-yang-type": "CISCO-DOT3-OAM-MIB:Cdot3Oui", "readOnly": true }, "cdot3OamPeerVendorInfo": { "type": "integer", "description": "The Vendor Info of the OAM peer as reflected in the latest\n Information OAMPDU received with a Local Information TLV. The\n vendor information field is within the Local Information TLV,\n and can be used to determine additional information about the\n peer entity. The format of the vendor information is\n unspecified within the 32-bit field. This value is\n initialized to zero before any Local Information TLV is\n received.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamPeerMode": { "type": "string", "description": "The mode of the OAM peer as reflected in the latest\n Information OAMPDU received with a Local Information TLV. The\n mode of the peer can be determined from the Configuration\n field in the Local Information TLV of the last Information\n OAMPDU received from the peer. The value is unknown(3)\n whenever no Local Information TLV has been received. The\n values of active(1) and passive(2) are returned when a Local\n Information TLV has been received indicating the peer is in\n active or passive mode, respectively.", "readOnly": true }, "cdot3OamPeerMaxOamPduSize": { "type": "integer", "description": "The maximum size of OAMPDU supported by the peer as reflected\n in the latest Information OAMPDU received with a Local\n Information TLV. Ethernet OAM on this interface must not use\n OAMPDUs that exceed this size. The maximum OAMPDU size can be\n determined from the PDU Configuration field of the Local\n Information TLV of the last Information OAMPDU received from\n the peer. A value of zero is returned if no Local Information\n TLV has been received. Otherwise, the value of the OAM peer's\n maximum OAMPDU size is returned in this value. \n Note that the values 1..63 are invalid sizes for Ethernet\n frames and should never appear.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamPeerConfigRevision": { "type": "integer", "description": "The configuration revision of the OAM peer as reflected in\n the latest OAMPDU. This attribute is changed by the peer\n whenever it has a local configuration change for Ethernet OAM\n this interface. The configuration revision can be determined\n from the Revision field of the Local Information TLV of the\n most recently received Information OAMPDU with a Local\n Information TLV. A value of zero is returned if no Local\n Information TLV has been received.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamPeerFunctionsSupported": { "type": "string", "description": "The OAM functions supported on this Ethernet like interface.\n OAM consists of separate functionality sets above the basic\n discovery process. This value indicates the capabilities of\n the peer OAM entity with respect to these functions. This\n value is initialized so all bits are clear. \n \n If unidirectionalSupport(0) is set, then the peer OAM entity\n supports sending OAM frames on Ethernet interfaces when the\n receive path is known to be inoperable. If\n loopbackSupport(1) is set, then the peer OAM entity can send\n and receive OAM loopback commands. If eventSupport(2) is set,\n then the peer OAM entity can send and receive event OAMPDUs to\n signal various error conditions. If variableSupport(3) is set,\n then the peer OAM entity can send and receive variable\n requests to monitor attribute value as described in Clause 57\n of [802.3ah]. \n \n The capabilities of the OAM peer can be determined from the\n configuration field of the Local Information TLV of the most\n recently received Information OAMPDU with a Local Information\n TLV. All zeros are returned if no Local Information TLV has\n yet been received.", "readOnly": true } } }, "readOnly": true }, "cdot3OamLoopbackEntry": { "type": "array", "description": "An entry in the table, containing information on the loopback\n status for a single Ethernet like interface. Entries in the\n table are automatically created whenever the local OAM entity\n supports loopback capabilities. The loopback status on the\n interface can be determined from the cdot3OamLoopbackStatus\n object.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamLoopbackStatus": { "type": "string", "description": "The loopback status of the OAM entity. This status is\n determined by a combination of the local parser and\n multiplexer states, the remote parser and multiplexer states,\n as well as by the actions of the local OAM client. When\n operating in normal mode with no loopback in progress, the\n status reads noLoopback(1). \n \n The values initiatingLooopback(2) and terminatingLoopback(4)\n can be read or written. The other values can only be read -\n they can never be written. Writing initiatingLoopback causes\n the local OAM entity to start the loopback process with its\n peer. This value can only be written when the status is\n noLoopback(1). Writing the value initiatingLoopback(2) in any\n other state has no effect. When in remoteLoopback(3), writing\n terminatingLoopback(4) causes the local OAM entity to initiate\n the termination of the loopback state. Writing\n terminatingLoopack(4) in any other state has no effect. \n If the OAM client initiates a looopback and has sent an\n Loopback OAMPDU and is waiting for a response, where the local\n parser and multiplexer states are DISCARD (see [802.3ah,\n 57.2.11.1]), the status is 'initiatingLoopback'. In this\n case, the local OAM entity has yet to receive any\n acknowledgement that the remote OAM entity has received its\n loopback command request. \n \n If the local OAM client knows that the remote OAM entity is in\n loopback mode (via the remote state information as described\n in [802.3ah, 57.2.11.1, 30.3.6.1.15]), the status is\n remoteLoopback(3). If the local OAM client is in the process\n of terminating the remote loopback [802.3ah, 57.2.11.3,\n 30.3.6.1.14], with its local multiplexer and parser states in\n DISCARD, the status is terminatingLoopback(4). If the remote\n OAM client has put the local OAM entity in loopback mode as\n indicated by its local parser state, the status is\n localLoopback(5). \n \n The unknown(6) status indicates the parser and multiplexer\n combination is unexpected. This status may be returned if the\n OAM loopback is in a transition state but should not persist. \n \n The values of this attribute correspond to the following\n values of the local and remote parser and multiplexer states. \n \n value LclPrsr LclMux RmtPrsr RmtMux\n noLoopback FWD FWD FWD FWD \n initLoopback DISCARD DISCARD FWD FWD \n rmtLoopback DISCARD FWD LPBK DISCARD\n tmtngLoopback DISCARD DISCARD LPBK DISCARD\n lclLoopback LPBK DISCARD DISCARD FWD\n unknown *** any other combination ***", "readOnly": true }, "cdot3OamLoopbackIgnoreRx": { "type": "string", "description": "Since OAM loopback is a disruptive operation (user traffic\n does not pass), this attribute provides a mechanism to provide\n controls over whether received OAM loopback commands are\n processed or ignored. When the value is ignore(1), received\n loopback commands are ignored. When the value is process(2),\n OAM loopback commands are processed. The default value is to\n ignore loopback commands (ignore(1)).", "readOnly": true } } }, "readOnly": true }, "cdot3OamStatsEntry": { "type": "array", "description": "An entry in the table, containing statistics information on\n the Ethernet OAM function for a single Ethernet like\n interface. Entries are automatically created for every entry\n in the cdot3OamTable. Counters are maintained across\n transitions in cdot3OamOperStatus.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamInformationTx": { "type": "integer", "description": "A count of the number of Information OAMPDUs transmitted on\n this interface.\n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamInformationRx": { "type": "integer", "description": "A count of the number of Information OAMPDUs received on this\n interface.\n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamUniqueEventNotificationTx": { "type": "integer", "description": "A count of the number of unique Event OAMPDUs transmitted on\n this interface. Event notifications may be sent in duplicate\n to increase the probability of successfully being received,\n given the possibility that a frame may be lost in transit.\n Duplicate Event Notification transmissions are counted by\n cdot3OamDuplicateEventNotificationTx. \n \n A unique Event Notification OAMPDU is indicated as an Event\n Notification OAMPDU with a Sequence Number field that is\n distinct from the previously transmitted Event Notification\n OAMPDU Sequence Number. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamUniqueEventNotificationRx": { "type": "integer", "description": "A count of the number of unique Event OAMPDUs received on\n this interface. Event notification OAMPDUs may be sent in\n duplicate to increase the probability of successfully being\n received, given the possibility that a frame may be lost in\n transit. Duplicate Event Notification receptions are counted\n by cdot3OamDuplicateEventNotificationRx. \n \n A unique Event Notification OAMPDU is indicated as an Event\n Notification OAMPDU with a Sequence Number field that is\n distinct from the previously received Event Notification\n OAMPDU Sequence Number. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamDuplicateEventNotificationTx": { "type": "integer", "description": "A count of the number of duplicate Event OAMPDUs transmitted\n on this interface. Event notification OAMPDUs may be sent in\n duplicate to increase the probability of successfully being\n received, given the possibility that a frame may be lost in\n transit. \n \n A duplicate Event Notification OAMPDU is indicated as an Event\n Notification OAMPDU with a Sequence Number field that is\n identical to the previously transmitted Event Notification\n OAMPDU Sequence Number. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamDuplicateEventNotificationRx": { "type": "integer", "description": "A count of the number of duplicate Event OAMPDUs received on\n this interface. Event notification OAMPDUs may be sent in\n duplicate to increase the probability of successfully being\n received, given the possibility that a frame may be lost in\n transit. \n \n A duplicate Event Notification OAMPDU is indicated as an Event\n Notification OAMPDU with a Sequence Number field that is\n identical to the previously received Event Notification OAMPDU\n Sequence Number. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamLoopbackControlTx": { "type": "integer", "description": "A count of the number of Loopback Control OAMPDUs transmitted\n on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamLoopbackControlRx": { "type": "integer", "description": "A count of the number of Loopback Control OAMPDUs received\n on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamVariableRequestTx": { "type": "integer", "description": "A count of the number of Variable Request OAMPDUs transmitted\n on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamVariableRequestRx": { "type": "integer", "description": "A count of the number of Variable Request OAMPDUs received on\n this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamVariableResponseTx": { "type": "integer", "description": "A count of the number of Variable Response OAMPDUs\n transmitted on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamVariableResponseRx": { "type": "integer", "description": "A count of the number of Variable Response OAMPDUs received\n on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamOrgSpecificTx": { "type": "integer", "description": "A count of the number of Organization Specific OAMPDUs\n transmitted on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamOrgSpecificRx": { "type": "integer", "description": "A count of the number of Organization Specific OAMPDUs\n received on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamUnsupportedCodesTx": { "type": "integer", "description": "A count of the number of OAMPDUs transmitted on this\n interface with an unsupported op-code. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamUnsupportedCodesRx": { "type": "integer", "description": "A count of the number of OAMPDUs received on this interface\n with an unsupported op-code. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamFramesLostDueToOam": { "type": "integer", "description": "A count of the number of frames that were dropped by the OAM\n multiplexer. Since the OAM multiplexer has multiple inputs\n and a single output, there may be cases where frames are\n dropped due to transmit resource contention. This counter is\n incremented whenever a frame is dropped by the OAM layer.\n Note that any Ethernet frame, not just OAMPDUs, may be dropped\n by the OAM layer. This can occur when an OAMPDU takes\n precedence over a 'normal' frame resulting in the 'normal'\n frame being dropped. \n \n When this counter is incremented, no other counters in this\n MIB are incremented. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "cdot3OamEventConfigEntry": { "type": "array", "description": "cdot3OamEventConfigEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamErrSymPeriodWindowHi": { "type": "integer", "description": "The two objects cdot3OamErrSymPeriodWindowHi and\n cdot3OamErrSymPeriodLo together form an unsigned 64-bit\n integer representing the number of symbols over which this\n threshold event is defined. This is defined as\n \n cdot3OamErrSymPeriodWindow = ((2^32)*cdot3OamErrSymPeriodWindowHi)\n + cdot3OamErrSymPeriodWindowLo\n \n If cdot3OamErrSymPeriodThreshold symbol errors occur within a\n window of cdot3OamErrSymPeriodWindow symbols, an Event\n Notification OAMPDU should be generated with an Errored Symbol\n Period Event TLV indicating the threshold has been crossed in\n this window. \n \n The default value for cdot3OamErrSymPeriodWindow is the number\n of symbols in one second for the underlying physical layer.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamErrSymPeriodWindowLo": { "type": "integer", "description": "The two objects cdot3OamErrSymPeriodWindowHi and\n cdot3OamErrSymPeriodWindowLo together form an unsigned 64-bit\n integer representing the number of symbols over which this\n threshold event is defined. This is defined as\n \n cdot3OamErrSymPeriodWindow = ((2^32)*cdot3OamErrSymPeriodWindowHi)\n + cdot3OamErrSymPeriodWindowLo\n \n If cdot3OamErrSymPeriodThreshold symbol errors occur within a\n window of cdot3OamErrSymPeriodWindow symbols, an Event\n Notification OAMPDU should be generated with an Errored Symbol\n Period Event TLV indicating the threshold has been crossed in\n this window. \n \n The default value for cdot3OamErrSymPeriodWindow is the number\n of symbols in one second for the underlying physical layer.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamErrSymPeriodThresholdHi": { "type": "integer", "description": "The two objects cdot3OamErrSymPeriodThresholdHi and\n cdot3OamErrSymPeriodThresholdLo together form an unsigned\n 64-bit integer representing the number of symbol errors that\n must occur within a given window to cause this event. \n \n This is defined as\n \n cdot3OamErrSymPeriodThreshold =\n ((2^32) * cdot3OamErrSymPeriodThresholdHi)\n + cdot3OamErrSymPeriodThresholdLo\n \n If cdot3OamErrSymPeriodThreshold symbol errors occur within a\n window of cdot3OamErrSymPeriodWindow symbols, an Event\n Notification OAMPDU should be generated with an Errored Symbol\n Period Event TLV indicating the threshold has been crossed in\n this window. \n \n The default value for cdot3OamErrSymPeriodThreshold is one\n symbol errors. If the threshold value is zero, then an Event\n Notification OAMPDU is sent periodically (at the end of every\n window). This can be used as an asynchronous notification to\n the peer OAM entity of the statistics related to this\n threshold crossing alarm.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamErrSymPeriodThresholdLo": { "type": "integer", "description": "The two objects cdot3OamErrSymPeriodThresholdHi and\n cdot3OamErrSymPeriodThresholdLo together form an unsigned\n 64-bit integer representing the number of symbol errors that\n must occur within a given window to cause this event. \n \n This is defined as\n \n cdot3OamErrSymPeriodThreshold =\n ((2^32) * cdot3OamErrSymPeriodThresholdHi)\n + cdot3OamErrSymPeriodThresholdLo\n \n If cdot3OamErrSymPeriodThreshold symbol errors occur within a\n window of cdot3OamErrSymPeriodWindow symbols, an Event\n Notification OAMPDU should be generated with an Errored Symbol\n Period Event TLV indicating the threshold has been crossed in\n this window. \n \n The default value for cdot3OamErrSymPeriodThreshold is one\n symbol error. If the threshold value is zero, then an Event\n Notification OAMPDU is sent periodically (at the end of every\n window). This can be used as an asynchronous notification to\n the peer OAM entity of the statistics related to this\n threshold crossing alarm.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamErrSymPeriodEvNotifEnable": { "type": "boolean", "description": "If true, the OAM entity should send an Event Notification\n OAMPDU when an Errored Symbol Period Event occurs. \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored.", "readOnly": true }, "cdot3OamErrFramePeriodWindow": { "type": "integer", "description": "The number of frames over which the threshold is defined.\n The default value of the window is the number of minimum size\n Ethernet frames that can be received over the physical layer\n in one second. \n \n If cdot3OamErrFramePeriodThreshold frame errors occur within a\n window of cdot3OamErrFramePeriodWindow frames, an Event\n Notification OAMPDU should be generated with an Errored Frame\n Period Event TLV indicating the threshold has been crossed in\n this window.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamErrFramePeriodThreshold": { "type": "integer", "description": "The number of frame errors that must occur for this event to\n be triggered. The default value is one frame error. If the\n threshold value is zero, then an Event Notification OAMPDU is\n sent periodically (at the end of every window). This can be\n used as an asynchronous notification to the peer OAM entity of\n the statistics related to this threshold crossing alarm.\n \n If cdot3OamErrFramePeriodThreshold frame errors occur within a\n window of cdot3OamErrFramePeriodWindow frames, an Event\n Notification OAMPDU should be generated with an Errored Frame\n Period Event TLV indicating the threshold has been crossed in\n this window.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamErrFramePeriodEvNotifEnable": { "type": "boolean", "description": "If true, the OAM entity should send an Event Notification\n OAMPDU when an Errored Frame Period Event occurs. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored.", "readOnly": true }, "cdot3OamErrFrameWindow": { "type": "integer", "description": "The amount of time (in 100ms increments) over which the\n threshold is defined. The default value is 10 (1 second). \n \n If cdot3OamErrFrameThreshold frame errors occur within a window\n of cdot3OamErrFrameWindow seconds (measured in tenths of\n seconds), an Event Notification OAMPDU should be generated\n with an Errored Frame Event TLV indicating the threshold has\n been crossed in this window.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamErrFrameThreshold": { "type": "integer", "description": "The number of frame errors that must occur for this event to\n be triggered. The default value is one frame error. If the\n threshold value is zero, then an Event Notification OAMPDU is\n sent periodically (at the end of every window). This can be\n used as an asynchronous notification to the peer OAM entity of\n the statistics related to this threshold crossing alarm. \n \n If cdot3OamErrFrameThreshold frame errors occur within a window\n of cdot3OamErrFrameWindow (in tenths of seconds), an Event\n Notification OAMPDU should be generated with an Errored Frame\n Event TLV indicating the threshold has been crossed in this\n window.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamErrFrameEvNotifEnable": { "type": "boolean", "description": "If true, the OAM entity should send an Event Notification\n OAMPDU when an Errored Frame Event occurs. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored.", "readOnly": true }, "cdot3OamErrFrameSecsSummaryWindow": { "type": "integer", "description": "The amount of time (in 100ms intervals) over which the\n threshold is defined. The default value is 100 (10 seconds). \n \n If cdot3OamErrFrameSecsSummaryThreshold frame errors occur\n within a window of cdot3OamErrFrameSecsSummaryWindow (in tenths\n of seconds), an Event Notification OAMPDU should be generated\n with an Errored Frame Seconds Summary Event TLV indicating the\n threshold has been crossed in this window.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cdot3OamErrFrameSecsSummaryThreshold": { "type": "integer", "description": "The number of errored frame seconds that must occur for this\n event to be triggered. The default value is one errored frame\n second. If the threshold value is zero, then an Event\n Notification OAMPDU is sent periodically (at the end of every\n window). This can be used as an asynchronous notification to\n the peer OAM entity of the statistics related to this\n threshold crossing alarm. \n \n If cdot3OamErrFrameSecsSummaryThreshold frame errors occur\n within a window of cdot3OamErrFrameSecsSummaryWindow (in tenths\n of seconds), an Event Notification OAMPDU should be generated\n with an Errored Frame Seconds Summary Event TLV indicating the\n threshold has been crossed in this window.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cdot3OamErrFrameSecsEvNotifEnable": { "type": "boolean", "description": "If true, the local OAM entity should send an Event\n Notification OAMPDU when an Errored Frame Seconds Event\n occurs. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored.", "readOnly": true }, "cdot3OamDyingGaspEnable": { "type": "boolean", "description": "If true, the local OAM entity should attempt to indicate a\n dying gasp via the OAMPDU flags field to its peer OAM entity\n when a dying gasp event occurs. The exact definition of a\n dying gasp event is implementation dependent. If the system\n does not support dying gasp capability, setting this object\n has no effect, and reading the object should always result in\n 'false'. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored.", "readOnly": true }, "cdot3OamCriticalEventEnable": { "type": "boolean", "description": "If true, the local OAM entity should attempt to indicate a\n critical event via the OAMPDU flags to its peer OAM entity\n when a critical event occurs. The exact definition of a\n critical event is implementation dependent. If the system\n does not support critical event capability, setting this\n object has no effect, and reading the object should always\n result in 'false'. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored.", "readOnly": true } } }, "readOnly": true }, "cdot3OamEventLogEntry": { "type": "array", "description": "cdot3OamEventLogEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamEventLogIndex": { "type": "integer", "description": "An arbitrary integer for identifying individual events\n within the event log.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamEventLogTimestamp": { "type": "string", "description": "The value of sysUpTime at the time of the logged event. For\n locally generated events, the time of the event can be\n accurately retrieved from sysUpTime. For remotely generated\n events, the time of the event is indicated by the reception of\n the Event Notification OAMPDU indicating the event occurred on\n the peer. A system may attempt to adjust the timestamp value\n to more accurately reflect the time of the event at the peer\n OAM entity by using other information, such as that found in\n the timestamp found of the Event Notification TLVs, which\n provides an indication of the relative time between events at\n the peer entity.", "x-yang-type": "yang:timestamp", "readOnly": true }, "cdot3OamEventLogOui": { "type": "string", "description": "The OUI of the entity defining the object type. All IEEE\n 802.3 defined events (as appearing in [802.3ah] except for the\n Organizationally Unique Event TLVs) use the IEEE 802.3 OUI of\n 0x0180C2. Organizations defining their own Event Notification\n TLVs include their OUI in the Event Notification TLV which\n gets reflected here.", "x-yang-type": "CISCO-DOT3-OAM-MIB:Cdot3Oui", "readOnly": true }, "cdot3OamEventLogType": { "type": "integer", "description": "The type of event that generated this entry in the event log.\n \n When the OUI is the IEEE 802.3 OUI of 0x0180C2, the following\n event types are defined:\n erroredSymbolEvent(1), \n erroredFramePeriodEvent (2), \n erroredFrameEvent(3),\n erroredFrameSecondsEvent(4), \n linkFault(256), \n dyingGaspEvent(257),\n criticalLinkEvent(258)\n The first four are considered threshold crossing events as\n they are generated when a metric exceeds a given value within\n a specified window. The other three are not threshold\n crossing events. \n \n When the OUI is not 71874 (0x0180C2 in hex), then some other\n organization has defined the event space. If event subtyping\n is known to the implementation, it may be reflected here.\n Otherwise, this value should return all Fs (2^32 - 1).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamEventLogLocation": { "type": "string", "description": "Whether this event occurred locally (local(1)), or was \n received from the OAM peer via Ethernet OAM (remote(2)).", "readOnly": true }, "cdot3OamEventLogWindowHi": { "type": "integer", "description": "If the event represents a threshold crossing event, the two\n objects cdot3OamEventWindowHi and cdot3OamEventWindowLo form an\n unsigned 64-bit integer yielding the window over which the\n value was measured for the threshold crossing event (for\n example, 5, when 11 occurrences happened in 5 seconds while\n the threshold was 10). The two objects are combined as:\n \n cdot3OamEventLogWindow = ((2^32) * cdot3OamEventLogWindowHi)\n + cdot3OamEventLogWindowLo\n \n \n Otherwise, this value is returned as all F's (2^32 - 1) and \n adds no useful information.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamEventLogWindowLo": { "type": "integer", "description": "If the event represents a threshold crossing event, the two\n objects cdot3OamEventWindowHi and cdot3OamEventWindowLo form an\n unsigned 64-bit integer yielding the window over which the\n value was measured for the threshold crossing event (for\n example, 5, when 11 occurrences happened in 5 seconds while\n the threshold was 10). The two objects are combined as:\n \n cdot3OamEventLogWindow = ((2^32) * cdot3OamEventLogWindowHi)\n + cdot3OamEventLogWindowLo\n \n Otherwise, this value is returned as all F's (2^32 - 1) and \n adds no useful information.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamEventLogThresholdHi": { "type": "integer", "description": "If the event represents a threshold crossing event, the two\n objects cdot3OamEventThresholdHi and cdot3OamEventThresholdLo\n form an unsigned 64-bit integer yielding the value that was\n crossed for the threshold crossing event (for example, 10,\n when 11 occurrences happened in 5 seconds while the threshold\n was 10). The two objects are combined as:\n \n cdot3OamEventLogThreshold = ((2^32) * cdot3OamEventLogThresholdHi)\n + cdot3OamEventLogThresholdLo\n \n Otherwise, this value is returned as all F's (2^32 -1) and \n adds no useful information.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamEventLogThresholdLo": { "type": "integer", "description": "If the event represents a threshold crossing event, the two\n objects cdot3OamEventThresholdHi and cdot3OamEventThresholdLo\n form an unsigned 64-bit integer yielding the value that was\n crossed for the threshold crossing event (for example, 10,\n when 11 occurrences happened in 5 seconds while the threshold\n was 10). The two objects are combined as:\n \n cdot3OamEventLogThreshold = ((2^32) * cdot3OamEventLogThresholdHi)\n + cdot3OamEventLogThresholdLo\n \n Otherwise, this value is returned as all F's (2^32 - 1) and\n adds no useful information.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamEventLogValue": { "type": "integer", "description": "If the event represents a threshold crossing event, this\n value indicates the value of the parameter within the given\n window that generated this event (for example, 11, when 11\n occurrences happened in 5 seconds while the threshold was 10). \n \n Otherwise, this value is returned as all F's \n (2^64 - 1) and adds no useful information.", "minimum": 0, "readOnly": true }, "cdot3OamEventLogRunningTotal": { "type": "integer", "description": "Each Event Notification TLV contains a running total of the\n number of times an event has occurred, as well as the number\n of times an Event Notification for the event has been\n transmitted. For non-threshold crossing events, the number of\n events (cdot3OamLogRunningTotal) and the number of resultant\n Event Notifications (cdot3OamLogEventTotal) should be\n identical. \n \n For threshold crossing events, since multiple occurrences may\n be required to cross the threshold, these values are likely\n different. This value represents the total number of times\n this event has happened since the last reset (for example,\n 3253, when 3253 symbol errors have occurred since the last\n reset, which has resulted in 51 symbol error threshold\n crossing events since the last reset).", "minimum": 0, "readOnly": true }, "cdot3OamEventLogEventTotal": { "type": "integer", "description": "Each Event Notification TLV contains a running total of the\n number of times an event has occurred, as well as the number\n of times an Event Notification for the event has been\n transmitted. For non-threshold crossing events, the number of\n events (cdot3OamLogRunningTotal) and the number of resultant\n Event Notifications (cdot3OamLogEventTotal) should be\n identical. \n \n For threshold crossing events, since multiple occurrences may\n be required to cross the threshold, these values are likely\n different. This value represents the total number of times\n one or more of these occurrences have resulted in an Event\n Notification (for example, 51 when 3253 symbol errors have\n occurred since the last reset, which has resulted in 51 symbol\n error threshold crossing events since the last reset).", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "cdot3OamTable": { "type": "object", "description": "This table contains the primary controls and status for the\n OAM capabilities of an Ethernet like interface. There will be\n one row in this table for each Ethernet like interface in the\n system that supports the OAM functions defined in [802.3ah].", "properties": { "cdot3OamEntry": { "type": "array", "description": "An entry in the table, containing information on the Ethernet\n OAM function for a single Ethernet like interface. Entries in\n the table are created automatically for each interface\n supporting Ethernet OAM. The status of the row entry can be\n determined from cdot3OamOperStatus. \n \n A cdot3OamEntry is indexed in the cdot3OamTable by the ifIndex\n object of the Interfaces MIB.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamAdminState": { "type": "string", "description": "This object is used to provision the default administrative\n OAM mode for this interface. This object represents the\n desired state of OAM for this interface. \n \n The cdot3OamAdminState always starts in the disabled(1) state\n until an explicit management action or configuration\n information retained by the system causes a transition to the\n enabled(2) state. When enabled(2), Ethernet OAM will attempt\n to operate over this interface.", "readOnly": true }, "cdot3OamOperStatus": { "type": "string", "description": "At initialization and failure conditions, two OAM entities on\n the same full-duplex Ethernet link begin a discovery phase to\n determine what OAM capabilities may be used on that link. The\n progress of this initialization is controlled by the OAM\n sublayer. \n \n This value is always disabled(1) if OAM is disabled on this\n interface via the cdot3OamAdminState. \n \n If the link has detected a fault and is transmitting OAMPDUs\n with a link fault indication, the value is linkFault(2). Also,\n if the interface is not operational (ifOperStatus is not \n up(1)), linkFault(2) is returned. Note that the object \n ifOperStatus may not be up(1) as a result of link failure or\n administrative action (ifAdminState being down(2) or\n testing(3)). \n \n The passiveWait(3) state is returned only by OAM entities in\n passive mode (cdot3OamMode) and reflects the state in which the\n OAM entity is waiting to see if the peer device is OAM\n capable. The activeSendLocal(4) value is used by active mode\n devices (cdot3OamMode) and reflects the OAM entity actively\n trying to discover whether the peer has OAM capability but has\n not yet made that determination. \n \n The state sendLocalAndRemote(5) reflects that the local OAM\n entity has discovered the peer but has not yet accepted or\n rejected the configuration of the peer. The local device can,\n for whatever reason, decide that the peer device is\n unacceptable and decline OAM peering. If the local OAM entity\n rejects the peer OAM entity, the state becomes\n oamPeeringLocallyRejected(7). If the OAM peering is allowed\n by the local device, the state moves to\n sendLocalAndRemoteOk(6). Note that both the\n sendLocalAndRemote(5) and oamPeeringLocallyRejected(7) states\n fall within the state SEND_LOCAL_REMOTE of the Discovery state\n diagram [802.3ah, Figure 57-5], with the difference being\n whether the local OAM client has actively rejected the peering\n or has just not indicated any decision yet. Whether a peering\n decision has been made is indicated via the local flags field\n in the OAMPDU (reflected in the aOAMLocalFlagsField of\n 30.3.6.1.10). \n \n If the remote OAM entity rejects the peering, the state\n becomes oamPeeringRemotelyRejected(8). Note that both the\n sendLocalAndRemoteOk(6) and oamPeeringRemotelyRejected(8)\n states fall within the state SEND_LOCAL_REMOTE_OK of the\n Discovery state diagram [802.3ah, Figure 57-5], with the\n difference being whether the remote OAM client has rejected\n the peering or has just not yet decided. This is indicated\n via the remote flags field in the OAM PDU (reflected in the\n aOAMRemoteFlagsField of 30.3.6.1.11). \n \n When the local OAM entity learns that both it and the remote\n OAM entity have accepted the peering, the state moves to\n operational(9) corresponding to the SEND_ANY state of the\n Discovery state diagram [802.3ah, Figure 57-5]. \n \n Since Ethernet OAM functions are not designed to work\n completely over half-duplex interfaces, the value\n nonOperHalfDuplex(10) is returned whenever Ethernet OAM is\n enabled (cdot3OamAdminState is enabled(1)) but the interface is\n in half-duplex operation.", "readOnly": true }, "cdot3OamMode": { "type": "string", "description": "This object configures the mode of OAM operation for this\n Ethernet like interface. OAM on Ethernet interfaces may be in\n 'active' mode or 'passive' mode. These two modes differ in\n that active mode provides additional capabilities to initiate\n monitoring activities with the remote OAM peer entity, while\n passive mode generally waits for the peer to initiate OAM\n actions with it. As an example, an active OAM entity can put\n the remote OAM entity in a loopback state, where a passive OAM\n entity cannot. \n \n The default value of cdot3OamMode is dependent on the type of\n system on which this Ethernet like interface resides. The\n default value should be 'active(1)' unless it is known that\n this system should take on a subservient role to the other\n device connected over this interface. \n \n Changing this value results in incrementing the configuration\n revision field of locally generated OAMPDUs (30.3.6.1.12) and\n potentially re-doing the OAM discovery process if the\n cdot3OamOperStatus was already operational(9).", "readOnly": true }, "cdot3OamMaxOamPduSize": { "type": "integer", "description": "The largest OAMPDU that the OAM entity supports. OAM\n entities exchange maximum OAMPDU sizes and negotiate to use\n the smaller of the two maximum OAMPDU sizes between the peers.\n This value is determined by the local implementation.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamConfigRevision": { "type": "integer", "description": "The configuration revision of the OAM entity as reflected in\n the latest OAMPDU sent by the OAM entity. The config revision\n is used by OAM entities to indicate configuration changes have\n occurred which might require the peer OAM entity to\n re-evaluate whether OAM peering is allowed.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamFunctionsSupported": { "type": "string", "description": "The OAM functions supported on this Ethernet like interface.\n OAM consists of separate functional sets beyond the basic\n discovery process which is always required. These functional\n groups can be supported independently by any implementation.\n These values are communicated to the peer via the local\n configuration field of Information OAMPDUs. \n \n Setting 'unidirectionalSupport(0)' indicates that the OAM\n entity supports the transmission of OAMPDUs on links that are\n operating in unidirectional mode (traffic flowing in one\n direction only). Setting 'loopbackSupport(1)' indicates the\n OAM entity can initiate and respond to loopback commands.\n Setting 'eventSupport(2)' indicates the OAM entity can send\n and receive Event Notification OAMPDUs. Setting\n 'variableSupport(3)' indicates the OAM entity can send and\n receive Variable Request and Response OAMPDUs.", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cdot3OamPeerTable": { "type": "object", "description": "This table contains information about the OAM peer for a\n particular Ethernet like interface. OAM entities communicate\n with a single OAM peer entity on Ethernet links on which OAM\n is enabled and operating properly. There is one entry in this\n table for each entry in the cdot3OamTable for which information\n on the peer OAM entity is available.", "properties": { "cdot3OamPeerEntry": { "type": "array", "description": "cdot3OamPeerEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamPeerMacAddress": { "type": "string", "description": "The MAC address of the peer OAM entity. The MAC address is\n derived from the most recently received OAMPDU.", "x-yang-type": "yang:mac-address", "readOnly": true }, "cdot3OamPeerVendorOui": { "type": "string", "description": "The OUI of the OAM peer as reflected in the latest\n Information OAMPDU received with a Local Information TLV. The\n OUI can be used to identify the vendor of the remote OAM\n entity. This value is initialized to zero before any Local\n Information TLV is received.", "x-yang-type": "CISCO-DOT3-OAM-MIB:Cdot3Oui", "readOnly": true }, "cdot3OamPeerVendorInfo": { "type": "integer", "description": "The Vendor Info of the OAM peer as reflected in the latest\n Information OAMPDU received with a Local Information TLV. The\n vendor information field is within the Local Information TLV,\n and can be used to determine additional information about the\n peer entity. The format of the vendor information is\n unspecified within the 32-bit field. This value is\n initialized to zero before any Local Information TLV is\n received.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamPeerMode": { "type": "string", "description": "The mode of the OAM peer as reflected in the latest\n Information OAMPDU received with a Local Information TLV. The\n mode of the peer can be determined from the Configuration\n field in the Local Information TLV of the last Information\n OAMPDU received from the peer. The value is unknown(3)\n whenever no Local Information TLV has been received. The\n values of active(1) and passive(2) are returned when a Local\n Information TLV has been received indicating the peer is in\n active or passive mode, respectively.", "readOnly": true }, "cdot3OamPeerMaxOamPduSize": { "type": "integer", "description": "The maximum size of OAMPDU supported by the peer as reflected\n in the latest Information OAMPDU received with a Local\n Information TLV. Ethernet OAM on this interface must not use\n OAMPDUs that exceed this size. The maximum OAMPDU size can be\n determined from the PDU Configuration field of the Local\n Information TLV of the last Information OAMPDU received from\n the peer. A value of zero is returned if no Local Information\n TLV has been received. Otherwise, the value of the OAM peer's\n maximum OAMPDU size is returned in this value. \n Note that the values 1..63 are invalid sizes for Ethernet\n frames and should never appear.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamPeerConfigRevision": { "type": "integer", "description": "The configuration revision of the OAM peer as reflected in\n the latest OAMPDU. This attribute is changed by the peer\n whenever it has a local configuration change for Ethernet OAM\n this interface. The configuration revision can be determined\n from the Revision field of the Local Information TLV of the\n most recently received Information OAMPDU with a Local\n Information TLV. A value of zero is returned if no Local\n Information TLV has been received.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamPeerFunctionsSupported": { "type": "string", "description": "The OAM functions supported on this Ethernet like interface.\n OAM consists of separate functionality sets above the basic\n discovery process. This value indicates the capabilities of\n the peer OAM entity with respect to these functions. This\n value is initialized so all bits are clear. \n \n If unidirectionalSupport(0) is set, then the peer OAM entity\n supports sending OAM frames on Ethernet interfaces when the\n receive path is known to be inoperable. If\n loopbackSupport(1) is set, then the peer OAM entity can send\n and receive OAM loopback commands. If eventSupport(2) is set,\n then the peer OAM entity can send and receive event OAMPDUs to\n signal various error conditions. If variableSupport(3) is set,\n then the peer OAM entity can send and receive variable\n requests to monitor attribute value as described in Clause 57\n of [802.3ah]. \n \n The capabilities of the OAM peer can be determined from the\n configuration field of the Local Information TLV of the most\n recently received Information OAMPDU with a Local Information\n TLV. All zeros are returned if no Local Information TLV has\n yet been received.", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cdot3OamLoopbackTable": { "type": "object", "description": "cdot3OamLoopbackTable", "properties": { "cdot3OamLoopbackEntry": { "type": "array", "description": "An entry in the table, containing information on the loopback\n status for a single Ethernet like interface. Entries in the\n table are automatically created whenever the local OAM entity\n supports loopback capabilities. The loopback status on the\n interface can be determined from the cdot3OamLoopbackStatus\n object.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamLoopbackStatus": { "type": "string", "description": "The loopback status of the OAM entity. This status is\n determined by a combination of the local parser and\n multiplexer states, the remote parser and multiplexer states,\n as well as by the actions of the local OAM client. When\n operating in normal mode with no loopback in progress, the\n status reads noLoopback(1). \n \n The values initiatingLooopback(2) and terminatingLoopback(4)\n can be read or written. The other values can only be read -\n they can never be written. Writing initiatingLoopback causes\n the local OAM entity to start the loopback process with its\n peer. This value can only be written when the status is\n noLoopback(1). Writing the value initiatingLoopback(2) in any\n other state has no effect. When in remoteLoopback(3), writing\n terminatingLoopback(4) causes the local OAM entity to initiate\n the termination of the loopback state. Writing\n terminatingLoopack(4) in any other state has no effect. \n If the OAM client initiates a looopback and has sent an\n Loopback OAMPDU and is waiting for a response, where the local\n parser and multiplexer states are DISCARD (see [802.3ah,\n 57.2.11.1]), the status is 'initiatingLoopback'. In this\n case, the local OAM entity has yet to receive any\n acknowledgement that the remote OAM entity has received its\n loopback command request. \n \n If the local OAM client knows that the remote OAM entity is in\n loopback mode (via the remote state information as described\n in [802.3ah, 57.2.11.1, 30.3.6.1.15]), the status is\n remoteLoopback(3). If the local OAM client is in the process\n of terminating the remote loopback [802.3ah, 57.2.11.3,\n 30.3.6.1.14], with its local multiplexer and parser states in\n DISCARD, the status is terminatingLoopback(4). If the remote\n OAM client has put the local OAM entity in loopback mode as\n indicated by its local parser state, the status is\n localLoopback(5). \n \n The unknown(6) status indicates the parser and multiplexer\n combination is unexpected. This status may be returned if the\n OAM loopback is in a transition state but should not persist. \n \n The values of this attribute correspond to the following\n values of the local and remote parser and multiplexer states. \n \n value LclPrsr LclMux RmtPrsr RmtMux\n noLoopback FWD FWD FWD FWD \n initLoopback DISCARD DISCARD FWD FWD \n rmtLoopback DISCARD FWD LPBK DISCARD\n tmtngLoopback DISCARD DISCARD LPBK DISCARD\n lclLoopback LPBK DISCARD DISCARD FWD\n unknown *** any other combination ***", "readOnly": true }, "cdot3OamLoopbackIgnoreRx": { "type": "string", "description": "Since OAM loopback is a disruptive operation (user traffic\n does not pass), this attribute provides a mechanism to provide\n controls over whether received OAM loopback commands are\n processed or ignored. When the value is ignore(1), received\n loopback commands are ignored. When the value is process(2),\n OAM loopback commands are processed. The default value is to\n ignore loopback commands (ignore(1)).", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cdot3OamStatsTable": { "type": "object", "description": "This table contains statistics for the OAM function on a\n particular Ethernet like interface. There is an entry in the\n table for every entry in the cdot3OamTable. \n \n The counters in this table are defined as 32-bit entries to\n match the counter size as defined in [802.3ah]. Given the OAM\n protocol is a slow protocol, the counters increment at a slow\n rate.", "properties": { "cdot3OamStatsEntry": { "type": "array", "description": "An entry in the table, containing statistics information on\n the Ethernet OAM function for a single Ethernet like\n interface. Entries are automatically created for every entry\n in the cdot3OamTable. Counters are maintained across\n transitions in cdot3OamOperStatus.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamInformationTx": { "type": "integer", "description": "A count of the number of Information OAMPDUs transmitted on\n this interface.\n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamInformationRx": { "type": "integer", "description": "A count of the number of Information OAMPDUs received on this\n interface.\n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamUniqueEventNotificationTx": { "type": "integer", "description": "A count of the number of unique Event OAMPDUs transmitted on\n this interface. Event notifications may be sent in duplicate\n to increase the probability of successfully being received,\n given the possibility that a frame may be lost in transit.\n Duplicate Event Notification transmissions are counted by\n cdot3OamDuplicateEventNotificationTx. \n \n A unique Event Notification OAMPDU is indicated as an Event\n Notification OAMPDU with a Sequence Number field that is\n distinct from the previously transmitted Event Notification\n OAMPDU Sequence Number. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamUniqueEventNotificationRx": { "type": "integer", "description": "A count of the number of unique Event OAMPDUs received on\n this interface. Event notification OAMPDUs may be sent in\n duplicate to increase the probability of successfully being\n received, given the possibility that a frame may be lost in\n transit. Duplicate Event Notification receptions are counted\n by cdot3OamDuplicateEventNotificationRx. \n \n A unique Event Notification OAMPDU is indicated as an Event\n Notification OAMPDU with a Sequence Number field that is\n distinct from the previously received Event Notification\n OAMPDU Sequence Number. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamDuplicateEventNotificationTx": { "type": "integer", "description": "A count of the number of duplicate Event OAMPDUs transmitted\n on this interface. Event notification OAMPDUs may be sent in\n duplicate to increase the probability of successfully being\n received, given the possibility that a frame may be lost in\n transit. \n \n A duplicate Event Notification OAMPDU is indicated as an Event\n Notification OAMPDU with a Sequence Number field that is\n identical to the previously transmitted Event Notification\n OAMPDU Sequence Number. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamDuplicateEventNotificationRx": { "type": "integer", "description": "A count of the number of duplicate Event OAMPDUs received on\n this interface. Event notification OAMPDUs may be sent in\n duplicate to increase the probability of successfully being\n received, given the possibility that a frame may be lost in\n transit. \n \n A duplicate Event Notification OAMPDU is indicated as an Event\n Notification OAMPDU with a Sequence Number field that is\n identical to the previously received Event Notification OAMPDU\n Sequence Number. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamLoopbackControlTx": { "type": "integer", "description": "A count of the number of Loopback Control OAMPDUs transmitted\n on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamLoopbackControlRx": { "type": "integer", "description": "A count of the number of Loopback Control OAMPDUs received\n on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamVariableRequestTx": { "type": "integer", "description": "A count of the number of Variable Request OAMPDUs transmitted\n on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamVariableRequestRx": { "type": "integer", "description": "A count of the number of Variable Request OAMPDUs received on\n this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamVariableResponseTx": { "type": "integer", "description": "A count of the number of Variable Response OAMPDUs\n transmitted on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamVariableResponseRx": { "type": "integer", "description": "A count of the number of Variable Response OAMPDUs received\n on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamOrgSpecificTx": { "type": "integer", "description": "A count of the number of Organization Specific OAMPDUs\n transmitted on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamOrgSpecificRx": { "type": "integer", "description": "A count of the number of Organization Specific OAMPDUs\n received on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamUnsupportedCodesTx": { "type": "integer", "description": "A count of the number of OAMPDUs transmitted on this\n interface with an unsupported op-code. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamUnsupportedCodesRx": { "type": "integer", "description": "A count of the number of OAMPDUs received on this interface\n with an unsupported op-code. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamFramesLostDueToOam": { "type": "integer", "description": "A count of the number of frames that were dropped by the OAM\n multiplexer. Since the OAM multiplexer has multiple inputs\n and a single output, there may be cases where frames are\n dropped due to transmit resource contention. This counter is\n incremented whenever a frame is dropped by the OAM layer.\n Note that any Ethernet frame, not just OAMPDUs, may be dropped\n by the OAM layer. This can occur when an OAMPDU takes\n precedence over a 'normal' frame resulting in the 'normal'\n frame being dropped. \n \n When this counter is incremented, no other counters in this\n MIB are incremented. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cdot3OamEventConfigTable": { "type": "object", "description": "cdot3OamEventConfigTable", "properties": { "cdot3OamEventConfigEntry": { "type": "array", "description": "cdot3OamEventConfigEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamErrSymPeriodWindowHi": { "type": "integer", "description": "The two objects cdot3OamErrSymPeriodWindowHi and\n cdot3OamErrSymPeriodLo together form an unsigned 64-bit\n integer representing the number of symbols over which this\n threshold event is defined. This is defined as\n \n cdot3OamErrSymPeriodWindow = ((2^32)*cdot3OamErrSymPeriodWindowHi)\n + cdot3OamErrSymPeriodWindowLo\n \n If cdot3OamErrSymPeriodThreshold symbol errors occur within a\n window of cdot3OamErrSymPeriodWindow symbols, an Event\n Notification OAMPDU should be generated with an Errored Symbol\n Period Event TLV indicating the threshold has been crossed in\n this window. \n \n The default value for cdot3OamErrSymPeriodWindow is the number\n of symbols in one second for the underlying physical layer.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamErrSymPeriodWindowLo": { "type": "integer", "description": "The two objects cdot3OamErrSymPeriodWindowHi and\n cdot3OamErrSymPeriodWindowLo together form an unsigned 64-bit\n integer representing the number of symbols over which this\n threshold event is defined. This is defined as\n \n cdot3OamErrSymPeriodWindow = ((2^32)*cdot3OamErrSymPeriodWindowHi)\n + cdot3OamErrSymPeriodWindowLo\n \n If cdot3OamErrSymPeriodThreshold symbol errors occur within a\n window of cdot3OamErrSymPeriodWindow symbols, an Event\n Notification OAMPDU should be generated with an Errored Symbol\n Period Event TLV indicating the threshold has been crossed in\n this window. \n \n The default value for cdot3OamErrSymPeriodWindow is the number\n of symbols in one second for the underlying physical layer.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamErrSymPeriodThresholdHi": { "type": "integer", "description": "The two objects cdot3OamErrSymPeriodThresholdHi and\n cdot3OamErrSymPeriodThresholdLo together form an unsigned\n 64-bit integer representing the number of symbol errors that\n must occur within a given window to cause this event. \n \n This is defined as\n \n cdot3OamErrSymPeriodThreshold =\n ((2^32) * cdot3OamErrSymPeriodThresholdHi)\n + cdot3OamErrSymPeriodThresholdLo\n \n If cdot3OamErrSymPeriodThreshold symbol errors occur within a\n window of cdot3OamErrSymPeriodWindow symbols, an Event\n Notification OAMPDU should be generated with an Errored Symbol\n Period Event TLV indicating the threshold has been crossed in\n this window. \n \n The default value for cdot3OamErrSymPeriodThreshold is one\n symbol errors. If the threshold value is zero, then an Event\n Notification OAMPDU is sent periodically (at the end of every\n window). This can be used as an asynchronous notification to\n the peer OAM entity of the statistics related to this\n threshold crossing alarm.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamErrSymPeriodThresholdLo": { "type": "integer", "description": "The two objects cdot3OamErrSymPeriodThresholdHi and\n cdot3OamErrSymPeriodThresholdLo together form an unsigned\n 64-bit integer representing the number of symbol errors that\n must occur within a given window to cause this event. \n \n This is defined as\n \n cdot3OamErrSymPeriodThreshold =\n ((2^32) * cdot3OamErrSymPeriodThresholdHi)\n + cdot3OamErrSymPeriodThresholdLo\n \n If cdot3OamErrSymPeriodThreshold symbol errors occur within a\n window of cdot3OamErrSymPeriodWindow symbols, an Event\n Notification OAMPDU should be generated with an Errored Symbol\n Period Event TLV indicating the threshold has been crossed in\n this window. \n \n The default value for cdot3OamErrSymPeriodThreshold is one\n symbol error. If the threshold value is zero, then an Event\n Notification OAMPDU is sent periodically (at the end of every\n window). This can be used as an asynchronous notification to\n the peer OAM entity of the statistics related to this\n threshold crossing alarm.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamErrSymPeriodEvNotifEnable": { "type": "boolean", "description": "If true, the OAM entity should send an Event Notification\n OAMPDU when an Errored Symbol Period Event occurs. \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored.", "readOnly": true }, "cdot3OamErrFramePeriodWindow": { "type": "integer", "description": "The number of frames over which the threshold is defined.\n The default value of the window is the number of minimum size\n Ethernet frames that can be received over the physical layer\n in one second. \n \n If cdot3OamErrFramePeriodThreshold frame errors occur within a\n window of cdot3OamErrFramePeriodWindow frames, an Event\n Notification OAMPDU should be generated with an Errored Frame\n Period Event TLV indicating the threshold has been crossed in\n this window.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamErrFramePeriodThreshold": { "type": "integer", "description": "The number of frame errors that must occur for this event to\n be triggered. The default value is one frame error. If the\n threshold value is zero, then an Event Notification OAMPDU is\n sent periodically (at the end of every window). This can be\n used as an asynchronous notification to the peer OAM entity of\n the statistics related to this threshold crossing alarm.\n \n If cdot3OamErrFramePeriodThreshold frame errors occur within a\n window of cdot3OamErrFramePeriodWindow frames, an Event\n Notification OAMPDU should be generated with an Errored Frame\n Period Event TLV indicating the threshold has been crossed in\n this window.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamErrFramePeriodEvNotifEnable": { "type": "boolean", "description": "If true, the OAM entity should send an Event Notification\n OAMPDU when an Errored Frame Period Event occurs. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored.", "readOnly": true }, "cdot3OamErrFrameWindow": { "type": "integer", "description": "The amount of time (in 100ms increments) over which the\n threshold is defined. The default value is 10 (1 second). \n \n If cdot3OamErrFrameThreshold frame errors occur within a window\n of cdot3OamErrFrameWindow seconds (measured in tenths of\n seconds), an Event Notification OAMPDU should be generated\n with an Errored Frame Event TLV indicating the threshold has\n been crossed in this window.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamErrFrameThreshold": { "type": "integer", "description": "The number of frame errors that must occur for this event to\n be triggered. The default value is one frame error. If the\n threshold value is zero, then an Event Notification OAMPDU is\n sent periodically (at the end of every window). This can be\n used as an asynchronous notification to the peer OAM entity of\n the statistics related to this threshold crossing alarm. \n \n If cdot3OamErrFrameThreshold frame errors occur within a window\n of cdot3OamErrFrameWindow (in tenths of seconds), an Event\n Notification OAMPDU should be generated with an Errored Frame\n Event TLV indicating the threshold has been crossed in this\n window.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamErrFrameEvNotifEnable": { "type": "boolean", "description": "If true, the OAM entity should send an Event Notification\n OAMPDU when an Errored Frame Event occurs. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored.", "readOnly": true }, "cdot3OamErrFrameSecsSummaryWindow": { "type": "integer", "description": "The amount of time (in 100ms intervals) over which the\n threshold is defined. The default value is 100 (10 seconds). \n \n If cdot3OamErrFrameSecsSummaryThreshold frame errors occur\n within a window of cdot3OamErrFrameSecsSummaryWindow (in tenths\n of seconds), an Event Notification OAMPDU should be generated\n with an Errored Frame Seconds Summary Event TLV indicating the\n threshold has been crossed in this window.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cdot3OamErrFrameSecsSummaryThreshold": { "type": "integer", "description": "The number of errored frame seconds that must occur for this\n event to be triggered. The default value is one errored frame\n second. If the threshold value is zero, then an Event\n Notification OAMPDU is sent periodically (at the end of every\n window). This can be used as an asynchronous notification to\n the peer OAM entity of the statistics related to this\n threshold crossing alarm. \n \n If cdot3OamErrFrameSecsSummaryThreshold frame errors occur\n within a window of cdot3OamErrFrameSecsSummaryWindow (in tenths\n of seconds), an Event Notification OAMPDU should be generated\n with an Errored Frame Seconds Summary Event TLV indicating the\n threshold has been crossed in this window.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cdot3OamErrFrameSecsEvNotifEnable": { "type": "boolean", "description": "If true, the local OAM entity should send an Event\n Notification OAMPDU when an Errored Frame Seconds Event\n occurs. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored.", "readOnly": true }, "cdot3OamDyingGaspEnable": { "type": "boolean", "description": "If true, the local OAM entity should attempt to indicate a\n dying gasp via the OAMPDU flags field to its peer OAM entity\n when a dying gasp event occurs. The exact definition of a\n dying gasp event is implementation dependent. If the system\n does not support dying gasp capability, setting this object\n has no effect, and reading the object should always result in\n 'false'. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored.", "readOnly": true }, "cdot3OamCriticalEventEnable": { "type": "boolean", "description": "If true, the local OAM entity should attempt to indicate a\n critical event via the OAMPDU flags to its peer OAM entity\n when a critical event occurs. The exact definition of a\n critical event is implementation dependent. If the system\n does not support critical event capability, setting this\n object has no effect, and reading the object should always\n result in 'false'. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored.", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cdot3OamEventLogTable": { "type": "object", "description": "cdot3OamEventLogTable", "properties": { "cdot3OamEventLogEntry": { "type": "array", "description": "cdot3OamEventLogEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamEventLogIndex": { "type": "integer", "description": "An arbitrary integer for identifying individual events\n within the event log.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamEventLogTimestamp": { "type": "string", "description": "The value of sysUpTime at the time of the logged event. For\n locally generated events, the time of the event can be\n accurately retrieved from sysUpTime. For remotely generated\n events, the time of the event is indicated by the reception of\n the Event Notification OAMPDU indicating the event occurred on\n the peer. A system may attempt to adjust the timestamp value\n to more accurately reflect the time of the event at the peer\n OAM entity by using other information, such as that found in\n the timestamp found of the Event Notification TLVs, which\n provides an indication of the relative time between events at\n the peer entity.", "x-yang-type": "yang:timestamp", "readOnly": true }, "cdot3OamEventLogOui": { "type": "string", "description": "The OUI of the entity defining the object type. All IEEE\n 802.3 defined events (as appearing in [802.3ah] except for the\n Organizationally Unique Event TLVs) use the IEEE 802.3 OUI of\n 0x0180C2. Organizations defining their own Event Notification\n TLVs include their OUI in the Event Notification TLV which\n gets reflected here.", "x-yang-type": "CISCO-DOT3-OAM-MIB:Cdot3Oui", "readOnly": true }, "cdot3OamEventLogType": { "type": "integer", "description": "The type of event that generated this entry in the event log.\n \n When the OUI is the IEEE 802.3 OUI of 0x0180C2, the following\n event types are defined:\n erroredSymbolEvent(1), \n erroredFramePeriodEvent (2), \n erroredFrameEvent(3),\n erroredFrameSecondsEvent(4), \n linkFault(256), \n dyingGaspEvent(257),\n criticalLinkEvent(258)\n The first four are considered threshold crossing events as\n they are generated when a metric exceeds a given value within\n a specified window. The other three are not threshold\n crossing events. \n \n When the OUI is not 71874 (0x0180C2 in hex), then some other\n organization has defined the event space. If event subtyping\n is known to the implementation, it may be reflected here.\n Otherwise, this value should return all Fs (2^32 - 1).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamEventLogLocation": { "type": "string", "description": "Whether this event occurred locally (local(1)), or was \n received from the OAM peer via Ethernet OAM (remote(2)).", "readOnly": true }, "cdot3OamEventLogWindowHi": { "type": "integer", "description": "If the event represents a threshold crossing event, the two\n objects cdot3OamEventWindowHi and cdot3OamEventWindowLo form an\n unsigned 64-bit integer yielding the window over which the\n value was measured for the threshold crossing event (for\n example, 5, when 11 occurrences happened in 5 seconds while\n the threshold was 10). The two objects are combined as:\n \n cdot3OamEventLogWindow = ((2^32) * cdot3OamEventLogWindowHi)\n + cdot3OamEventLogWindowLo\n \n \n Otherwise, this value is returned as all F's (2^32 - 1) and \n adds no useful information.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamEventLogWindowLo": { "type": "integer", "description": "If the event represents a threshold crossing event, the two\n objects cdot3OamEventWindowHi and cdot3OamEventWindowLo form an\n unsigned 64-bit integer yielding the window over which the\n value was measured for the threshold crossing event (for\n example, 5, when 11 occurrences happened in 5 seconds while\n the threshold was 10). The two objects are combined as:\n \n cdot3OamEventLogWindow = ((2^32) * cdot3OamEventLogWindowHi)\n + cdot3OamEventLogWindowLo\n \n Otherwise, this value is returned as all F's (2^32 - 1) and \n adds no useful information.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamEventLogThresholdHi": { "type": "integer", "description": "If the event represents a threshold crossing event, the two\n objects cdot3OamEventThresholdHi and cdot3OamEventThresholdLo\n form an unsigned 64-bit integer yielding the value that was\n crossed for the threshold crossing event (for example, 10,\n when 11 occurrences happened in 5 seconds while the threshold\n was 10). The two objects are combined as:\n \n cdot3OamEventLogThreshold = ((2^32) * cdot3OamEventLogThresholdHi)\n + cdot3OamEventLogThresholdLo\n \n Otherwise, this value is returned as all F's (2^32 -1) and \n adds no useful information.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamEventLogThresholdLo": { "type": "integer", "description": "If the event represents a threshold crossing event, the two\n objects cdot3OamEventThresholdHi and cdot3OamEventThresholdLo\n form an unsigned 64-bit integer yielding the value that was\n crossed for the threshold crossing event (for example, 10,\n when 11 occurrences happened in 5 seconds while the threshold\n was 10). The two objects are combined as:\n \n cdot3OamEventLogThreshold = ((2^32) * cdot3OamEventLogThresholdHi)\n + cdot3OamEventLogThresholdLo\n \n Otherwise, this value is returned as all F's (2^32 - 1) and\n adds no useful information.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamEventLogValue": { "type": "integer", "description": "If the event represents a threshold crossing event, this\n value indicates the value of the parameter within the given\n window that generated this event (for example, 11, when 11\n occurrences happened in 5 seconds while the threshold was 10). \n \n Otherwise, this value is returned as all F's \n (2^64 - 1) and adds no useful information.", "minimum": 0, "readOnly": true }, "cdot3OamEventLogRunningTotal": { "type": "integer", "description": "Each Event Notification TLV contains a running total of the\n number of times an event has occurred, as well as the number\n of times an Event Notification for the event has been\n transmitted. For non-threshold crossing events, the number of\n events (cdot3OamLogRunningTotal) and the number of resultant\n Event Notifications (cdot3OamLogEventTotal) should be\n identical. \n \n For threshold crossing events, since multiple occurrences may\n be required to cross the threshold, these values are likely\n different. This value represents the total number of times\n this event has happened since the last reset (for example,\n 3253, when 3253 symbol errors have occurred since the last\n reset, which has resulted in 51 symbol error threshold\n crossing events since the last reset).", "minimum": 0, "readOnly": true }, "cdot3OamEventLogEventTotal": { "type": "integer", "description": "Each Event Notification TLV contains a running total of the\n number of times an event has occurred, as well as the number\n of times an Event Notification for the event has been\n transmitted. For non-threshold crossing events, the number of\n events (cdot3OamLogRunningTotal) and the number of resultant\n Event Notifications (cdot3OamLogEventTotal) should be\n identical. \n \n For threshold crossing events, since multiple occurrences may\n be required to cross the threshold, these values are likely\n different. This value represents the total number of times\n one or more of these occurrences have resulted in an Event\n Notification (for example, 51 when 3253 symbol errors have\n occurred since the last reset, which has resulted in 51 symbol\n error threshold crossing events since the last reset).", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "CISCO-DOT3-OAM-MIB_object-1": { "type": "object", "description": "object-1", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamEventLogIndex": { "type": "string", "description": "cdot3OamEventLogIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamEventLogTimestamp": { "type": "string", "description": "cdot3OamEventLogTimestamp", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-DOT3-OAM-MIB_object-2": { "type": "object", "description": "object-2", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamEventLogIndex": { "type": "string", "description": "cdot3OamEventLogIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamEventLogOui": { "type": "string", "description": "cdot3OamEventLogOui", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-DOT3-OAM-MIB_object-3": { "type": "object", "description": "object-3", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamEventLogIndex": { "type": "string", "description": "cdot3OamEventLogIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamEventLogType": { "type": "string", "description": "cdot3OamEventLogType", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-DOT3-OAM-MIB_object-4": { "type": "object", "description": "object-4", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamEventLogIndex": { "type": "string", "description": "cdot3OamEventLogIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamEventLogLocation": { "type": "string", "description": "cdot3OamEventLogLocation", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-DOT3-OAM-MIB_object-5": { "type": "object", "description": "object-5", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamEventLogIndex": { "type": "string", "description": "cdot3OamEventLogIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamEventLogEventTotal": { "type": "string", "description": "cdot3OamEventLogEventTotal", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-DOT3-OAM-MIB_object-6": { "type": "object", "description": "object-6", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamEventLogIndex": { "type": "string", "description": "cdot3OamEventLogIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamEventLogWindowLo": { "type": "string", "description": "cdot3OamEventLogWindowLo", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-DOT3-OAM-MIB_object-7": { "type": "object", "description": "object-7", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamEventLogIndex": { "type": "string", "description": "cdot3OamEventLogIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamEventLogThresholdHi": { "type": "string", "description": "cdot3OamEventLogThresholdHi", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-DOT3-OAM-MIB_object-8": { "type": "object", "description": "object-8", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamEventLogIndex": { "type": "string", "description": "cdot3OamEventLogIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamEventLogThresholdLo": { "type": "string", "description": "cdot3OamEventLogThresholdLo", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-DOT3-OAM-MIB_object-9": { "type": "object", "description": "object-9", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamEventLogIndex": { "type": "string", "description": "cdot3OamEventLogIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamEventLogValue": { "type": "string", "description": "cdot3OamEventLogValue", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-DOT3-OAM-MIB_object-10": { "type": "object", "description": "object-10", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamEventLogIndex": { "type": "string", "description": "cdot3OamEventLogIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamEventLogRunningTotal": { "type": "string", "description": "cdot3OamEventLogRunningTotal", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-DOT3-OAM-MIB_object-11": { "type": "object", "description": "object-11", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamEventLogIndex": { "type": "string", "description": "cdot3OamEventLogIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamEventLogEventTotal": { "type": "string", "description": "cdot3OamEventLogEventTotal", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-DOT3-OAM-MIB_cdot3OamEntry": { "type": "array", "description": "An entry in the table, containing information on the Ethernet\n OAM function for a single Ethernet like interface. Entries in\n the table are created automatically for each interface\n supporting Ethernet OAM. The status of the row entry can be\n determined from cdot3OamOperStatus. \n \n A cdot3OamEntry is indexed in the cdot3OamTable by the ifIndex\n object of the Interfaces MIB.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamAdminState": { "type": "string", "description": "This object is used to provision the default administrative\n OAM mode for this interface. This object represents the\n desired state of OAM for this interface. \n \n The cdot3OamAdminState always starts in the disabled(1) state\n until an explicit management action or configuration\n information retained by the system causes a transition to the\n enabled(2) state. When enabled(2), Ethernet OAM will attempt\n to operate over this interface.", "readOnly": true }, "cdot3OamOperStatus": { "type": "string", "description": "At initialization and failure conditions, two OAM entities on\n the same full-duplex Ethernet link begin a discovery phase to\n determine what OAM capabilities may be used on that link. The\n progress of this initialization is controlled by the OAM\n sublayer. \n \n This value is always disabled(1) if OAM is disabled on this\n interface via the cdot3OamAdminState. \n \n If the link has detected a fault and is transmitting OAMPDUs\n with a link fault indication, the value is linkFault(2). Also,\n if the interface is not operational (ifOperStatus is not \n up(1)), linkFault(2) is returned. Note that the object \n ifOperStatus may not be up(1) as a result of link failure or\n administrative action (ifAdminState being down(2) or\n testing(3)). \n \n The passiveWait(3) state is returned only by OAM entities in\n passive mode (cdot3OamMode) and reflects the state in which the\n OAM entity is waiting to see if the peer device is OAM\n capable. The activeSendLocal(4) value is used by active mode\n devices (cdot3OamMode) and reflects the OAM entity actively\n trying to discover whether the peer has OAM capability but has\n not yet made that determination. \n \n The state sendLocalAndRemote(5) reflects that the local OAM\n entity has discovered the peer but has not yet accepted or\n rejected the configuration of the peer. The local device can,\n for whatever reason, decide that the peer device is\n unacceptable and decline OAM peering. If the local OAM entity\n rejects the peer OAM entity, the state becomes\n oamPeeringLocallyRejected(7). If the OAM peering is allowed\n by the local device, the state moves to\n sendLocalAndRemoteOk(6). Note that both the\n sendLocalAndRemote(5) and oamPeeringLocallyRejected(7) states\n fall within the state SEND_LOCAL_REMOTE of the Discovery state\n diagram [802.3ah, Figure 57-5], with the difference being\n whether the local OAM client has actively rejected the peering\n or has just not indicated any decision yet. Whether a peering\n decision has been made is indicated via the local flags field\n in the OAMPDU (reflected in the aOAMLocalFlagsField of\n 30.3.6.1.10). \n \n If the remote OAM entity rejects the peering, the state\n becomes oamPeeringRemotelyRejected(8). Note that both the\n sendLocalAndRemoteOk(6) and oamPeeringRemotelyRejected(8)\n states fall within the state SEND_LOCAL_REMOTE_OK of the\n Discovery state diagram [802.3ah, Figure 57-5], with the\n difference being whether the remote OAM client has rejected\n the peering or has just not yet decided. This is indicated\n via the remote flags field in the OAM PDU (reflected in the\n aOAMRemoteFlagsField of 30.3.6.1.11). \n \n When the local OAM entity learns that both it and the remote\n OAM entity have accepted the peering, the state moves to\n operational(9) corresponding to the SEND_ANY state of the\n Discovery state diagram [802.3ah, Figure 57-5]. \n \n Since Ethernet OAM functions are not designed to work\n completely over half-duplex interfaces, the value\n nonOperHalfDuplex(10) is returned whenever Ethernet OAM is\n enabled (cdot3OamAdminState is enabled(1)) but the interface is\n in half-duplex operation.", "readOnly": true }, "cdot3OamMode": { "type": "string", "description": "This object configures the mode of OAM operation for this\n Ethernet like interface. OAM on Ethernet interfaces may be in\n 'active' mode or 'passive' mode. These two modes differ in\n that active mode provides additional capabilities to initiate\n monitoring activities with the remote OAM peer entity, while\n passive mode generally waits for the peer to initiate OAM\n actions with it. As an example, an active OAM entity can put\n the remote OAM entity in a loopback state, where a passive OAM\n entity cannot. \n \n The default value of cdot3OamMode is dependent on the type of\n system on which this Ethernet like interface resides. The\n default value should be 'active(1)' unless it is known that\n this system should take on a subservient role to the other\n device connected over this interface. \n \n Changing this value results in incrementing the configuration\n revision field of locally generated OAMPDUs (30.3.6.1.12) and\n potentially re-doing the OAM discovery process if the\n cdot3OamOperStatus was already operational(9).", "readOnly": true }, "cdot3OamMaxOamPduSize": { "type": "integer", "description": "The largest OAMPDU that the OAM entity supports. OAM\n entities exchange maximum OAMPDU sizes and negotiate to use\n the smaller of the two maximum OAMPDU sizes between the peers.\n This value is determined by the local implementation.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamConfigRevision": { "type": "integer", "description": "The configuration revision of the OAM entity as reflected in\n the latest OAMPDU sent by the OAM entity. The config revision\n is used by OAM entities to indicate configuration changes have\n occurred which might require the peer OAM entity to\n re-evaluate whether OAM peering is allowed.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamFunctionsSupported": { "type": "string", "description": "The OAM functions supported on this Ethernet like interface.\n OAM consists of separate functional sets beyond the basic\n discovery process which is always required. These functional\n groups can be supported independently by any implementation.\n These values are communicated to the peer via the local\n configuration field of Information OAMPDUs. \n \n Setting 'unidirectionalSupport(0)' indicates that the OAM\n entity supports the transmission of OAMPDUs on links that are\n operating in unidirectional mode (traffic flowing in one\n direction only). Setting 'loopbackSupport(1)' indicates the\n OAM entity can initiate and respond to loopback commands.\n Setting 'eventSupport(2)' indicates the OAM entity can send\n and receive Event Notification OAMPDUs. Setting\n 'variableSupport(3)' indicates the OAM entity can send and\n receive Variable Request and Response OAMPDUs.", "readOnly": true } } } }, "CISCO-DOT3-OAM-MIB_cdot3OamPeerEntry": { "type": "array", "description": "cdot3OamPeerEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamPeerMacAddress": { "type": "string", "description": "The MAC address of the peer OAM entity. The MAC address is\n derived from the most recently received OAMPDU.", "x-yang-type": "yang:mac-address", "readOnly": true }, "cdot3OamPeerVendorOui": { "type": "string", "description": "The OUI of the OAM peer as reflected in the latest\n Information OAMPDU received with a Local Information TLV. The\n OUI can be used to identify the vendor of the remote OAM\n entity. This value is initialized to zero before any Local\n Information TLV is received.", "x-yang-type": "CISCO-DOT3-OAM-MIB:Cdot3Oui", "readOnly": true }, "cdot3OamPeerVendorInfo": { "type": "integer", "description": "The Vendor Info of the OAM peer as reflected in the latest\n Information OAMPDU received with a Local Information TLV. The\n vendor information field is within the Local Information TLV,\n and can be used to determine additional information about the\n peer entity. The format of the vendor information is\n unspecified within the 32-bit field. This value is\n initialized to zero before any Local Information TLV is\n received.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamPeerMode": { "type": "string", "description": "The mode of the OAM peer as reflected in the latest\n Information OAMPDU received with a Local Information TLV. The\n mode of the peer can be determined from the Configuration\n field in the Local Information TLV of the last Information\n OAMPDU received from the peer. The value is unknown(3)\n whenever no Local Information TLV has been received. The\n values of active(1) and passive(2) are returned when a Local\n Information TLV has been received indicating the peer is in\n active or passive mode, respectively.", "readOnly": true }, "cdot3OamPeerMaxOamPduSize": { "type": "integer", "description": "The maximum size of OAMPDU supported by the peer as reflected\n in the latest Information OAMPDU received with a Local\n Information TLV. Ethernet OAM on this interface must not use\n OAMPDUs that exceed this size. The maximum OAMPDU size can be\n determined from the PDU Configuration field of the Local\n Information TLV of the last Information OAMPDU received from\n the peer. A value of zero is returned if no Local Information\n TLV has been received. Otherwise, the value of the OAM peer's\n maximum OAMPDU size is returned in this value. \n Note that the values 1..63 are invalid sizes for Ethernet\n frames and should never appear.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamPeerConfigRevision": { "type": "integer", "description": "The configuration revision of the OAM peer as reflected in\n the latest OAMPDU. This attribute is changed by the peer\n whenever it has a local configuration change for Ethernet OAM\n this interface. The configuration revision can be determined\n from the Revision field of the Local Information TLV of the\n most recently received Information OAMPDU with a Local\n Information TLV. A value of zero is returned if no Local\n Information TLV has been received.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamPeerFunctionsSupported": { "type": "string", "description": "The OAM functions supported on this Ethernet like interface.\n OAM consists of separate functionality sets above the basic\n discovery process. This value indicates the capabilities of\n the peer OAM entity with respect to these functions. This\n value is initialized so all bits are clear. \n \n If unidirectionalSupport(0) is set, then the peer OAM entity\n supports sending OAM frames on Ethernet interfaces when the\n receive path is known to be inoperable. If\n loopbackSupport(1) is set, then the peer OAM entity can send\n and receive OAM loopback commands. If eventSupport(2) is set,\n then the peer OAM entity can send and receive event OAMPDUs to\n signal various error conditions. If variableSupport(3) is set,\n then the peer OAM entity can send and receive variable\n requests to monitor attribute value as described in Clause 57\n of [802.3ah]. \n \n The capabilities of the OAM peer can be determined from the\n configuration field of the Local Information TLV of the most\n recently received Information OAMPDU with a Local Information\n TLV. All zeros are returned if no Local Information TLV has\n yet been received.", "readOnly": true } } } }, "CISCO-DOT3-OAM-MIB_cdot3OamLoopbackEntry": { "type": "array", "description": "An entry in the table, containing information on the loopback\n status for a single Ethernet like interface. Entries in the\n table are automatically created whenever the local OAM entity\n supports loopback capabilities. The loopback status on the\n interface can be determined from the cdot3OamLoopbackStatus\n object.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamLoopbackStatus": { "type": "string", "description": "The loopback status of the OAM entity. This status is\n determined by a combination of the local parser and\n multiplexer states, the remote parser and multiplexer states,\n as well as by the actions of the local OAM client. When\n operating in normal mode with no loopback in progress, the\n status reads noLoopback(1). \n \n The values initiatingLooopback(2) and terminatingLoopback(4)\n can be read or written. The other values can only be read -\n they can never be written. Writing initiatingLoopback causes\n the local OAM entity to start the loopback process with its\n peer. This value can only be written when the status is\n noLoopback(1). Writing the value initiatingLoopback(2) in any\n other state has no effect. When in remoteLoopback(3), writing\n terminatingLoopback(4) causes the local OAM entity to initiate\n the termination of the loopback state. Writing\n terminatingLoopack(4) in any other state has no effect. \n If the OAM client initiates a looopback and has sent an\n Loopback OAMPDU and is waiting for a response, where the local\n parser and multiplexer states are DISCARD (see [802.3ah,\n 57.2.11.1]), the status is 'initiatingLoopback'. In this\n case, the local OAM entity has yet to receive any\n acknowledgement that the remote OAM entity has received its\n loopback command request. \n \n If the local OAM client knows that the remote OAM entity is in\n loopback mode (via the remote state information as described\n in [802.3ah, 57.2.11.1, 30.3.6.1.15]), the status is\n remoteLoopback(3). If the local OAM client is in the process\n of terminating the remote loopback [802.3ah, 57.2.11.3,\n 30.3.6.1.14], with its local multiplexer and parser states in\n DISCARD, the status is terminatingLoopback(4). If the remote\n OAM client has put the local OAM entity in loopback mode as\n indicated by its local parser state, the status is\n localLoopback(5). \n \n The unknown(6) status indicates the parser and multiplexer\n combination is unexpected. This status may be returned if the\n OAM loopback is in a transition state but should not persist. \n \n The values of this attribute correspond to the following\n values of the local and remote parser and multiplexer states. \n \n value LclPrsr LclMux RmtPrsr RmtMux\n noLoopback FWD FWD FWD FWD \n initLoopback DISCARD DISCARD FWD FWD \n rmtLoopback DISCARD FWD LPBK DISCARD\n tmtngLoopback DISCARD DISCARD LPBK DISCARD\n lclLoopback LPBK DISCARD DISCARD FWD\n unknown *** any other combination ***", "readOnly": true }, "cdot3OamLoopbackIgnoreRx": { "type": "string", "description": "Since OAM loopback is a disruptive operation (user traffic\n does not pass), this attribute provides a mechanism to provide\n controls over whether received OAM loopback commands are\n processed or ignored. When the value is ignore(1), received\n loopback commands are ignored. When the value is process(2),\n OAM loopback commands are processed. The default value is to\n ignore loopback commands (ignore(1)).", "readOnly": true } } } }, "CISCO-DOT3-OAM-MIB_cdot3OamStatsEntry": { "type": "array", "description": "An entry in the table, containing statistics information on\n the Ethernet OAM function for a single Ethernet like\n interface. Entries are automatically created for every entry\n in the cdot3OamTable. Counters are maintained across\n transitions in cdot3OamOperStatus.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamInformationTx": { "type": "integer", "description": "A count of the number of Information OAMPDUs transmitted on\n this interface.\n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamInformationRx": { "type": "integer", "description": "A count of the number of Information OAMPDUs received on this\n interface.\n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamUniqueEventNotificationTx": { "type": "integer", "description": "A count of the number of unique Event OAMPDUs transmitted on\n this interface. Event notifications may be sent in duplicate\n to increase the probability of successfully being received,\n given the possibility that a frame may be lost in transit.\n Duplicate Event Notification transmissions are counted by\n cdot3OamDuplicateEventNotificationTx. \n \n A unique Event Notification OAMPDU is indicated as an Event\n Notification OAMPDU with a Sequence Number field that is\n distinct from the previously transmitted Event Notification\n OAMPDU Sequence Number. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamUniqueEventNotificationRx": { "type": "integer", "description": "A count of the number of unique Event OAMPDUs received on\n this interface. Event notification OAMPDUs may be sent in\n duplicate to increase the probability of successfully being\n received, given the possibility that a frame may be lost in\n transit. Duplicate Event Notification receptions are counted\n by cdot3OamDuplicateEventNotificationRx. \n \n A unique Event Notification OAMPDU is indicated as an Event\n Notification OAMPDU with a Sequence Number field that is\n distinct from the previously received Event Notification\n OAMPDU Sequence Number. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamDuplicateEventNotificationTx": { "type": "integer", "description": "A count of the number of duplicate Event OAMPDUs transmitted\n on this interface. Event notification OAMPDUs may be sent in\n duplicate to increase the probability of successfully being\n received, given the possibility that a frame may be lost in\n transit. \n \n A duplicate Event Notification OAMPDU is indicated as an Event\n Notification OAMPDU with a Sequence Number field that is\n identical to the previously transmitted Event Notification\n OAMPDU Sequence Number. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamDuplicateEventNotificationRx": { "type": "integer", "description": "A count of the number of duplicate Event OAMPDUs received on\n this interface. Event notification OAMPDUs may be sent in\n duplicate to increase the probability of successfully being\n received, given the possibility that a frame may be lost in\n transit. \n \n A duplicate Event Notification OAMPDU is indicated as an Event\n Notification OAMPDU with a Sequence Number field that is\n identical to the previously received Event Notification OAMPDU\n Sequence Number. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamLoopbackControlTx": { "type": "integer", "description": "A count of the number of Loopback Control OAMPDUs transmitted\n on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamLoopbackControlRx": { "type": "integer", "description": "A count of the number of Loopback Control OAMPDUs received\n on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamVariableRequestTx": { "type": "integer", "description": "A count of the number of Variable Request OAMPDUs transmitted\n on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamVariableRequestRx": { "type": "integer", "description": "A count of the number of Variable Request OAMPDUs received on\n this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamVariableResponseTx": { "type": "integer", "description": "A count of the number of Variable Response OAMPDUs\n transmitted on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamVariableResponseRx": { "type": "integer", "description": "A count of the number of Variable Response OAMPDUs received\n on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamOrgSpecificTx": { "type": "integer", "description": "A count of the number of Organization Specific OAMPDUs\n transmitted on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamOrgSpecificRx": { "type": "integer", "description": "A count of the number of Organization Specific OAMPDUs\n received on this interface. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamUnsupportedCodesTx": { "type": "integer", "description": "A count of the number of OAMPDUs transmitted on this\n interface with an unsupported op-code. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamUnsupportedCodesRx": { "type": "integer", "description": "A count of the number of OAMPDUs received on this interface\n with an unsupported op-code. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamFramesLostDueToOam": { "type": "integer", "description": "A count of the number of frames that were dropped by the OAM\n multiplexer. Since the OAM multiplexer has multiple inputs\n and a single output, there may be cases where frames are\n dropped due to transmit resource contention. This counter is\n incremented whenever a frame is dropped by the OAM layer.\n Note that any Ethernet frame, not just OAMPDUs, may be dropped\n by the OAM layer. This can occur when an OAMPDU takes\n precedence over a 'normal' frame resulting in the 'normal'\n frame being dropped. \n \n When this counter is incremented, no other counters in this\n MIB are incremented. \n \n Discontinuities of this counter can occur at re-initialization\n of the management system, and at other times as indicated by\n the value of the ifCounterDiscontinuityTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } } }, "CISCO-DOT3-OAM-MIB_cdot3OamEventConfigEntry": { "type": "array", "description": "cdot3OamEventConfigEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamErrSymPeriodWindowHi": { "type": "integer", "description": "The two objects cdot3OamErrSymPeriodWindowHi and\n cdot3OamErrSymPeriodLo together form an unsigned 64-bit\n integer representing the number of symbols over which this\n threshold event is defined. This is defined as\n \n cdot3OamErrSymPeriodWindow = ((2^32)*cdot3OamErrSymPeriodWindowHi)\n + cdot3OamErrSymPeriodWindowLo\n \n If cdot3OamErrSymPeriodThreshold symbol errors occur within a\n window of cdot3OamErrSymPeriodWindow symbols, an Event\n Notification OAMPDU should be generated with an Errored Symbol\n Period Event TLV indicating the threshold has been crossed in\n this window. \n \n The default value for cdot3OamErrSymPeriodWindow is the number\n of symbols in one second for the underlying physical layer.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamErrSymPeriodWindowLo": { "type": "integer", "description": "The two objects cdot3OamErrSymPeriodWindowHi and\n cdot3OamErrSymPeriodWindowLo together form an unsigned 64-bit\n integer representing the number of symbols over which this\n threshold event is defined. This is defined as\n \n cdot3OamErrSymPeriodWindow = ((2^32)*cdot3OamErrSymPeriodWindowHi)\n + cdot3OamErrSymPeriodWindowLo\n \n If cdot3OamErrSymPeriodThreshold symbol errors occur within a\n window of cdot3OamErrSymPeriodWindow symbols, an Event\n Notification OAMPDU should be generated with an Errored Symbol\n Period Event TLV indicating the threshold has been crossed in\n this window. \n \n The default value for cdot3OamErrSymPeriodWindow is the number\n of symbols in one second for the underlying physical layer.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamErrSymPeriodThresholdHi": { "type": "integer", "description": "The two objects cdot3OamErrSymPeriodThresholdHi and\n cdot3OamErrSymPeriodThresholdLo together form an unsigned\n 64-bit integer representing the number of symbol errors that\n must occur within a given window to cause this event. \n \n This is defined as\n \n cdot3OamErrSymPeriodThreshold =\n ((2^32) * cdot3OamErrSymPeriodThresholdHi)\n + cdot3OamErrSymPeriodThresholdLo\n \n If cdot3OamErrSymPeriodThreshold symbol errors occur within a\n window of cdot3OamErrSymPeriodWindow symbols, an Event\n Notification OAMPDU should be generated with an Errored Symbol\n Period Event TLV indicating the threshold has been crossed in\n this window. \n \n The default value for cdot3OamErrSymPeriodThreshold is one\n symbol errors. If the threshold value is zero, then an Event\n Notification OAMPDU is sent periodically (at the end of every\n window). This can be used as an asynchronous notification to\n the peer OAM entity of the statistics related to this\n threshold crossing alarm.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamErrSymPeriodThresholdLo": { "type": "integer", "description": "The two objects cdot3OamErrSymPeriodThresholdHi and\n cdot3OamErrSymPeriodThresholdLo together form an unsigned\n 64-bit integer representing the number of symbol errors that\n must occur within a given window to cause this event. \n \n This is defined as\n \n cdot3OamErrSymPeriodThreshold =\n ((2^32) * cdot3OamErrSymPeriodThresholdHi)\n + cdot3OamErrSymPeriodThresholdLo\n \n If cdot3OamErrSymPeriodThreshold symbol errors occur within a\n window of cdot3OamErrSymPeriodWindow symbols, an Event\n Notification OAMPDU should be generated with an Errored Symbol\n Period Event TLV indicating the threshold has been crossed in\n this window. \n \n The default value for cdot3OamErrSymPeriodThreshold is one\n symbol error. If the threshold value is zero, then an Event\n Notification OAMPDU is sent periodically (at the end of every\n window). This can be used as an asynchronous notification to\n the peer OAM entity of the statistics related to this\n threshold crossing alarm.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamErrSymPeriodEvNotifEnable": { "type": "boolean", "description": "If true, the OAM entity should send an Event Notification\n OAMPDU when an Errored Symbol Period Event occurs. \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored.", "readOnly": true }, "cdot3OamErrFramePeriodWindow": { "type": "integer", "description": "The number of frames over which the threshold is defined.\n The default value of the window is the number of minimum size\n Ethernet frames that can be received over the physical layer\n in one second. \n \n If cdot3OamErrFramePeriodThreshold frame errors occur within a\n window of cdot3OamErrFramePeriodWindow frames, an Event\n Notification OAMPDU should be generated with an Errored Frame\n Period Event TLV indicating the threshold has been crossed in\n this window.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamErrFramePeriodThreshold": { "type": "integer", "description": "The number of frame errors that must occur for this event to\n be triggered. The default value is one frame error. If the\n threshold value is zero, then an Event Notification OAMPDU is\n sent periodically (at the end of every window). This can be\n used as an asynchronous notification to the peer OAM entity of\n the statistics related to this threshold crossing alarm.\n \n If cdot3OamErrFramePeriodThreshold frame errors occur within a\n window of cdot3OamErrFramePeriodWindow frames, an Event\n Notification OAMPDU should be generated with an Errored Frame\n Period Event TLV indicating the threshold has been crossed in\n this window.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamErrFramePeriodEvNotifEnable": { "type": "boolean", "description": "If true, the OAM entity should send an Event Notification\n OAMPDU when an Errored Frame Period Event occurs. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored.", "readOnly": true }, "cdot3OamErrFrameWindow": { "type": "integer", "description": "The amount of time (in 100ms increments) over which the\n threshold is defined. The default value is 10 (1 second). \n \n If cdot3OamErrFrameThreshold frame errors occur within a window\n of cdot3OamErrFrameWindow seconds (measured in tenths of\n seconds), an Event Notification OAMPDU should be generated\n with an Errored Frame Event TLV indicating the threshold has\n been crossed in this window.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamErrFrameThreshold": { "type": "integer", "description": "The number of frame errors that must occur for this event to\n be triggered. The default value is one frame error. If the\n threshold value is zero, then an Event Notification OAMPDU is\n sent periodically (at the end of every window). This can be\n used as an asynchronous notification to the peer OAM entity of\n the statistics related to this threshold crossing alarm. \n \n If cdot3OamErrFrameThreshold frame errors occur within a window\n of cdot3OamErrFrameWindow (in tenths of seconds), an Event\n Notification OAMPDU should be generated with an Errored Frame\n Event TLV indicating the threshold has been crossed in this\n window.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamErrFrameEvNotifEnable": { "type": "boolean", "description": "If true, the OAM entity should send an Event Notification\n OAMPDU when an Errored Frame Event occurs. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored.", "readOnly": true }, "cdot3OamErrFrameSecsSummaryWindow": { "type": "integer", "description": "The amount of time (in 100ms intervals) over which the\n threshold is defined. The default value is 100 (10 seconds). \n \n If cdot3OamErrFrameSecsSummaryThreshold frame errors occur\n within a window of cdot3OamErrFrameSecsSummaryWindow (in tenths\n of seconds), an Event Notification OAMPDU should be generated\n with an Errored Frame Seconds Summary Event TLV indicating the\n threshold has been crossed in this window.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cdot3OamErrFrameSecsSummaryThreshold": { "type": "integer", "description": "The number of errored frame seconds that must occur for this\n event to be triggered. The default value is one errored frame\n second. If the threshold value is zero, then an Event\n Notification OAMPDU is sent periodically (at the end of every\n window). This can be used as an asynchronous notification to\n the peer OAM entity of the statistics related to this\n threshold crossing alarm. \n \n If cdot3OamErrFrameSecsSummaryThreshold frame errors occur\n within a window of cdot3OamErrFrameSecsSummaryWindow (in tenths\n of seconds), an Event Notification OAMPDU should be generated\n with an Errored Frame Seconds Summary Event TLV indicating the\n threshold has been crossed in this window.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cdot3OamErrFrameSecsEvNotifEnable": { "type": "boolean", "description": "If true, the local OAM entity should send an Event\n Notification OAMPDU when an Errored Frame Seconds Event\n occurs. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored.", "readOnly": true }, "cdot3OamDyingGaspEnable": { "type": "boolean", "description": "If true, the local OAM entity should attempt to indicate a\n dying gasp via the OAMPDU flags field to its peer OAM entity\n when a dying gasp event occurs. The exact definition of a\n dying gasp event is implementation dependent. If the system\n does not support dying gasp capability, setting this object\n has no effect, and reading the object should always result in\n 'false'. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored.", "readOnly": true }, "cdot3OamCriticalEventEnable": { "type": "boolean", "description": "If true, the local OAM entity should attempt to indicate a\n critical event via the OAMPDU flags to its peer OAM entity\n when a critical event occurs. The exact definition of a\n critical event is implementation dependent. If the system\n does not support critical event capability, setting this\n object has no effect, and reading the object should always\n result in 'false'. \n \n By default, this object should have the value true for\n Ethernet like interfaces that support OAM. If the OAM layer\n does not support event notifications (as indicated via the\n cdot3OamFunctionsSupported attribute), this value is ignored.", "readOnly": true } } } }, "CISCO-DOT3-OAM-MIB_cdot3OamEventLogEntry": { "type": "array", "description": "cdot3OamEventLogEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cdot3OamEventLogIndex": { "type": "integer", "description": "An arbitrary integer for identifying individual events\n within the event log.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamEventLogTimestamp": { "type": "string", "description": "The value of sysUpTime at the time of the logged event. For\n locally generated events, the time of the event can be\n accurately retrieved from sysUpTime. For remotely generated\n events, the time of the event is indicated by the reception of\n the Event Notification OAMPDU indicating the event occurred on\n the peer. A system may attempt to adjust the timestamp value\n to more accurately reflect the time of the event at the peer\n OAM entity by using other information, such as that found in\n the timestamp found of the Event Notification TLVs, which\n provides an indication of the relative time between events at\n the peer entity.", "x-yang-type": "yang:timestamp", "readOnly": true }, "cdot3OamEventLogOui": { "type": "string", "description": "The OUI of the entity defining the object type. All IEEE\n 802.3 defined events (as appearing in [802.3ah] except for the\n Organizationally Unique Event TLVs) use the IEEE 802.3 OUI of\n 0x0180C2. Organizations defining their own Event Notification\n TLVs include their OUI in the Event Notification TLV which\n gets reflected here.", "x-yang-type": "CISCO-DOT3-OAM-MIB:Cdot3Oui", "readOnly": true }, "cdot3OamEventLogType": { "type": "integer", "description": "The type of event that generated this entry in the event log.\n \n When the OUI is the IEEE 802.3 OUI of 0x0180C2, the following\n event types are defined:\n erroredSymbolEvent(1), \n erroredFramePeriodEvent (2), \n erroredFrameEvent(3),\n erroredFrameSecondsEvent(4), \n linkFault(256), \n dyingGaspEvent(257),\n criticalLinkEvent(258)\n The first four are considered threshold crossing events as\n they are generated when a metric exceeds a given value within\n a specified window. The other three are not threshold\n crossing events. \n \n When the OUI is not 71874 (0x0180C2 in hex), then some other\n organization has defined the event space. If event subtyping\n is known to the implementation, it may be reflected here.\n Otherwise, this value should return all Fs (2^32 - 1).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamEventLogLocation": { "type": "string", "description": "Whether this event occurred locally (local(1)), or was \n received from the OAM peer via Ethernet OAM (remote(2)).", "readOnly": true }, "cdot3OamEventLogWindowHi": { "type": "integer", "description": "If the event represents a threshold crossing event, the two\n objects cdot3OamEventWindowHi and cdot3OamEventWindowLo form an\n unsigned 64-bit integer yielding the window over which the\n value was measured for the threshold crossing event (for\n example, 5, when 11 occurrences happened in 5 seconds while\n the threshold was 10). The two objects are combined as:\n \n cdot3OamEventLogWindow = ((2^32) * cdot3OamEventLogWindowHi)\n + cdot3OamEventLogWindowLo\n \n \n Otherwise, this value is returned as all F's (2^32 - 1) and \n adds no useful information.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamEventLogWindowLo": { "type": "integer", "description": "If the event represents a threshold crossing event, the two\n objects cdot3OamEventWindowHi and cdot3OamEventWindowLo form an\n unsigned 64-bit integer yielding the window over which the\n value was measured for the threshold crossing event (for\n example, 5, when 11 occurrences happened in 5 seconds while\n the threshold was 10). The two objects are combined as:\n \n cdot3OamEventLogWindow = ((2^32) * cdot3OamEventLogWindowHi)\n + cdot3OamEventLogWindowLo\n \n Otherwise, this value is returned as all F's (2^32 - 1) and \n adds no useful information.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamEventLogThresholdHi": { "type": "integer", "description": "If the event represents a threshold crossing event, the two\n objects cdot3OamEventThresholdHi and cdot3OamEventThresholdLo\n form an unsigned 64-bit integer yielding the value that was\n crossed for the threshold crossing event (for example, 10,\n when 11 occurrences happened in 5 seconds while the threshold\n was 10). The two objects are combined as:\n \n cdot3OamEventLogThreshold = ((2^32) * cdot3OamEventLogThresholdHi)\n + cdot3OamEventLogThresholdLo\n \n Otherwise, this value is returned as all F's (2^32 -1) and \n adds no useful information.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamEventLogThresholdLo": { "type": "integer", "description": "If the event represents a threshold crossing event, the two\n objects cdot3OamEventThresholdHi and cdot3OamEventThresholdLo\n form an unsigned 64-bit integer yielding the value that was\n crossed for the threshold crossing event (for example, 10,\n when 11 occurrences happened in 5 seconds while the threshold\n was 10). The two objects are combined as:\n \n cdot3OamEventLogThreshold = ((2^32) * cdot3OamEventLogThresholdHi)\n + cdot3OamEventLogThresholdLo\n \n Otherwise, this value is returned as all F's (2^32 - 1) and\n adds no useful information.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdot3OamEventLogValue": { "type": "integer", "description": "If the event represents a threshold crossing event, this\n value indicates the value of the parameter within the given\n window that generated this event (for example, 11, when 11\n occurrences happened in 5 seconds while the threshold was 10). \n \n Otherwise, this value is returned as all F's \n (2^64 - 1) and adds no useful information.", "minimum": 0, "readOnly": true }, "cdot3OamEventLogRunningTotal": { "type": "integer", "description": "Each Event Notification TLV contains a running total of the\n number of times an event has occurred, as well as the number\n of times an Event Notification for the event has been\n transmitted. For non-threshold crossing events, the number of\n events (cdot3OamLogRunningTotal) and the number of resultant\n Event Notifications (cdot3OamLogEventTotal) should be\n identical. \n \n For threshold crossing events, since multiple occurrences may\n be required to cross the threshold, these values are likely\n different. This value represents the total number of times\n this event has happened since the last reset (for example,\n 3253, when 3253 symbol errors have occurred since the last\n reset, which has resulted in 51 symbol error threshold\n crossing events since the last reset).", "minimum": 0, "readOnly": true }, "cdot3OamEventLogEventTotal": { "type": "integer", "description": "Each Event Notification TLV contains a running total of the\n number of times an event has occurred, as well as the number\n of times an Event Notification for the event has been\n transmitted. For non-threshold crossing events, the number of\n events (cdot3OamLogRunningTotal) and the number of resultant\n Event Notifications (cdot3OamLogEventTotal) should be\n identical. \n \n For threshold crossing events, since multiple occurrences may\n be required to cross the threshold, these values are likely\n different. This value represents the total number of times\n one or more of these occurrences have resulted in an Event\n Notification (for example, 51 when 3253 symbol errors have\n occurred since the last reset, which has resulted in 51 symbol\n error threshold crossing events since the last reset).", "minimum": 0, "maximum": 4294967295, "readOnly": true } } } }, "restconf-error": { "type": "object", "description": "Standard RESTCONF error response (RFC 8040 Section 7.1)", "properties": { "ietf-restconf:errors": { "type": "object", "properties": { "error": { "type": "array", "items": { "type": "object", "properties": { "error-type": { "type": "string", "enum": [ "transport", "rpc", "protocol", "application" ], "description": "Layer where the error occurred" }, "error-tag": { "type": "string", "description": "Enumerated error tag (e.g. invalid-value, data-missing, access-denied)" }, "error-severity": { "type": "string", "enum": [ "error", "warning" ], "description": "Error severity" }, "error-app-tag": { "type": "string", "description": "Application-specific error tag" }, "error-path": { "type": "string", "description": "YANG instance-identifier of the error node" }, "error-message": { "type": "string", "description": "Human-readable error description" } }, "required": [ "error-type", "error-tag" ] } } } } }, "example": { "ietf-restconf:errors": { "error": [ { "error-type": "protocol", "error-tag": "invalid-value", "error-severity": "error", "error-message": "Invalid input parameter" } ] } } } }, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } } }, "security": [ { "basicAuth": [] } ], "tags": [ { "name": "CISCO-DOT3-OAM-MIB", "description": "MIB operations for CISCO-DOT3-OAM-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }