• ca_dmi_add_package() - page 100

• ca_dmi_attrValChngNotif() - page 101

• ca_dmi_attrValChngNotifSingle() - page 103

• ca_dmi_bldAttrChngLst() - page 105

• ca_dmi_bldAttrLst() - page 107 - page 107

• ca_dmi_commsAlrmNotif() - page 108

• ca_dmi_encode_moi_usrRef() - page 110

• ca_dmi_encode_objectClass() - page 111

• ca_dmi_envAlrmNotif() - page 112

• ca_dmi_equipAlrmNotif() - page 114

• ca_dmi_freeAttrChngLst() - page 115

• ca_dmi_freeAttrLst() - page 116

• ca_dmi_init() - page 117

• ca_dmi_objCreNotif() - page 118

• ca_dmi_objDelNotif() - page 120

• ca_dmi_object_init() - page 122

• ca_dmi_procErrAlrmNotif() - page 124

• ca_dmi_qualOfSvceAlrmNotif() - page 126

• ca_dmi_relChngNotif() - page 127

• ca_dmi_relChngNotifSingle() - page 129

• ca_dmi_stateChngNotif() - page 131

• ca_dmi_stateChngNotifSingle() - page 133

• ca_dmi_tick() - page 135

Synopsis

---

#include <cmip/xom.h> #include <tmn_agent/usr_caDefs.h> #include <tmn_agent/usr_caDmi.h> OM_return_code ca_dmi_add_package( ca_ident_t *id, OM_string *encod );

---

Arguments

The id parameter contains the OID to be added. The id parameter does not need to be encoded.

The encod parameter contains the current encoded data. Before calling the ca_dmi_add_package() function for the first time, this parameter must be initialized to NULL.

Synopsis

---

#include <cmip/xom.h> #include <tmn_agent/usr_caDefs.h> #include <tmn_agent/usr_caDmi.h> OM_return_code ca_dmi_attrValChngNotif( ca_context_t *context, void *usrRef, OM_enumeration sourceIndicator, OM_integer notificationIdentifier, char *attributeValueChangeDef, char *additionalText );

---

The function does not allow these elements, defined in ITU-T X.721/ISO-10165-2 Definition of Management Information, to be specified in the notification:

• correlatedNotifications
• additionalInformation
• attributeIdentifierList

Pointer to a structure of type ca_context_t, which is defined in the file tmn_agent/usr_caDefs.h and contains information that defines the behavior of the core agent.

The usrRef parameter contains the user reference, which identifies the object instance emitting the notification. This is the identifier that was passed to the core agent when the instance was added to the management information tree (MIT). If no user reference was passed to the core agent when the instance was added to the MIT, this parameter must be set to NULL.

The sourceIndicator parameter indicates whether the source of the attribute value change is the managed resource, the manager or unknown. Predefined values are provided as follows:

---

#define CA_DMI_T_SOURCEINDICATOR_resource 0 #define CA_DMI_T_SOURCEINDICATOR_management 1 #define CA_DMI_T_SOURCEINDICATOR_unknown 2

---

The notificationIdentifier parameter allows the caller to provide a notification identifier. If no value is required, notificationIdentifier should be set to -1.

The attributeValueChangeDef parameter allows the caller to specify the list of attribute value changes to be included in the notification. As required in ITU-T X.730/ISO-10164-1 Object Management Function, at least one change needs to be reported. Therefore, attributeValueChangeDef must not be NULL. It must contain a value previously built by one or more calls to ca_dmi_bldAttrChngLst(). The memory required for storing attributeValueChangeDef is freed by the function.

The additionalText parameter allows the caller to provide additional text to be added to the attribute value change notification as specified in ITU-T X.721/ISO-10165-2 Definition of Management Information. If no value is required, additionalText should be set to NULL.

Synopsis

---

#include <cmip/xom.h> #include <tmn_agent/usr_caDefs.h> #include <tmn_agent/usr_caDmi.h> OM_return_code ca_dmi_attrValChngNotifSingle( ca_context_t *context, void *usrRef, OM_enumeration sourceIndicator, OM_integer notificationIdentifier, char *additionalText, ca_ident_t *attributeIdentifier, OM_descriptor *oldValue, OM_descriptor *newValue );

---

• correlatedNotifications
• additionalInformation
• attributeIdentifierList

Pointer to a structure of type ca_context_t, which is defined in the file tmn_agent/usr_caDefs.h and contains information that defines the behavior of the core agent.

The usrRef parameter contains the user reference, which identifies the object instance emitting the notification. This is the identifier that was passed to the core agent when the instance was added to the management information tree (MIT). If no user reference was passed to the core agent when the instance was added to the MIT, this parameter must be set to NULL.

The sourceIndicator parameter indicates whether the source of the attribute value change is the managed resource, the manager or unknown. Predefined values are provided as follows:

---

#define CA_DMI_T_SOURCEINDICATOR_resource 0 #define CA_DMI_T_SOURCEINDICATOR_management 1 #define CA_DMI_T_SOURCEINDICATOR_unknown 2

---

The notificationIdentifier parameter allows the caller to provide a notification identifier. If no value is required, notificationIdentifier should be set to -1.

The additionalText parameter allows the caller to provide additional text to be added to the attribute value change notification as specified in ITU-T X.721/ISO-10165-2 Definition of Management Information. If no value is required, additionalText should be set to NULL.

The attributeIdentifier parameter provides the identification of the attribute that has changed in value. Use the pointer to the ca_ident_t structure used for declaring the attribute to the GO API.

The oldValue parameter should contain the old value of the attribute that has been modified and for which a notification should be emitted. If you do not require the old value to be included in the notification, oldValue should be set to NULL.

The newValue parameter contains the new value of the attribute that has been modified and for which a notification should be emitted.

Synopsis

---

#include <cmip/xom.h> #include <tmn_agent/usr_caDefs.h> #include <tmn_agent/usr_caDmi.h> OM_return_code ca_dmi_bldAttrChngLst( ca_context_t *context, char **attributeValueChange, ca_ident_t *attributeIdentifier, OM_descriptor *oldValue, OM_descriptor *newValue );

---

Arguments

Pointer to a structure of type ca_context_t, which is defined in the file tmn_agent/usr_caDefs.h and contains information that defines the behavior of the core agent.

Pointer to the set of attributeValueChange elements to which an element needs to be added.

The attributeIdentifier parameter provides the identification of the attribute that has changed in value. Use the pointer to the ca_ident_t structure used for declaring the attribute to the GO API.

The oldValue parameter should contain the old value of the attribute that has been modified and for which a notification should be emitted. If no value is required, oldValue should be set to NULL.

The newValue parameter should contain the new value of the attribute that has been modified and for which a notification should be emitted.

Synopsis

---

#include <cmip/xom.h> #include <tmn_agent/usr_caDefs.h> #include <tmn_agent/usr_caDmi.h> OM_return_code ca_dmi_bldAttrLst( ca_context_t *context, char **attributeList, ca_ident_t *attributeIdentifier, OM_descriptor *value );

---

Arguments

Pointer to a structure of type ca_context_t, which is defined in the file tmn_agent/usr_caDefs.h and contains information that defines the behavior of the core agent.

Pointer to the set of attributeValue elements to which an element needs to be added.

The attributeIdentifier parameter provides the identification of the attribute that is to be added to the list. Use the pointer to the ca_ident_t structure used for declaring the attribute to the GO API.

The value parameter should contain the value of the attribute for which a notification should be emitted.

Synopsis

---

#include <cmip/xom.h> #include <tmn_agent/usr_caDefs.h> #include <tmn_agent/usr_caDmi.h> OM_return_code ca_dmi_commsAlrmNotif( ca_context_t *context, void *usrRef, ca_dmi_alarmInfo_t *alarmInfo );

---

The function does not allow these elements, defined in ITU-T X.721/ISO-10165-2 Definition of Management Information, to be specified in the notification:

• correlatedNotifications
• proposedRepairActions
• additionalInformation

Pointer to a structure of type ca_context_t, which is defined in the file tmn_agent/usr_caDefs.h and contains information that defines the behavior of the core agent.

The usrRef parameter contains the user reference, which identifies the object instance emitting the notification. This is the identifier that was passed to the core agent when the instance was added to the management information tree (MIT). If no user reference was passed to the core agent when the instance was added to the MIT, this parameter must be set to NULL.

Pointer to a structure of type ca_dmi_alarmInfo_t containing information to be included in the communications alarm.

Synopsis

---

#include <cmip/xom.h> #include <tmn_agent/usr_caDefs.h> #include <tmn_agent/usr_caDmi.h> OM_return_code ca_dmi_encode_moi_usrRef( ca_context_t *context, void *usrRef, OM_descriptor *encod );

---

Arguments

Pointer to a structure of type ca_context_t, which is defined in the file tmn_agent/usr_caDefs.h and contains information that defines the behavior of the core agent.

The usrRef parameter contains the user reference, which identifies the managed object instance. This is the identifier that was passed to the core agent when the instance was added to the management information tree (MIT).

Pointer to an OM_descriptor structure that contains the encoded string representing the distinguished name of the managed object instance. The value member of the OM_descriptor structure is an OM_string structure. The length member of the OM_string structure contains the length of the encoded string. The elements member of the OM_string structure contains the encoded string.

Synopsis

---

#include <cmip/xom.h> #include <tmn_agent/usr_caDefs.h> #include <tmn_agent/usr_caDmi.h> OM_return_code ca_dmi_encode_objectClass( OM_descriptor *class, OM_descriptor *encod );

---

Arguments

Pointer to a structure of type OM_descriptor, as defined by the XOM API. This structure contains the class name to be encoded. The type member of the OM_descriptor structure must correspond to the form in which you want the class name to be encoded; namely, MP_LOCAL_FORM if the form is local or MP_GLOBAL_FORM if the form is global.

Pointer to an OM_descriptor structure that contains the encoded string representing the name of the managed object class. The value member of the OM_descriptor structure is an OM_string structure. The length member of the OM_string structure contains the length of the encoded string. The elements member of the OM_string structure contains the encoded string.

Synopsis

---

#include <cmip/xom.h> #include <tmn_agent/usr_caDefs.h> #include <tmn_agent/usr_caDmi.h> OM_return_code ca_dmi_envAlrmNotif( ca_context_t *context, void *usrRef, ca_dmi_alarmInfo_t *alarmInfo );

---

The function does not allow these elements, defined in ITU-T X.721/ISO-10165-2 Definition of Management Information, to be specified in the notification:

• correlatedNotifications
• proposedRepairActions
• additionalInformation

Pointer to a structure of type ca_context_t, which is defined in the file tmn_agent/usr_caDefs.h and contains information that defines the behavior of the core agent.

The usrRef parameter contains the user reference, which identifies the object instance emitting the notification. This is the identifier that was passed to the core agent when the instance was added to the management information tree (MIT). If no user reference was passed to the core agent when the instance was added to the MIT, this parameter must be set to NULL.

Pointer to a structure of type ca_dmi_alarmInfo_t containing information to be included in the environmental alarm.

Synopsis

---

#include <cmip/xom.h> #include <tmn_agent/usr_caDefs.h> #include <tmn_agent/usr_caDmi.h> OM_return_code ca_dmi_equipAlrmNotif( ca_context_t *context, void *usrRef, ca_dmi_alarmInfo_t *alarmInfo );

---

The function does not allow these elements, defined in ITU-T X.721/ISO-10165-2 Definition of Management Information, to be specified in the notification:

• correlatedNotifications
• proposedRepairActions
• additionalInformation

Pointer to a structure of type ca_context_t, which is defined in the file tmn_agent/usr_caDefs.h and contains information that defines the behavior of the core agent.

The usrRef parameter contains the user reference, which identifies the object instance emitting the notification. This is the identifier that was passed to the core agent when the instance was added to the management information tree (MIT). If no user reference was passed to the core agent when the instance was added to the MIT, this parameter must be set to NULL.

Pointer to a structure of type ca_dmi_alarmInfo_t containing information to be included in the equipment alarm.

Synopsis

---

#include <cmip/xom.h> #include <tmn_agent/usr_caDefs.h> #include <tmn_agent/usr_caDmi.h> OM_return_code ca_dmi_freeAttrChngLst( ca_context_t *context, char *attributeValueChange );

---

Arguments

Pointer to a structure of type ca_context_t, which is defined in the file tmn_agent/usr_caDefs.h and contains information that defines the behavior of the core agent.

Pointer to the set of attribute value changes to be freed.

Synopsis

---

#include <cmip/xom.h> #include <tmn_agent/usr_caDefs.h> #include <tmn_agent/usr_caDmi.h> OM_return_code ca_dmi_freeAttrLst( ca_context_t *context, char *attributeList );

---

Arguments

Pointer to a structure of type ca_context_t, which is defined in the file tmn_agent/usr_caDefs.h and contains information that defines the behavior of the core agent.

Pointer to the set of attribute values to be freed.

Synopsis

---

#include <cmip/xom.h> #include <tmn_agent/usr_caDefs.h> #include <tmn_agent/usr_caDmi.h> OM_return_code ca_dmi_init( ca_context_t *context );

---

Arguments

Pointer to a structure of type ca_context_t, which is defined in the file tmn_agent/usr_caDefs.h and contains information that defines the behavior of the core agent.

Synopsis

---

#include <cmip/xom.h> #include <tmn_agent/usr_caDefs.h> #include <tmn_agent/usr_caDmi.h> OM_return_code ca_dmi_objCreNotif( ca_context_t *context, void *usrRef, OM_enumeration sourceIndicator, OM_boolean attributeList, OM_integer notificationIdentifier, char *additionalText );

---

• correlatedNotifications
• additionalInformation

Pointer to a structure of type ca_context_t, which is defined in the file tmn_agent/usr_caDefs.h and contains information that defines the behavior of the core agent.

The usrRef parameter contains the user reference, which identifies the object instance emitting the notification. This is the identifier that was passed to the core agent when the instance was added to the management information tree (MIT). If no user reference was passed to the core agent when the instance was added to the MIT, this parameter must be set to NULL.

The sourceIndicator parameter indicates whether the source of the creation is the managed resource, the manager or unknown. Predefined values are provided as follows:

---

#define CA_DMI_T_SOURCEINDICATOR_resource 0 #define CA_DMI_T_SOURCEINDICATOR_management 1 #define CA_DMI_T_SOURCEINDICATOR_unknown 2

---

The attributeList parameter is not supported currently. It is always set to OM_FALSE.

The notificationIdentifier parameter allows the caller to provide a notification identifier. If no value is required, notificationIdentifier should be set to -1.

The additionalText parameter allows the caller to provide additional text to be added to the object creation notification as specified in ITU-T X.721/ISO-10165-2 Definition of Management Information. If no value is required, additionalText should be set to NULL.

Synopsis

---

#include <cmip/xom.h> #include <tmn_agent/usr_caDefs.h> #include <tmn_agent/usr_caDmi.h> OM_return_code ca_dmi_objDelNotif( ca_context_t *context, void *usrRef, OM_enumeration sourceIndicator, OM_boolean attributeList, OM_integer notificationIdentifier, char *additionalText );

---

• correlatedNotifications
• additionalInformation

Pointer to a structure of type ca_context_t, which is defined in the file tmn_agent/usr_caDefs.h and contains information that defines the behavior of the core agent.

The usrRef parameter contains the user reference, which identifies the object instance emitting the notification. This is the identifier that was passed to the core agent when the instance was added to the management information tree (MIT). If no user reference was passed to the core agent when the instance was added to the MIT, this parameter must be set to NULL.

The sourceIndicator parameter indicates whether the source of the deletion is the managed resource, the manager or unknown. Predefined values are provided as follows:

---

#define CA_DMI_T_SOURCEINDICATOR_resource 0 #define CA_DMI_T_SOURCEINDICATOR_management 1 #define CA_DMI_T_SOURCEINDICATOR_unknown 2

---

attributeList

The attributeList parameter specifies whether or not the object deletion notification should contain the attribute list element. If the attributeList parameter is set to OM_TRUE, the function adds the list of attributes from the object instance identified by usrRef to the object deletion notification.

The notificationIdentifier parameter allows the caller to provide a notification identifier. If no value is required, notificationIdentifier should be set to -1.

The additionalText parameter allows the caller to provide additional text to be added to the object deletion notification as specified in ITU-T X.721/ISO-10165-2 Definition of Management Information. If no value is required, additionalText should be set to NULL.

Synopsis

---

#include <cmip/xom.h> #include <tmn_agent/usr_caDefs.h> #include <tmn_agent/usr_caDmi.h> #include <tmn_agent/usr_caNoti.h> #include <tmn_agent/usr_caEfd.h> OM_return_code ca_dmi_object_init( ca_context_t *context, ca_generic_attribute_t *listOfAttribute[], ca_gdmo_notif_t *listOfNotification[], ca_ident_t *bindingName, ca_class_t *superiorClass, char scheduling );

---

• The list of generic attributes, with callbacks for decoding and validating a filter item defined for the attributes. The list of generic attributes is used for validating and decoding the discriminator construct attribute of the EFD.

• For each notification, the list of attributes within the notification. The information on each notification is used to compare a discriminator construct attribute with the corresponding attribute of the specific notification. For each attribute, you have to provide a function for comparing an attribute value with another value.

Arguments

Pointer to a structure of type ca_context_t, which is defined in the file tmn_agent/usr_caDefs.h and contains information that defines the behavior of the core agent.

The listOfAttribute parameter corresponds to the list of generic attributes. Providing a generic description of attributes allows the EFD to validate filter items applying to the attribute when the discriminator construct attribute is created or modified.

The listOfNotification parameter identifies the list of notifications and their attributes. By providing such information, the EFD can filter on all the attributes associated with a specific notification. For notifications not described in the listOfNotification parameter, the EFD can still filter on the managed object class, managed object instance, event time and event type attributes.

The bindingName parameter specifies which registration of the name binding to use. If the name binding corresponds to the TMN or the ISO model, bindingName should be set to NULL. In this case, the function uses the registration associated with the model.

The superiorClass parameter identifies the superior object class to be used for creating instances of the EFD or log object classes. The parameter must correspond to the address of the class description provided within the list of all classes supported by the agent.

The scheduling parameter is a bitmask which enables you to restrict the support of scheduling packages for the EFD and the log. The values of the bitmask are:

---

#define CA_EFD_DURATION_PACKAGE 0x01 #define CA_EFD_DAILY_SCHEDULING_PACKAGE 0x02 #define CA_EFD_WEEKLY_SCHEDULING_PACKAGE 0x04 #define CA_LOG_DURATION_PACKAGE 0x10 #define CA_LOG_DAILY_SCHEDULING_PACKAGE 0x20 #define CA_LOG_WEEKLY_SCHEDULING_PACKAGE 0x40

---

Synopsis

---

#include <cmip/xom.h> #include <tmn_agent/usr_caDefs.h> #include <tmn_agent/usr_caDmi.h> OM_return_code ca_dmi_procErrAlrmNotif( ca_context_t *context, void *usrRef, ca_dmi_alarmInfo_t *alarmInfo );

---

The function does not allow these elements, defined in ITU-T X.721/ISO-10165-2 Definition of Management Information, to be specified in the notification:

• correlatedNotifications
• proposedRepairActions
• additionalInformation

Pointer to a structure of type ca_context_t, which is defined in the file tmn_agent/usr_caDefs.h and contains information that defines the behavior of the core agent.

The usrRef parameter contains the user reference, which identifies the object instance emitting the notification. This is the identifier that was passed to the core agent when the instance was added to the management information tree (MIT). If no user reference was passed to the core agent when the instance was added to the MIT, this parameter must be set to NULL.

Pointer to a structure of type ca_dmi_alarmInfo_t containing information to be included in the processing error alarm.

Synopsis

---

#include <cmip/xom.h> #include <tmn_agent/usr_caDefs.h> #include <tmn_agent/usr_caDmi.h> OM_return_code ca_dmi_qualOfSvceAlrmNotif( ca_context_t *context, void *usrRef, ca_dmi_alarmInfo_t *alarmInfo );

---

The function does not allow these elements, defined in ITU-T X.721/ISO-10165-2 Definition of Management Information, to be specified in the notification:

• correlatedNotifications
• proposedRepairActions
• additionalInformation

Pointer to a structure of type ca_context_t, which is defined in the file tmn_agent/usr_caDefs.h and contains information that defines the behavior of the core agent.

The usrRef parameter contains the user reference, which identifies the object instance emitting the notification. This is the identifier that was passed to the core agent when the instance was added to the management information tree (MIT). If no user reference was passed to the core agent when the instance was added to the MIT, this parameter must be set to NULL.

Pointer to a structure of type ca_dmi_alarmInfo_t containing information to be included in the quality of service alarm.

Synopsis

---

#include <cmip/xom.h> #include <tmn_agent/usr_caDefs.h> #include <tmn_agent/usr_caDmi.h> OM_return_code ca_dmi_relChngNotif( ca_context_t *context, void *usrRef, OM_enumeration sourceIndicator, OM_integer notificationIdentifier, char *attributeValueChangeDef, char *additionalText );

---

The function does not allow these elements, defined in ITU-T X.721/ISO-10165-2 Definition of Management Information, to be specified in the notification:

• correlatedNotifications
• additionalInformation
• attributeIdentifierList

Pointer to a structure of type ca_context_t, which is defined in the file tmn_agent/usr_caDefs.h and contains information that defines the behavior of the core agent.

The usrRef parameter contains the user reference, which identifies the object instance emitting the notification. This is the identifier that was passed to the core agent when the instance was added to the management information tree (MIT). If no user reference was passed to the core agent when the instance was added to the MIT, this parameter must be set to NULL.

The sourceIndicator parameter indicates whether the source of the relationship change is the managed resource, the manager or unknown. Predefined values are provided as follows:

---

#define CA_DMI_T_SOURCEINDICATOR_resource 0 #define CA_DMI_T_SOURCEINDICATOR_management 1 #define CA_DMI_T_SOURCEINDICATOR_unknown 2

---

The notificationIdentifier parameter allows the caller to provide a notification identifier. If no value is required, notificationIdentifier should be set to -1.

The attributeValueChangeDef parameter allows the caller to specify the list of relationship changes to be notified. As required in ITU-T X.732/ISO-10164-3 Attributes for Representing Relationships, at least one change needs to be reported. Therefore, attributeValueChangeDef must not be NULL. It must contain a value previously built by one or more calls to ca_dmi_bldAttrChngLst(). The memory required for storing attributeValueChangeDef is freed by the function.

The additionalText parameter allows the caller to provide additional text to be added to the relationship change notification as specified in ITU-T X.721/ISO-10165-2 Definition of Management Information. If no value is required, additionalText should be set to NULL.

Synopsis

---

#include <cmip/xom.h> #include <tmn_agent/usr_caDefs.h> #include <tmn_agent/usr_caDmi.h> OM_return_code ca_dmi_relChngNotifSingle( ca_context_t *context, void *usrRef, OM_enumeration sourceIndicator, OM_integer notificationIdentifier, char *additionalText, ca_ident_t *attributeIdentifier, OM_descriptor *oldValue, OM_descriptor *newValue );

---

• correlatedNotifications
• additionalInformation
• attributeIdentifierList

Pointer to a structure of type ca_context_t, which is defined in the file tmn_agent/usr_caDefs.h and contains information that defines the behavior of the core agent.

The usrRef parameter contains the user reference, which identifies the object instance emitting the notification. This is the identifier that was passed to the core agent when the instance was added to the management information tree (MIT). If no user reference was passed to the core agent when the instance was added to the MIT, this parameter must be set to NULL.

The sourceIndicator parameter indicates whether the source of the relationship change is the managed resource, the manager or unknown. Predefined values are provided as follows:

---

#define CA_DMI_T_SOURCEINDICATOR_resource 0 #define CA_DMI_T_SOURCEINDICATOR_management 1 #define CA_DMI_T_SOURCEINDICATOR_unknown 2

---

The notificationIdentifier parameter allows the caller to provide a notification identifier. If no value is required, notificationIdentifier should be set to -1.

The additionalText parameter allows the caller to provide additional text to be added to the relationship change notification as specified in ITU-T X.721/ISO-10165-2 Definition of Management Information. If no value is required, additionalText should be set to NULL.

The attributeIdentifier parameter provides the identification of the attribute for which a relationship change has occurred. Use the pointer to the ca_ident_t structure for declaring the attribute to the GO API.

The oldValue parameter should contain the old value of the attribute that has been modified and for which a notification should be emitted. If no value is required, oldValue should be set to NULL.

The newValue parameter should contain the new value of the attribute that has been modified and for which a notification should be emitted.

Synopsis

---

#include <cmip/xom.h> #include <tmn_agent/usr_caDefs.h> #include <tmn_agent/usr_caDmi.h> OM_return_code ca_dmi_stateChngNotif( ca_context_t *context, void *usrRef, OM_enumeration sourceIndicator, OM_integer notificationIdentifier, char *attributeValueChangeDef, char *additionalText );

---

The function does not allow these elements, defined in ITU-T X.721/ISO-10165-2 Definition of Management Information, to be specified in the notification:

• correlatedNotifications
• additionalInformation
• attributeIdentifierList

Pointer to a structure of type ca_context_t, which is defined in the file tmn_agent/usr_caDefs.h and contains information that defines the behavior of the core agent.

The usrRef parameter contains the user reference, which identifies the object instance emitting the notification. This is the identifier that was passed to the core agent when the instance was added to the management information tree (MIT). If no user reference was passed to the core agent when the instance was added to the MIT, this parameter must be set to NULL.

The sourceIndicator parameter indicates whether the source of the state change is the managed resource, the manager or unknown. Predefined values are provided as follows:

---

#define CA_DMI_T_SOURCEINDICATOR_resource 0 #define CA_DMI_T_SOURCEINDICATOR_management 1 #define CA_DMI_T_SOURCEINDICATOR_unknown 2

---

The notificationIdentifier parameter allows the caller to provide a notification identifier. If no value is required, notificationIdentifier should be set to -1.

The attributeValueChangeDef parameter allows the caller to specify the list of state changes to be notified. As required in ITU-T X.731/ISO-10164-2 State Management Function, at least one change needs to be reported. Therefore, attributeValueChangeDef must not be NULL. It must contain a value previously built by one or more calls to ca_dmi_bldAttrChngLst(). The memory required for storing attributeValueChangeDef is freed by the function.

The additionalText parameter allows the caller to provide additional text to be added to the state change notification as specified in ITU-T X.721/ISO-10165-2 Definition of Management Information. If no value is required, additionalText should be set to NULL.

Synopsis

---

#include <cmip/xom.h> #include <tmn_agent/usr_caDefs.h> #include <tmn_agent/usr_caDmi.h> OM_return_code ca_dmi_stateChngNotifSingle( ca_context_t *context, void *usrRef, OM_enumeration sourceIndicator, OM_integer notificationIdentifier, char *additionalText, ca_ident_t *attributeIdentifier, OM_descriptor *oldValue, OM_descriptor *newValue );

---

• correlatedNotifications
• additionalInformation
• attributeIdentifierList

Pointer to a structure of type ca_context_t, which is defined in the file tmn_agent/usr_caDefs.h and contains information that defines the behavior of the core agent.

The usrRef parameter contains the user reference, which identifies the object instance emitting the notification. This is the identifier that was passed to the core agent when the instance was added to the management information tree (MIT). If no user reference was passed to the core agent when the instance was added to the MIT, this parameter must be set to NULL.

The sourceIndicator parameter indicates whether the source of the state change is the managed resource, the manager or unknown. Predefined values are provided as follows:

---

#define CA_DMI_T_SOURCEINDICATOR_resource 0 #define CA_DMI_T_SOURCEINDICATOR_management 1 #define CA_DMI_T_SOURCEINDICATOR_unknown 2

---

The notificationIdentifier parameter allows the caller to provide a notification identifier. If no value is required, notificationIdentifier should be set to -1.

The additionalText parameter allows the caller to provide additional text to be added to the state change notification as specified in ITU-T X.721/ISO-10165-2 Definition of Management Information. If no value is required, additionalText should be set to NULL.

The attributeIdentifier parameter provides the identification of the attribute that has changed state. Use the pointer to the ca_ident_t structure used for declaring the attribute to the GO API.

The oldValue parameter should contain the old state of the attribute that has changed state and for which a notification should be emitted. If no state is required, oldValue should be set to NULL.

The newValue parameter should contain the new state of the attribute that has changed state and for which a notification should be emitted.

Synopsis

---

#include <cmip/xom.h> #include <tmn_agent/usr_caDefs.h> #include <tmn_agent/usr_caDmi.h> OM_return_code ca_dmi_tick( ca_context_t *context );

---

The ca_dmi_tick() function is used to update the DMI library's internal clock. This function needs to be called regularly by the agent to ensure that scheduling operations occur as expected. The granularity of time used in the scheduling attributes is one minute, therefore, calling this function at the minimum every 30 seconds is sufficient to maintain synchronization with a manager.

When ca_dmi_tick() is called, the operational state and availability status attribute values are checked for all EFD and log instances in the system, and updated if necessary.

Arguments

Pointer to a structure of type ca_context_t, which is defined in the file tmn_agent/usr_caDefs.h and contains information that defines the behavior of the core agent.

• Structures of type ca_dmi_alarmInfo_t

• Structures of type ca_dmi_observedValue_t

• Structures of type ca_dmi_thresholdInfo_t

• Structures of type ca_dmi_thresholdLevelInd_t

Declaration

---

typedef struct ca_dmi_alarmInfo_t { char *probableCause; OM_string encod_oid; int perceivedSeverity; int backedUpStatusPresent; OM_boolean backedUpStatus; void *backUpObject; OM_string encod_moi; int trendIndication; int thresPresent; ca_dmi_thresholdInfo_t thresholdInfo; void *stateChangeDef; void *monitoredAttributes; char *additionalText; } ca_dmi_alarmInfo_t;

---

Some members of this structure have a name that ends in Present. They indicate whether the optional member that follows them is present in a particular instance of the structure. For example, the member thresPresent is followed by the optional member thresholdInfo. If the thresholdInfo member is present, the thresPresent member must be set to CA_DMI_OPTIONAL_PRESENT. Otherwise, the thresPresent member must be set to CA_DMI_OPTIONAL_NOT_PRESENT.

Members

The probableCause member identifies the probable cause of the alarm. It must contain a string which can be either an object identifier or an integer. For an object identifier, the value should be given in the decoded form. Predefined values are provided in the file tmn_agent/usr_caDmi.h. for all the probable causes defined in ITU-T X.733/ISO-10164-4 Alarm Reporting Function and ITU-T X.721/ISO-10165-2 Definition of Management Information are provided.

The encod_oid member is used by the DMI API for storing the encoded value of the probable cause of the alarm.

The perceivedSeverity member indicates the severity of the alarm. It must be set to one of the values predefined as follows:

---

#define CA_DMI_T_PERCEIVEDSEVERITY_indeterminate 0 #define CA_DMI_T_PERCEIVEDSEVERITY_critical 1 #define CA_DMI_T_PERCEIVEDSEVERITY_major 2 #define CA_DMI_T_PERCEIVEDSEVERITY_minor 3 #define CA_DMI_T_PERCEIVEDSEVERITY_warning 4 #define CA_DMI_T_PERCEIVEDSEVERITY_cleared 5

---

The backedUpStatusPresent member indicates whether the backedUpStatus member is present. It must be set to one of the values predefined as follows:

---

#define CA_DMI_OPTIONAL_NOT_PRESENT 0 #define CA_DMI_OPTIONAL_PRESENT 1

---

The backedUpStatus member specifies whether the object emitting the alarm has been backed up. If backedUpStatus is OM_TRUE, the object has been backed up. If backedUpStatus is OM_FALSE, the object has not been backed up. The backedUpStatus member is optional.

If backedUpStatus is OM_TRUE, the backUpObject member provides a pointer to the user reference of the back-up object. Otherwise, the backUpObject member should be set to NULL.

If there is a back-up object, the encod_moi member is used by the DMI API for storing the encoded value of the back-up object.

The trendIndication member indicates whether the severity of the alarm is decreasing, increasing or not changed. If no trend indication is to be given, the trendIndication member should be set to -1. Otherwise, it should be set to one of the values predefined as follows:

---

#define CA_DMI_T_TRENDINDICATION_lessSevere 0 #define CA_DMI_T_TRENDINDICATION_noChange 1 #define CA_DMI_T_TRENDINDICATION_moreSevere 2

---

The thresPresent member indicates whether the thresholdInfo member is present. It must be set to one of the values predefined as follows:

---

#define CA_DMI_OPTIONAL_NOT_PRESENT 0 #define CA_DMI_OPTIONAL_PRESENT 1

---

The thresholdInfo member contains threshold information expressed as a structure of type ca_dmi_thresholdInfo_t. The thresholdInfo member is optional.

The stateChangeDef member optionally contains a pointer to a list of state changes to be reported. To build the list of state changes, use the ca_dmi_bldAttrChngLst() function. If no state changes are to be reported, the stateChangeDef member should be set to NULL.

The monitoredAttributes member optionally contains a pointer to a list of monitored attributes. To build the list of attributes, use the ca_dmi_bldAttrLst() function. If no attributes are to be monitored, the monitoredAttributes member should be set to NULL.

The additionalText optionally contains a pointer to a text string to be added to the notification. If no additional text is to be added to the notification, the additionalText member should be set to NULL.

Declaration

---

typedef struct ca_dmi_observedValue_t { int choice; union { int integer; double real; } alt; } ca_dmi_observedValue_t;

---

Members

The choice member specifies the syntax of the observed value. If the observed value is an integer, the choice member must be set to OM_S_INTEGER. Otherwise, the choice member can be set to any other value.

The integer member contains the observed value if the choice member is set to OM_S_INTEGER.

The real member contains the observed value if the choice member specifies a syntax other than integer.

Declaration

---

typedef struct ca_dmi_thresholdInfo_t { ca_ident_t *id; ca_dmi_observedValue_t val; int thresPresent; ca_dmi_thresholdLevelInd_t thres; int armTimePresent; char armTime[24]; } ca_dmi_thresholdInfo_t;

---

Some members of this structure have a name that ends in Present. They indicate whether the optional member that follows them is present in a particular instance of the structure. For example, the member thresPresent is followed by the optional member thres. If the thres member is present, the thresPresent member must be set to CA_DMI_OPTIONAL_PRESENT. Otherwise, the thresPresent member must be set to CA_DMI_OPTIONAL_NOT_PRESENT.

Members

The id member contains a pointer to a structure of type ca_ident_t that contains information about the threshold that triggered the alarm.

The val member contains the observed value that triggered the alarm. It is expressed as a structure of type ca_dmi_observedValue_t.

The thresPresent member indicates whether the thres member is present. It must be set to one of the values predefined as follows:

---

#define CA_DMI_OPTIONAL_NOT_PRESENT 0 #define CA_DMI_OPTIONAL_PRESENT 1

---

The thres member contains the value of the threshold limit for triggering alarms. It is expressed as a structure of type ca_dmi_thresholdLevelInd_t. The thres member is optional.

The armTimePresent member indicates whether the armTime member is present. It must be set to one of the values predefined as follows:

---

#define CA_DMI_OPTIONAL_NOT_PRESENT 0 #define CA_DMI_OPTIONAL_PRESENT 1

---

The armTime member indicates the Generalized Time at which the threshold was reached. The armTime member is optional.

Declaration

---

typedef struct ca_dmi_thresholdLevelInd_t { int type; ca_dmi_observedValue_t high; int lowPresent; ca_dmi_observedValue_t low; } ca_dmi_thresholdLevelInd_t;

---

Some members of this structure have a name that ends in Present. They indicate whether the optional member that follows them is present in a particular instance of the structure. For example, the member lowPresent is followed by the optional member low. If the low member is present, the lowPresent member must be set to CA_DMI_OPTIONAL_PRESENT. Otherwise, the lowPresent member must be set to CA_DMI_OPTIONAL_NOT_PRESENT.

Members

The type member indicates whether the threshold level indicator is up or down. It must be set to one of the values predefined as follows

---

#define CA_DMI_THRESHOLDLEVELIND_UP 1 #define CA_DMI_THRESHOLDLEVELIND_DOWN 2

---

The high member contains the high observed value expressed as a structure of type ca_dmi_observedValue_t. The high member is mandatory.

The lowPresent member indicates whether the low member is present. It must be set to one of the values predefined as follows:

---

#define CA_DMI_OPTIONAL_NOT_PRESENT 0 #define CA_DMI_OPTIONAL_PRESENT 1

---

The low member contains the low observed value expressed as a structure of type ca_dmi_observedValue_t. The low member is optional.