Typedefs

This subsection lists the members and possible values for each typedef data definition, arranged in alphabetical order.

SPD_alarmEventTP

Purpose

D efines the portion of an event report that is specific to alert event reports. This structure is contained in SPD_eventTP, defined elsewhere in this section.

Syntax

typedef struct {
   SPD_alarmSeverityTP severity;
   char *alarmIdentifier;
   char *alarmQualifier;
   char *alarmText;
   char *helpText;
   char *externalActionList;
} SPD_alarmEventTP;

Description

severity

indicates the severity of the alert. SPD_alarmSeverityTP is defined elsewhere in this section.

alarmIdentifier

identifies the type of alert. This value can also be the name of the optional help text file for the alert, if the value returned for helpText is NULL. This value can also be the name of the optional external action list, if the value returned for externalActionList is NULL.

alarmQualifier

further qualifies the type of alert when multiple alerts with the same alarmIdentifier are raised and must be kept distinct from one another. This value may be NULL.

alarmText

explains the alert condition.

helpText

provides help text for this alert. Help text is identified for an alert using the following set of rules:

If the value of helpText is the name of a file name in the Operations Sentinel help text folder, the contents of that file is the help text.
Otherwise, if the value of helpText is not NULL, the value of helpText is the actual help text.
Otherwise, if the value of helpText is NULL and the value of alarmIdentifier is the name of a file in the Operations Sentinel help text folder, then the contents of that file is the help text.
Otherwise, there is no help text for the alert.

externalActionList

identifies the external action list that is associated with this alert. External action lists are defined in alert policies. This value may be NULL.

SPD_alarmSeverityTP

Purpose

D efines the set of possible values for the severity of an alert event report.

Syntax

typedef enum {
   SPD_criticalCN,
   SPD_majorCN,
   SPD_minorCN,
   SPD_warningCN,
   SPD_informationalCN,
   SPD_indeterminateCN,
   SPD_clearCN,
   SPD_acknowledgeCN
} SPD_alarmSeverityTP;

Description

SPD_criticalCN

indicates an alert of critical severity.

SPD_majorCN

indicates an alert of major severity.

SPD_minorCN

indicates an alert of minor severity.

SPD_warningCN

indicates an alert of warning severity.

SPD_informationalCN

indicates an alert of informational severity.

SPD_indeterminateCN

indicates an alert of indeterminate severity.

SPD_clearCN

indicates an alert that has been cleared.

SPD_acknowledgeCN

indicates an alert that has been acknowledged, but not cleared.

SPD_commandStatusTP

Purpose

D efines the set of possible values for the status of submission of a command to a host (managed system). It is passed to the callback function specified for SPD_Command. See 7.5.

Syntax

typedef enum {
   SPD_unknownStatusCN,
   SPD_commandSuccessCN,
   SPD_illegalCommandCN,
   SPD_unknownHostCN,
   SPD_unreachableHostCN,
   SPD_hostNotReadyCN,
   SPD_accessDeniedCN
} SPD_commandStatusTP;

Description

SPD_commandSuccessCN

means that, as far as the Event Server can detect, the command was successfully sent to the specified host.

SPD_illegalCommandCN

means that an error in the format of the command was detected. This value is only reported for commands to OS 2200 consoles.

SPD_unknownHostCN

means that the Event Server does not know about the specified host. This typically means that the Operations Sentinel server is not currently managing the host or the host name is in error.

SPD_unreachableHostCN

means that the specified host name is valid, but the command could not be sent. This could be because the host is down or the connection to the host is down. Retrying the command at a future time may or may not be successful.

SPD_hostNotReadyCN

means that the specified host is not in a state to receive another command (that is, it is still processing the last command). This status is returned for OS 2200 hosts only.

SPD_unknownStatusCN

means something went wrong during reporting of the status. (This status should never be returned.)

SPD_accessDeniedCN

means the specified host system is not configured to receive commands. The site administrator can limit command submission to each host system using the Operations Sentinel Configuration application. Unlimited access, automation access (the default), or no access can be specified. This status is returned if the host is configured for automation access or for no access. See the Operations Sentinel Administration and Configuration Guide for further information.

SPD_errorTP

Purpose

D efines the set of possible values that are returned by calls to the Event Server API functions. See Section 7. A value of this type can be passed to SPD_GetErrorMessage. See 7.7.

Syntax

typedef enum {
   SPD_normalCN,
   SPD_notInitializedCN,
   SPD_alreadyInitializedCN,
   SPD_versionMismatchCN,
   SPD_invalidTypeCN,
   SPD_commFailureCN,
   SPD_badTimerCN,
   SPD_badInputCN,
   SPD_badFormatCN,
   SPD_badClassCN,
   SPD_badNameCN,
   SPD_badApplicationCN,
   SPD_badAlarmIdCN,
   SPD_badAlarmQualifierCN,
   SPD_badTypeCN,
   SPD_badTextCN,
   SPD_badAttributeCN,
   SPD_badValueCN,
   SPD_badFileNameCN,
   SPD_badSeverityCN,
   SPD_badHostCN,
   SPD_badCommandCN,
   SPD_badCallbackCN,
   SPD_badReservedValueCN,
   SPD_badTimeCN,
   SPD_obsoleteInterfaceCN
} SPD_errorTP;

Description

SPD_normalCN

means that no error occurred.

SPD_notInitializedCN

means that the SPD_InitClient function was not previously called.

SPD_alreadyInitializedCN

means that the SPD_InitClient function has already been called.

SPD_versionMismatchCN

means that the client is linked with a version of the Event Server API that is incompatible with the Event Server included with the level of Operations Sentinel running on the Operations Sentinel server.

SPD_invalidTypeCN

means that an invalid type parameter was specified.

SPD_commFailureCN

means that a communications problem occurred.

SPD_badTimerCN

means that an invalid timer parameter was specified.

SPD_badInputCN

means that an invalid ID parameter was specified.

SPD_badFormatCN

means that an invalid event report format was specified.

SPD_badClassCN

means that an invalid objectClass parameter was specified.

SPD_badNameCN

means that an invalid objectName parameter was specified.

SPD_badApplicationCN

means that an invalid applicationName parameter was specified.

SPD_badAlarmIdCN

means that an invalid alarmIdentifier parameter was specified.

SPD_badAlarmQualifierCN

means that an invalid alarmQualifier parameter was specified.

SPD_badTypeCN

means that an invalid type parameter was specified.

SPD_badTextCN

means that an invalid message parameter was specified.

SPD_badAttributeCN

means that an invalid attrNames parameter was specified.

SPD_badValueCN

means that an invalid attrValues parameter was specified.

SPD_badFileNameCN

means that an invalid logFileName parameter was specified.

SPD_badSeverityCN

means that an invalid severity parameter was specified.

SPD_badHostCN

means that an invalid hostName parameter was specified.

SPD_badCommandCN

means that an invalid command parameter was specified.

SPD_badCallbackCN

means that an invalid callback parameter was specified.

SPD_badReservedValueCN

means that SPD_reservedValueCN was not specified as the reserved value.

SPD_badTimeCN

means that an invalid senderTime attribute was specified.

SPD_obsoleteInterfaceCN

means that a normal status was returned from the obsolete command, SPD_SendCommand. Use SPD_Command instead. See 7.5

SPD_eventTP

Purpose

D efines the basic structure for all event reports. A structure of this type is passed to the callback function for SPD_HandleEvent. See 7.8.

Syntax

typedef struct {
   SPD_eventTypeTP type;
   char *objectClass;
   char *objectName;
   char *applicationName;
   char *applicationQualifier;
   char *host;
   time_t senderTime;
   time_t serverTime;
   int  variableCount;
   SPD_variableDataTP *variableData;
   union {
      SPD_alarmEventTP alarm;
      SPD_logEventTP log;
   } eventData;
} SPD_eventTP;

Description

type

is the type of event. SPD_eventTypeTP is defined elsewhere in this subsection.

objectClass

identifies the class of the object that is the source of the event, for example, a disk drive name or application.

objectName

identifies the instance of the object class that is the source of the event, for example, a disk drive name or application name.

applicationName

is the name of the application that sent the event.

applicationQualifier

further qualifies the applicationName in case more than one instance of the application may be present. This value can be null.

host

identifies the host system to which the event applies, as used by attribute-change and delete-object events.

senderTime

is the optional time stamp specified by the event sender. senderTime can be 0 (zero).

serverTime

is the optional time stamp added by the Event Server. serverTime can be 0 (zero).

variableCount

is the number of items in the variableData array. This item is used only for alert and attribute-change events. For other events, the variableCount is 0 (zero).

variableData

is a variable data area for alert and attribute-change events. SPD_variableDataTP is described elsewhere in this section.

alarm

describes the portion of the parsed event report that is specific to alert event reports. SPD_alarmEventTP is described elsewhere in this subsection.

log

describes the portion of the parsed event report that is specific to log event reports. SPD_logEventTP is described elsewhere in this subsection.

SPD_eventStateTP

Purpose

D efines the set of possible event states as reported by the event state callback, which is registered by SPD_MonitorEventState (see 7.12). Also see SPD_eventStateCallbackTP in [xref text to replace].

Syntax

typedef enum {
   SPD_eventUnknownCN,
   SPD_eventDownCN,
   SPD_eventUpCN
} SPD_eventStateTP;

Description

SPD_eventUnknown

is a state that never occurs.

SPD_eventDownCN

means that the Event Server is not currently handling the event in question. If there are two Operations Sentinel servers configured (see 5.7), then neither is handling the event.

SPD_eventUpCN

means that the Event Server is currently handling the event type in question. The Event Server can be located on the primary or the secondary Operations Sentinel server.

SPD_eventTypeTP

Purpose

D efines the set of possible event types. You must specify a parameter with this data type when calling SPD_MonitorEventState (see 7.12). A value of this type is passed to the callback function registered by SPD_MonitorEventState (see SPD_eventStateCallbackTP in 8.2).

Syntax

typedef enum {
  SPD_unknownEventCN,
  SPD_alarmEventCN,
  SPD_attributeChangeEventCN,
  SPD_deleteObjectEventCN,
  SPD_logEventCN
} SPD_eventTypeTP;

Description

SPD_unknownEventCN

is an illegal event type.

SPD_alarmEventCN

identifies an alert event.

SPD_attributeChangeEventCN

identifies an attribute-change event.

SPD_deleteObjectEventCN

identifies a delete-object event.

SPD_logEventCN

identifies a log event.

SPD_inputTP

Purpose

A handle for an I/O handler that a client can use to uniquely identify the I/O handler. SPD_inputTPstruct is an undefined data type that hides the real structure of the handle from the calling program. A value of this data type is returned by SPD_AddInput (see 7.2), and is supplied as a parameter to SPD_RemoveInput (see 7.14).

Syntax

typedef struct SPD_inputTPstruct *SPD_inputTP;

SPD_inputTypeTP

Purpose

D efines the set of possible I/O events that can be monitored through calls to SPD_AddInput (see 7.2).

Syntax

typedef enum {
  SPD_readCN,
  SPD_writeCN
} SPD_inputTypeTP;

SPD_logEventTP

Purpose

D efines the portion of a parsed event report that is specific to log event reports. This structure is contained in SPD_eventTP, described elsewhere in this section.

Syntax

typedef struct {
   char *messageType;
   char *logText;
} SPD_logEventTP;

Description

messageType

is the optional message type specified by the sender. messageType can be a NULL string.

logText

is the message to be logged.

SPD_passbackTP

Purpose

A handle for passback data that the Event Server API uses to declare passback data in a type-independent fashion. SPD_passbackTPstruct is an undefined data type that hides the real structure of the handle from the calling program.

Each function that registers a passback function supplies a value of this data type. Each invocation of a passback function (see [xref text to replace]) is passed the value that was specified by the function that registered it.

Syntax

typedef struct SPD_passbackTPstruct *SPD_passbackTP;

SPD_timeoutTP

Purpose

A handle for a timer handler that a client can use to uniquely identify the timer handler. SPD_timeoutTPstruct is an undefined value that hides the real structure of the handle from the calling program.

A value of this type is returned by SPD_AddTimeOut (see 7.3), and is supplied as a parameter to SPD_RemoveTimeOut (see 7.15).

Syntax

typedef struct SPD_timeoutTPstruct *SPD_timeoutTP;

SPD_variableDataTP

Purpose

D efines the structure of free format data for an event. This is used for alert and attribute-change event reports where you can specify any number of attributes. This structure is contained in SPD_eventTP, described elsewhere in this section.

Syntax

typedef struct {
   char *attribute;
   char *value;
} SPD_variableDataTP;