- 'alarmDefinitionId': fields.String,
- 'alarmName': fields.String,
- 'alarmLastChange': fields.String,
- 'alarmChangeType': fields.String,
- 'alarmDescription': fields.String,
- 'proposedRepairActions': fields.String,
- 'clearingType': fields.String,
- 'managementInterfaceId': fields.String,
- 'pkNotificationField': fields.String,
- 'alarmAdditionalFields': fields.String,
+ 'alarmDefinitionId': fields.String(
+ example='eaefa070-7cb6-3403-be46-177bd9ccc2d3',
+ description='Provides a unique identifier of the alarm ' +
+ 'being raised.'),
+ 'alarmName': fields.String(
+ example='100.104',
+ description='Provides short name for the alarm.'),
+ 'alarmLastChange': fields.String(
+ example='0.1',
+ description='Indicates the Alarm Dictionary Version in ' +
+ 'which this alarm last changed.'),
+ 'alarmChangeType': fields.String(
+ example='ADDED',
+ description='Indicates the type of change that occurred ' +
+ 'during the alarm last change; added, deleted, modified.'),
+ 'alarmDescription': fields.String(
+ example='host=<hostname>.filesystem=<mount-dir>\n ' +
+ 'File System threshold exceeded; threshold x%, actual y% .\n' +
+ ' CRITICAL @ 90%\n ' +
+ 'MAJOR @ 80%\nOR\n' +
+ 'host=<hostname>.volumegroup=<volumegroup-name>\n ' +
+ 'Monitor and if condition persists, consider addin ...',
+ description='Provides a longer descriptive meaning of ' +
+ 'the alarm condition and a description of the ' +
+ 'consequences of the alarm condition.'),
+ 'proposedRepairActions': fields.String(
+ example='Reduce usage or resize filesystem.',
+ description='Provides guidance for proposed repair actions.'),
+ 'clearingType': fields.String(
+ example='MANUAL',
+ description='Identifies whether alarm is cleared ' +
+ 'automatically or manually.'),
+ 'managementInterfaceId': fields.String(
+ example='O2IMS',
+ description='List of management interface over which ' +
+ 'alarms are transmitted for this Entity Type.'),
+ 'pkNotificationField': fields.String(
+ example='',
+ description='Identifies which field or list of fields in ' +
+ 'the alarm notification contains the primary key (PK) into ' +
+ 'the Alarm Dictionary for this interface; i.e. which ' +
+ 'field contains the Alarm Definition ID.'),
+ 'alarmAdditionalFields': fields.String(
+ example='',
+ description='List of metadata key-value pairs used to ' +
+ 'associate meaningful metadata to the related resource type.'),