Attribute
|
Scope
|
Type
|
Properties
|
Description
|
OPCDATA_DATATYPE |
get |
long |
|
|
|
Returns
the type of the opcdata object. |
OPCDATA_SEVERITY |
get/set |
long |
|
|
|
Severity
of the message. Possible values are:
OPC_SEV_UNCHANGED
OPC_SEV_UNKNOWN
OPC_SEV_NORMAL
OPC_SEV_WARNING
OPC_SEV_CRITICAL
OPC_SEV_MINOR
OPC_SEV_MAJOR
|
OPCDATA_CREATION_TIME |
get/set |
long |
|
|
|
Time the
message was created. The time is in UNIX format (seconds since
Epoch). Default: the (local) time when the message was
created. |
OPCDATA_RECEIVE_TIME |
get |
long |
|
|
|
Time the
message was received by the management server. |
OPCDATA_AACTION_ACK |
get/set |
long |
|
|
|
Auto
Acknowledge after successful execution of the Automatic Action
0 (default): do not auto-acknowledge
1: auto-acknowledge. |
OPCDATA_AACTION_ANNOTATE |
get/set |
long |
|
|
|
Defines
whether HPOM creates start and end annotations for the automatic
action. Possible values for the attribute are:
0 (default): do not create annotations
1: create annotations. |
OPCDATA_AACTION_STATUS |
get/set |
long |
|
|
|
Status of
the automatic action:
OPC_ACTION_UNDEF (default): no automatic action
for this message defined.
OPC_ACTION_DEF : the automatic action for this
message is defined but was not yet started.
OPC_ACTION_STARTED : the automatic action for this
message is defined and was already started.
OPC_ACTION_FINISHED : the automatic action was
started and completed successfully.
OPC_ACTION_FAILED : the automatic action was
started and failed.
|
OPCDATA_OPACTION_ACK |
get/set |
long |
|
|
|
Automatically acknowledge a message after a successful execution of
the operator-initiated action. Possible values:
0 (default): do not auto-acknowledge
1: auto-acknowledge. |
OPCDATA_OPACTION_ANNOTATE |
get/set |
long |
|
|
|
Defines
whether HPOM creates start and end annotations for the
operator-initiated action. Possible values for the attribute
are:
0 (default): do not create annotations
1: create annotations. |
OPCDATA_OPACTION_STATUS |
get |
long |
|
|
|
Status of
the action:
OPC_ACTION_UNDEF
OPC_ACTION_DEF
OPC_ACTION_STARTED
OPC_ACTION_FINISHED
OPC_ACTION_FAILED
|
OPCDATA_ESCALATED |
get |
long |
|
|
|
Message
was escalated:
OPC_ESCALATED_TO
OPC_ESCALATED_FROM
The escalation server can be retrieved using
OPCDATA_ESCALATION_SERVER . |
OPCDATA_NOTIFICATION |
get/set |
long |
|
|
|
Notification. |
OPCDATA_TROUBLETICKET |
get/set |
long |
|
|
|
Forward
message to Trouble Ticket system. |
OPCDATA_MSG_LOG_ONLY |
get/set |
long |
|
|
|
Message
is Server Log Only. |
OPCDATA_TROUBLETICKET_ACK |
get/set |
long |
|
|
|
Acknowledge message after forwarding it to the Trouble Ticket
System. |
OPCDATA_MSI_OUTPUT |
get/set |
long |
|
|
|
The
message will be forwarded to the MSI. |
OPCDATA_INSTR_IF_TYPE |
get/set |
long |
|
|
|
Type of
the Instruction Interface:
OPC_INSTR_NOT_SET
OPC_FROM_OPC
OPC_FROM_OTHER
OPC_FROM_INTERNAL
|
OPCDATA_UNMATCHED |
get |
long |
|
|
|
Defines
whether the message matches a condition. Possible values are:
0 (default): the message was sent to the server because it matched
a match condition
1: the message did not match a match condition of the assigned
templates, but was forwarded nevertheless. |
OPCDATA_TIME_ZONE_DIFF |
get/set |
long |
|
|
|
Time
difference to GMT in seconds. |
OPCDATA_FORWARDED_FROM |
get |
long |
|
|
|
This flag
signals whether another management server has forwarded the
message. |
OPCDATA_IS_READONLY |
get |
long |
|
|
|
The
message is read only (TRUE) or can be acknowledged on this
server. |
OPCDATA_MSGSRC_TYPE |
get |
long |
|
|
|
Defines
the Message Source Type, the source which originated this message,
for example, the monitor agent. Possible values are:
OPC_CONSOLE_SRC : MPE/iX console.
OPC_OPCMSG_SRC : opcmsg(1|3) template
OPC_LOGFILE_SRC : logfile
OPC_MONITOR_SRC : monitor agent
OPC_SNMPTRAP_SRC : SNMP trap interceptor
OPC_SVMSI_SRC : server MSI
OPC_AGTMSI_SRC : agent MSI
OPC_LEGLINK_SRC : legacy link interface
OPC_SCHEDULE_SRC : scheduler
|
OPCDATA_TIME_OWNED |
get |
long |
|
|
|
Time an
operator took ownership of a message. |
OPCDATA_DATA_INFO |
get/set |
long |
|
|
|
Additional information about the message:
|
OPCDATA_MSG_STATUS |
get |
long |
|
|
|
Status of
the message:
OPC_MSG_ACTIVE
OPC_MSG_HISTORY
|
OPCDATA_ACKNOWLEDGE_TIME |
get |
long |
|
|
|
Time when
the message was acknowledged. |
OPCDATA_NUM_ANNOTATIONS |
get |
long |
|
|
|
Number of
annotations. |
OPCDATA_APPLICATION |
get/set |
str |
|
|
L |
Application which produced the message. Default: empty string. |
OPCDATA_GROUP |
get/set |
str |
|
|
|
Message
group. Default: empty string. |
OPCDATA_MSGTEXT |
get/set |
str |
|
|
L |
Message
Text. Default: empty string. |
OPCDATA_ORIGMSGTEXT |
get/set |
str |
|
|
L |
Original
Message Text. Allows you to set additional source information for a
message. It is only useful if the message text was reformatted but
the HPOM operator can access the original text as it appeared
before formatting. Default: empty string. |
OPCDATA_MSGTYPE |
get/set |
str |
|
|
|
Message
Type. This attribute is used to group messages into subgroups (for
example, to denote the occurrence of a specific problem). This
information may be used by event correlation engines. Default:
empty string. |
OPCDATA_NODENAME |
get/set |
str |
|
|
|
Name of
the node producing the message. The message is only handled by the
HPOM manager if this system is part of the HPOM Node Bank. Default:
local node name. |
OPCDATA_OBJECT |
get/set |
str |
|
|
L |
Object
name to use for the HPOM message. Default: empty string. |
OPCDATA_MSGSRC |
get |
str |
|
|
|
Message
source. For example, the name of the encapsulated logfile if the
message originated from logfile encapsulation or the interface name
if the message was sent using an instance of the Message Stream
Interface. Default: empty string. |
OPCDATA_MSGID |
get |
str |
|
|
|
The
unique ID of the message. |
OPCDATA_AACTION_NODE |
get/set |
str |
|
|
|
Defines
the node on which the automatic action should run. Default: value
of OPCDATA_NODENAME . |
OPCDATA_AACTION_CALL |
get/set |
str |
|
|
L |
Command
to use as automatic action for the HPOM message. Default: empty
string. |
OPCDATA_OPACTION_NODE |
get/set |
str |
|
|
|
Defines
the node on which the operator-initiated action should run.
Default: value of OPCDATA_NODENAME . |
OPCDATA_OPACTION_CALL |
get/set |
str |
|
|
L |
Command
to use as operator-initiated action for the HPOM message. Default:
empty string. Call of the operator-initiated action. |
OPCDATA_INSTR_IF |
get/set |
str |
|
|
|
Name of
the external instruction text interface. The external instruction
text interface must be configured in HPOM. Default: empty
string. |
OPCDATA_INSTR_PAR |
get/set |
str |
|
|
L |
Parameters for a call to the external instruction text interface.
Default: empty string. |
OPCDATA_OWNED_BY |
get |
str |
|
|
|
Name of
the operator who owns the message. |
OPCDATA_ESCALATION_SERVER |
get |
str |
|
|
|
The
escalation server. |
OPCDATA_OPTION_VAR |
set |
str |
|
|
L |
A string
containing the optional parameters used for resolving the
$OPTION variables by the message interceptor. The
string should have the format [<var>=<value>]* with
<var> and <value> not containing spaces or the '='
character. |
OPCDATA_ACKNOWLEDGE_OP |
get |
str |
|
|
|
Name of
operator who has acknowledged the message. |
OPCDATA_MSG_KEY |
get/set |
str |
|
|
L |
Additional message attribute for customized message handling. |
OPCDATA_SERVICE_NAME |
get/set |
str |
|
|
|
Specifies
the service name. |
OPCDATA_ORIGMSGID |
get |
str |
|
|
|
Unique
identifier of the original message. This is set when the message ID
was changed because of a message change. |
OPCDATA_ESCALATED_BY |
get |
str |
|
|
|
Name of
the operator who escalated the message. Default: empty string. |
OPCDATA_NUM_DUPLICATES |
get |
long |
|
|
|
Number of
duplicate messages of this message. |
OPCDATA_LAST_REC_TIME |
get |
long |
|
|
|
Contains
the time when the last duplicate message was received. |
OPCDATA_MSG_KEY_RELATION |
get/set |
str |
|
|
L |
Specifies
the message key relation. Can contain patterns. |
OPCDATA_MSG_KEY_RELATION_ICASE |
get/set |
long |
|
|
|
Case
sensitivity of message key relation: 0=case-sensitive, !=0 not
case-sensitive. |
OPCDATA_MSG_KEY_RELATION_SEPS |
get/set |
str |
|
|
|
Field
separators for message key relations. |
OPCDATA_MSG_GEN_NODENAME |
get |
string |
|
|
|
Name of
the node where the event occurred. |
OPCDATA_MSG_GEN_IP_ADDRESS |
get |
long |
|
|
|
IP
address of the node where the event occurred. |
OPCDATA_MSG_GEN_NETWORK_TYPE |
get |
long |
|
|
|
Network
type of the node where the event occurred. |