sms.sme - SysMan Station event file
EVM_event_name:
ACCESS_STATE = access_state
ACCESS_STATE_LABEL = access_state_label
ACCOUNT = account_name
DEFINITION = repository_definition
DISPLAY_STATE = [$event_variable$ | NORMAL |
WARNING|
FAILED | INACTIVE]
ENVIRONMENT = [S | P | C | A]
INDICTED = [$event_variable$ | TRUE |
FALSE]
INDICTMENT_LABEL = indictment_label
NEW_PARENT = new_parent_name
OBJECT_ID = KSM_object_id
OBJECT_ID_STR = MCL_object_id
OBJECT_KEY1 = [MCL_primary_key |
$event_variable$]
OBJECT_KEY2 = [MCL_secondary_key |
$event_variable$]
OBJECT_NAME = object_name
PARENT_IS_HOST = [y | n]
PREDICATE = predicate
PREDICATE_VARNAME = event_variable
PLATFORM = [LITE | WORKSTATION | SERVER
| ALL]
REPOSITORY_TYPE = [CH | MCL | FSA | CLU]
STATE = physical_state
STATUS_LABEL = status_label
VERSION = [os_version | ALL]
Introduction to System Management Event Files
The SysMan Station Event file (.sme) describes all the
events to which the SysMan Station daemon (smsd) should
subscribe. In addition to event names, it also specifies
which object the event pertains to, what state to put the
object in, and what action to take, if any, when the event
occurs.
You can register events with the SysMan Station by creating
any number of event files in /usr/share/sysman/sms/events.
SysMan Station event file names must end
with .sme. A list of events that the smsd subscribes to
for a standalone system is included with the base operating
system and is defined in the file, base.sme. A list of
events for a cluster is included with the base operating
system and is defined in the file, clu.sme. Neither file
should be edited.
SysMan Station Event files consist of stanzas of
attribute/value pairs. The first line in an entry specifies
the Event Manager (EVM) name of the event. Subsequent
lines specify the event's attributes and values. If
more than one value is needed for an attribute, they
should be entered as a comma separated list. See stanza(4)
for more information on syntax.
It is recommended that you create new event files when you
add new objects or applications to the SysMan Station.
Event Attributes [Toc] [Back]
Event stanzas may contain both mandatory and optional
attributes. The following list describes the attributes
and indicates whether or not each is mandatory. Notifies
the smsd of the access state of the object. The
access_state can be one of the following values: The name
of an event variable, the value of which will be passed to
the ACCESS_STATE keyword. Notifies the smsd that the
object is in an unusable state; its power is not turned on
after the system reboots. Notifies the smsd that the
object is an unusable state; it is returned to an operational
state after the system reboots. Notifies the smsd
that the object is in a usable state without limitations.
Notifies the smsd that the object's power is off.
This attribute is optional. The text that the smsd
appends to the label of the object's icon, which
represents the object in the SysMan Station client,
after this event is received. This may contain
embedded state variables.
This attribute is optional. The account to be used
when executing an action after the event is
received. The account specified may be root.
If the ACTION attribute is specified, then this
attribute is mandatory. The repository definition
for the object.
This attribute is optional. The display state for
the object after the event is received. It can be
either a state variable or an explicit display
state name. The name of an event variable, the
value of which will be passed to the STATE keyword.
Displays the object's icon without a warning or a
failed symbol, which indicates that the object is
in a normal operational state. Displays the
object's icon with a yellow box with a yellow line
through it, which indicates that there is a problem
with the managed object and has reduced its services.
Displays the object's icon with a red circle
with a red line through it, which indicates
that the object cannot be used. Displays the
object's icon with a yellow box, which indicates
that the object is no longer active.
This attribute is optional. This attribute limits
the scope of watched events from the specified origin.
You can specify a specific environment; however,
it is recommended that you specify all environments.
The valid values are: Specifies a single
system Specifies an event poster Specifies cluster
members Specifies all of the above
This attribute is mandatory. Specifies whether or
not the object is indicted. An indicted object is
one that experiences a high incidence of correctable
errors, and therefore should be serviced,
replaced or both. The valid values are: The indictment
state is determined from an EVM event variable
The object is always indicted when the SysMan
Station receives this event The object is never
indicted when the SysMan Station receives this
event
This attribute is optional. Text indicating that
the object is indicted after the event is received.
The smsd appends this to the label of the object's
icon, which represents the object in the SysMan
Station client. This may contain embedded state
variables.
This attribute is optional. The name of the new
parent for an object that is in the MOVED state.
This may be either an event variable or an explicit
object.
This attribute is optional. An explicit object
that is the subject of this event. An event variable
is not allowed for this attribute; therefore,
its use is limited to objects known at the time you
add this attribute. Its use also is limited to a
single object. The OBJECT_ID attribute usually is
used to imply a KSM object, which usually has a
numeric identifier.
This attribute is optional. An explicit object
that is the subject of this event. An event variable
is not allowed for this attribute; therefore,
its use is limited to objects known at the time you
add this attribute. Its use also is limited to a
single object. The OBJECT_ID_STR attribute is usually
used to imply a MCL object, which usually has
an alphanumeric identifier.
This attribute is optional. The MCL primary key of
an object that is the subject of this event. An
event variable that is defined in an EVM template
file also is allowed for this attribute. See
evmtemplate(4) for more information.
This attribute is optional. The MCL secondary key
of an object that is the subject of this event. An
event variable that is defined in an EVM template
file also is allowed for this attribute. See
evmtemplate(4) for more information.
This attribute is optional. The name of an
explicit object that is the subject of this event.
An event variable is not allowed for this
attribute. Its use is limited to objects known at
the time you add this attribute. Unlike a key or
id, an object name is not necessarily unique, in
which case the first object found with this name
will be used.
This attribute is optional. Specifies whether or
not the new parent is a host or alias. Used when
the STATE attribute is set to MOVED. Informs the
smsd that it needs to format the name of a host or
alias into a fully qualified domain name.
This attribute is optional. Specifies that the
parent is a host. Specifies that the parent is an
alias. The processor class associated with the
event. If ALL is specified, LITE, WORKSTATION, and
SERVER processors are included. It is recommended
that you use the ALL attribute.
This attribute is mandatory. Specifies, from the
information supplied by the PREDICATE_VARNAME
attribute, the explicit object that is the subject
of the event. The predicate can be one of the following
values: The object ID; this usually indicates
a KSM ID. The object ID as a string. This
usually indicates a MCL ID. The primary MCL object
key for the object. The secondary MCL object key
for the object. The name of the object.
This attribute is optional. Specifies an EVM event
variable defined in an event template and supplies
the event's information to the PREDICATE attribute.
See evmtemplate(4) for more information.
This attribute is mandatory if you specify the
PREDICATE attribute. The type of the repository
for the object mentioned in the event. The valid
values are: Specifies a KSM API Specifies a MCL API
Specifies that the information is located in an
internal repository used for file system data Uses
the clu_get_info command to acquire cluster information
This attribute is mandatory. Notifies the smsd of
the object's physical state. The physical_state can
be one of the following values:
Notifies the smsd that the object's power is on and
is available for use by the operating system Notifies
the smsd that the object is deleted Notifies
the smsd that all of the object's services are
stopped Notifies the smsd that the object is inactive
Notifies the smsd that the object is in a
degraded state Notifies the smsd that a new object
has been Notifies the smsd that the object is in a
normal operational state Notifies the smsd that the
object's power is off Notifies the smsd that all
objects for the given repository have been deleted
and recreated Notifies the smsd that the state of
the object based on the object's attributes Notifies
the smsd that the object is in test mode; its
power is turned on and the object is operational
Notifies the smsd that the object's power is turned
off; it cannot send the operating system information
Notifies the smsd that the object's services
are reduced
This attribute is optional. The text that the smsd
appends to the label of the object's icon, which
represents the object in the SysMan Station client,
after this event is received. This may contain
embedded state variables.
This attribute is optional. The version of the
Tru64 UNIX operating system that must be running to
support the event; either the output of the uname
-r -v command or ALL; which supports all versions
of the operating system. It is recommended that
you use the ALL option. If you use the output of
the uname -r -v command, you can specify multiple
releases of the operating system if the action
caused by the event functions differently for different
versions.
See uname(1) for more information.
This attribute is mandatory.
The following is an example of a SysMan Station event file
entry:
%SYS_VP%.sysman.station.update.*.%PORT_NUMBER%: VERSION =
ALL PLATFORM = ALL ENVIRONMENT = ALL STATE = NEW REPOSITORY_TYPE
= CH DEFINITION = $definition$ PREDICATE_VARNAME
= obj_id_str PREDICATE = %OBJECT_ID_STR% ACCOUNT = root
Location of the SysMan Station objects files.
Commands: dop(8), smsd(8), sysman_station(8)
Files: evmtemplate(4), stanza(4)
Others: EVM(5)
Programmer's Guide, System Administration
sms.sme(4)
[ Back ] |
