HP Operations Manager for Windows

Function-naming Conventions


The functions of the HPOM APIs have consistent names which reflect the operation they perform and the HPOM object on which they perform it. See Figure: Naming the HPOM API Functions for an example of how the HPOM API functions are named.

Naming the HPOM API Functions

The function names consist of the following parts:

product identifier
Identifies the product, in HPOM this is always opc.

HPOM object identifier
Identifies the HPOM object on which the function performs the operation.

operation identifier
Identifies the operation which the function performs.

additional identifier
Additional description to identify what the function does or expects.

Table: Overview of Function-name Combinations gives an overview of all available identifiers.

Note NOTE:
Not all operations are available on all HPOM objects and not every addition is available for each operation.

Overview of Function-name Combinations 

Product Identifier
HPOM Object Identifier
Operation Identifier
Additional Identifier
Additional Identifier
opc appl _add _all _layoutgrps
applgrp _modify _list _nodes
data _delete _node
if _get _nodes
msg _assign _nodegrps
msggrp _deassign _templates
msgregrp _move _templgrps
node
_nodehier
nodegrp _layoutgrp
nodehier _layoutgrps
profile _appls
reg _applgrps
sync _parentusers
templ _profiles
templfile _resps
templgrp _defaults
transact
user

Table: HPOM Objects gives an overview of all available HPOM objects which can be manipulated with the APIs. The opcdata type must be used to describe the objects when using the APIs. See HPOM Data Structures for more information about the opcdata types.

HPOM Objects 

HPOM Object
Description
opcdata Type
Action Request Action request to start an action on a managed node. Used by the Legacy Link Interface. OPCDTYPE_ACTION_REQUEST
Action Response Action response from a previously started action on a managed node. Used by the Legacy Link Interface. OPCDTYPE_ACTION_RESPONSE
Annotation Message annotation. OPCDTYPE_ANNOTATION
Application Application used in HPOM OPCDTYPE_APPLIC
Application Configuration Configuration of an HPOM application. This object type is used to configure HPOM applications. OPCDTYPE_APPL_CONFIG
Application Group Application group; an application group is a container of applications and other application groups. OPCDTYPE_APPL_GROUP
Application Response An application response is the response of a previously started HPOM application. Application responses can be received using the Application Response Interface; see also Interface API. OPCDTYPE_APPLIC_RESPONSE
Container A container contains a list of objects of one type. OPCDTYPE_CONTAINER
Layout Group A layout group contains a list of layout elements in a node hierarchy. OPCDTYPE_LAYOUT_GROUP
Message A message is the central management information element of the managed nodes. OPCDTYPE_MESSAGE
Message Event A message event is sent when a message was changed. OPCDTYPE_MESSAGE_EVENT
Message Group A message group is a grouping criteria of incoming messages. OPCDTYPE_MESSAGE_GROUP
Message ID A message ID contains the unique identifier of a message. OPCDTYPE_MESSAGE_ID
Monitor Message A monitor message is a monitor value which can be sent using the Agent Monitor API OPCDTYPE_MONITOR_MESSAGE
Node A node is an HPOM managed node. OPCDTYPE_NODE
Node Configuration A node configuration is the configuration of an HPOM managed node. It contains all necessary parameters to specify a node with all its characteristics. OPCDTYPE_NODE_CONFIG
Node Group A node group collects several nodes. OPCDTYPE_NODE_GROUP
Node Hierarchy A node hierarchy is a tree structure containing node layout elements and nodes as its leaves. OPCDTYPE_NODEHIER
Regroup Condition A regroup condition regroups messages matching the specified condition. OPCDTYPE_REGROUP_COND
Template A template is used to configure message conditions on managed nodes. OPCDTYPE_TEMPLATE_INFO
Template Group A template group collects several templates and other template groups. Template groups are handled like templates. OPCDTYPE_TEMPLATE_INFO
Template File A template file contains the complete configuration of a template including its conditions. Template files are only used by the template file API. [char *]
Template Info A template info object contains the name, description, and type of a template. It can be used to get a list of all available templates instead of the complete template configuration. OPCDTYPE_TEMPLATE_INFO
User Configuration A user configuration contains the properties of an HPOM user. OPCDTYPE_USER_CONFIG
User Profile A user profile contains the properties of users and is assigned to users so that the user takes over the properties defined in the profile. OPCDTYPE_USER_PROFILE