{ "openapi": "3.0.0", "info": { "title": "CISCO-ETHER-CFM-MIB MIB API", "version": "1.0.0", "description": "This MIB module defines the managed objects \n and notifications for Ethernet Connectivity \n Fault Management (CFM).\n \n CFM is an end-to-end per service instance Ethernet layer \n Operations, Administration and Management (OAM) protocol. \n \n CFM events include: \n \n - Maintenance End-Point (MEP) coming up: establishing \n connectivity\n \n - Maintenance End-Point going down: losing connectivity\n \n - Maintenance End-Point unknown: unexpected\n \n - Maintenance End-Point missing: expected but not reachable\n \n - Continuity Check Configuration Error: collision in MEP IDs\n \n - Continuity Check Loop: forwarding loop in network\n \n - Continuity Check Cross-connect: cross-connected \n forwarding path.\n \n The following acronyms are used in this module:\n \n - MEP: Maintenance End Point\n \n - MEPID: Maintenance End Point Identifier\n \n - CC: Continuity Check\n \n - CCDB: Continuity Check Database\n \n - SVLAN: Service Provider Virtual Local Area Network\n \n - VLAN: Virtual Local Area Network\n \n - CLI: Command Line Interface.\n \n - OAM: Operations Administration and Management.\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-ETHER-CFM-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/CISCO-ETHER-CFM-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "CISCO-ETHER-CFM-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-ETHER-CFM-MIB:cecCfmEvents": { "get": { "summary": "Get cecCfmEvents data", "description": "Retrieve cecCfmEvents operational data from MIB", "tags": [ "CISCO-ETHER-CFM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This object specifies the maximum upper value supported \n for the cEtherCfmEventIndex index by this agent.", "properties": { "cEtherCfmMaxEventIndex": { "type": "integer", "description": "This object specifies the maximum upper value supported \n for the cEtherCfmEventIndex index by this agent.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-ETHER-CFM-MIB:cecCfmEvents": { "cEtherCfmMaxEventIndex": 1 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cecCfmEvents", "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": "/cecCfmEvents", "x-restconf-kind": "container" }, "/data/CISCO-ETHER-CFM-MIB:cEtherCfmEventTable": { "get": { "summary": "Get cEtherCfmEventTable data", "description": "Retrieve cEtherCfmEventTable operational data from MIB", "tags": [ "CISCO-ETHER-CFM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "cEtherCfmEventTable", "properties": { "cEtherCfmEventEntry": { "type": "array", "description": "An entry in this table is created for every event reported\n by Ethernet CFM.", "items": { "type": "object", "properties": { "cEtherCfmEventDomainIndex": { "type": "integer", "description": "This object represents the ID which uniquely identifies \n a CFM maintenance domain on the device. Every domain can\n be uniquely identified by its user-defined \n name (cEtherCfmEventDomainName) or device-assigned ID (this\n object).", "minimum": 0, "maximum": 4294967295 }, "cEtherCfmEventSvlan": { "type": "string", "description": "The service VLAN identifier of the customer service \n instance to which the event belongs.", "x-yang-type": "q-bridge:VlanId" }, "cEtherCfmEventIndex": { "type": "integer", "description": "A monotonically increasing integer for the sole purpose of\n indexing CFM events. When it reaches the maximum value \n supported by the agent, as defined in the \n cEtherCfmMaxEventIndex object, the agent wraps the value\n back to 1 and may flush existing entries.", "minimum": 0, "maximum": 4294967295 }, "cEtherCfmEventDomainName": { "type": "string", "description": "The name of the CFM maintenance domain.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cEtherCfmEventType": { "type": "string", "description": "This object informs the management station of how to interpret\n the rest of the objects within a row, as summarized in the \n following table:\n \n Legend I: Ignored Object \n V: Valid Object\n \n Object cEtherCfmEventType\n | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8\n ================================================================\n | | | | | | | |\n cEtherCfmEventDomainIndex | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventSvlan | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventIndex | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventLastChange | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventServiceId | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventDomainName | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventLclMepid | I | I | I | V | V | I | I | I\n | | | | | | | |\n cEtherCfmEventLclMacAddress | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventLclMepCount | V | V | I | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventLclIfCount | V | V | I | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventRmtMepid | V | V | V | I | I | V | V | I\n | | | | | | | |\n cEtherCfmEventRmtMacAddress | V | V | V | I | V | V | V | I\n | | | | | | | |\n cEtherCfmEventRmtPortState | V | I | I | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventRmtServiceId | I | I | V | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventCode | V | V | I | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventDeleteRow | V | V | V | V | V | V | V | V\n | | | | | | | |\n \n Note: When reading any ignored object, a value of 0 will \n be returned by the agent." }, "cEtherCfmEventLastChange": { "type": "string", "description": "The value of sysUpTime at the time when this row was created.", "x-yang-type": "yang:timestamp" }, "cEtherCfmEventServiceId": { "type": "string", "description": "The customer service instance to which the event belongs.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cEtherCfmEventLclMepid": { "type": "string", "description": "The identifier of the local MEP impacted by the event.", "x-yang-type": "CISCO-ETHER-CFM-MIB:CfmMepid" }, "cEtherCfmEventLclMacAddress": { "type": "string", "description": "The MAC address of the device reporting the event.", "x-yang-type": "yang:mac-address" }, "cEtherCfmEventLclMepCount": { "type": "integer", "description": "The number of local MEPs affected by the event.", "minimum": 0, "maximum": 4294967295 }, "cEtherCfmEventLclIfCount": { "type": "integer", "description": "The number of local interfaces affected by the event.", "minimum": 0, "maximum": 4294967295 }, "cEtherCfmEventRmtMepid": { "type": "string", "description": "The maintenance end-point identifier of the remote \n MEP causing the event entry to be logged.", "x-yang-type": "CISCO-ETHER-CFM-MIB:CfmMepid" }, "cEtherCfmEventRmtMacAddress": { "type": "string", "description": "The MAC address of the remote maintenance point for which\n the event entry is being logged.", "x-yang-type": "yang:mac-address" }, "cEtherCfmEventRmtPortState": { "type": "string", "description": "The operational state of the port on which the \n remote MEP is configured. This information is \n derived from the port-state as indicated in the \n CC message. The possible values are:\n \n 'up' - The port is operationally up.\n \n 'down' - The port is operationally (but not\n administratively) down.\n \n 'adminDown' - The port is administratively down.\n \n 'test' - The port is in test mode (perhaps \n due to an IEEE Standard 802.3ah OAM\n intrusive loopback operation).\n \n 'remoteExcessiveErrors' - 802.3ah OAM reports that the other \n end of the link is receiving an \n excessive number of invalid frames.\n \n 'localExcessiveErrors' - 802.3ah OAM reports that this end of\n the link is receiving an excessive \n number of invalid frames.\n \n 'localNoData' - No data and no CFM messages have been\n received for an excessive length of \n time." }, "cEtherCfmEventRmtServiceId": { "type": "string", "description": "The ID that the remote device has configured for the \n customer service instance (VLAN).", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cEtherCfmEventCode": { "type": "string", "description": "This object is used in decoding 'mepUp' and 'mepDown' events. \n \n ** For 'mepUp', the following codes are relevant:\n \n 'new' - This is the very first time the device \n receives a CC message from the remote MEP.\n \n 'returning' - The device received a CC message from a \n remote MEP for which it had an expired \n CCDB entry.\n \n 'portState' - The device received a CC message from a \n remote MEP for which it has a valid CCDB \n entry, and the message indicates a port \n status change.\n \n ** For 'mepDown', the following codes are relevant:\n \n 'lastGasp' - The device received a CC message from a\n remote MEP with zero lifetime.\n \n 'timeout' - The local CCDB entry for the remote MEP \n expired.\n \n 'configClear' - A previous CC message from a MEP that\n triggered a configuration error event\n is cleared.\n \n 'loopClear' - A previous CC message from a MEP that\n triggered a loop error event is cleared.\n \n 'xconnectClear' - A previous CC message from a MEP that\n triggered a crossconnect error event \n is cleared.\n \n 'unknownClear' - A previous CC message from a MEP that\n triggered an unknown MEP event is \n cleared." }, "cEtherCfmEventDeleteRow": { "type": "string", "description": "This object allows the management station to \n delete a row in the cEtherCfmEventTable in order\n to free system resources.\n \n When reading this object the value of 'noop' will be \n returned. This object can only be set to 'delete'. \n \n When this object is set to 'delete', the conceptual\n row corresponding to this object will be deleted to\n free system resources. This is equivalent to clearing\n the event log. Should the trigger that caused the event\n to be logged reoccur, the event will be re-asserted but\n in a different conceptual row." } } } } } }, "example": { "CISCO-ETHER-CFM-MIB:cEtherCfmEventTable": { "cEtherCfmEventEntry": [ { "cEtherCfmEventDomainIndex": 1, "cEtherCfmEventSvlan": "example-string", "cEtherCfmEventIndex": 1, "cEtherCfmEventDomainName": "interface-1", "cEtherCfmEventType": "ethernetCsmacd(6)", "cEtherCfmEventLastChange": "example-string", "cEtherCfmEventServiceId": "example-string", "cEtherCfmEventLclMepid": "example-string", "cEtherCfmEventLclMacAddress": "00:11:22:33:44:55", "cEtherCfmEventLclMepCount": 0, "cEtherCfmEventLclIfCount": 0, "cEtherCfmEventRmtMepid": "example-string", "cEtherCfmEventRmtMacAddress": "00:11:22:33:44:55", "cEtherCfmEventRmtPortState": "up(1)", "cEtherCfmEventRmtServiceId": "example-string", "cEtherCfmEventCode": "example-string", "cEtherCfmEventDeleteRow": "example-string" }, { "cEtherCfmEventDomainIndex": 2, "cEtherCfmEventSvlan": "example-string", "cEtherCfmEventIndex": 2, "cEtherCfmEventDomainName": "interface-1", "cEtherCfmEventType": "ethernetCsmacd(6)", "cEtherCfmEventLastChange": "example-string", "cEtherCfmEventServiceId": "example-string", "cEtherCfmEventLclMepid": "example-string", "cEtherCfmEventLclMacAddress": "00:11:22:33:44:55", "cEtherCfmEventLclMepCount": 0, "cEtherCfmEventLclIfCount": 0, "cEtherCfmEventRmtMepid": "example-string", "cEtherCfmEventRmtMacAddress": "00:11:22:33:44:55", "cEtherCfmEventRmtPortState": "up(1)", "cEtherCfmEventRmtServiceId": "example-string", "cEtherCfmEventCode": "example-string", "cEtherCfmEventDeleteRow": "example-string" }, { "cEtherCfmEventDomainIndex": 3, "cEtherCfmEventSvlan": "example-string", "cEtherCfmEventIndex": 3, "cEtherCfmEventDomainName": "interface-1", "cEtherCfmEventType": "ethernetCsmacd(6)", "cEtherCfmEventLastChange": "example-string", "cEtherCfmEventServiceId": "example-string", "cEtherCfmEventLclMepid": "example-string", "cEtherCfmEventLclMacAddress": "00:11:22:33:44:55", "cEtherCfmEventLclMepCount": 0, "cEtherCfmEventLclIfCount": 0, "cEtherCfmEventRmtMepid": "example-string", "cEtherCfmEventRmtMacAddress": "00:11:22:33:44:55", "cEtherCfmEventRmtPortState": "up(1)", "cEtherCfmEventRmtServiceId": "example-string", "cEtherCfmEventCode": "example-string", "cEtherCfmEventDeleteRow": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cEtherCfmEventTable", "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": "/cEtherCfmEventTable", "x-restconf-kind": "container" }, "/data/CISCO-ETHER-CFM-MIB:cEtherCfmEventTable/cEtherCfmEventEntry": { "get": { "summary": "Get cEtherCfmEventEntry list", "description": "Retrieve list of cEtherCfmEventEntry entries from MIB", "tags": [ "CISCO-ETHER-CFM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in this table is created for every event reported\n by Ethernet CFM.", "items": { "type": "object", "properties": { "cEtherCfmEventDomainIndex": { "type": "integer", "description": "This object represents the ID which uniquely identifies \n a CFM maintenance domain on the device. Every domain can\n be uniquely identified by its user-defined \n name (cEtherCfmEventDomainName) or device-assigned ID (this\n object).", "minimum": 0, "maximum": 4294967295 }, "cEtherCfmEventSvlan": { "type": "string", "description": "The service VLAN identifier of the customer service \n instance to which the event belongs.", "x-yang-type": "q-bridge:VlanId" }, "cEtherCfmEventIndex": { "type": "integer", "description": "A monotonically increasing integer for the sole purpose of\n indexing CFM events. When it reaches the maximum value \n supported by the agent, as defined in the \n cEtherCfmMaxEventIndex object, the agent wraps the value\n back to 1 and may flush existing entries.", "minimum": 0, "maximum": 4294967295 }, "cEtherCfmEventDomainName": { "type": "string", "description": "The name of the CFM maintenance domain.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cEtherCfmEventType": { "type": "string", "description": "This object informs the management station of how to interpret\n the rest of the objects within a row, as summarized in the \n following table:\n \n Legend I: Ignored Object \n V: Valid Object\n \n Object cEtherCfmEventType\n | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8\n ================================================================\n | | | | | | | |\n cEtherCfmEventDomainIndex | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventSvlan | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventIndex | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventLastChange | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventServiceId | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventDomainName | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventLclMepid | I | I | I | V | V | I | I | I\n | | | | | | | |\n cEtherCfmEventLclMacAddress | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventLclMepCount | V | V | I | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventLclIfCount | V | V | I | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventRmtMepid | V | V | V | I | I | V | V | I\n | | | | | | | |\n cEtherCfmEventRmtMacAddress | V | V | V | I | V | V | V | I\n | | | | | | | |\n cEtherCfmEventRmtPortState | V | I | I | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventRmtServiceId | I | I | V | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventCode | V | V | I | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventDeleteRow | V | V | V | V | V | V | V | V\n | | | | | | | |\n \n Note: When reading any ignored object, a value of 0 will \n be returned by the agent." }, "cEtherCfmEventLastChange": { "type": "string", "description": "The value of sysUpTime at the time when this row was created.", "x-yang-type": "yang:timestamp" }, "cEtherCfmEventServiceId": { "type": "string", "description": "The customer service instance to which the event belongs.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cEtherCfmEventLclMepid": { "type": "string", "description": "The identifier of the local MEP impacted by the event.", "x-yang-type": "CISCO-ETHER-CFM-MIB:CfmMepid" }, "cEtherCfmEventLclMacAddress": { "type": "string", "description": "The MAC address of the device reporting the event.", "x-yang-type": "yang:mac-address" }, "cEtherCfmEventLclMepCount": { "type": "integer", "description": "The number of local MEPs affected by the event.", "minimum": 0, "maximum": 4294967295 }, "cEtherCfmEventLclIfCount": { "type": "integer", "description": "The number of local interfaces affected by the event.", "minimum": 0, "maximum": 4294967295 }, "cEtherCfmEventRmtMepid": { "type": "string", "description": "The maintenance end-point identifier of the remote \n MEP causing the event entry to be logged.", "x-yang-type": "CISCO-ETHER-CFM-MIB:CfmMepid" }, "cEtherCfmEventRmtMacAddress": { "type": "string", "description": "The MAC address of the remote maintenance point for which\n the event entry is being logged.", "x-yang-type": "yang:mac-address" }, "cEtherCfmEventRmtPortState": { "type": "string", "description": "The operational state of the port on which the \n remote MEP is configured. This information is \n derived from the port-state as indicated in the \n CC message. The possible values are:\n \n 'up' - The port is operationally up.\n \n 'down' - The port is operationally (but not\n administratively) down.\n \n 'adminDown' - The port is administratively down.\n \n 'test' - The port is in test mode (perhaps \n due to an IEEE Standard 802.3ah OAM\n intrusive loopback operation).\n \n 'remoteExcessiveErrors' - 802.3ah OAM reports that the other \n end of the link is receiving an \n excessive number of invalid frames.\n \n 'localExcessiveErrors' - 802.3ah OAM reports that this end of\n the link is receiving an excessive \n number of invalid frames.\n \n 'localNoData' - No data and no CFM messages have been\n received for an excessive length of \n time." }, "cEtherCfmEventRmtServiceId": { "type": "string", "description": "The ID that the remote device has configured for the \n customer service instance (VLAN).", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cEtherCfmEventCode": { "type": "string", "description": "This object is used in decoding 'mepUp' and 'mepDown' events. \n \n ** For 'mepUp', the following codes are relevant:\n \n 'new' - This is the very first time the device \n receives a CC message from the remote MEP.\n \n 'returning' - The device received a CC message from a \n remote MEP for which it had an expired \n CCDB entry.\n \n 'portState' - The device received a CC message from a \n remote MEP for which it has a valid CCDB \n entry, and the message indicates a port \n status change.\n \n ** For 'mepDown', the following codes are relevant:\n \n 'lastGasp' - The device received a CC message from a\n remote MEP with zero lifetime.\n \n 'timeout' - The local CCDB entry for the remote MEP \n expired.\n \n 'configClear' - A previous CC message from a MEP that\n triggered a configuration error event\n is cleared.\n \n 'loopClear' - A previous CC message from a MEP that\n triggered a loop error event is cleared.\n \n 'xconnectClear' - A previous CC message from a MEP that\n triggered a crossconnect error event \n is cleared.\n \n 'unknownClear' - A previous CC message from a MEP that\n triggered an unknown MEP event is \n cleared." }, "cEtherCfmEventDeleteRow": { "type": "string", "description": "This object allows the management station to \n delete a row in the cEtherCfmEventTable in order\n to free system resources.\n \n When reading this object the value of 'noop' will be \n returned. This object can only be set to 'delete'. \n \n When this object is set to 'delete', the conceptual\n row corresponding to this object will be deleted to\n free system resources. This is equivalent to clearing\n the event log. Should the trigger that caused the event\n to be logged reoccur, the event will be re-asserted but\n in a different conceptual row." } } } }, "example": { "CISCO-ETHER-CFM-MIB:cEtherCfmEventEntry": [ { "cEtherCfmEventDomainIndex": 1, "cEtherCfmEventSvlan": "example-string", "cEtherCfmEventIndex": 1, "cEtherCfmEventDomainName": "interface-1", "cEtherCfmEventType": "ethernetCsmacd(6)", "cEtherCfmEventLastChange": "example-string", "cEtherCfmEventServiceId": "example-string", "cEtherCfmEventLclMepid": "example-string", "cEtherCfmEventLclMacAddress": "00:11:22:33:44:55", "cEtherCfmEventLclMepCount": 0, "cEtherCfmEventLclIfCount": 0, "cEtherCfmEventRmtMepid": "example-string", "cEtherCfmEventRmtMacAddress": "00:11:22:33:44:55", "cEtherCfmEventRmtPortState": "up(1)", "cEtherCfmEventRmtServiceId": "example-string", "cEtherCfmEventCode": "example-string", "cEtherCfmEventDeleteRow": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cEtherCfmEventEntry", "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": "/cEtherCfmEventTable/cEtherCfmEventEntry", "x-restconf-kind": "container" }, "/data/CISCO-ETHER-CFM-MIB:cEtherCfmEventEntry": { "get": { "summary": "Get cEtherCfmEventEntry list", "description": "Retrieve list of cEtherCfmEventEntry entries from MIB", "tags": [ "CISCO-ETHER-CFM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in this table is created for every event reported\n by Ethernet CFM.", "items": { "type": "object", "properties": { "cEtherCfmEventDomainIndex": { "type": "integer", "description": "This object represents the ID which uniquely identifies \n a CFM maintenance domain on the device. Every domain can\n be uniquely identified by its user-defined \n name (cEtherCfmEventDomainName) or device-assigned ID (this\n object).", "minimum": 0, "maximum": 4294967295 }, "cEtherCfmEventSvlan": { "type": "string", "description": "The service VLAN identifier of the customer service \n instance to which the event belongs.", "x-yang-type": "q-bridge:VlanId" }, "cEtherCfmEventIndex": { "type": "integer", "description": "A monotonically increasing integer for the sole purpose of\n indexing CFM events. When it reaches the maximum value \n supported by the agent, as defined in the \n cEtherCfmMaxEventIndex object, the agent wraps the value\n back to 1 and may flush existing entries.", "minimum": 0, "maximum": 4294967295 }, "cEtherCfmEventDomainName": { "type": "string", "description": "The name of the CFM maintenance domain.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cEtherCfmEventType": { "type": "string", "description": "This object informs the management station of how to interpret\n the rest of the objects within a row, as summarized in the \n following table:\n \n Legend I: Ignored Object \n V: Valid Object\n \n Object cEtherCfmEventType\n | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8\n ================================================================\n | | | | | | | |\n cEtherCfmEventDomainIndex | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventSvlan | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventIndex | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventLastChange | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventServiceId | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventDomainName | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventLclMepid | I | I | I | V | V | I | I | I\n | | | | | | | |\n cEtherCfmEventLclMacAddress | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventLclMepCount | V | V | I | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventLclIfCount | V | V | I | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventRmtMepid | V | V | V | I | I | V | V | I\n | | | | | | | |\n cEtherCfmEventRmtMacAddress | V | V | V | I | V | V | V | I\n | | | | | | | |\n cEtherCfmEventRmtPortState | V | I | I | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventRmtServiceId | I | I | V | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventCode | V | V | I | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventDeleteRow | V | V | V | V | V | V | V | V\n | | | | | | | |\n \n Note: When reading any ignored object, a value of 0 will \n be returned by the agent." }, "cEtherCfmEventLastChange": { "type": "string", "description": "The value of sysUpTime at the time when this row was created.", "x-yang-type": "yang:timestamp" }, "cEtherCfmEventServiceId": { "type": "string", "description": "The customer service instance to which the event belongs.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cEtherCfmEventLclMepid": { "type": "string", "description": "The identifier of the local MEP impacted by the event.", "x-yang-type": "CISCO-ETHER-CFM-MIB:CfmMepid" }, "cEtherCfmEventLclMacAddress": { "type": "string", "description": "The MAC address of the device reporting the event.", "x-yang-type": "yang:mac-address" }, "cEtherCfmEventLclMepCount": { "type": "integer", "description": "The number of local MEPs affected by the event.", "minimum": 0, "maximum": 4294967295 }, "cEtherCfmEventLclIfCount": { "type": "integer", "description": "The number of local interfaces affected by the event.", "minimum": 0, "maximum": 4294967295 }, "cEtherCfmEventRmtMepid": { "type": "string", "description": "The maintenance end-point identifier of the remote \n MEP causing the event entry to be logged.", "x-yang-type": "CISCO-ETHER-CFM-MIB:CfmMepid" }, "cEtherCfmEventRmtMacAddress": { "type": "string", "description": "The MAC address of the remote maintenance point for which\n the event entry is being logged.", "x-yang-type": "yang:mac-address" }, "cEtherCfmEventRmtPortState": { "type": "string", "description": "The operational state of the port on which the \n remote MEP is configured. This information is \n derived from the port-state as indicated in the \n CC message. The possible values are:\n \n 'up' - The port is operationally up.\n \n 'down' - The port is operationally (but not\n administratively) down.\n \n 'adminDown' - The port is administratively down.\n \n 'test' - The port is in test mode (perhaps \n due to an IEEE Standard 802.3ah OAM\n intrusive loopback operation).\n \n 'remoteExcessiveErrors' - 802.3ah OAM reports that the other \n end of the link is receiving an \n excessive number of invalid frames.\n \n 'localExcessiveErrors' - 802.3ah OAM reports that this end of\n the link is receiving an excessive \n number of invalid frames.\n \n 'localNoData' - No data and no CFM messages have been\n received for an excessive length of \n time." }, "cEtherCfmEventRmtServiceId": { "type": "string", "description": "The ID that the remote device has configured for the \n customer service instance (VLAN).", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cEtherCfmEventCode": { "type": "string", "description": "This object is used in decoding 'mepUp' and 'mepDown' events. \n \n ** For 'mepUp', the following codes are relevant:\n \n 'new' - This is the very first time the device \n receives a CC message from the remote MEP.\n \n 'returning' - The device received a CC message from a \n remote MEP for which it had an expired \n CCDB entry.\n \n 'portState' - The device received a CC message from a \n remote MEP for which it has a valid CCDB \n entry, and the message indicates a port \n status change.\n \n ** For 'mepDown', the following codes are relevant:\n \n 'lastGasp' - The device received a CC message from a\n remote MEP with zero lifetime.\n \n 'timeout' - The local CCDB entry for the remote MEP \n expired.\n \n 'configClear' - A previous CC message from a MEP that\n triggered a configuration error event\n is cleared.\n \n 'loopClear' - A previous CC message from a MEP that\n triggered a loop error event is cleared.\n \n 'xconnectClear' - A previous CC message from a MEP that\n triggered a crossconnect error event \n is cleared.\n \n 'unknownClear' - A previous CC message from a MEP that\n triggered an unknown MEP event is \n cleared." }, "cEtherCfmEventDeleteRow": { "type": "string", "description": "This object allows the management station to \n delete a row in the cEtherCfmEventTable in order\n to free system resources.\n \n When reading this object the value of 'noop' will be \n returned. This object can only be set to 'delete'. \n \n When this object is set to 'delete', the conceptual\n row corresponding to this object will be deleted to\n free system resources. This is equivalent to clearing\n the event log. Should the trigger that caused the event\n to be logged reoccur, the event will be re-asserted but\n in a different conceptual row." } } } }, "example": { "CISCO-ETHER-CFM-MIB:cEtherCfmEventEntry": [ { "cEtherCfmEventDomainIndex": 1, "cEtherCfmEventSvlan": "example-string", "cEtherCfmEventIndex": 1, "cEtherCfmEventDomainName": "interface-1", "cEtherCfmEventType": "ethernetCsmacd(6)", "cEtherCfmEventLastChange": "example-string", "cEtherCfmEventServiceId": "example-string", "cEtherCfmEventLclMepid": "example-string", "cEtherCfmEventLclMacAddress": "00:11:22:33:44:55", "cEtherCfmEventLclMepCount": 0, "cEtherCfmEventLclIfCount": 0, "cEtherCfmEventRmtMepid": "example-string", "cEtherCfmEventRmtMacAddress": "00:11:22:33:44:55", "cEtherCfmEventRmtPortState": "up(1)", "cEtherCfmEventRmtServiceId": "example-string", "cEtherCfmEventCode": "example-string", "cEtherCfmEventDeleteRow": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cEtherCfmEventEntry-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": "/cEtherCfmEventEntry", "x-restconf-kind": "container" }, "/data/CISCO-ETHER-CFM-MIB:cEtherCfmEventTable/cEtherCfmEventEntry={cEtherCfmEventDomainIndex},{cEtherCfmEventSvlan},{cEtherCfmEventIndex}": { "get": { "summary": "Get cEtherCfmEventEntry entry", "description": "Retrieve specific cEtherCfmEventEntry entry by key from MIB", "tags": [ "CISCO-ETHER-CFM-MIB" ], "parameters": [ { "name": "cEtherCfmEventDomainIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cEtherCfmEventSvlan", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cEtherCfmEventIndex", "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": { "cEtherCfmEventDomainIndex": { "type": "integer", "description": "This object represents the ID which uniquely identifies \n a CFM maintenance domain on the device. Every domain can\n be uniquely identified by its user-defined \n name (cEtherCfmEventDomainName) or device-assigned ID (this\n object).", "minimum": 0, "maximum": 4294967295 }, "cEtherCfmEventSvlan": { "type": "string", "description": "The service VLAN identifier of the customer service \n instance to which the event belongs.", "x-yang-type": "q-bridge:VlanId" }, "cEtherCfmEventIndex": { "type": "integer", "description": "A monotonically increasing integer for the sole purpose of\n indexing CFM events. When it reaches the maximum value \n supported by the agent, as defined in the \n cEtherCfmMaxEventIndex object, the agent wraps the value\n back to 1 and may flush existing entries.", "minimum": 0, "maximum": 4294967295 }, "cEtherCfmEventDomainName": { "type": "string", "description": "The name of the CFM maintenance domain.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cEtherCfmEventType": { "type": "string", "description": "This object informs the management station of how to interpret\n the rest of the objects within a row, as summarized in the \n following table:\n \n Legend I: Ignored Object \n V: Valid Object\n \n Object cEtherCfmEventType\n | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8\n ================================================================\n | | | | | | | |\n cEtherCfmEventDomainIndex | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventSvlan | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventIndex | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventLastChange | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventServiceId | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventDomainName | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventLclMepid | I | I | I | V | V | I | I | I\n | | | | | | | |\n cEtherCfmEventLclMacAddress | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventLclMepCount | V | V | I | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventLclIfCount | V | V | I | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventRmtMepid | V | V | V | I | I | V | V | I\n | | | | | | | |\n cEtherCfmEventRmtMacAddress | V | V | V | I | V | V | V | I\n | | | | | | | |\n cEtherCfmEventRmtPortState | V | I | I | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventRmtServiceId | I | I | V | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventCode | V | V | I | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventDeleteRow | V | V | V | V | V | V | V | V\n | | | | | | | |\n \n Note: When reading any ignored object, a value of 0 will \n be returned by the agent." }, "cEtherCfmEventLastChange": { "type": "string", "description": "The value of sysUpTime at the time when this row was created.", "x-yang-type": "yang:timestamp" }, "cEtherCfmEventServiceId": { "type": "string", "description": "The customer service instance to which the event belongs.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cEtherCfmEventLclMepid": { "type": "string", "description": "The identifier of the local MEP impacted by the event.", "x-yang-type": "CISCO-ETHER-CFM-MIB:CfmMepid" }, "cEtherCfmEventLclMacAddress": { "type": "string", "description": "The MAC address of the device reporting the event.", "x-yang-type": "yang:mac-address" }, "cEtherCfmEventLclMepCount": { "type": "integer", "description": "The number of local MEPs affected by the event.", "minimum": 0, "maximum": 4294967295 }, "cEtherCfmEventLclIfCount": { "type": "integer", "description": "The number of local interfaces affected by the event.", "minimum": 0, "maximum": 4294967295 }, "cEtherCfmEventRmtMepid": { "type": "string", "description": "The maintenance end-point identifier of the remote \n MEP causing the event entry to be logged.", "x-yang-type": "CISCO-ETHER-CFM-MIB:CfmMepid" }, "cEtherCfmEventRmtMacAddress": { "type": "string", "description": "The MAC address of the remote maintenance point for which\n the event entry is being logged.", "x-yang-type": "yang:mac-address" }, "cEtherCfmEventRmtPortState": { "type": "string", "description": "The operational state of the port on which the \n remote MEP is configured. This information is \n derived from the port-state as indicated in the \n CC message. The possible values are:\n \n 'up' - The port is operationally up.\n \n 'down' - The port is operationally (but not\n administratively) down.\n \n 'adminDown' - The port is administratively down.\n \n 'test' - The port is in test mode (perhaps \n due to an IEEE Standard 802.3ah OAM\n intrusive loopback operation).\n \n 'remoteExcessiveErrors' - 802.3ah OAM reports that the other \n end of the link is receiving an \n excessive number of invalid frames.\n \n 'localExcessiveErrors' - 802.3ah OAM reports that this end of\n the link is receiving an excessive \n number of invalid frames.\n \n 'localNoData' - No data and no CFM messages have been\n received for an excessive length of \n time." }, "cEtherCfmEventRmtServiceId": { "type": "string", "description": "The ID that the remote device has configured for the \n customer service instance (VLAN).", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cEtherCfmEventCode": { "type": "string", "description": "This object is used in decoding 'mepUp' and 'mepDown' events. \n \n ** For 'mepUp', the following codes are relevant:\n \n 'new' - This is the very first time the device \n receives a CC message from the remote MEP.\n \n 'returning' - The device received a CC message from a \n remote MEP for which it had an expired \n CCDB entry.\n \n 'portState' - The device received a CC message from a \n remote MEP for which it has a valid CCDB \n entry, and the message indicates a port \n status change.\n \n ** For 'mepDown', the following codes are relevant:\n \n 'lastGasp' - The device received a CC message from a\n remote MEP with zero lifetime.\n \n 'timeout' - The local CCDB entry for the remote MEP \n expired.\n \n 'configClear' - A previous CC message from a MEP that\n triggered a configuration error event\n is cleared.\n \n 'loopClear' - A previous CC message from a MEP that\n triggered a loop error event is cleared.\n \n 'xconnectClear' - A previous CC message from a MEP that\n triggered a crossconnect error event \n is cleared.\n \n 'unknownClear' - A previous CC message from a MEP that\n triggered an unknown MEP event is \n cleared." }, "cEtherCfmEventDeleteRow": { "type": "string", "description": "This object allows the management station to \n delete a row in the cEtherCfmEventTable in order\n to free system resources.\n \n When reading this object the value of 'noop' will be \n returned. This object can only be set to 'delete'. \n \n When this object is set to 'delete', the conceptual\n row corresponding to this object will be deleted to\n free system resources. This is equivalent to clearing\n the event log. Should the trigger that caused the event\n to be logged reoccur, the event will be re-asserted but\n in a different conceptual row." } } }, "example": { "CISCO-ETHER-CFM-MIB:cEtherCfmEventEntry": { "cEtherCfmEventDomainIndex": 1, "cEtherCfmEventSvlan": "example-string", "cEtherCfmEventIndex": 1, "cEtherCfmEventDomainName": "interface-1", "cEtherCfmEventType": "ethernetCsmacd(6)", "cEtherCfmEventLastChange": "example-string", "cEtherCfmEventServiceId": "example-string", "cEtherCfmEventLclMepid": "example-string", "cEtherCfmEventLclMacAddress": "00:11:22:33:44:55", "cEtherCfmEventLclMepCount": 0, "cEtherCfmEventLclIfCount": 0, "cEtherCfmEventRmtMepid": "example-string", "cEtherCfmEventRmtMacAddress": "00:11:22:33:44:55", "cEtherCfmEventRmtPortState": "up(1)", "cEtherCfmEventRmtServiceId": "example-string", "cEtherCfmEventCode": "example-string", "cEtherCfmEventDeleteRow": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cEtherCfmEventEntry-2" }, "x-yang-path": "/cEtherCfmEventTable/cEtherCfmEventEntry={cEtherCfmEventDomainIndex cEtherCfmEventSvlan cEtherCfmEventIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cEtherCfmEventDomainIndex cEtherCfmEventSvlan cEtherCfmEventIndex" ] }, "/data/CISCO-ETHER-CFM-MIB:cEtherCfmEventEntry={cEtherCfmEventDomainIndex},{cEtherCfmEventSvlan},{cEtherCfmEventIndex}": { "get": { "summary": "Get cEtherCfmEventEntry entry", "description": "Retrieve specific cEtherCfmEventEntry entry by key from MIB", "tags": [ "CISCO-ETHER-CFM-MIB" ], "parameters": [ { "name": "cEtherCfmEventDomainIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cEtherCfmEventSvlan", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cEtherCfmEventIndex", "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": { "cEtherCfmEventDomainIndex": { "type": "integer", "description": "This object represents the ID which uniquely identifies \n a CFM maintenance domain on the device. Every domain can\n be uniquely identified by its user-defined \n name (cEtherCfmEventDomainName) or device-assigned ID (this\n object).", "minimum": 0, "maximum": 4294967295 }, "cEtherCfmEventSvlan": { "type": "string", "description": "The service VLAN identifier of the customer service \n instance to which the event belongs.", "x-yang-type": "q-bridge:VlanId" }, "cEtherCfmEventIndex": { "type": "integer", "description": "A monotonically increasing integer for the sole purpose of\n indexing CFM events. When it reaches the maximum value \n supported by the agent, as defined in the \n cEtherCfmMaxEventIndex object, the agent wraps the value\n back to 1 and may flush existing entries.", "minimum": 0, "maximum": 4294967295 }, "cEtherCfmEventDomainName": { "type": "string", "description": "The name of the CFM maintenance domain.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cEtherCfmEventType": { "type": "string", "description": "This object informs the management station of how to interpret\n the rest of the objects within a row, as summarized in the \n following table:\n \n Legend I: Ignored Object \n V: Valid Object\n \n Object cEtherCfmEventType\n | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8\n ================================================================\n | | | | | | | |\n cEtherCfmEventDomainIndex | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventSvlan | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventIndex | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventLastChange | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventServiceId | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventDomainName | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventLclMepid | I | I | I | V | V | I | I | I\n | | | | | | | |\n cEtherCfmEventLclMacAddress | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventLclMepCount | V | V | I | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventLclIfCount | V | V | I | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventRmtMepid | V | V | V | I | I | V | V | I\n | | | | | | | |\n cEtherCfmEventRmtMacAddress | V | V | V | I | V | V | V | I\n | | | | | | | |\n cEtherCfmEventRmtPortState | V | I | I | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventRmtServiceId | I | I | V | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventCode | V | V | I | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventDeleteRow | V | V | V | V | V | V | V | V\n | | | | | | | |\n \n Note: When reading any ignored object, a value of 0 will \n be returned by the agent." }, "cEtherCfmEventLastChange": { "type": "string", "description": "The value of sysUpTime at the time when this row was created.", "x-yang-type": "yang:timestamp" }, "cEtherCfmEventServiceId": { "type": "string", "description": "The customer service instance to which the event belongs.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cEtherCfmEventLclMepid": { "type": "string", "description": "The identifier of the local MEP impacted by the event.", "x-yang-type": "CISCO-ETHER-CFM-MIB:CfmMepid" }, "cEtherCfmEventLclMacAddress": { "type": "string", "description": "The MAC address of the device reporting the event.", "x-yang-type": "yang:mac-address" }, "cEtherCfmEventLclMepCount": { "type": "integer", "description": "The number of local MEPs affected by the event.", "minimum": 0, "maximum": 4294967295 }, "cEtherCfmEventLclIfCount": { "type": "integer", "description": "The number of local interfaces affected by the event.", "minimum": 0, "maximum": 4294967295 }, "cEtherCfmEventRmtMepid": { "type": "string", "description": "The maintenance end-point identifier of the remote \n MEP causing the event entry to be logged.", "x-yang-type": "CISCO-ETHER-CFM-MIB:CfmMepid" }, "cEtherCfmEventRmtMacAddress": { "type": "string", "description": "The MAC address of the remote maintenance point for which\n the event entry is being logged.", "x-yang-type": "yang:mac-address" }, "cEtherCfmEventRmtPortState": { "type": "string", "description": "The operational state of the port on which the \n remote MEP is configured. This information is \n derived from the port-state as indicated in the \n CC message. The possible values are:\n \n 'up' - The port is operationally up.\n \n 'down' - The port is operationally (but not\n administratively) down.\n \n 'adminDown' - The port is administratively down.\n \n 'test' - The port is in test mode (perhaps \n due to an IEEE Standard 802.3ah OAM\n intrusive loopback operation).\n \n 'remoteExcessiveErrors' - 802.3ah OAM reports that the other \n end of the link is receiving an \n excessive number of invalid frames.\n \n 'localExcessiveErrors' - 802.3ah OAM reports that this end of\n the link is receiving an excessive \n number of invalid frames.\n \n 'localNoData' - No data and no CFM messages have been\n received for an excessive length of \n time." }, "cEtherCfmEventRmtServiceId": { "type": "string", "description": "The ID that the remote device has configured for the \n customer service instance (VLAN).", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cEtherCfmEventCode": { "type": "string", "description": "This object is used in decoding 'mepUp' and 'mepDown' events. \n \n ** For 'mepUp', the following codes are relevant:\n \n 'new' - This is the very first time the device \n receives a CC message from the remote MEP.\n \n 'returning' - The device received a CC message from a \n remote MEP for which it had an expired \n CCDB entry.\n \n 'portState' - The device received a CC message from a \n remote MEP for which it has a valid CCDB \n entry, and the message indicates a port \n status change.\n \n ** For 'mepDown', the following codes are relevant:\n \n 'lastGasp' - The device received a CC message from a\n remote MEP with zero lifetime.\n \n 'timeout' - The local CCDB entry for the remote MEP \n expired.\n \n 'configClear' - A previous CC message from a MEP that\n triggered a configuration error event\n is cleared.\n \n 'loopClear' - A previous CC message from a MEP that\n triggered a loop error event is cleared.\n \n 'xconnectClear' - A previous CC message from a MEP that\n triggered a crossconnect error event \n is cleared.\n \n 'unknownClear' - A previous CC message from a MEP that\n triggered an unknown MEP event is \n cleared." }, "cEtherCfmEventDeleteRow": { "type": "string", "description": "This object allows the management station to \n delete a row in the cEtherCfmEventTable in order\n to free system resources.\n \n When reading this object the value of 'noop' will be \n returned. This object can only be set to 'delete'. \n \n When this object is set to 'delete', the conceptual\n row corresponding to this object will be deleted to\n free system resources. This is equivalent to clearing\n the event log. Should the trigger that caused the event\n to be logged reoccur, the event will be re-asserted but\n in a different conceptual row." } } }, "example": { "CISCO-ETHER-CFM-MIB:cEtherCfmEventEntry": { "cEtherCfmEventDomainIndex": 1, "cEtherCfmEventSvlan": "example-string", "cEtherCfmEventIndex": 1, "cEtherCfmEventDomainName": "interface-1", "cEtherCfmEventType": "ethernetCsmacd(6)", "cEtherCfmEventLastChange": "example-string", "cEtherCfmEventServiceId": "example-string", "cEtherCfmEventLclMepid": "example-string", "cEtherCfmEventLclMacAddress": "00:11:22:33:44:55", "cEtherCfmEventLclMepCount": 0, "cEtherCfmEventLclIfCount": 0, "cEtherCfmEventRmtMepid": "example-string", "cEtherCfmEventRmtMacAddress": "00:11:22:33:44:55", "cEtherCfmEventRmtPortState": "up(1)", "cEtherCfmEventRmtServiceId": "example-string", "cEtherCfmEventCode": "example-string", "cEtherCfmEventDeleteRow": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cEtherCfmEventEntry-4" }, "x-yang-path": "/cEtherCfmEventEntry={cEtherCfmEventDomainIndex cEtherCfmEventSvlan cEtherCfmEventIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cEtherCfmEventDomainIndex cEtherCfmEventSvlan cEtherCfmEventIndex" ] } }, "components": { "schemas": { "CISCO-ETHER-CFM-MIB_CISCO-ETHER-CFM-MIB": { "type": "object", "description": "This object specifies the maximum upper value supported \n for the cEtherCfmEventIndex index by this agent.", "properties": { "cEtherCfmEventEntry": { "type": "array", "description": "An entry in this table is created for every event reported\n by Ethernet CFM.", "items": { "type": "object", "properties": { "cEtherCfmEventDomainIndex": { "type": "integer", "description": "This object represents the ID which uniquely identifies \n a CFM maintenance domain on the device. Every domain can\n be uniquely identified by its user-defined \n name (cEtherCfmEventDomainName) or device-assigned ID (this\n object).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cEtherCfmEventSvlan": { "type": "string", "description": "The service VLAN identifier of the customer service \n instance to which the event belongs.", "x-yang-type": "q-bridge:VlanId", "readOnly": true }, "cEtherCfmEventIndex": { "type": "integer", "description": "A monotonically increasing integer for the sole purpose of\n indexing CFM events. When it reaches the maximum value \n supported by the agent, as defined in the \n cEtherCfmMaxEventIndex object, the agent wraps the value\n back to 1 and may flush existing entries.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cEtherCfmEventDomainName": { "type": "string", "description": "The name of the CFM maintenance domain.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cEtherCfmEventType": { "type": "string", "description": "This object informs the management station of how to interpret\n the rest of the objects within a row, as summarized in the \n following table:\n \n Legend I: Ignored Object \n V: Valid Object\n \n Object cEtherCfmEventType\n | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8\n ================================================================\n | | | | | | | |\n cEtherCfmEventDomainIndex | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventSvlan | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventIndex | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventLastChange | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventServiceId | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventDomainName | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventLclMepid | I | I | I | V | V | I | I | I\n | | | | | | | |\n cEtherCfmEventLclMacAddress | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventLclMepCount | V | V | I | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventLclIfCount | V | V | I | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventRmtMepid | V | V | V | I | I | V | V | I\n | | | | | | | |\n cEtherCfmEventRmtMacAddress | V | V | V | I | V | V | V | I\n | | | | | | | |\n cEtherCfmEventRmtPortState | V | I | I | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventRmtServiceId | I | I | V | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventCode | V | V | I | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventDeleteRow | V | V | V | V | V | V | V | V\n | | | | | | | |\n \n Note: When reading any ignored object, a value of 0 will \n be returned by the agent.", "readOnly": true }, "cEtherCfmEventLastChange": { "type": "string", "description": "The value of sysUpTime at the time when this row was created.", "x-yang-type": "yang:timestamp", "readOnly": true }, "cEtherCfmEventServiceId": { "type": "string", "description": "The customer service instance to which the event belongs.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cEtherCfmEventLclMepid": { "type": "string", "description": "The identifier of the local MEP impacted by the event.", "x-yang-type": "CISCO-ETHER-CFM-MIB:CfmMepid", "readOnly": true }, "cEtherCfmEventLclMacAddress": { "type": "string", "description": "The MAC address of the device reporting the event.", "x-yang-type": "yang:mac-address", "readOnly": true }, "cEtherCfmEventLclMepCount": { "type": "integer", "description": "The number of local MEPs affected by the event.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cEtherCfmEventLclIfCount": { "type": "integer", "description": "The number of local interfaces affected by the event.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cEtherCfmEventRmtMepid": { "type": "string", "description": "The maintenance end-point identifier of the remote \n MEP causing the event entry to be logged.", "x-yang-type": "CISCO-ETHER-CFM-MIB:CfmMepid", "readOnly": true }, "cEtherCfmEventRmtMacAddress": { "type": "string", "description": "The MAC address of the remote maintenance point for which\n the event entry is being logged.", "x-yang-type": "yang:mac-address", "readOnly": true }, "cEtherCfmEventRmtPortState": { "type": "string", "description": "The operational state of the port on which the \n remote MEP is configured. This information is \n derived from the port-state as indicated in the \n CC message. The possible values are:\n \n 'up' - The port is operationally up.\n \n 'down' - The port is operationally (but not\n administratively) down.\n \n 'adminDown' - The port is administratively down.\n \n 'test' - The port is in test mode (perhaps \n due to an IEEE Standard 802.3ah OAM\n intrusive loopback operation).\n \n 'remoteExcessiveErrors' - 802.3ah OAM reports that the other \n end of the link is receiving an \n excessive number of invalid frames.\n \n 'localExcessiveErrors' - 802.3ah OAM reports that this end of\n the link is receiving an excessive \n number of invalid frames.\n \n 'localNoData' - No data and no CFM messages have been\n received for an excessive length of \n time.", "readOnly": true }, "cEtherCfmEventRmtServiceId": { "type": "string", "description": "The ID that the remote device has configured for the \n customer service instance (VLAN).", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cEtherCfmEventCode": { "type": "string", "description": "This object is used in decoding 'mepUp' and 'mepDown' events. \n \n ** For 'mepUp', the following codes are relevant:\n \n 'new' - This is the very first time the device \n receives a CC message from the remote MEP.\n \n 'returning' - The device received a CC message from a \n remote MEP for which it had an expired \n CCDB entry.\n \n 'portState' - The device received a CC message from a \n remote MEP for which it has a valid CCDB \n entry, and the message indicates a port \n status change.\n \n ** For 'mepDown', the following codes are relevant:\n \n 'lastGasp' - The device received a CC message from a\n remote MEP with zero lifetime.\n \n 'timeout' - The local CCDB entry for the remote MEP \n expired.\n \n 'configClear' - A previous CC message from a MEP that\n triggered a configuration error event\n is cleared.\n \n 'loopClear' - A previous CC message from a MEP that\n triggered a loop error event is cleared.\n \n 'xconnectClear' - A previous CC message from a MEP that\n triggered a crossconnect error event \n is cleared.\n \n 'unknownClear' - A previous CC message from a MEP that\n triggered an unknown MEP event is \n cleared.", "readOnly": true }, "cEtherCfmEventDeleteRow": { "type": "string", "description": "This object allows the management station to \n delete a row in the cEtherCfmEventTable in order\n to free system resources.\n \n When reading this object the value of 'noop' will be \n returned. This object can only be set to 'delete'. \n \n When this object is set to 'delete', the conceptual\n row corresponding to this object will be deleted to\n free system resources. This is equivalent to clearing\n the event log. Should the trigger that caused the event\n to be logged reoccur, the event will be re-asserted but\n in a different conceptual row.", "readOnly": true } } }, "readOnly": true }, "cecCfmEvents": { "type": "object", "description": "This object specifies the maximum upper value supported \n for the cEtherCfmEventIndex index by this agent.", "properties": { "cEtherCfmMaxEventIndex": { "type": "integer", "description": "This object specifies the maximum upper value supported \n for the cEtherCfmEventIndex index by this agent.", "minimum": 0, "maximum": 4294967295, "readOnly": true } }, "readOnly": true }, "cEtherCfmEventTable": { "type": "object", "description": "cEtherCfmEventTable", "properties": { "cEtherCfmEventEntry": { "type": "array", "description": "An entry in this table is created for every event reported\n by Ethernet CFM.", "items": { "type": "object", "properties": { "cEtherCfmEventDomainIndex": { "type": "integer", "description": "This object represents the ID which uniquely identifies \n a CFM maintenance domain on the device. Every domain can\n be uniquely identified by its user-defined \n name (cEtherCfmEventDomainName) or device-assigned ID (this\n object).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cEtherCfmEventSvlan": { "type": "string", "description": "The service VLAN identifier of the customer service \n instance to which the event belongs.", "x-yang-type": "q-bridge:VlanId", "readOnly": true }, "cEtherCfmEventIndex": { "type": "integer", "description": "A monotonically increasing integer for the sole purpose of\n indexing CFM events. When it reaches the maximum value \n supported by the agent, as defined in the \n cEtherCfmMaxEventIndex object, the agent wraps the value\n back to 1 and may flush existing entries.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cEtherCfmEventDomainName": { "type": "string", "description": "The name of the CFM maintenance domain.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cEtherCfmEventType": { "type": "string", "description": "This object informs the management station of how to interpret\n the rest of the objects within a row, as summarized in the \n following table:\n \n Legend I: Ignored Object \n V: Valid Object\n \n Object cEtherCfmEventType\n | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8\n ================================================================\n | | | | | | | |\n cEtherCfmEventDomainIndex | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventSvlan | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventIndex | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventLastChange | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventServiceId | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventDomainName | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventLclMepid | I | I | I | V | V | I | I | I\n | | | | | | | |\n cEtherCfmEventLclMacAddress | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventLclMepCount | V | V | I | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventLclIfCount | V | V | I | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventRmtMepid | V | V | V | I | I | V | V | I\n | | | | | | | |\n cEtherCfmEventRmtMacAddress | V | V | V | I | V | V | V | I\n | | | | | | | |\n cEtherCfmEventRmtPortState | V | I | I | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventRmtServiceId | I | I | V | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventCode | V | V | I | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventDeleteRow | V | V | V | V | V | V | V | V\n | | | | | | | |\n \n Note: When reading any ignored object, a value of 0 will \n be returned by the agent.", "readOnly": true }, "cEtherCfmEventLastChange": { "type": "string", "description": "The value of sysUpTime at the time when this row was created.", "x-yang-type": "yang:timestamp", "readOnly": true }, "cEtherCfmEventServiceId": { "type": "string", "description": "The customer service instance to which the event belongs.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cEtherCfmEventLclMepid": { "type": "string", "description": "The identifier of the local MEP impacted by the event.", "x-yang-type": "CISCO-ETHER-CFM-MIB:CfmMepid", "readOnly": true }, "cEtherCfmEventLclMacAddress": { "type": "string", "description": "The MAC address of the device reporting the event.", "x-yang-type": "yang:mac-address", "readOnly": true }, "cEtherCfmEventLclMepCount": { "type": "integer", "description": "The number of local MEPs affected by the event.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cEtherCfmEventLclIfCount": { "type": "integer", "description": "The number of local interfaces affected by the event.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cEtherCfmEventRmtMepid": { "type": "string", "description": "The maintenance end-point identifier of the remote \n MEP causing the event entry to be logged.", "x-yang-type": "CISCO-ETHER-CFM-MIB:CfmMepid", "readOnly": true }, "cEtherCfmEventRmtMacAddress": { "type": "string", "description": "The MAC address of the remote maintenance point for which\n the event entry is being logged.", "x-yang-type": "yang:mac-address", "readOnly": true }, "cEtherCfmEventRmtPortState": { "type": "string", "description": "The operational state of the port on which the \n remote MEP is configured. This information is \n derived from the port-state as indicated in the \n CC message. The possible values are:\n \n 'up' - The port is operationally up.\n \n 'down' - The port is operationally (but not\n administratively) down.\n \n 'adminDown' - The port is administratively down.\n \n 'test' - The port is in test mode (perhaps \n due to an IEEE Standard 802.3ah OAM\n intrusive loopback operation).\n \n 'remoteExcessiveErrors' - 802.3ah OAM reports that the other \n end of the link is receiving an \n excessive number of invalid frames.\n \n 'localExcessiveErrors' - 802.3ah OAM reports that this end of\n the link is receiving an excessive \n number of invalid frames.\n \n 'localNoData' - No data and no CFM messages have been\n received for an excessive length of \n time.", "readOnly": true }, "cEtherCfmEventRmtServiceId": { "type": "string", "description": "The ID that the remote device has configured for the \n customer service instance (VLAN).", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cEtherCfmEventCode": { "type": "string", "description": "This object is used in decoding 'mepUp' and 'mepDown' events. \n \n ** For 'mepUp', the following codes are relevant:\n \n 'new' - This is the very first time the device \n receives a CC message from the remote MEP.\n \n 'returning' - The device received a CC message from a \n remote MEP for which it had an expired \n CCDB entry.\n \n 'portState' - The device received a CC message from a \n remote MEP for which it has a valid CCDB \n entry, and the message indicates a port \n status change.\n \n ** For 'mepDown', the following codes are relevant:\n \n 'lastGasp' - The device received a CC message from a\n remote MEP with zero lifetime.\n \n 'timeout' - The local CCDB entry for the remote MEP \n expired.\n \n 'configClear' - A previous CC message from a MEP that\n triggered a configuration error event\n is cleared.\n \n 'loopClear' - A previous CC message from a MEP that\n triggered a loop error event is cleared.\n \n 'xconnectClear' - A previous CC message from a MEP that\n triggered a crossconnect error event \n is cleared.\n \n 'unknownClear' - A previous CC message from a MEP that\n triggered an unknown MEP event is \n cleared.", "readOnly": true }, "cEtherCfmEventDeleteRow": { "type": "string", "description": "This object allows the management station to \n delete a row in the cEtherCfmEventTable in order\n to free system resources.\n \n When reading this object the value of 'noop' will be \n returned. This object can only be set to 'delete'. \n \n When this object is set to 'delete', the conceptual\n row corresponding to this object will be deleted to\n free system resources. This is equivalent to clearing\n the event log. Should the trigger that caused the event\n to be logged reoccur, the event will be re-asserted but\n in a different conceptual row.", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "CISCO-ETHER-CFM-MIB_object-1": { "type": "object", "description": "object-1", "properties": { "cEtherCfmEventDomainIndex": { "type": "string", "description": "cEtherCfmEventDomainIndex", "x-yang-type": "leafref", "readOnly": true }, "cEtherCfmEventSvlan": { "type": "string", "description": "cEtherCfmEventSvlan", "x-yang-type": "leafref", "readOnly": true }, "cEtherCfmEventIndex": { "type": "string", "description": "cEtherCfmEventIndex", "x-yang-type": "leafref", "readOnly": true }, "cEtherCfmEventServiceId": { "type": "string", "description": "cEtherCfmEventServiceId", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-ETHER-CFM-MIB_object-2": { "type": "object", "description": "object-2", "properties": { "cEtherCfmEventDomainIndex": { "type": "string", "description": "cEtherCfmEventDomainIndex", "x-yang-type": "leafref", "readOnly": true }, "cEtherCfmEventSvlan": { "type": "string", "description": "cEtherCfmEventSvlan", "x-yang-type": "leafref", "readOnly": true }, "cEtherCfmEventIndex": { "type": "string", "description": "cEtherCfmEventIndex", "x-yang-type": "leafref", "readOnly": true }, "cEtherCfmEventLclMacAddress": { "type": "string", "description": "cEtherCfmEventLclMacAddress", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-ETHER-CFM-MIB_object-3": { "type": "object", "description": "object-3", "properties": { "cEtherCfmEventDomainIndex": { "type": "string", "description": "cEtherCfmEventDomainIndex", "x-yang-type": "leafref", "readOnly": true }, "cEtherCfmEventSvlan": { "type": "string", "description": "cEtherCfmEventSvlan", "x-yang-type": "leafref", "readOnly": true }, "cEtherCfmEventIndex": { "type": "string", "description": "cEtherCfmEventIndex", "x-yang-type": "leafref", "readOnly": true }, "cEtherCfmEventRmtMepid": { "type": "string", "description": "cEtherCfmEventRmtMepid", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-ETHER-CFM-MIB_object-4": { "type": "object", "description": "object-4", "properties": { "cEtherCfmEventDomainIndex": { "type": "string", "description": "cEtherCfmEventDomainIndex", "x-yang-type": "leafref", "readOnly": true }, "cEtherCfmEventSvlan": { "type": "string", "description": "cEtherCfmEventSvlan", "x-yang-type": "leafref", "readOnly": true }, "cEtherCfmEventIndex": { "type": "string", "description": "cEtherCfmEventIndex", "x-yang-type": "leafref", "readOnly": true }, "cEtherCfmEventRmtMacAddress": { "type": "string", "description": "cEtherCfmEventRmtMacAddress", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-ETHER-CFM-MIB_object-5": { "type": "object", "description": "object-5", "properties": { "cEtherCfmEventDomainIndex": { "type": "string", "description": "cEtherCfmEventDomainIndex", "x-yang-type": "leafref", "readOnly": true }, "cEtherCfmEventSvlan": { "type": "string", "description": "cEtherCfmEventSvlan", "x-yang-type": "leafref", "readOnly": true }, "cEtherCfmEventIndex": { "type": "string", "description": "cEtherCfmEventIndex", "x-yang-type": "leafref", "readOnly": true }, "cEtherCfmEventRmtServiceId": { "type": "string", "description": "cEtherCfmEventRmtServiceId", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-ETHER-CFM-MIB_object-6": { "type": "object", "description": "object-6", "properties": { "cEtherCfmEventDomainIndex": { "type": "string", "description": "cEtherCfmEventDomainIndex", "x-yang-type": "leafref", "readOnly": true }, "cEtherCfmEventSvlan": { "type": "string", "description": "cEtherCfmEventSvlan", "x-yang-type": "leafref", "readOnly": true }, "cEtherCfmEventIndex": { "type": "string", "description": "cEtherCfmEventIndex", "x-yang-type": "leafref", "readOnly": true }, "cEtherCfmEventRmtMacAddress": { "type": "string", "description": "cEtherCfmEventRmtMacAddress", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-ETHER-CFM-MIB_object-7": { "type": "object", "description": "object-7", "properties": { "cEtherCfmEventDomainIndex": { "type": "string", "description": "cEtherCfmEventDomainIndex", "x-yang-type": "leafref", "readOnly": true }, "cEtherCfmEventSvlan": { "type": "string", "description": "cEtherCfmEventSvlan", "x-yang-type": "leafref", "readOnly": true }, "cEtherCfmEventIndex": { "type": "string", "description": "cEtherCfmEventIndex", "x-yang-type": "leafref", "readOnly": true }, "cEtherCfmEventCode": { "type": "string", "description": "cEtherCfmEventCode", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-ETHER-CFM-MIB_object-8": { "type": "object", "description": "object-8", "properties": { "cEtherCfmEventDomainIndex": { "type": "string", "description": "cEtherCfmEventDomainIndex", "x-yang-type": "leafref", "readOnly": true }, "cEtherCfmEventSvlan": { "type": "string", "description": "cEtherCfmEventSvlan", "x-yang-type": "leafref", "readOnly": true }, "cEtherCfmEventIndex": { "type": "string", "description": "cEtherCfmEventIndex", "x-yang-type": "leafref", "readOnly": true }, "cEtherCfmEventRmtPortState": { "type": "string", "description": "cEtherCfmEventRmtPortState", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-ETHER-CFM-MIB_cEtherCfmEventEntry": { "type": "array", "description": "An entry in this table is created for every event reported\n by Ethernet CFM.", "items": { "type": "object", "properties": { "cEtherCfmEventDomainIndex": { "type": "integer", "description": "This object represents the ID which uniquely identifies \n a CFM maintenance domain on the device. Every domain can\n be uniquely identified by its user-defined \n name (cEtherCfmEventDomainName) or device-assigned ID (this\n object).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cEtherCfmEventSvlan": { "type": "string", "description": "The service VLAN identifier of the customer service \n instance to which the event belongs.", "x-yang-type": "q-bridge:VlanId", "readOnly": true }, "cEtherCfmEventIndex": { "type": "integer", "description": "A monotonically increasing integer for the sole purpose of\n indexing CFM events. When it reaches the maximum value \n supported by the agent, as defined in the \n cEtherCfmMaxEventIndex object, the agent wraps the value\n back to 1 and may flush existing entries.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cEtherCfmEventDomainName": { "type": "string", "description": "The name of the CFM maintenance domain.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cEtherCfmEventType": { "type": "string", "description": "This object informs the management station of how to interpret\n the rest of the objects within a row, as summarized in the \n following table:\n \n Legend I: Ignored Object \n V: Valid Object\n \n Object cEtherCfmEventType\n | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8\n ================================================================\n | | | | | | | |\n cEtherCfmEventDomainIndex | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventSvlan | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventIndex | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventLastChange | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventServiceId | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventDomainName | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventLclMepid | I | I | I | V | V | I | I | I\n | | | | | | | |\n cEtherCfmEventLclMacAddress | V | V | V | V | V | V | V | V\n | | | | | | | |\n cEtherCfmEventLclMepCount | V | V | I | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventLclIfCount | V | V | I | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventRmtMepid | V | V | V | I | I | V | V | I\n | | | | | | | |\n cEtherCfmEventRmtMacAddress | V | V | V | I | V | V | V | I\n | | | | | | | |\n cEtherCfmEventRmtPortState | V | I | I | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventRmtServiceId | I | I | V | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventCode | V | V | I | I | I | I | I | I\n | | | | | | | |\n cEtherCfmEventDeleteRow | V | V | V | V | V | V | V | V\n | | | | | | | |\n \n Note: When reading any ignored object, a value of 0 will \n be returned by the agent.", "readOnly": true }, "cEtherCfmEventLastChange": { "type": "string", "description": "The value of sysUpTime at the time when this row was created.", "x-yang-type": "yang:timestamp", "readOnly": true }, "cEtherCfmEventServiceId": { "type": "string", "description": "The customer service instance to which the event belongs.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cEtherCfmEventLclMepid": { "type": "string", "description": "The identifier of the local MEP impacted by the event.", "x-yang-type": "CISCO-ETHER-CFM-MIB:CfmMepid", "readOnly": true }, "cEtherCfmEventLclMacAddress": { "type": "string", "description": "The MAC address of the device reporting the event.", "x-yang-type": "yang:mac-address", "readOnly": true }, "cEtherCfmEventLclMepCount": { "type": "integer", "description": "The number of local MEPs affected by the event.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cEtherCfmEventLclIfCount": { "type": "integer", "description": "The number of local interfaces affected by the event.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cEtherCfmEventRmtMepid": { "type": "string", "description": "The maintenance end-point identifier of the remote \n MEP causing the event entry to be logged.", "x-yang-type": "CISCO-ETHER-CFM-MIB:CfmMepid", "readOnly": true }, "cEtherCfmEventRmtMacAddress": { "type": "string", "description": "The MAC address of the remote maintenance point for which\n the event entry is being logged.", "x-yang-type": "yang:mac-address", "readOnly": true }, "cEtherCfmEventRmtPortState": { "type": "string", "description": "The operational state of the port on which the \n remote MEP is configured. This information is \n derived from the port-state as indicated in the \n CC message. The possible values are:\n \n 'up' - The port is operationally up.\n \n 'down' - The port is operationally (but not\n administratively) down.\n \n 'adminDown' - The port is administratively down.\n \n 'test' - The port is in test mode (perhaps \n due to an IEEE Standard 802.3ah OAM\n intrusive loopback operation).\n \n 'remoteExcessiveErrors' - 802.3ah OAM reports that the other \n end of the link is receiving an \n excessive number of invalid frames.\n \n 'localExcessiveErrors' - 802.3ah OAM reports that this end of\n the link is receiving an excessive \n number of invalid frames.\n \n 'localNoData' - No data and no CFM messages have been\n received for an excessive length of \n time.", "readOnly": true }, "cEtherCfmEventRmtServiceId": { "type": "string", "description": "The ID that the remote device has configured for the \n customer service instance (VLAN).", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cEtherCfmEventCode": { "type": "string", "description": "This object is used in decoding 'mepUp' and 'mepDown' events. \n \n ** For 'mepUp', the following codes are relevant:\n \n 'new' - This is the very first time the device \n receives a CC message from the remote MEP.\n \n 'returning' - The device received a CC message from a \n remote MEP for which it had an expired \n CCDB entry.\n \n 'portState' - The device received a CC message from a \n remote MEP for which it has a valid CCDB \n entry, and the message indicates a port \n status change.\n \n ** For 'mepDown', the following codes are relevant:\n \n 'lastGasp' - The device received a CC message from a\n remote MEP with zero lifetime.\n \n 'timeout' - The local CCDB entry for the remote MEP \n expired.\n \n 'configClear' - A previous CC message from a MEP that\n triggered a configuration error event\n is cleared.\n \n 'loopClear' - A previous CC message from a MEP that\n triggered a loop error event is cleared.\n \n 'xconnectClear' - A previous CC message from a MEP that\n triggered a crossconnect error event \n is cleared.\n \n 'unknownClear' - A previous CC message from a MEP that\n triggered an unknown MEP event is \n cleared.", "readOnly": true }, "cEtherCfmEventDeleteRow": { "type": "string", "description": "This object allows the management station to \n delete a row in the cEtherCfmEventTable in order\n to free system resources.\n \n When reading this object the value of 'noop' will be \n returned. This object can only be set to 'delete'. \n \n When this object is set to 'delete', the conceptual\n row corresponding to this object will be deleted to\n free system resources. This is equivalent to clearing\n the event log. Should the trigger that caused the event\n to be logged reoccur, the event will be re-asserted but\n in a different conceptual row.", "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-ETHER-CFM-MIB", "description": "MIB operations for CISCO-ETHER-CFM-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }