Systems Management: Event Management Service

Systems Management; Event Management Service (XEMS)
Copyright © 1997 The Open Group

Command Line Interface

Besides the set of APIs, the Event Service provides a command line interface to assist wrapping legacy applications and shell scripts as event suppliers. The importance of the CLI will certainly decrease with the increasing acceptance of the ES and the usage of its APIs by integrating applications. Due to the nature of UNIX commands, the performance of CLI calls will suffer compared to API calls.

The supplier command line interface allows immediate integration of event generating applications into the Event Service.

The Event Management Service Command Line interface provides a command line interface that can be used by a system administrator to manage EMS.

Event Supplier Interface

The Event Supplier Interface provides commands to send (or push) an event to the Event Channel. Systems Management: Event Management Service - Supplier Send Previous section.

Why not acquire a nicely bound hard copy?
Click here to return to the publication details or order a copy of this publication.

NAME

Supplier Send

SYNOPSIS

ems_supplier_send <type> [origin_netname=<service:addr> 
[origin_desc=<descname>]] [pid=<pid>] [uid=<uid>] [gid=<gid>] 
[severity=<sev>] [<attr_name>=<attr_value> [...]]

DESCRIPTION

This command is called by event suppliers to create and send an event to the Event Service. An event of the specified type is created and the attributes are set according to the name=value pairs. Unspecified attributes are set to default values.

PARAMETERS

type

specifies the name of the event type in the Event Type Schema database.

origin_netname

specifies the originating node in the format <service>:<addr>, where service is one of¹:

other

dns

dce

x500

nis

sna.

Default value for this parameter is the local node².

origin_desc

a string provided as a description of the originator; defaults to an empty string.

pid

the process ID or the originating application; defaults to -1.

uid, gid

user and group ID of the originating application; defaults to the uid and gid of the calling process.

severity

severity of the event; one of³:

info

emergency

alert

critical

warning

notice

debug.

attr_name

specifies the name of the attribute that is set

attr_value

value that is assigned to the attribute attr_name. The value is converted to the respective data type that is defined for attr_name in the Event Type Schema of event type type.

EMS Command Line Interface

The Event Management Service command line interface allows for management of all EMS Objects. The interface has been defined as a set of objects, with operations on those objects. The objects defined are:

ems
emsconsumer
emssupplier
emsfilter
emsevent-type
emslog.

The management objects and command line syntax are defined in the remainder of this Chapter. Systems Management: Event Management Service - Event Service Object

Previous section.

NAME

Event Service Object

SYNOPSIS

ems catalog
ems show [-host hostname]
ems modify [-host hostname] 
    [-add attr_name:attr_value -change attr_name:attr_value |
                                           -delete attr_name]

DESCRIPTION

This command is used to manage hosts running the EMS Event Service. The ems object represents an Event Service on a host.

OPERATIONS

catalog

returns all hosts in the current domain providing Event Services (for example, all DCE hosts running the event service daemon)

show

returns all the Event Service attributes for the Event Service on the given host.

modify

allow for the modification of the attributes of an Event Service on a given host. Attributes can be added, deleted, or their values can be changed.

PARAMETERS

-host hostname

specifies the name of the host running the Event service. If this parameter is not present, then the local host is assumed.

-add attr_name:attr_value

add the specified attribute to the Event Service attribute list. attr_name specifies the name of the attribute that is set. attr_value specifies the value that is assigned to the attribute attr_name.

-change attr_name:attr_value

change the specified attribute in the Event Service attribute list. attr_name specifies the name of the attribute to change. attr_value specifies the new value that is assigned to the attribute attr_name.

-delete attr_name

delete the specified attribute in the Event Service attribute list. attr_name specifies the name of the attribute to delete.

Systems Management: Event Management Service - Consumer Object Previous section.

NAME

Consumer Object

SYNOPSIS

emsconsumer catalog [-host hostname]
emsconsumer show <consumer_name> [-uuid consumer_uuid][-host hostname]
emsconsumer delete <consumer_name> [-uuid consumer_uuid][-host hostname]
emsconsumer modify <consumer_name> [-uuid consumer_uuid][-host hostname]
                     -add filter_name | -delete filter_name

DESCRIPTION

This command is used to manage registered consumers in the EMS Consumer Database. The emsconsumer object represents an EMS consumer.

OPERATIONS

catalog

returns a list registered consumers in the Consumer Database.

show

shows the filter group for consumer consumer_name.

delete

delete consumer consumer_name from the Consumer Database.

modify

modify consumer consumer_name's filter group.

PARAMETERS

-host hostname

specifies the name of the host running the Event Service. If this parameter is not present, then the local host is assumed.

consumer_name

specifies the name of the consumer to perform the operation on.

-uuid consumer_uuid

specifies the consumers unique identifier to uniquely identify consumer_name.

-add filter_name

add filter_name to the specified consumers filter group.

--delete filter_name

delete filter_name from consumer_name's filter group.

Systems Management: Event Management Service - Supplier Object Previous section.

NAME

Supplier Object

SYNOPSIS

emssupplier catalog [-host hostname]
emssupplier show <supplier_name> [-uuid supplier_uuid][-host hostname]
emssupplier delete <supplier_name> [-uuid supplier_uuid][-host hostname]

DESCRIPTION

This command is used to manage registered suppliers in the EMS Supplier Database. The emssupplier object represents an EMS supplier.

OPERATIONS

catalog

returns a list registered suppliers in the supplier Database.

show

shows the filter group for supplier supplier_name.

delete

delete supplier supplier_name from the supplier Database.

modify

modify supplier supplier_name's filter group.

PARAMETERS

-host hostname

specifies the name of the host running the Event Service. If this parameter is not present, then the local host is assumed.

supplier_name

specifies the name of the supplier to perform the operation on.

-uuid supplier_uuid

specifies the suppliers unique identifier to uniquely identify supplier_name.

Systems Management: Event Management Service - Filter Object Previous section.

NAME

Filter Object

SYNOPSIS

emsfilter catalog [-host hostname]
emsfilter show <filter_name> [-host hostname]
emsfilter delete <filter_name>[-host hostname]
emsfilter modify <filter_name> [-host hostname] [-append filter_exp]

DESCRIPTION

This command is used to manage filters in the EMS Filter Database. The emsfilter object represents an EMS filter.

OPERATIONS

catalog

returns a list of filters in the Filter Database.

show

shows the contents of the event filter filter_name.

delete

delete the event filter filter_name from the Event Filter Database.

modify

modify the event filter filter_name.

PARAMETERS

-host hostname

specifies the name of the host running the Event Service. If this parameter is not present, then the local host is assumed.

filter_name

specifies the name of the filter to perform the operation on.

-append filter_exp

append filter_exp to filter_name's filter expression list. This parameter is required for the modify operation.

Systems Management: Event Management Service - Event Type Object Previous section.

NAME

Event Type Object

SYNOPSIS

emsevent-type catalog [-host hostname]
emsevent-type show <event_type_name> [-uuid event_type_uuid]
                                     [-host hostname]
emsevent-type add <event_type_name> [-uuid event_type_uuid] 
                   [-host hostname] [[-attr attr_name:attr_fmt]..].
emsevent-type delete <event_type_name>[-uuid event_type_uuid]
                                      [-host hostname]

DESCRIPTION

This command is used to manage event types in the EMS Event Type Database. The emsevent-type object represents an EMS event type.

OPERATIONS

catalog

returns a list of event types in the Event Type Database.

show

shows the contents of the event type event_type_name .

add

add the event type event_type_name to the Event Type Database.

delete

delete the event type event_type_name from the Event Type Database.

PARAMETERS

event_type_name

specifies the name of the event type to perform the operation on.

-uuid event_type_uuid

specifies the event type that uniquely identifies event_type_name. This parameter required for the add operation.

-host hostname

specifies the name of the host running the Event Service. If this parameter is not present, then the local host is assumed.

-attr attr_name:attr_fmt

specifies the an attribute in the event type schema. attr_name specifies the attribute name, and attr_fmt specifies the attribute format name as specified in the Data Structures section. Attributes defined in schema correspond one for one with the attributes specified by the -attr parameters, in the order specified on this command. At least one -attr parameter is required for the add operation.

Systems Management: Event Management Service - Event Log Object Previous section.

NAME

Event Log Object

SYNOPSIS

emslog catalog [-host hostname]
emslog delete <event_uuid> [-host hostname]

DESCRIPTION

This command is used to manage undelivered events in the EMS Event log. The emslog object represents an EMS event log.

OPERATIONS

catalog

returns a list of undelivered events in the EMS Event log.

delete

delete the event specified by event_uuid from the Event log.

PARAMETERS

-host hostname

specifies the name of the host running the Event Service. If this parameter is not present, then the local host is assumed.

event_uuid

specifies the unique identifier for the undelivered event to delete.

Footnotes

1.: The keywords that are allowed for service match the value of XES_NameService.
2.: It is necessary that both service and address can be determined on a node.
3.: The keywords that are allowed for severity match the values of XES_Severity.

Contents

Next section

Index