{ "openapi": "3.0.0", "info": { "title": "CISCO-ENTITY-ALARM-MIB MIB API", "version": "1.0.0", "description": "This MIB module defines the managed objects that support the\n monitoring of alarms generated by physical entities contained\n by the system, including chassis, slots, modules, ports, power\n supplies, and fans. In order to monitor alarms generated by a\n physical entity, it must be represented by a row in the\n entPhysicalTable (see ENTITY-MIB).\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-ENTITY-ALARM-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/CISCO-ENTITY-ALARM-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "CISCO-ENTITY-ALARM-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-ENTITY-ALARM-MIB:ceAlarmMonitoring": { "get": { "summary": "Get ceAlarmMonitoring data", "description": "Retrieve ceAlarmMonitoring operational data from MIB", "tags": [ "CISCO-ENTITY-ALARM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The value of this object specifies the number of alarms\n currently asserted with a severity of 'critical'.", "properties": { "ceAlarmCriticalCount": { "type": "integer", "description": "The value of this object specifies the number of alarms\n currently asserted with a severity of 'critical'.", "minimum": 0, "maximum": 4294967295 }, "ceAlarmMajorCount": { "type": "integer", "description": "The value of this object specifies the number of alarms\n currently asserted with a severity of 'major'.", "minimum": 0, "maximum": 4294967295 }, "ceAlarmMinorCount": { "type": "integer", "description": "The value of this object specifies the number of alarms\n currently asserted with a severity of 'minor'.", "minimum": 0, "maximum": 4294967295 }, "ceAlarmCutOff": { "type": "boolean", "description": "If the management client writes a value of 'true' to this\n object, the agent stops signalling all external audible alarms\n under the control of the agent. Reading this object should\n always result in a value of 'false'.\n \n Observe that alarm cutoff does not have an effect on monitoring,\n history logging, generation of notifications, or syslog message\n generation. It also does not prevent the agent from signalling\n external audible alarms for alarms asserted after alarm-cutoff.\n \n This object emulates the 'alarm cut-off' mechanism typically\n installed in a central office (e.g., a big red button). Observe\n this object should neither affect external visual alarms under\n the control of the agent, nor should it affect the current state\n of alarms being asserted by the system." } } }, "example": { "CISCO-ENTITY-ALARM-MIB:ceAlarmMonitoring": { "ceAlarmCriticalCount": 0, "ceAlarmMajorCount": 0, "ceAlarmMinorCount": 0, "ceAlarmCutOff": true } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ceAlarmMonitoring", "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": "/ceAlarmMonitoring", "x-restconf-kind": "container" }, "/data/CISCO-ENTITY-ALARM-MIB:ceAlarmHistory": { "get": { "summary": "Get ceAlarmHistory data", "description": "Retrieve ceAlarmHistory operational data from MIB", "tags": [ "CISCO-ENTITY-ALARM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "ceAlarmHistory", "properties": { "ceAlarmHistTableSize": { "type": "integer", "description": "This object specifies the number of entries that the \n ceAlarmHistTable can contain. When a physical entity\n generates an unfiltered alarm, and the capacity of the\n ceAlarmHistTable has reached the value specified by\n this object, then the agent deletes the oldest entity in\n order to accommodate the new entry. A value of '0' prevents\n any history from being retained.", "minimum": -2147483648, "maximum": 2147483647 }, "ceAlarmHistLastIndex": { "type": "integer", "description": "This object specifies the value of the ceAlarmHistIndex\n object corresponding to the last entry added to the table by the\n agent.\n \n If the management client uses the notifications defined by this\n module, then it can poll this object to determine whether it has\n missed a notification sent by the agent.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-ENTITY-ALARM-MIB:ceAlarmHistory": { "ceAlarmHistTableSize": -2147483648, "ceAlarmHistLastIndex": 1 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ceAlarmHistory", "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": "/ceAlarmHistory", "x-restconf-kind": "container" }, "/data/CISCO-ENTITY-ALARM-MIB:ceAlarmFiltering": { "get": { "summary": "Get ceAlarmFiltering data", "description": "Retrieve ceAlarmFiltering operational data from MIB", "tags": [ "CISCO-ENTITY-ALARM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "ceAlarmFiltering", "properties": { "ceAlarmNotifiesEnable": { "type": "string", "description": "This object specifies a severity threshold governing the\n generation of ceAlarmAsserted and ceAlarmCleared\n notifications. For example, if the value of this object is\n set to 'major', then the agent generates these notifications\n if and only if the severity of the alarm being indicated is\n 'major' or 'critical'. The value of '0' disables the \n generation of notifications.\n \n Observe that this setting overrides the value of the \n ceAlarmFilterNotifiesEnabled object.\n \n This object affects notification generation only; that is, it\n does not affect monitoring, history logging, and syslog message\n generation.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmSeverityOrZero" }, "ceAlarmSyslogEnable": { "type": "string", "description": "This object specifies a severity threshold governing the\n generation of syslog messages corresponding to alarms. For\n example, if the value of this object is set to 'major', then\n the agent generates these a syslog message if and only if the\n severity of the alarm being indicated is 'major' or 'critical'.\n The value of '0' disables the generation of syslog messages\n corresponding to alarms.\n \n Observe that this setting overrides the value of the \n ceAlarmFilterSyslogEnabled object.\n \n This object affects syslog message generation only; that is, it\n does not have an effect on monitoring, history logging, and\n generation of notifications.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmSeverityOrZero" }, "ceAlarmFilterProfileIndexNext": { "type": "string", "description": "This object contains an appropriate value to be used\n for ceAlarmFilterIndex when creating entries in the\n ceAlarmFilterProfileTable. The value '0' indicates\n that no unassigned entries are available. To obtain\n a ceAlarmFilterIndex, the management client issues\n a get request. The agent has the responsibility of \n modifying the value of this object following each \n successful get request.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmFilterProfileType" } } }, "example": { "CISCO-ENTITY-ALARM-MIB:ceAlarmFiltering": { "ceAlarmNotifiesEnable": "example-string", "ceAlarmSyslogEnable": "example-string", "ceAlarmFilterProfileIndexNext": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ceAlarmFiltering", "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": "/ceAlarmFiltering", "x-restconf-kind": "container" }, "/data/CISCO-ENTITY-ALARM-MIB:ceAlarmDescrMapTable": { "get": { "summary": "Get ceAlarmDescrMapTable data", "description": "Retrieve ceAlarmDescrMapTable operational data from MIB", "tags": [ "CISCO-ENTITY-ALARM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "For each type of entity (represented entPhysicalVendorType\n OID), this table contains a mapping between a unique \n ceAlarmDescrIndex and entPhysicalvendorType OID.", "properties": { "ceAlarmDescrMapEntry": { "type": "array", "description": "A mapping between an alarm description and a vendor type.", "items": { "type": "object", "properties": { "ceAlarmDescrIndex": { "type": "integer", "description": "This object uniquely identifies an alarm description.", "minimum": 0, "maximum": 4294967295 }, "ceAlarmDescrVendorType": { "type": "string", "description": "This object specifies an object identifier (typically an\n enterprise-specific OID) that uniquely identifies the vendor\n type of those physical entities that this alarm description\n applies to.", "x-yang-type": "snmpv2-tc:AutonomousType" } } } } } }, "example": { "CISCO-ENTITY-ALARM-MIB:ceAlarmDescrMapTable": { "ceAlarmDescrMapEntry": [ { "ceAlarmDescrIndex": 1, "ceAlarmDescrVendorType": "GigabitEthernet1/0/1" }, { "ceAlarmDescrIndex": 2, "ceAlarmDescrVendorType": "GigabitEthernet1/0/1" }, { "ceAlarmDescrIndex": 3, "ceAlarmDescrVendorType": "GigabitEthernet1/0/1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ceAlarmDescrMapTable", "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": "/ceAlarmDescrMapTable", "x-restconf-kind": "container" }, "/data/CISCO-ENTITY-ALARM-MIB:ceAlarmDescrMapTable/ceAlarmDescrMapEntry": { "get": { "summary": "Get ceAlarmDescrMapEntry list", "description": "Retrieve list of ceAlarmDescrMapEntry entries from MIB", "tags": [ "CISCO-ENTITY-ALARM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A mapping between an alarm description and a vendor type.", "items": { "type": "object", "properties": { "ceAlarmDescrIndex": { "type": "integer", "description": "This object uniquely identifies an alarm description.", "minimum": 0, "maximum": 4294967295 }, "ceAlarmDescrVendorType": { "type": "string", "description": "This object specifies an object identifier (typically an\n enterprise-specific OID) that uniquely identifies the vendor\n type of those physical entities that this alarm description\n applies to.", "x-yang-type": "snmpv2-tc:AutonomousType" } } } }, "example": { "CISCO-ENTITY-ALARM-MIB:ceAlarmDescrMapEntry": [ { "ceAlarmDescrIndex": 1, "ceAlarmDescrVendorType": "GigabitEthernet1/0/1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ceAlarmDescrMapEntry", "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": "/ceAlarmDescrMapTable/ceAlarmDescrMapEntry", "x-restconf-kind": "container" }, "/data/CISCO-ENTITY-ALARM-MIB:ceAlarmDescrMapTable/ceAlarmDescrMapEntry={ceAlarmDescrIndex}": { "get": { "summary": "Get ceAlarmDescrMapEntry entry", "description": "Retrieve specific ceAlarmDescrMapEntry entry by key from MIB", "tags": [ "CISCO-ENTITY-ALARM-MIB" ], "parameters": [ { "name": "ceAlarmDescrIndex", "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": { "ceAlarmDescrIndex": { "type": "integer", "description": "This object uniquely identifies an alarm description.", "minimum": 0, "maximum": 4294967295 }, "ceAlarmDescrVendorType": { "type": "string", "description": "This object specifies an object identifier (typically an\n enterprise-specific OID) that uniquely identifies the vendor\n type of those physical entities that this alarm description\n applies to.", "x-yang-type": "snmpv2-tc:AutonomousType" } } }, "example": { "CISCO-ENTITY-ALARM-MIB:ceAlarmDescrMapEntry": { "ceAlarmDescrIndex": 1, "ceAlarmDescrVendorType": "GigabitEthernet1/0/1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ceAlarmDescrMapEntry-2" }, "x-yang-path": "/ceAlarmDescrMapTable/ceAlarmDescrMapEntry={ceAlarmDescrIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ceAlarmDescrIndex" ] }, "/data/CISCO-ENTITY-ALARM-MIB:ceAlarmDescrTable": { "get": { "summary": "Get ceAlarmDescrTable data", "description": "Retrieve ceAlarmDescrTable operational data from MIB", "tags": [ "CISCO-ENTITY-ALARM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains a description for each alarm type\n defined by each vendor type employed by the system.\n Observe that this table is sparse in nature, as it is\n rarely the case that a physical entity type needs to \n define every alarm in its alarm space.", "properties": { "ceAlarmDescrEntry": { "type": "array", "description": "A collection of attributes that describe an alarm type.", "items": { "type": "object", "properties": { "ceAlarmDescrIndex": { "type": "string", "description": "ceAlarmDescrIndex", "x-yang-type": "leafref" }, "ceAlarmDescrAlarmType": { "type": "string", "description": "This object specifies the alarm type being described.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmType" }, "ceAlarmDescrSeverity": { "type": "string", "description": "This object specifies the severity associated with the\n alarm type.\n \n An implementation may chose to not allow dynamic severity\n assignment, in which case it would restrict access to this\n object to be read-only.\n \n If an implementation allows dynamic severity assignment, then\n a management client can revert to the default severity by\n writing the value '0' to this object.\n \n There exists a class of systems that should implement dynamic\n severity assignment. For example, consider a DSLAM (Digital\n Subscriber Loop Access Multiplexor) designed for both the\n central office and pedestal environments. A 'pedestal' is\n typically a dark-green metal box mounted on a concrete or stone\n foundation in which carrier-class companies house equipment.\n The central office typically controls the temperature and\n humidity of the environment, reducing reliance on a system's\n fans. Thus, the customer probably has a desire to reduce the \n severity of alarms indicating the failure of a fan. However, a\n pedestal environment has a much greater reliance on a system's\n fans. Thus, the customer probably has a desire to increase the\n severity of alarms indicating the failure of a fan.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmSeverityOrZero" }, "ceAlarmDescrText": { "type": "string", "description": "This object specifies a human-readable message describing\n the alarm.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } } } }, "example": { "CISCO-ENTITY-ALARM-MIB:ceAlarmDescrTable": { "ceAlarmDescrEntry": [ { "ceAlarmDescrIndex": "1", "ceAlarmDescrAlarmType": "GigabitEthernet1/0/1", "ceAlarmDescrSeverity": "GigabitEthernet1/0/1", "ceAlarmDescrText": "GigabitEthernet1/0/1" }, { "ceAlarmDescrIndex": "2", "ceAlarmDescrAlarmType": "GigabitEthernet1/0/1", "ceAlarmDescrSeverity": "GigabitEthernet1/0/1", "ceAlarmDescrText": "GigabitEthernet1/0/1" }, { "ceAlarmDescrIndex": "3", "ceAlarmDescrAlarmType": "GigabitEthernet1/0/1", "ceAlarmDescrSeverity": "GigabitEthernet1/0/1", "ceAlarmDescrText": "GigabitEthernet1/0/1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ceAlarmDescrTable", "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": "/ceAlarmDescrTable", "x-restconf-kind": "container" }, "/data/CISCO-ENTITY-ALARM-MIB:ceAlarmDescrTable/ceAlarmDescrEntry": { "get": { "summary": "Get ceAlarmDescrEntry list", "description": "Retrieve list of ceAlarmDescrEntry entries from MIB", "tags": [ "CISCO-ENTITY-ALARM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A collection of attributes that describe an alarm type.", "items": { "type": "object", "properties": { "ceAlarmDescrIndex": { "type": "string", "description": "ceAlarmDescrIndex", "x-yang-type": "leafref" }, "ceAlarmDescrAlarmType": { "type": "string", "description": "This object specifies the alarm type being described.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmType" }, "ceAlarmDescrSeverity": { "type": "string", "description": "This object specifies the severity associated with the\n alarm type.\n \n An implementation may chose to not allow dynamic severity\n assignment, in which case it would restrict access to this\n object to be read-only.\n \n If an implementation allows dynamic severity assignment, then\n a management client can revert to the default severity by\n writing the value '0' to this object.\n \n There exists a class of systems that should implement dynamic\n severity assignment. For example, consider a DSLAM (Digital\n Subscriber Loop Access Multiplexor) designed for both the\n central office and pedestal environments. A 'pedestal' is\n typically a dark-green metal box mounted on a concrete or stone\n foundation in which carrier-class companies house equipment.\n The central office typically controls the temperature and\n humidity of the environment, reducing reliance on a system's\n fans. Thus, the customer probably has a desire to reduce the \n severity of alarms indicating the failure of a fan. However, a\n pedestal environment has a much greater reliance on a system's\n fans. Thus, the customer probably has a desire to increase the\n severity of alarms indicating the failure of a fan.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmSeverityOrZero" }, "ceAlarmDescrText": { "type": "string", "description": "This object specifies a human-readable message describing\n the alarm.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } }, "example": { "CISCO-ENTITY-ALARM-MIB:ceAlarmDescrEntry": [ { "ceAlarmDescrIndex": "GigabitEthernet1/0/1", "ceAlarmDescrAlarmType": "GigabitEthernet1/0/1", "ceAlarmDescrSeverity": "GigabitEthernet1/0/1", "ceAlarmDescrText": "GigabitEthernet1/0/1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ceAlarmDescrEntry", "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": "/ceAlarmDescrTable/ceAlarmDescrEntry", "x-restconf-kind": "container" }, "/data/CISCO-ENTITY-ALARM-MIB:ceAlarmTable": { "get": { "summary": "Get ceAlarmTable data", "description": "Retrieve ceAlarmTable operational data from MIB", "tags": [ "CISCO-ENTITY-ALARM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table specifies alarm control and status information\n related to each physical entity contained by the system,\n including the alarms currently being asserted by each physical\n entity capable of generating alarms.", "properties": { "ceAlarmEntry": { "type": "array", "description": "Alarm control and status information related to the \n corresponding physical entity, including a list of those\n alarms currently being asserted by that physical entity.", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "ceAlarmFilterProfile": { "type": "string", "description": "This object specifies the alarm filter profile associated\n with the corresponding physical entity. An alarm filter\n profile controls which alarm types the agent will monitor\n and signal for the corresponding physical entity.\n \n If the value of this object is '0', then the agent monitors\n and signals all alarms associated with the corresponding\n physical entity.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmFilterProfileType" }, "ceAlarmSeverity": { "type": "string", "description": "This object specifies the highest severity alarm currently\n being asserted by the corresponding physical entity. A value\n of '0' indicates that there the corresponding physical entity\n currently is not asserting any alarms.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmSeverityOrZero" }, "ceAlarmList": { "type": "string", "description": "This object specifies those alarms currently being asserted\n by the corresponding physical entity. Note, an alarm indicates\n a condition, not an event. An alarm has two states:\n \n 'asserted' Indicates that the condition described by the\n alarm exists.\n \n 'cleared' Indicates that the condition described by the\n alarm does not exist.\n \n For example, a slot in a chassis may define an alarm that\n specifies whether the slot contains a module. At the time of\n module insertion, the physical entity corresponding to the slot\n asserts this alarm, and the alarm remains asserted until the \n slot becomes empty.\n \n If an alarm is being asserted by the physical entity, then the\n corresponding bit in the alarm list is set to a one. Observe\n that if the physical entity is not currently asserting any\n alarms, then the list will have a length of zero.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmList" } } } } } }, "example": { "CISCO-ENTITY-ALARM-MIB:ceAlarmTable": { "ceAlarmEntry": [ { "entPhysicalIndex": "1", "ceAlarmFilterProfile": "example-string", "ceAlarmSeverity": "example-string", "ceAlarmList": "example-string" }, { "entPhysicalIndex": "2", "ceAlarmFilterProfile": "example-string", "ceAlarmSeverity": "example-string", "ceAlarmList": "example-string" }, { "entPhysicalIndex": "3", "ceAlarmFilterProfile": "example-string", "ceAlarmSeverity": "example-string", "ceAlarmList": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ceAlarmTable", "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": "/ceAlarmTable", "x-restconf-kind": "container" }, "/data/CISCO-ENTITY-ALARM-MIB:ceAlarmTable/ceAlarmEntry": { "get": { "summary": "Get ceAlarmEntry list", "description": "Retrieve list of ceAlarmEntry entries from MIB", "tags": [ "CISCO-ENTITY-ALARM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Alarm control and status information related to the \n corresponding physical entity, including a list of those\n alarms currently being asserted by that physical entity.", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "ceAlarmFilterProfile": { "type": "string", "description": "This object specifies the alarm filter profile associated\n with the corresponding physical entity. An alarm filter\n profile controls which alarm types the agent will monitor\n and signal for the corresponding physical entity.\n \n If the value of this object is '0', then the agent monitors\n and signals all alarms associated with the corresponding\n physical entity.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmFilterProfileType" }, "ceAlarmSeverity": { "type": "string", "description": "This object specifies the highest severity alarm currently\n being asserted by the corresponding physical entity. A value\n of '0' indicates that there the corresponding physical entity\n currently is not asserting any alarms.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmSeverityOrZero" }, "ceAlarmList": { "type": "string", "description": "This object specifies those alarms currently being asserted\n by the corresponding physical entity. Note, an alarm indicates\n a condition, not an event. An alarm has two states:\n \n 'asserted' Indicates that the condition described by the\n alarm exists.\n \n 'cleared' Indicates that the condition described by the\n alarm does not exist.\n \n For example, a slot in a chassis may define an alarm that\n specifies whether the slot contains a module. At the time of\n module insertion, the physical entity corresponding to the slot\n asserts this alarm, and the alarm remains asserted until the \n slot becomes empty.\n \n If an alarm is being asserted by the physical entity, then the\n corresponding bit in the alarm list is set to a one. Observe\n that if the physical entity is not currently asserting any\n alarms, then the list will have a length of zero.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmList" } } } }, "example": { "CISCO-ENTITY-ALARM-MIB:ceAlarmEntry": [ { "entPhysicalIndex": "example-string", "ceAlarmFilterProfile": "example-string", "ceAlarmSeverity": "example-string", "ceAlarmList": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ceAlarmEntry", "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": "/ceAlarmTable/ceAlarmEntry", "x-restconf-kind": "container" }, "/data/CISCO-ENTITY-ALARM-MIB:ceAlarmTable/ceAlarmEntry={entPhysicalIndex}": { "get": { "summary": "Get ceAlarmEntry entry", "description": "Retrieve specific ceAlarmEntry entry by key from MIB", "tags": [ "CISCO-ENTITY-ALARM-MIB" ], "parameters": [ { "name": "entPhysicalIndex", "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": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "ceAlarmFilterProfile": { "type": "string", "description": "This object specifies the alarm filter profile associated\n with the corresponding physical entity. An alarm filter\n profile controls which alarm types the agent will monitor\n and signal for the corresponding physical entity.\n \n If the value of this object is '0', then the agent monitors\n and signals all alarms associated with the corresponding\n physical entity.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmFilterProfileType" }, "ceAlarmSeverity": { "type": "string", "description": "This object specifies the highest severity alarm currently\n being asserted by the corresponding physical entity. A value\n of '0' indicates that there the corresponding physical entity\n currently is not asserting any alarms.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmSeverityOrZero" }, "ceAlarmList": { "type": "string", "description": "This object specifies those alarms currently being asserted\n by the corresponding physical entity. Note, an alarm indicates\n a condition, not an event. An alarm has two states:\n \n 'asserted' Indicates that the condition described by the\n alarm exists.\n \n 'cleared' Indicates that the condition described by the\n alarm does not exist.\n \n For example, a slot in a chassis may define an alarm that\n specifies whether the slot contains a module. At the time of\n module insertion, the physical entity corresponding to the slot\n asserts this alarm, and the alarm remains asserted until the \n slot becomes empty.\n \n If an alarm is being asserted by the physical entity, then the\n corresponding bit in the alarm list is set to a one. Observe\n that if the physical entity is not currently asserting any\n alarms, then the list will have a length of zero.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmList" } } }, "example": { "CISCO-ENTITY-ALARM-MIB:ceAlarmEntry": { "entPhysicalIndex": "example-string", "ceAlarmFilterProfile": "example-string", "ceAlarmSeverity": "example-string", "ceAlarmList": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ceAlarmEntry-2" }, "x-yang-path": "/ceAlarmTable/ceAlarmEntry={entPhysicalIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "entPhysicalIndex" ] }, "/data/CISCO-ENTITY-ALARM-MIB:ceAlarmHistTable": { "get": { "summary": "Get ceAlarmHistTable data", "description": "Retrieve ceAlarmHistTable operational data from MIB", "tags": [ "CISCO-ENTITY-ALARM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains a history of ceAlarmIndicate and\n ceAlarmClear traps generated by the agent.", "properties": { "ceAlarmHistEntry": { "type": "array", "description": "The information conveyed by a ceAlarmIndicate or\n ceAlarmClear trap.", "items": { "type": "object", "properties": { "ceAlarmHistIndex": { "type": "integer", "description": "An integer value uniquely identifying the entry in the table.\n The value of this object starts at '1' and monotonically\n increases for each alarm condition transition monitored by the\n agent. If the value of this object is '4294967295', the agent\n will reset it to '1' upon monitoring the next alarm condition\n transition.", "minimum": 0, "maximum": 4294967295 }, "ceAlarmHistType": { "type": "string", "description": "This object specifies whether the agent created the entry as\n the result of an alarm being asserted or cleared." }, "ceAlarmHistEntPhysicalIndex": { "type": "string", "description": "This object specifies the physical entity that generated\n the alarm.", "x-yang-type": "entity-mib:PhysicalIndex" }, "ceAlarmHistAlarmType": { "type": "string", "description": "This object specifies the type of alarm generated.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmType" }, "ceAlarmHistSeverity": { "type": "string", "description": "This object specifies the severity of the alarm generated.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmSeverity" }, "ceAlarmHistTimeStamp": { "type": "string", "description": "This object specifies the value of the sysUpTime object at\n the time the alarm was generated.", "x-yang-type": "yang:timestamp" } } } } } }, "example": { "CISCO-ENTITY-ALARM-MIB:ceAlarmHistTable": { "ceAlarmHistEntry": [ { "ceAlarmHistIndex": 1, "ceAlarmHistType": "ethernetCsmacd(6)", "ceAlarmHistEntPhysicalIndex": "1", "ceAlarmHistAlarmType": "ethernetCsmacd(6)", "ceAlarmHistSeverity": "example-string", "ceAlarmHistTimeStamp": "example-string" }, { "ceAlarmHistIndex": 2, "ceAlarmHistType": "ethernetCsmacd(6)", "ceAlarmHistEntPhysicalIndex": "2", "ceAlarmHistAlarmType": "ethernetCsmacd(6)", "ceAlarmHistSeverity": "example-string", "ceAlarmHistTimeStamp": "example-string" }, { "ceAlarmHistIndex": 3, "ceAlarmHistType": "ethernetCsmacd(6)", "ceAlarmHistEntPhysicalIndex": "3", "ceAlarmHistAlarmType": "ethernetCsmacd(6)", "ceAlarmHistSeverity": "example-string", "ceAlarmHistTimeStamp": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ceAlarmHistTable", "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": "/ceAlarmHistTable", "x-restconf-kind": "container" }, "/data/CISCO-ENTITY-ALARM-MIB:ceAlarmHistTable/ceAlarmHistEntry": { "get": { "summary": "Get ceAlarmHistEntry list", "description": "Retrieve list of ceAlarmHistEntry entries from MIB", "tags": [ "CISCO-ENTITY-ALARM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "The information conveyed by a ceAlarmIndicate or\n ceAlarmClear trap.", "items": { "type": "object", "properties": { "ceAlarmHistIndex": { "type": "integer", "description": "An integer value uniquely identifying the entry in the table.\n The value of this object starts at '1' and monotonically\n increases for each alarm condition transition monitored by the\n agent. If the value of this object is '4294967295', the agent\n will reset it to '1' upon monitoring the next alarm condition\n transition.", "minimum": 0, "maximum": 4294967295 }, "ceAlarmHistType": { "type": "string", "description": "This object specifies whether the agent created the entry as\n the result of an alarm being asserted or cleared." }, "ceAlarmHistEntPhysicalIndex": { "type": "string", "description": "This object specifies the physical entity that generated\n the alarm.", "x-yang-type": "entity-mib:PhysicalIndex" }, "ceAlarmHistAlarmType": { "type": "string", "description": "This object specifies the type of alarm generated.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmType" }, "ceAlarmHistSeverity": { "type": "string", "description": "This object specifies the severity of the alarm generated.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmSeverity" }, "ceAlarmHistTimeStamp": { "type": "string", "description": "This object specifies the value of the sysUpTime object at\n the time the alarm was generated.", "x-yang-type": "yang:timestamp" } } } }, "example": { "CISCO-ENTITY-ALARM-MIB:ceAlarmHistEntry": [ { "ceAlarmHistIndex": 1, "ceAlarmHistType": "ethernetCsmacd(6)", "ceAlarmHistEntPhysicalIndex": "example-string", "ceAlarmHistAlarmType": "ethernetCsmacd(6)", "ceAlarmHistSeverity": "example-string", "ceAlarmHistTimeStamp": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ceAlarmHistEntry", "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": "/ceAlarmHistTable/ceAlarmHistEntry", "x-restconf-kind": "container" }, "/data/CISCO-ENTITY-ALARM-MIB:ceAlarmHistTable/ceAlarmHistEntry={ceAlarmHistIndex}": { "get": { "summary": "Get ceAlarmHistEntry entry", "description": "Retrieve specific ceAlarmHistEntry entry by key from MIB", "tags": [ "CISCO-ENTITY-ALARM-MIB" ], "parameters": [ { "name": "ceAlarmHistIndex", "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": { "ceAlarmHistIndex": { "type": "integer", "description": "An integer value uniquely identifying the entry in the table.\n The value of this object starts at '1' and monotonically\n increases for each alarm condition transition monitored by the\n agent. If the value of this object is '4294967295', the agent\n will reset it to '1' upon monitoring the next alarm condition\n transition.", "minimum": 0, "maximum": 4294967295 }, "ceAlarmHistType": { "type": "string", "description": "This object specifies whether the agent created the entry as\n the result of an alarm being asserted or cleared." }, "ceAlarmHistEntPhysicalIndex": { "type": "string", "description": "This object specifies the physical entity that generated\n the alarm.", "x-yang-type": "entity-mib:PhysicalIndex" }, "ceAlarmHistAlarmType": { "type": "string", "description": "This object specifies the type of alarm generated.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmType" }, "ceAlarmHistSeverity": { "type": "string", "description": "This object specifies the severity of the alarm generated.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmSeverity" }, "ceAlarmHistTimeStamp": { "type": "string", "description": "This object specifies the value of the sysUpTime object at\n the time the alarm was generated.", "x-yang-type": "yang:timestamp" } } }, "example": { "CISCO-ENTITY-ALARM-MIB:ceAlarmHistEntry": { "ceAlarmHistIndex": 1, "ceAlarmHistType": "ethernetCsmacd(6)", "ceAlarmHistEntPhysicalIndex": "example-string", "ceAlarmHistAlarmType": "ethernetCsmacd(6)", "ceAlarmHistSeverity": "example-string", "ceAlarmHistTimeStamp": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ceAlarmHistEntry-2" }, "x-yang-path": "/ceAlarmHistTable/ceAlarmHistEntry={ceAlarmHistIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ceAlarmHistIndex" ] }, "/data/CISCO-ENTITY-ALARM-MIB:ceAlarmFilterProfileTable": { "get": { "summary": "Get ceAlarmFilterProfileTable data", "description": "Retrieve ceAlarmFilterProfileTable operational data from MIB", "tags": [ "CISCO-ENTITY-ALARM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains a list of alarm filter profiles.", "properties": { "ceAlarmFilterProfileEntry": { "type": "array", "description": "ceAlarmFilterProfileEntry", "items": { "type": "object", "properties": { "ceAlarmFilterIndex": { "type": "string", "description": "This object uniquely identifies the alarm filter profile.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmFilterProfileType" }, "ceAlarmFilterStatus": { "type": "string", "description": "This object facilitates the creation, modification, or \n deletion of a conceptual row in this table.\n \n A management client can create a conceptual row in this\n table by setting this object to 'createAndWait' or \n 'createAndGo'. If a request to create a conceptual row\n in this table fails, then the system is not capable of\n supporting any more alarm filters.\n \n Before modifying a conceptual row in this table, the \n management client must set this object to 'notInService'.\n After modifying a conceptual row in this table, the \n management client must set this object to 'active'.\n This operation causes the modifications made to an\n alarm filter profile to take effect.\n \n An implementation should not allow a conceptual row in\n this table to be deleted if one or more physical entities\n reference it.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ceAlarmFilterAlias": { "type": "string", "description": "This object specifies an arbitrary name associated with the\n alarm filter profile by the management client, and provides\n a non-volatile 'handle' for the alarm filter profile.\n \n On the first instantiation of an alarm filter profile, the\n value of this object is a zero-length string. However, an\n agent may choose to set the value to a locally unique default\n value.\n \n If an implementation supports write access to this object,\n then the agent is responsible for ensuring the retention\n of any value written to this object until a management client\n deletes it. The level of retention must span reboots and \n reinitializations of the network management system, including\n those that result in different assignments to the value of\n the entPhysicalIndex associated with the physical entity.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ceAlarmFilterAlarmsEnabled": { "type": "string", "description": "This object specifies a list of alarms that are enabled.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmList" }, "ceAlarmFilterNotifiesEnabled": { "type": "string", "description": "This object specifies a list of alarms for which notification\n generation is enabled.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmList" }, "ceAlarmFilterSyslogEnabled": { "type": "string", "description": "This object specifies a list of alarms for which syslog\n message generation is enabled.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmList" } } } } } }, "example": { "CISCO-ENTITY-ALARM-MIB:ceAlarmFilterProfileTable": { "ceAlarmFilterProfileEntry": [ { "ceAlarmFilterIndex": "1", "ceAlarmFilterStatus": "up(1)", "ceAlarmFilterAlias": "example-string", "ceAlarmFilterAlarmsEnabled": "example-string", "ceAlarmFilterNotifiesEnabled": "example-string", "ceAlarmFilterSyslogEnabled": "example-string" }, { "ceAlarmFilterIndex": "2", "ceAlarmFilterStatus": "up(1)", "ceAlarmFilterAlias": "example-string", "ceAlarmFilterAlarmsEnabled": "example-string", "ceAlarmFilterNotifiesEnabled": "example-string", "ceAlarmFilterSyslogEnabled": "example-string" }, { "ceAlarmFilterIndex": "3", "ceAlarmFilterStatus": "up(1)", "ceAlarmFilterAlias": "example-string", "ceAlarmFilterAlarmsEnabled": "example-string", "ceAlarmFilterNotifiesEnabled": "example-string", "ceAlarmFilterSyslogEnabled": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ceAlarmFilterProfileTable", "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": "/ceAlarmFilterProfileTable", "x-restconf-kind": "container" }, "/data/CISCO-ENTITY-ALARM-MIB:ceAlarmFilterProfileTable/ceAlarmFilterProfileEntry": { "get": { "summary": "Get ceAlarmFilterProfileEntry list", "description": "Retrieve list of ceAlarmFilterProfileEntry entries from MIB", "tags": [ "CISCO-ENTITY-ALARM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "ceAlarmFilterProfileEntry", "items": { "type": "object", "properties": { "ceAlarmFilterIndex": { "type": "string", "description": "This object uniquely identifies the alarm filter profile.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmFilterProfileType" }, "ceAlarmFilterStatus": { "type": "string", "description": "This object facilitates the creation, modification, or \n deletion of a conceptual row in this table.\n \n A management client can create a conceptual row in this\n table by setting this object to 'createAndWait' or \n 'createAndGo'. If a request to create a conceptual row\n in this table fails, then the system is not capable of\n supporting any more alarm filters.\n \n Before modifying a conceptual row in this table, the \n management client must set this object to 'notInService'.\n After modifying a conceptual row in this table, the \n management client must set this object to 'active'.\n This operation causes the modifications made to an\n alarm filter profile to take effect.\n \n An implementation should not allow a conceptual row in\n this table to be deleted if one or more physical entities\n reference it.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ceAlarmFilterAlias": { "type": "string", "description": "This object specifies an arbitrary name associated with the\n alarm filter profile by the management client, and provides\n a non-volatile 'handle' for the alarm filter profile.\n \n On the first instantiation of an alarm filter profile, the\n value of this object is a zero-length string. However, an\n agent may choose to set the value to a locally unique default\n value.\n \n If an implementation supports write access to this object,\n then the agent is responsible for ensuring the retention\n of any value written to this object until a management client\n deletes it. The level of retention must span reboots and \n reinitializations of the network management system, including\n those that result in different assignments to the value of\n the entPhysicalIndex associated with the physical entity.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ceAlarmFilterAlarmsEnabled": { "type": "string", "description": "This object specifies a list of alarms that are enabled.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmList" }, "ceAlarmFilterNotifiesEnabled": { "type": "string", "description": "This object specifies a list of alarms for which notification\n generation is enabled.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmList" }, "ceAlarmFilterSyslogEnabled": { "type": "string", "description": "This object specifies a list of alarms for which syslog\n message generation is enabled.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmList" } } } }, "example": { "CISCO-ENTITY-ALARM-MIB:ceAlarmFilterProfileEntry": [ { "ceAlarmFilterIndex": "example-string", "ceAlarmFilterStatus": "up(1)", "ceAlarmFilterAlias": "example-string", "ceAlarmFilterAlarmsEnabled": "example-string", "ceAlarmFilterNotifiesEnabled": "example-string", "ceAlarmFilterSyslogEnabled": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ceAlarmFilterProfileEntry", "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": "/ceAlarmFilterProfileTable/ceAlarmFilterProfileEntry", "x-restconf-kind": "container" }, "/data/CISCO-ENTITY-ALARM-MIB:ceAlarmFilterProfileTable/ceAlarmFilterProfileEntry={ceAlarmFilterIndex}": { "get": { "summary": "Get ceAlarmFilterProfileEntry entry", "description": "Retrieve specific ceAlarmFilterProfileEntry entry by key from MIB", "tags": [ "CISCO-ENTITY-ALARM-MIB" ], "parameters": [ { "name": "ceAlarmFilterIndex", "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": { "ceAlarmFilterIndex": { "type": "string", "description": "This object uniquely identifies the alarm filter profile.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmFilterProfileType" }, "ceAlarmFilterStatus": { "type": "string", "description": "This object facilitates the creation, modification, or \n deletion of a conceptual row in this table.\n \n A management client can create a conceptual row in this\n table by setting this object to 'createAndWait' or \n 'createAndGo'. If a request to create a conceptual row\n in this table fails, then the system is not capable of\n supporting any more alarm filters.\n \n Before modifying a conceptual row in this table, the \n management client must set this object to 'notInService'.\n After modifying a conceptual row in this table, the \n management client must set this object to 'active'.\n This operation causes the modifications made to an\n alarm filter profile to take effect.\n \n An implementation should not allow a conceptual row in\n this table to be deleted if one or more physical entities\n reference it.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ceAlarmFilterAlias": { "type": "string", "description": "This object specifies an arbitrary name associated with the\n alarm filter profile by the management client, and provides\n a non-volatile 'handle' for the alarm filter profile.\n \n On the first instantiation of an alarm filter profile, the\n value of this object is a zero-length string. However, an\n agent may choose to set the value to a locally unique default\n value.\n \n If an implementation supports write access to this object,\n then the agent is responsible for ensuring the retention\n of any value written to this object until a management client\n deletes it. The level of retention must span reboots and \n reinitializations of the network management system, including\n those that result in different assignments to the value of\n the entPhysicalIndex associated with the physical entity.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ceAlarmFilterAlarmsEnabled": { "type": "string", "description": "This object specifies a list of alarms that are enabled.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmList" }, "ceAlarmFilterNotifiesEnabled": { "type": "string", "description": "This object specifies a list of alarms for which notification\n generation is enabled.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmList" }, "ceAlarmFilterSyslogEnabled": { "type": "string", "description": "This object specifies a list of alarms for which syslog\n message generation is enabled.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmList" } } }, "example": { "CISCO-ENTITY-ALARM-MIB:ceAlarmFilterProfileEntry": { "ceAlarmFilterIndex": "example-string", "ceAlarmFilterStatus": "up(1)", "ceAlarmFilterAlias": "example-string", "ceAlarmFilterAlarmsEnabled": "example-string", "ceAlarmFilterNotifiesEnabled": "example-string", "ceAlarmFilterSyslogEnabled": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ceAlarmFilterProfileEntry-2" }, "x-yang-path": "/ceAlarmFilterProfileTable/ceAlarmFilterProfileEntry={ceAlarmFilterIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ceAlarmFilterIndex" ] }, "/data/CISCO-ENTITY-ALARM-MIB:ceAlarmDescrMapEntry": { "get": { "summary": "Get ceAlarmDescrMapEntry list", "description": "Retrieve list of ceAlarmDescrMapEntry entries from MIB", "tags": [ "CISCO-ENTITY-ALARM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A mapping between an alarm description and a vendor type.", "items": { "type": "object", "properties": { "ceAlarmDescrIndex": { "type": "integer", "description": "This object uniquely identifies an alarm description.", "minimum": 0, "maximum": 4294967295 }, "ceAlarmDescrVendorType": { "type": "string", "description": "This object specifies an object identifier (typically an\n enterprise-specific OID) that uniquely identifies the vendor\n type of those physical entities that this alarm description\n applies to.", "x-yang-type": "snmpv2-tc:AutonomousType" } } } }, "example": { "CISCO-ENTITY-ALARM-MIB:ceAlarmDescrMapEntry": [ { "ceAlarmDescrIndex": 1, "ceAlarmDescrVendorType": "GigabitEthernet1/0/1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ceAlarmDescrMapEntry-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": "/ceAlarmDescrMapEntry", "x-restconf-kind": "container" }, "/data/CISCO-ENTITY-ALARM-MIB:ceAlarmDescrMapEntry={ceAlarmDescrIndex}": { "get": { "summary": "Get ceAlarmDescrMapEntry entry", "description": "Retrieve specific ceAlarmDescrMapEntry entry by key from MIB", "tags": [ "CISCO-ENTITY-ALARM-MIB" ], "parameters": [ { "name": "ceAlarmDescrIndex", "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": { "ceAlarmDescrIndex": { "type": "integer", "description": "This object uniquely identifies an alarm description.", "minimum": 0, "maximum": 4294967295 }, "ceAlarmDescrVendorType": { "type": "string", "description": "This object specifies an object identifier (typically an\n enterprise-specific OID) that uniquely identifies the vendor\n type of those physical entities that this alarm description\n applies to.", "x-yang-type": "snmpv2-tc:AutonomousType" } } }, "example": { "CISCO-ENTITY-ALARM-MIB:ceAlarmDescrMapEntry": { "ceAlarmDescrIndex": 1, "ceAlarmDescrVendorType": "GigabitEthernet1/0/1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ceAlarmDescrMapEntry-4" }, "x-yang-path": "/ceAlarmDescrMapEntry={ceAlarmDescrIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ceAlarmDescrIndex" ] }, "/data/CISCO-ENTITY-ALARM-MIB:ceAlarmDescrEntry": { "get": { "summary": "Get ceAlarmDescrEntry list", "description": "Retrieve list of ceAlarmDescrEntry entries from MIB", "tags": [ "CISCO-ENTITY-ALARM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A collection of attributes that describe an alarm type.", "items": { "type": "object", "properties": { "ceAlarmDescrIndex": { "type": "string", "description": "ceAlarmDescrIndex", "x-yang-type": "leafref" }, "ceAlarmDescrAlarmType": { "type": "string", "description": "This object specifies the alarm type being described.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmType" }, "ceAlarmDescrSeverity": { "type": "string", "description": "This object specifies the severity associated with the\n alarm type.\n \n An implementation may chose to not allow dynamic severity\n assignment, in which case it would restrict access to this\n object to be read-only.\n \n If an implementation allows dynamic severity assignment, then\n a management client can revert to the default severity by\n writing the value '0' to this object.\n \n There exists a class of systems that should implement dynamic\n severity assignment. For example, consider a DSLAM (Digital\n Subscriber Loop Access Multiplexor) designed for both the\n central office and pedestal environments. A 'pedestal' is\n typically a dark-green metal box mounted on a concrete or stone\n foundation in which carrier-class companies house equipment.\n The central office typically controls the temperature and\n humidity of the environment, reducing reliance on a system's\n fans. Thus, the customer probably has a desire to reduce the \n severity of alarms indicating the failure of a fan. However, a\n pedestal environment has a much greater reliance on a system's\n fans. Thus, the customer probably has a desire to increase the\n severity of alarms indicating the failure of a fan.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmSeverityOrZero" }, "ceAlarmDescrText": { "type": "string", "description": "This object specifies a human-readable message describing\n the alarm.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } }, "example": { "CISCO-ENTITY-ALARM-MIB:ceAlarmDescrEntry": [ { "ceAlarmDescrIndex": "GigabitEthernet1/0/1", "ceAlarmDescrAlarmType": "GigabitEthernet1/0/1", "ceAlarmDescrSeverity": "GigabitEthernet1/0/1", "ceAlarmDescrText": "GigabitEthernet1/0/1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ceAlarmDescrEntry-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": "/ceAlarmDescrEntry", "x-restconf-kind": "container" }, "/data/CISCO-ENTITY-ALARM-MIB:ceAlarmEntry": { "get": { "summary": "Get ceAlarmEntry list", "description": "Retrieve list of ceAlarmEntry entries from MIB", "tags": [ "CISCO-ENTITY-ALARM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Alarm control and status information related to the \n corresponding physical entity, including a list of those\n alarms currently being asserted by that physical entity.", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "ceAlarmFilterProfile": { "type": "string", "description": "This object specifies the alarm filter profile associated\n with the corresponding physical entity. An alarm filter\n profile controls which alarm types the agent will monitor\n and signal for the corresponding physical entity.\n \n If the value of this object is '0', then the agent monitors\n and signals all alarms associated with the corresponding\n physical entity.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmFilterProfileType" }, "ceAlarmSeverity": { "type": "string", "description": "This object specifies the highest severity alarm currently\n being asserted by the corresponding physical entity. A value\n of '0' indicates that there the corresponding physical entity\n currently is not asserting any alarms.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmSeverityOrZero" }, "ceAlarmList": { "type": "string", "description": "This object specifies those alarms currently being asserted\n by the corresponding physical entity. Note, an alarm indicates\n a condition, not an event. An alarm has two states:\n \n 'asserted' Indicates that the condition described by the\n alarm exists.\n \n 'cleared' Indicates that the condition described by the\n alarm does not exist.\n \n For example, a slot in a chassis may define an alarm that\n specifies whether the slot contains a module. At the time of\n module insertion, the physical entity corresponding to the slot\n asserts this alarm, and the alarm remains asserted until the \n slot becomes empty.\n \n If an alarm is being asserted by the physical entity, then the\n corresponding bit in the alarm list is set to a one. Observe\n that if the physical entity is not currently asserting any\n alarms, then the list will have a length of zero.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmList" } } } }, "example": { "CISCO-ENTITY-ALARM-MIB:ceAlarmEntry": [ { "entPhysicalIndex": "example-string", "ceAlarmFilterProfile": "example-string", "ceAlarmSeverity": "example-string", "ceAlarmList": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ceAlarmEntry-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": "/ceAlarmEntry", "x-restconf-kind": "container" }, "/data/CISCO-ENTITY-ALARM-MIB:ceAlarmEntry={entPhysicalIndex}": { "get": { "summary": "Get ceAlarmEntry entry", "description": "Retrieve specific ceAlarmEntry entry by key from MIB", "tags": [ "CISCO-ENTITY-ALARM-MIB" ], "parameters": [ { "name": "entPhysicalIndex", "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": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "ceAlarmFilterProfile": { "type": "string", "description": "This object specifies the alarm filter profile associated\n with the corresponding physical entity. An alarm filter\n profile controls which alarm types the agent will monitor\n and signal for the corresponding physical entity.\n \n If the value of this object is '0', then the agent monitors\n and signals all alarms associated with the corresponding\n physical entity.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmFilterProfileType" }, "ceAlarmSeverity": { "type": "string", "description": "This object specifies the highest severity alarm currently\n being asserted by the corresponding physical entity. A value\n of '0' indicates that there the corresponding physical entity\n currently is not asserting any alarms.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmSeverityOrZero" }, "ceAlarmList": { "type": "string", "description": "This object specifies those alarms currently being asserted\n by the corresponding physical entity. Note, an alarm indicates\n a condition, not an event. An alarm has two states:\n \n 'asserted' Indicates that the condition described by the\n alarm exists.\n \n 'cleared' Indicates that the condition described by the\n alarm does not exist.\n \n For example, a slot in a chassis may define an alarm that\n specifies whether the slot contains a module. At the time of\n module insertion, the physical entity corresponding to the slot\n asserts this alarm, and the alarm remains asserted until the \n slot becomes empty.\n \n If an alarm is being asserted by the physical entity, then the\n corresponding bit in the alarm list is set to a one. Observe\n that if the physical entity is not currently asserting any\n alarms, then the list will have a length of zero.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmList" } } }, "example": { "CISCO-ENTITY-ALARM-MIB:ceAlarmEntry": { "entPhysicalIndex": "example-string", "ceAlarmFilterProfile": "example-string", "ceAlarmSeverity": "example-string", "ceAlarmList": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ceAlarmEntry-4" }, "x-yang-path": "/ceAlarmEntry={entPhysicalIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "entPhysicalIndex" ] }, "/data/CISCO-ENTITY-ALARM-MIB:ceAlarmHistEntry": { "get": { "summary": "Get ceAlarmHistEntry list", "description": "Retrieve list of ceAlarmHistEntry entries from MIB", "tags": [ "CISCO-ENTITY-ALARM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "The information conveyed by a ceAlarmIndicate or\n ceAlarmClear trap.", "items": { "type": "object", "properties": { "ceAlarmHistIndex": { "type": "integer", "description": "An integer value uniquely identifying the entry in the table.\n The value of this object starts at '1' and monotonically\n increases for each alarm condition transition monitored by the\n agent. If the value of this object is '4294967295', the agent\n will reset it to '1' upon monitoring the next alarm condition\n transition.", "minimum": 0, "maximum": 4294967295 }, "ceAlarmHistType": { "type": "string", "description": "This object specifies whether the agent created the entry as\n the result of an alarm being asserted or cleared." }, "ceAlarmHistEntPhysicalIndex": { "type": "string", "description": "This object specifies the physical entity that generated\n the alarm.", "x-yang-type": "entity-mib:PhysicalIndex" }, "ceAlarmHistAlarmType": { "type": "string", "description": "This object specifies the type of alarm generated.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmType" }, "ceAlarmHistSeverity": { "type": "string", "description": "This object specifies the severity of the alarm generated.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmSeverity" }, "ceAlarmHistTimeStamp": { "type": "string", "description": "This object specifies the value of the sysUpTime object at\n the time the alarm was generated.", "x-yang-type": "yang:timestamp" } } } }, "example": { "CISCO-ENTITY-ALARM-MIB:ceAlarmHistEntry": [ { "ceAlarmHistIndex": 1, "ceAlarmHistType": "ethernetCsmacd(6)", "ceAlarmHistEntPhysicalIndex": "example-string", "ceAlarmHistAlarmType": "ethernetCsmacd(6)", "ceAlarmHistSeverity": "example-string", "ceAlarmHistTimeStamp": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ceAlarmHistEntry-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": "/ceAlarmHistEntry", "x-restconf-kind": "container" }, "/data/CISCO-ENTITY-ALARM-MIB:ceAlarmHistEntry={ceAlarmHistIndex}": { "get": { "summary": "Get ceAlarmHistEntry entry", "description": "Retrieve specific ceAlarmHistEntry entry by key from MIB", "tags": [ "CISCO-ENTITY-ALARM-MIB" ], "parameters": [ { "name": "ceAlarmHistIndex", "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": { "ceAlarmHistIndex": { "type": "integer", "description": "An integer value uniquely identifying the entry in the table.\n The value of this object starts at '1' and monotonically\n increases for each alarm condition transition monitored by the\n agent. If the value of this object is '4294967295', the agent\n will reset it to '1' upon monitoring the next alarm condition\n transition.", "minimum": 0, "maximum": 4294967295 }, "ceAlarmHistType": { "type": "string", "description": "This object specifies whether the agent created the entry as\n the result of an alarm being asserted or cleared." }, "ceAlarmHistEntPhysicalIndex": { "type": "string", "description": "This object specifies the physical entity that generated\n the alarm.", "x-yang-type": "entity-mib:PhysicalIndex" }, "ceAlarmHistAlarmType": { "type": "string", "description": "This object specifies the type of alarm generated.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmType" }, "ceAlarmHistSeverity": { "type": "string", "description": "This object specifies the severity of the alarm generated.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmSeverity" }, "ceAlarmHistTimeStamp": { "type": "string", "description": "This object specifies the value of the sysUpTime object at\n the time the alarm was generated.", "x-yang-type": "yang:timestamp" } } }, "example": { "CISCO-ENTITY-ALARM-MIB:ceAlarmHistEntry": { "ceAlarmHistIndex": 1, "ceAlarmHistType": "ethernetCsmacd(6)", "ceAlarmHistEntPhysicalIndex": "example-string", "ceAlarmHistAlarmType": "ethernetCsmacd(6)", "ceAlarmHistSeverity": "example-string", "ceAlarmHistTimeStamp": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ceAlarmHistEntry-4" }, "x-yang-path": "/ceAlarmHistEntry={ceAlarmHistIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ceAlarmHistIndex" ] }, "/data/CISCO-ENTITY-ALARM-MIB:ceAlarmFilterProfileEntry": { "get": { "summary": "Get ceAlarmFilterProfileEntry list", "description": "Retrieve list of ceAlarmFilterProfileEntry entries from MIB", "tags": [ "CISCO-ENTITY-ALARM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "ceAlarmFilterProfileEntry", "items": { "type": "object", "properties": { "ceAlarmFilterIndex": { "type": "string", "description": "This object uniquely identifies the alarm filter profile.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmFilterProfileType" }, "ceAlarmFilterStatus": { "type": "string", "description": "This object facilitates the creation, modification, or \n deletion of a conceptual row in this table.\n \n A management client can create a conceptual row in this\n table by setting this object to 'createAndWait' or \n 'createAndGo'. If a request to create a conceptual row\n in this table fails, then the system is not capable of\n supporting any more alarm filters.\n \n Before modifying a conceptual row in this table, the \n management client must set this object to 'notInService'.\n After modifying a conceptual row in this table, the \n management client must set this object to 'active'.\n This operation causes the modifications made to an\n alarm filter profile to take effect.\n \n An implementation should not allow a conceptual row in\n this table to be deleted if one or more physical entities\n reference it.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ceAlarmFilterAlias": { "type": "string", "description": "This object specifies an arbitrary name associated with the\n alarm filter profile by the management client, and provides\n a non-volatile 'handle' for the alarm filter profile.\n \n On the first instantiation of an alarm filter profile, the\n value of this object is a zero-length string. However, an\n agent may choose to set the value to a locally unique default\n value.\n \n If an implementation supports write access to this object,\n then the agent is responsible for ensuring the retention\n of any value written to this object until a management client\n deletes it. The level of retention must span reboots and \n reinitializations of the network management system, including\n those that result in different assignments to the value of\n the entPhysicalIndex associated with the physical entity.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ceAlarmFilterAlarmsEnabled": { "type": "string", "description": "This object specifies a list of alarms that are enabled.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmList" }, "ceAlarmFilterNotifiesEnabled": { "type": "string", "description": "This object specifies a list of alarms for which notification\n generation is enabled.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmList" }, "ceAlarmFilterSyslogEnabled": { "type": "string", "description": "This object specifies a list of alarms for which syslog\n message generation is enabled.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmList" } } } }, "example": { "CISCO-ENTITY-ALARM-MIB:ceAlarmFilterProfileEntry": [ { "ceAlarmFilterIndex": "example-string", "ceAlarmFilterStatus": "up(1)", "ceAlarmFilterAlias": "example-string", "ceAlarmFilterAlarmsEnabled": "example-string", "ceAlarmFilterNotifiesEnabled": "example-string", "ceAlarmFilterSyslogEnabled": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ceAlarmFilterProfileEntry-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": "/ceAlarmFilterProfileEntry", "x-restconf-kind": "container" }, "/data/CISCO-ENTITY-ALARM-MIB:ceAlarmFilterProfileEntry={ceAlarmFilterIndex}": { "get": { "summary": "Get ceAlarmFilterProfileEntry entry", "description": "Retrieve specific ceAlarmFilterProfileEntry entry by key from MIB", "tags": [ "CISCO-ENTITY-ALARM-MIB" ], "parameters": [ { "name": "ceAlarmFilterIndex", "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": { "ceAlarmFilterIndex": { "type": "string", "description": "This object uniquely identifies the alarm filter profile.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmFilterProfileType" }, "ceAlarmFilterStatus": { "type": "string", "description": "This object facilitates the creation, modification, or \n deletion of a conceptual row in this table.\n \n A management client can create a conceptual row in this\n table by setting this object to 'createAndWait' or \n 'createAndGo'. If a request to create a conceptual row\n in this table fails, then the system is not capable of\n supporting any more alarm filters.\n \n Before modifying a conceptual row in this table, the \n management client must set this object to 'notInService'.\n After modifying a conceptual row in this table, the \n management client must set this object to 'active'.\n This operation causes the modifications made to an\n alarm filter profile to take effect.\n \n An implementation should not allow a conceptual row in\n this table to be deleted if one or more physical entities\n reference it.", "x-yang-type": "snmpv2-tc:RowStatus" }, "ceAlarmFilterAlias": { "type": "string", "description": "This object specifies an arbitrary name associated with the\n alarm filter profile by the management client, and provides\n a non-volatile 'handle' for the alarm filter profile.\n \n On the first instantiation of an alarm filter profile, the\n value of this object is a zero-length string. However, an\n agent may choose to set the value to a locally unique default\n value.\n \n If an implementation supports write access to this object,\n then the agent is responsible for ensuring the retention\n of any value written to this object until a management client\n deletes it. The level of retention must span reboots and \n reinitializations of the network management system, including\n those that result in different assignments to the value of\n the entPhysicalIndex associated with the physical entity.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ceAlarmFilterAlarmsEnabled": { "type": "string", "description": "This object specifies a list of alarms that are enabled.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmList" }, "ceAlarmFilterNotifiesEnabled": { "type": "string", "description": "This object specifies a list of alarms for which notification\n generation is enabled.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmList" }, "ceAlarmFilterSyslogEnabled": { "type": "string", "description": "This object specifies a list of alarms for which syslog\n message generation is enabled.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmList" } } }, "example": { "CISCO-ENTITY-ALARM-MIB:ceAlarmFilterProfileEntry": { "ceAlarmFilterIndex": "example-string", "ceAlarmFilterStatus": "up(1)", "ceAlarmFilterAlias": "example-string", "ceAlarmFilterAlarmsEnabled": "example-string", "ceAlarmFilterNotifiesEnabled": "example-string", "ceAlarmFilterSyslogEnabled": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ceAlarmFilterProfileEntry-4" }, "x-yang-path": "/ceAlarmFilterProfileEntry={ceAlarmFilterIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ceAlarmFilterIndex" ] }, "/data/CISCO-ENTITY-ALARM-MIB:ceAlarmDescrTable/ceAlarmDescrEntry={ceAlarmDescrIndex},{ceAlarmDescrAlarmType}": { "get": { "summary": "Get ceAlarmDescrEntry entry", "description": "Retrieve specific ceAlarmDescrEntry entry by key from MIB", "tags": [ "CISCO-ENTITY-ALARM-MIB" ], "parameters": [ { "name": "ceAlarmDescrIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ceAlarmDescrAlarmType", "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": { "ceAlarmDescrIndex": { "type": "string", "description": "ceAlarmDescrIndex", "x-yang-type": "leafref" }, "ceAlarmDescrAlarmType": { "type": "string", "description": "This object specifies the alarm type being described.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmType" }, "ceAlarmDescrSeverity": { "type": "string", "description": "This object specifies the severity associated with the\n alarm type.\n \n An implementation may chose to not allow dynamic severity\n assignment, in which case it would restrict access to this\n object to be read-only.\n \n If an implementation allows dynamic severity assignment, then\n a management client can revert to the default severity by\n writing the value '0' to this object.\n \n There exists a class of systems that should implement dynamic\n severity assignment. For example, consider a DSLAM (Digital\n Subscriber Loop Access Multiplexor) designed for both the\n central office and pedestal environments. A 'pedestal' is\n typically a dark-green metal box mounted on a concrete or stone\n foundation in which carrier-class companies house equipment.\n The central office typically controls the temperature and\n humidity of the environment, reducing reliance on a system's\n fans. Thus, the customer probably has a desire to reduce the \n severity of alarms indicating the failure of a fan. However, a\n pedestal environment has a much greater reliance on a system's\n fans. Thus, the customer probably has a desire to increase the\n severity of alarms indicating the failure of a fan.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmSeverityOrZero" }, "ceAlarmDescrText": { "type": "string", "description": "This object specifies a human-readable message describing\n the alarm.", "x-yang-type": "snmp-framework:SnmpAdminString" } } }, "example": { "CISCO-ENTITY-ALARM-MIB:ceAlarmDescrEntry": { "ceAlarmDescrIndex": "GigabitEthernet1/0/1", "ceAlarmDescrAlarmType": "GigabitEthernet1/0/1", "ceAlarmDescrSeverity": "GigabitEthernet1/0/1", "ceAlarmDescrText": "GigabitEthernet1/0/1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ceAlarmDescrEntry-2" }, "x-yang-path": "/ceAlarmDescrTable/ceAlarmDescrEntry={ceAlarmDescrIndex ceAlarmDescrAlarmType}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ceAlarmDescrIndex ceAlarmDescrAlarmType" ] }, "/data/CISCO-ENTITY-ALARM-MIB:ceAlarmDescrEntry={ceAlarmDescrIndex},{ceAlarmDescrAlarmType}": { "get": { "summary": "Get ceAlarmDescrEntry entry", "description": "Retrieve specific ceAlarmDescrEntry entry by key from MIB", "tags": [ "CISCO-ENTITY-ALARM-MIB" ], "parameters": [ { "name": "ceAlarmDescrIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ceAlarmDescrAlarmType", "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": { "ceAlarmDescrIndex": { "type": "string", "description": "ceAlarmDescrIndex", "x-yang-type": "leafref" }, "ceAlarmDescrAlarmType": { "type": "string", "description": "This object specifies the alarm type being described.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmType" }, "ceAlarmDescrSeverity": { "type": "string", "description": "This object specifies the severity associated with the\n alarm type.\n \n An implementation may chose to not allow dynamic severity\n assignment, in which case it would restrict access to this\n object to be read-only.\n \n If an implementation allows dynamic severity assignment, then\n a management client can revert to the default severity by\n writing the value '0' to this object.\n \n There exists a class of systems that should implement dynamic\n severity assignment. For example, consider a DSLAM (Digital\n Subscriber Loop Access Multiplexor) designed for both the\n central office and pedestal environments. A 'pedestal' is\n typically a dark-green metal box mounted on a concrete or stone\n foundation in which carrier-class companies house equipment.\n The central office typically controls the temperature and\n humidity of the environment, reducing reliance on a system's\n fans. Thus, the customer probably has a desire to reduce the \n severity of alarms indicating the failure of a fan. However, a\n pedestal environment has a much greater reliance on a system's\n fans. Thus, the customer probably has a desire to increase the\n severity of alarms indicating the failure of a fan.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmSeverityOrZero" }, "ceAlarmDescrText": { "type": "string", "description": "This object specifies a human-readable message describing\n the alarm.", "x-yang-type": "snmp-framework:SnmpAdminString" } } }, "example": { "CISCO-ENTITY-ALARM-MIB:ceAlarmDescrEntry": { "ceAlarmDescrIndex": "GigabitEthernet1/0/1", "ceAlarmDescrAlarmType": "GigabitEthernet1/0/1", "ceAlarmDescrSeverity": "GigabitEthernet1/0/1", "ceAlarmDescrText": "GigabitEthernet1/0/1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ceAlarmDescrEntry-4" }, "x-yang-path": "/ceAlarmDescrEntry={ceAlarmDescrIndex ceAlarmDescrAlarmType}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ceAlarmDescrIndex ceAlarmDescrAlarmType" ] } }, "components": { "schemas": { "CISCO-ENTITY-ALARM-MIB_CISCO-ENTITY-ALARM-MIB": { "type": "object", "description": "The value of this object specifies the number of alarms\n currently asserted with a severity of 'critical'.", "properties": { "ceAlarmDescrMapEntry": { "type": "array", "description": "A mapping between an alarm description and a vendor type.", "items": { "type": "object", "properties": { "ceAlarmDescrIndex": { "type": "integer", "description": "This object uniquely identifies an alarm description.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ceAlarmDescrVendorType": { "type": "string", "description": "This object specifies an object identifier (typically an\n enterprise-specific OID) that uniquely identifies the vendor\n type of those physical entities that this alarm description\n applies to.", "x-yang-type": "snmpv2-tc:AutonomousType", "readOnly": true } } }, "readOnly": true }, "ceAlarmDescrEntry": { "type": "array", "description": "A collection of attributes that describe an alarm type.", "items": { "type": "object", "properties": { "ceAlarmDescrIndex": { "type": "string", "description": "ceAlarmDescrIndex", "x-yang-type": "leafref", "readOnly": true }, "ceAlarmDescrAlarmType": { "type": "string", "description": "This object specifies the alarm type being described.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmType", "readOnly": true }, "ceAlarmDescrSeverity": { "type": "string", "description": "This object specifies the severity associated with the\n alarm type.\n \n An implementation may chose to not allow dynamic severity\n assignment, in which case it would restrict access to this\n object to be read-only.\n \n If an implementation allows dynamic severity assignment, then\n a management client can revert to the default severity by\n writing the value '0' to this object.\n \n There exists a class of systems that should implement dynamic\n severity assignment. For example, consider a DSLAM (Digital\n Subscriber Loop Access Multiplexor) designed for both the\n central office and pedestal environments. A 'pedestal' is\n typically a dark-green metal box mounted on a concrete or stone\n foundation in which carrier-class companies house equipment.\n The central office typically controls the temperature and\n humidity of the environment, reducing reliance on a system's\n fans. Thus, the customer probably has a desire to reduce the \n severity of alarms indicating the failure of a fan. However, a\n pedestal environment has a much greater reliance on a system's\n fans. Thus, the customer probably has a desire to increase the\n severity of alarms indicating the failure of a fan.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmSeverityOrZero", "readOnly": true }, "ceAlarmDescrText": { "type": "string", "description": "This object specifies a human-readable message describing\n the alarm.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } }, "readOnly": true }, "ceAlarmEntry": { "type": "array", "description": "Alarm control and status information related to the \n corresponding physical entity, including a list of those\n alarms currently being asserted by that physical entity.", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref", "readOnly": true }, "ceAlarmFilterProfile": { "type": "string", "description": "This object specifies the alarm filter profile associated\n with the corresponding physical entity. An alarm filter\n profile controls which alarm types the agent will monitor\n and signal for the corresponding physical entity.\n \n If the value of this object is '0', then the agent monitors\n and signals all alarms associated with the corresponding\n physical entity.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmFilterProfileType", "readOnly": true }, "ceAlarmSeverity": { "type": "string", "description": "This object specifies the highest severity alarm currently\n being asserted by the corresponding physical entity. A value\n of '0' indicates that there the corresponding physical entity\n currently is not asserting any alarms.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmSeverityOrZero", "readOnly": true }, "ceAlarmList": { "type": "string", "description": "This object specifies those alarms currently being asserted\n by the corresponding physical entity. Note, an alarm indicates\n a condition, not an event. An alarm has two states:\n \n 'asserted' Indicates that the condition described by the\n alarm exists.\n \n 'cleared' Indicates that the condition described by the\n alarm does not exist.\n \n For example, a slot in a chassis may define an alarm that\n specifies whether the slot contains a module. At the time of\n module insertion, the physical entity corresponding to the slot\n asserts this alarm, and the alarm remains asserted until the \n slot becomes empty.\n \n If an alarm is being asserted by the physical entity, then the\n corresponding bit in the alarm list is set to a one. Observe\n that if the physical entity is not currently asserting any\n alarms, then the list will have a length of zero.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmList", "readOnly": true } } }, "readOnly": true }, "ceAlarmHistEntry": { "type": "array", "description": "The information conveyed by a ceAlarmIndicate or\n ceAlarmClear trap.", "items": { "type": "object", "properties": { "ceAlarmHistIndex": { "type": "integer", "description": "An integer value uniquely identifying the entry in the table.\n The value of this object starts at '1' and monotonically\n increases for each alarm condition transition monitored by the\n agent. If the value of this object is '4294967295', the agent\n will reset it to '1' upon monitoring the next alarm condition\n transition.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ceAlarmHistType": { "type": "string", "description": "This object specifies whether the agent created the entry as\n the result of an alarm being asserted or cleared.", "readOnly": true }, "ceAlarmHistEntPhysicalIndex": { "type": "string", "description": "This object specifies the physical entity that generated\n the alarm.", "x-yang-type": "entity-mib:PhysicalIndex", "readOnly": true }, "ceAlarmHistAlarmType": { "type": "string", "description": "This object specifies the type of alarm generated.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmType", "readOnly": true }, "ceAlarmHistSeverity": { "type": "string", "description": "This object specifies the severity of the alarm generated.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmSeverity", "readOnly": true }, "ceAlarmHistTimeStamp": { "type": "string", "description": "This object specifies the value of the sysUpTime object at\n the time the alarm was generated.", "x-yang-type": "yang:timestamp", "readOnly": true } } }, "readOnly": true }, "ceAlarmFilterProfileEntry": { "type": "array", "description": "ceAlarmFilterProfileEntry", "items": { "type": "object", "properties": { "ceAlarmFilterIndex": { "type": "string", "description": "This object uniquely identifies the alarm filter profile.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmFilterProfileType", "readOnly": true }, "ceAlarmFilterStatus": { "type": "string", "description": "This object facilitates the creation, modification, or \n deletion of a conceptual row in this table.\n \n A management client can create a conceptual row in this\n table by setting this object to 'createAndWait' or \n 'createAndGo'. If a request to create a conceptual row\n in this table fails, then the system is not capable of\n supporting any more alarm filters.\n \n Before modifying a conceptual row in this table, the \n management client must set this object to 'notInService'.\n After modifying a conceptual row in this table, the \n management client must set this object to 'active'.\n This operation causes the modifications made to an\n alarm filter profile to take effect.\n \n An implementation should not allow a conceptual row in\n this table to be deleted if one or more physical entities\n reference it.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ceAlarmFilterAlias": { "type": "string", "description": "This object specifies an arbitrary name associated with the\n alarm filter profile by the management client, and provides\n a non-volatile 'handle' for the alarm filter profile.\n \n On the first instantiation of an alarm filter profile, the\n value of this object is a zero-length string. However, an\n agent may choose to set the value to a locally unique default\n value.\n \n If an implementation supports write access to this object,\n then the agent is responsible for ensuring the retention\n of any value written to this object until a management client\n deletes it. The level of retention must span reboots and \n reinitializations of the network management system, including\n those that result in different assignments to the value of\n the entPhysicalIndex associated with the physical entity.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ceAlarmFilterAlarmsEnabled": { "type": "string", "description": "This object specifies a list of alarms that are enabled.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmList", "readOnly": true }, "ceAlarmFilterNotifiesEnabled": { "type": "string", "description": "This object specifies a list of alarms for which notification\n generation is enabled.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmList", "readOnly": true }, "ceAlarmFilterSyslogEnabled": { "type": "string", "description": "This object specifies a list of alarms for which syslog\n message generation is enabled.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmList", "readOnly": true } } }, "readOnly": true }, "ceAlarmMonitoring": { "type": "object", "description": "The value of this object specifies the number of alarms\n currently asserted with a severity of 'critical'.", "properties": { "ceAlarmCriticalCount": { "type": "integer", "description": "The value of this object specifies the number of alarms\n currently asserted with a severity of 'critical'.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ceAlarmMajorCount": { "type": "integer", "description": "The value of this object specifies the number of alarms\n currently asserted with a severity of 'major'.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ceAlarmMinorCount": { "type": "integer", "description": "The value of this object specifies the number of alarms\n currently asserted with a severity of 'minor'.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ceAlarmCutOff": { "type": "boolean", "description": "If the management client writes a value of 'true' to this\n object, the agent stops signalling all external audible alarms\n under the control of the agent. Reading this object should\n always result in a value of 'false'.\n \n Observe that alarm cutoff does not have an effect on monitoring,\n history logging, generation of notifications, or syslog message\n generation. It also does not prevent the agent from signalling\n external audible alarms for alarms asserted after alarm-cutoff.\n \n This object emulates the 'alarm cut-off' mechanism typically\n installed in a central office (e.g., a big red button). Observe\n this object should neither affect external visual alarms under\n the control of the agent, nor should it affect the current state\n of alarms being asserted by the system.", "readOnly": true } }, "readOnly": true }, "ceAlarmHistory": { "type": "object", "description": "ceAlarmHistory", "properties": { "ceAlarmHistTableSize": { "type": "integer", "description": "This object specifies the number of entries that the \n ceAlarmHistTable can contain. When a physical entity\n generates an unfiltered alarm, and the capacity of the\n ceAlarmHistTable has reached the value specified by\n this object, then the agent deletes the oldest entity in\n order to accommodate the new entry. A value of '0' prevents\n any history from being retained.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ceAlarmHistLastIndex": { "type": "integer", "description": "This object specifies the value of the ceAlarmHistIndex\n object corresponding to the last entry added to the table by the\n agent.\n \n If the management client uses the notifications defined by this\n module, then it can poll this object to determine whether it has\n missed a notification sent by the agent.", "minimum": 0, "maximum": 4294967295, "readOnly": true } }, "readOnly": true }, "ceAlarmFiltering": { "type": "object", "description": "ceAlarmFiltering", "properties": { "ceAlarmNotifiesEnable": { "type": "string", "description": "This object specifies a severity threshold governing the\n generation of ceAlarmAsserted and ceAlarmCleared\n notifications. For example, if the value of this object is\n set to 'major', then the agent generates these notifications\n if and only if the severity of the alarm being indicated is\n 'major' or 'critical'. The value of '0' disables the \n generation of notifications.\n \n Observe that this setting overrides the value of the \n ceAlarmFilterNotifiesEnabled object.\n \n This object affects notification generation only; that is, it\n does not affect monitoring, history logging, and syslog message\n generation.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmSeverityOrZero", "readOnly": true }, "ceAlarmSyslogEnable": { "type": "string", "description": "This object specifies a severity threshold governing the\n generation of syslog messages corresponding to alarms. For\n example, if the value of this object is set to 'major', then\n the agent generates these a syslog message if and only if the\n severity of the alarm being indicated is 'major' or 'critical'.\n The value of '0' disables the generation of syslog messages\n corresponding to alarms.\n \n Observe that this setting overrides the value of the \n ceAlarmFilterSyslogEnabled object.\n \n This object affects syslog message generation only; that is, it\n does not have an effect on monitoring, history logging, and\n generation of notifications.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmSeverityOrZero", "readOnly": true }, "ceAlarmFilterProfileIndexNext": { "type": "string", "description": "This object contains an appropriate value to be used\n for ceAlarmFilterIndex when creating entries in the\n ceAlarmFilterProfileTable. The value '0' indicates\n that no unassigned entries are available. To obtain\n a ceAlarmFilterIndex, the management client issues\n a get request. The agent has the responsibility of \n modifying the value of this object following each \n successful get request.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmFilterProfileType", "readOnly": true } }, "readOnly": true }, "ceAlarmDescrMapTable": { "type": "object", "description": "For each type of entity (represented entPhysicalVendorType\n OID), this table contains a mapping between a unique \n ceAlarmDescrIndex and entPhysicalvendorType OID.", "properties": { "ceAlarmDescrMapEntry": { "type": "array", "description": "A mapping between an alarm description and a vendor type.", "items": { "type": "object", "properties": { "ceAlarmDescrIndex": { "type": "integer", "description": "This object uniquely identifies an alarm description.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ceAlarmDescrVendorType": { "type": "string", "description": "This object specifies an object identifier (typically an\n enterprise-specific OID) that uniquely identifies the vendor\n type of those physical entities that this alarm description\n applies to.", "x-yang-type": "snmpv2-tc:AutonomousType", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ceAlarmDescrTable": { "type": "object", "description": "This table contains a description for each alarm type\n defined by each vendor type employed by the system.\n Observe that this table is sparse in nature, as it is\n rarely the case that a physical entity type needs to \n define every alarm in its alarm space.", "properties": { "ceAlarmDescrEntry": { "type": "array", "description": "A collection of attributes that describe an alarm type.", "items": { "type": "object", "properties": { "ceAlarmDescrIndex": { "type": "string", "description": "ceAlarmDescrIndex", "x-yang-type": "leafref", "readOnly": true }, "ceAlarmDescrAlarmType": { "type": "string", "description": "This object specifies the alarm type being described.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmType", "readOnly": true }, "ceAlarmDescrSeverity": { "type": "string", "description": "This object specifies the severity associated with the\n alarm type.\n \n An implementation may chose to not allow dynamic severity\n assignment, in which case it would restrict access to this\n object to be read-only.\n \n If an implementation allows dynamic severity assignment, then\n a management client can revert to the default severity by\n writing the value '0' to this object.\n \n There exists a class of systems that should implement dynamic\n severity assignment. For example, consider a DSLAM (Digital\n Subscriber Loop Access Multiplexor) designed for both the\n central office and pedestal environments. A 'pedestal' is\n typically a dark-green metal box mounted on a concrete or stone\n foundation in which carrier-class companies house equipment.\n The central office typically controls the temperature and\n humidity of the environment, reducing reliance on a system's\n fans. Thus, the customer probably has a desire to reduce the \n severity of alarms indicating the failure of a fan. However, a\n pedestal environment has a much greater reliance on a system's\n fans. Thus, the customer probably has a desire to increase the\n severity of alarms indicating the failure of a fan.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmSeverityOrZero", "readOnly": true }, "ceAlarmDescrText": { "type": "string", "description": "This object specifies a human-readable message describing\n the alarm.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ceAlarmTable": { "type": "object", "description": "This table specifies alarm control and status information\n related to each physical entity contained by the system,\n including the alarms currently being asserted by each physical\n entity capable of generating alarms.", "properties": { "ceAlarmEntry": { "type": "array", "description": "Alarm control and status information related to the \n corresponding physical entity, including a list of those\n alarms currently being asserted by that physical entity.", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref", "readOnly": true }, "ceAlarmFilterProfile": { "type": "string", "description": "This object specifies the alarm filter profile associated\n with the corresponding physical entity. An alarm filter\n profile controls which alarm types the agent will monitor\n and signal for the corresponding physical entity.\n \n If the value of this object is '0', then the agent monitors\n and signals all alarms associated with the corresponding\n physical entity.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmFilterProfileType", "readOnly": true }, "ceAlarmSeverity": { "type": "string", "description": "This object specifies the highest severity alarm currently\n being asserted by the corresponding physical entity. A value\n of '0' indicates that there the corresponding physical entity\n currently is not asserting any alarms.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmSeverityOrZero", "readOnly": true }, "ceAlarmList": { "type": "string", "description": "This object specifies those alarms currently being asserted\n by the corresponding physical entity. Note, an alarm indicates\n a condition, not an event. An alarm has two states:\n \n 'asserted' Indicates that the condition described by the\n alarm exists.\n \n 'cleared' Indicates that the condition described by the\n alarm does not exist.\n \n For example, a slot in a chassis may define an alarm that\n specifies whether the slot contains a module. At the time of\n module insertion, the physical entity corresponding to the slot\n asserts this alarm, and the alarm remains asserted until the \n slot becomes empty.\n \n If an alarm is being asserted by the physical entity, then the\n corresponding bit in the alarm list is set to a one. Observe\n that if the physical entity is not currently asserting any\n alarms, then the list will have a length of zero.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmList", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ceAlarmHistTable": { "type": "object", "description": "This table contains a history of ceAlarmIndicate and\n ceAlarmClear traps generated by the agent.", "properties": { "ceAlarmHistEntry": { "type": "array", "description": "The information conveyed by a ceAlarmIndicate or\n ceAlarmClear trap.", "items": { "type": "object", "properties": { "ceAlarmHistIndex": { "type": "integer", "description": "An integer value uniquely identifying the entry in the table.\n The value of this object starts at '1' and monotonically\n increases for each alarm condition transition monitored by the\n agent. If the value of this object is '4294967295', the agent\n will reset it to '1' upon monitoring the next alarm condition\n transition.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ceAlarmHistType": { "type": "string", "description": "This object specifies whether the agent created the entry as\n the result of an alarm being asserted or cleared.", "readOnly": true }, "ceAlarmHistEntPhysicalIndex": { "type": "string", "description": "This object specifies the physical entity that generated\n the alarm.", "x-yang-type": "entity-mib:PhysicalIndex", "readOnly": true }, "ceAlarmHistAlarmType": { "type": "string", "description": "This object specifies the type of alarm generated.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmType", "readOnly": true }, "ceAlarmHistSeverity": { "type": "string", "description": "This object specifies the severity of the alarm generated.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmSeverity", "readOnly": true }, "ceAlarmHistTimeStamp": { "type": "string", "description": "This object specifies the value of the sysUpTime object at\n the time the alarm was generated.", "x-yang-type": "yang:timestamp", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ceAlarmFilterProfileTable": { "type": "object", "description": "This table contains a list of alarm filter profiles.", "properties": { "ceAlarmFilterProfileEntry": { "type": "array", "description": "ceAlarmFilterProfileEntry", "items": { "type": "object", "properties": { "ceAlarmFilterIndex": { "type": "string", "description": "This object uniquely identifies the alarm filter profile.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmFilterProfileType", "readOnly": true }, "ceAlarmFilterStatus": { "type": "string", "description": "This object facilitates the creation, modification, or \n deletion of a conceptual row in this table.\n \n A management client can create a conceptual row in this\n table by setting this object to 'createAndWait' or \n 'createAndGo'. If a request to create a conceptual row\n in this table fails, then the system is not capable of\n supporting any more alarm filters.\n \n Before modifying a conceptual row in this table, the \n management client must set this object to 'notInService'.\n After modifying a conceptual row in this table, the \n management client must set this object to 'active'.\n This operation causes the modifications made to an\n alarm filter profile to take effect.\n \n An implementation should not allow a conceptual row in\n this table to be deleted if one or more physical entities\n reference it.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ceAlarmFilterAlias": { "type": "string", "description": "This object specifies an arbitrary name associated with the\n alarm filter profile by the management client, and provides\n a non-volatile 'handle' for the alarm filter profile.\n \n On the first instantiation of an alarm filter profile, the\n value of this object is a zero-length string. However, an\n agent may choose to set the value to a locally unique default\n value.\n \n If an implementation supports write access to this object,\n then the agent is responsible for ensuring the retention\n of any value written to this object until a management client\n deletes it. The level of retention must span reboots and \n reinitializations of the network management system, including\n those that result in different assignments to the value of\n the entPhysicalIndex associated with the physical entity.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ceAlarmFilterAlarmsEnabled": { "type": "string", "description": "This object specifies a list of alarms that are enabled.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmList", "readOnly": true }, "ceAlarmFilterNotifiesEnabled": { "type": "string", "description": "This object specifies a list of alarms for which notification\n generation is enabled.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmList", "readOnly": true }, "ceAlarmFilterSyslogEnabled": { "type": "string", "description": "This object specifies a list of alarms for which syslog\n message generation is enabled.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmList", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "CISCO-ENTITY-ALARM-MIB_object-1": { "type": "object", "description": "object-1", "properties": { "ceAlarmHistIndex": { "type": "string", "description": "ceAlarmHistIndex", "x-yang-type": "leafref", "readOnly": true }, "ceAlarmHistEntPhysicalIndex": { "type": "string", "description": "ceAlarmHistEntPhysicalIndex", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-ENTITY-ALARM-MIB_object-2": { "type": "object", "description": "object-2", "properties": { "ceAlarmHistIndex": { "type": "string", "description": "ceAlarmHistIndex", "x-yang-type": "leafref", "readOnly": true }, "ceAlarmHistAlarmType": { "type": "string", "description": "ceAlarmHistAlarmType", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-ENTITY-ALARM-MIB_object-3": { "type": "object", "description": "object-3", "properties": { "ceAlarmHistIndex": { "type": "string", "description": "ceAlarmHistIndex", "x-yang-type": "leafref", "readOnly": true }, "ceAlarmHistSeverity": { "type": "string", "description": "ceAlarmHistSeverity", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-ENTITY-ALARM-MIB_object-4": { "type": "object", "description": "object-4", "properties": { "ceAlarmHistIndex": { "type": "string", "description": "ceAlarmHistIndex", "x-yang-type": "leafref", "readOnly": true }, "ceAlarmHistTimeStamp": { "type": "string", "description": "ceAlarmHistTimeStamp", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-ENTITY-ALARM-MIB_ceAlarmDescrMapEntry": { "type": "array", "description": "A mapping between an alarm description and a vendor type.", "items": { "type": "object", "properties": { "ceAlarmDescrIndex": { "type": "integer", "description": "This object uniquely identifies an alarm description.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ceAlarmDescrVendorType": { "type": "string", "description": "This object specifies an object identifier (typically an\n enterprise-specific OID) that uniquely identifies the vendor\n type of those physical entities that this alarm description\n applies to.", "x-yang-type": "snmpv2-tc:AutonomousType", "readOnly": true } } } }, "CISCO-ENTITY-ALARM-MIB_ceAlarmDescrEntry": { "type": "array", "description": "A collection of attributes that describe an alarm type.", "items": { "type": "object", "properties": { "ceAlarmDescrIndex": { "type": "string", "description": "ceAlarmDescrIndex", "x-yang-type": "leafref", "readOnly": true }, "ceAlarmDescrAlarmType": { "type": "string", "description": "This object specifies the alarm type being described.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmType", "readOnly": true }, "ceAlarmDescrSeverity": { "type": "string", "description": "This object specifies the severity associated with the\n alarm type.\n \n An implementation may chose to not allow dynamic severity\n assignment, in which case it would restrict access to this\n object to be read-only.\n \n If an implementation allows dynamic severity assignment, then\n a management client can revert to the default severity by\n writing the value '0' to this object.\n \n There exists a class of systems that should implement dynamic\n severity assignment. For example, consider a DSLAM (Digital\n Subscriber Loop Access Multiplexor) designed for both the\n central office and pedestal environments. A 'pedestal' is\n typically a dark-green metal box mounted on a concrete or stone\n foundation in which carrier-class companies house equipment.\n The central office typically controls the temperature and\n humidity of the environment, reducing reliance on a system's\n fans. Thus, the customer probably has a desire to reduce the \n severity of alarms indicating the failure of a fan. However, a\n pedestal environment has a much greater reliance on a system's\n fans. Thus, the customer probably has a desire to increase the\n severity of alarms indicating the failure of a fan.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmSeverityOrZero", "readOnly": true }, "ceAlarmDescrText": { "type": "string", "description": "This object specifies a human-readable message describing\n the alarm.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } } }, "CISCO-ENTITY-ALARM-MIB_ceAlarmEntry": { "type": "array", "description": "Alarm control and status information related to the \n corresponding physical entity, including a list of those\n alarms currently being asserted by that physical entity.", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref", "readOnly": true }, "ceAlarmFilterProfile": { "type": "string", "description": "This object specifies the alarm filter profile associated\n with the corresponding physical entity. An alarm filter\n profile controls which alarm types the agent will monitor\n and signal for the corresponding physical entity.\n \n If the value of this object is '0', then the agent monitors\n and signals all alarms associated with the corresponding\n physical entity.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmFilterProfileType", "readOnly": true }, "ceAlarmSeverity": { "type": "string", "description": "This object specifies the highest severity alarm currently\n being asserted by the corresponding physical entity. A value\n of '0' indicates that there the corresponding physical entity\n currently is not asserting any alarms.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmSeverityOrZero", "readOnly": true }, "ceAlarmList": { "type": "string", "description": "This object specifies those alarms currently being asserted\n by the corresponding physical entity. Note, an alarm indicates\n a condition, not an event. An alarm has two states:\n \n 'asserted' Indicates that the condition described by the\n alarm exists.\n \n 'cleared' Indicates that the condition described by the\n alarm does not exist.\n \n For example, a slot in a chassis may define an alarm that\n specifies whether the slot contains a module. At the time of\n module insertion, the physical entity corresponding to the slot\n asserts this alarm, and the alarm remains asserted until the \n slot becomes empty.\n \n If an alarm is being asserted by the physical entity, then the\n corresponding bit in the alarm list is set to a one. Observe\n that if the physical entity is not currently asserting any\n alarms, then the list will have a length of zero.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmList", "readOnly": true } } } }, "CISCO-ENTITY-ALARM-MIB_ceAlarmHistEntry": { "type": "array", "description": "The information conveyed by a ceAlarmIndicate or\n ceAlarmClear trap.", "items": { "type": "object", "properties": { "ceAlarmHistIndex": { "type": "integer", "description": "An integer value uniquely identifying the entry in the table.\n The value of this object starts at '1' and monotonically\n increases for each alarm condition transition monitored by the\n agent. If the value of this object is '4294967295', the agent\n will reset it to '1' upon monitoring the next alarm condition\n transition.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ceAlarmHistType": { "type": "string", "description": "This object specifies whether the agent created the entry as\n the result of an alarm being asserted or cleared.", "readOnly": true }, "ceAlarmHistEntPhysicalIndex": { "type": "string", "description": "This object specifies the physical entity that generated\n the alarm.", "x-yang-type": "entity-mib:PhysicalIndex", "readOnly": true }, "ceAlarmHistAlarmType": { "type": "string", "description": "This object specifies the type of alarm generated.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmType", "readOnly": true }, "ceAlarmHistSeverity": { "type": "string", "description": "This object specifies the severity of the alarm generated.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmSeverity", "readOnly": true }, "ceAlarmHistTimeStamp": { "type": "string", "description": "This object specifies the value of the sysUpTime object at\n the time the alarm was generated.", "x-yang-type": "yang:timestamp", "readOnly": true } } } }, "CISCO-ENTITY-ALARM-MIB_ceAlarmFilterProfileEntry": { "type": "array", "description": "ceAlarmFilterProfileEntry", "items": { "type": "object", "properties": { "ceAlarmFilterIndex": { "type": "string", "description": "This object uniquely identifies the alarm filter profile.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmFilterProfileType", "readOnly": true }, "ceAlarmFilterStatus": { "type": "string", "description": "This object facilitates the creation, modification, or \n deletion of a conceptual row in this table.\n \n A management client can create a conceptual row in this\n table by setting this object to 'createAndWait' or \n 'createAndGo'. If a request to create a conceptual row\n in this table fails, then the system is not capable of\n supporting any more alarm filters.\n \n Before modifying a conceptual row in this table, the \n management client must set this object to 'notInService'.\n After modifying a conceptual row in this table, the \n management client must set this object to 'active'.\n This operation causes the modifications made to an\n alarm filter profile to take effect.\n \n An implementation should not allow a conceptual row in\n this table to be deleted if one or more physical entities\n reference it.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "ceAlarmFilterAlias": { "type": "string", "description": "This object specifies an arbitrary name associated with the\n alarm filter profile by the management client, and provides\n a non-volatile 'handle' for the alarm filter profile.\n \n On the first instantiation of an alarm filter profile, the\n value of this object is a zero-length string. However, an\n agent may choose to set the value to a locally unique default\n value.\n \n If an implementation supports write access to this object,\n then the agent is responsible for ensuring the retention\n of any value written to this object until a management client\n deletes it. The level of retention must span reboots and \n reinitializations of the network management system, including\n those that result in different assignments to the value of\n the entPhysicalIndex associated with the physical entity.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ceAlarmFilterAlarmsEnabled": { "type": "string", "description": "This object specifies a list of alarms that are enabled.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmList", "readOnly": true }, "ceAlarmFilterNotifiesEnabled": { "type": "string", "description": "This object specifies a list of alarms for which notification\n generation is enabled.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmList", "readOnly": true }, "ceAlarmFilterSyslogEnabled": { "type": "string", "description": "This object specifies a list of alarms for which syslog\n message generation is enabled.", "x-yang-type": "CISCO-ENTITY-ALARM-MIB:AlarmList", "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-ENTITY-ALARM-MIB", "description": "MIB operations for CISCO-ENTITY-ALARM-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }