HPUX lrf[4]
LRF(4) LRF(4)
NAME
LRF - format for HP OpenView Local Registration File
DESCRIPTION
An LRF (Local Registration File) is read by the commands ovaddobj and
ovdelobj to register or de-register an Agent. The information
contained in the LRF serves two distinct purposes: it conveys to
ovspmd the information needed to start the Agent program as a daemon,
and it registers with the ORS (Object Registration Service) the object
instances to be managed by the Agent and the routing information used
to communicate with it.
Syntax
LRF lines consist of fields separated by colons. Each line has a pre-
defined constant number of fields that it must contain. Fields for
which defaults are defined can be omitted, but all separating colons
are required. Any empty line and any line starting with # is treated
as a comment line and is ignored. All characters appearing after a #
on a non-comment line are also treated as comments, and are ignored.
For all fields, unless otherwise stated below, there are certain
limitations on what characters may appear in them. Normally, a field
may not contain control characters (ASCII values less than 32), blank
characters, colons (:), commas (,), backslashes (\), number signs (#),
or characters with ASCII values greater than 126. These are known as
exception characters. For any field that does allow exception
characters (as documented below), the exception character may not be
used literally, but must be encoded. The encoded form is \\ nnn where
nnn is a three-digit octal representation of the ASCII value of the
exception character.
First Line
The first line of an LRF is required, and must contain the following
fields:
Name This is the official name by which this Agent is known to
ovstart, ovstop, ovstatus, ovspmd, and the ORS. This name
must be locally unique, and if the name is changed, the
Agent must be deleted with ovdelobj before changing the name
and added under its new name with ovaddobj.
Name is a required field; there is no default.
Path The absolute pathname of the executable Agent program.
Path is a required field; there is no default.
Second Line
The second line of an LRF is required, and must contain the following
fields:
Hewlett-Packard Company - 1 - NNM Release 4.0: August 1995
LRF(4) LRF(4)
Initial_Start_Flag
This field must be either OVs_YES_START or OVs_NO_START. If
it is OVs_YES_START, the Agent will be started automatically
when ovstart is run with no arguments. OVs_NO_START, it
will only be started if ovstart is explicitly run with the
name (see Name field) of the Agent as an argument, or if
another Agent depends on this one (see Dependenciesfield).
If not specified, Initial_Start_Flag defaults to
OVs_NO_START.
Dependencies
This field is a comma-separated list of other Agents
(specified by their Name fields) that must already be ovspmd
will start Agents in the ovspmd(1M) and OVsPMD_API(3).
By default, an Agent has no dependencies, in other words, it
can be started even if no other OpenView components are
running.
Arguments This is a comma-separated list of command line arguments
with which ovspmd will start the Agent.
By default, the Agent program is started with no arguments.
Behavior This field describes whether the Agent has been integrated
with ovspmd using the OVsPMD_API(3). Behavior must be
OVs_WELL_BEHAVED, OVs_NON_WELL_BEHAVED, or OVs_DAEMON.
OVs_WELL_BEHAVED means that the Agent is fully integrated
with ovspmd. ovspmd expects it not to go into the background
of its own accord, but to let ovspmd start it in the
background as its child. Furthermore, ovspmd expects the
Agent to establish communication with it using the functions
defined in OVsPMD_API(3), assumes it is running only after
it has sent a SUCCESS response, and expects it to exit when
ovspmd sends it an EXIT command.
OVs_NON_WELL_BEHAVED means that the Agent is not integrated
with ovspmd. ovspmd expects only that it does not go into
the background of its own accord, but lets ovspmd start it
in the background as its child. ovspmd assumes that the
Agent is Timeout seconds have elapsed, and terminates it by
killing it with SIGTERM (see kill(2)).
OVs_DAEMON means not only that the Agent is not integrated
with ovspmd, but also that it runs as a daemon, that is, it
runs in the background of its own accord. Since ovspmd
cannot manage a process that is not its child, it can start
such an Agent, but cannot terminate it or report meaningful
status about it.
Hewlett-Packard Company - 2 - NNM Release 4.0: August 1995
LRF(4) LRF(4)
If the definition does not match the actual behavior of the
Agent, ovspmd treats the Agent as it Behavior is
OVs_NON_WELL_BEHAVED.
Timeout This field must contain an integer, interpreted as a number
of seconds. If an Agent is configured OVs_NON_WELL_BEHAVED,
ovspmd will assume the Agent program has fully initialized
and is running after Timeout seconds have elapsed since the
Agent was started, and will then start other Agents that
depend on it. When ovspmd kills the Agent with SIGTERM,
Timeout seconds, ovspmd will kill it with SIGKILL.
If an Agent is configured OVs_WELL_BEHAVED, and if it sends
a DONE response but does not actually exit within Timeout
seconds, ovspmd will kill it with SIGTERM (and later with
SIGKILL, if it still does not exit). The default Timeout is
5 seconds.
Third and Subsequent Lines
Any additional lines are used to register Object Instances to be
managed by the Agent. An LRF is not required to contain any Object
Instance registration lines. Whether any are required depends on the
design of the Agent. An Object Instance registration line must contain
the following fields:
Syntax Conventions for Fields
s A string of ASCII characters
i A string of digits
;;; Indicates one or more of the previous production, separated
by semicolons
/// Indicates one or more of the previous production, separated
by slashes
Indicates one or more of the previous production, separated by dots
[ ] Brackets enclose an optional field
{ } Braces enclose a syntax production
| Indicates an alternative production
Object_Class
Syntax: { i ...}|*
This field defines the Class identifier of managed objects
with the same properties. An object class is specified by
its unique name which has been assigned by the Registration
Hewlett-Packard Company - 3 - NNM Release 4.0: August 1995
LRF(4) LRF(4)
Authority. In the case of registering SNMP Agents for use
with XMP, this field is used to define an SNMP OID. The use
of a wildcard ( *) on the last character of an identifier is
only allowed in the case of an SNMP OID.
Object_Instance
Syntax: " {{{i ...}=s|~|!|*;;;}///|-}
This field identifies how an instance of the Object_Class is
distinguished from other instances of the same Object Class.
It may be the Full or Locally Distinguished Name of the
object instance. The name may be obtained by traversing the
containment hierarchy tree from the root to the object
instance, concatenating the Relative Distinguished Names
(RDNs) along the path. The Object Instance field consists of
an list of RDNs. Each RDN defines at least one Attribute
Value Assertion (AVA).
An AVA consists of an attribute name followed by its
asserted value, for example:
1.4.21.1.1=10
o Exception Characters
Within AVAs, if the attribute type is IA5
string or printable string, there are certain
restrictions on what characters may be included
in the asserted value. Any of the characters
normally allowed in a string of the particular
type are allowed in the AVA, but any of the
characters which are exception characters must
be encoded as detailed above. In addition to
the above exception characters, the equals (=)
is also treated as an exception character.
o Special Characters
asterisk( *)
Indicates wildcard semantics is to be used for
this component of the instance name. It may be
used only on the last character of the entire
instance field.
tilde( ~)
This character creates entries for each IP
address associated with the hostname specified
by the - ttarget_host option to ovaddobj. When
each entry is created, the "~" character is
replaced with one of the associated IP
addresses.
exclamation mark( !)
Hewlett-Packard Company - 4 - NNM Release 4.0: August 1995
LRF(4) LRF(4)
This character is replaced by either the "name
string" specified on the ovaddobj command with
the " -t" option or the "system identifier" if
the " -t" option is not specified. If the " -t"
option is not specified, the "system
identifier" must contain either a "hostname" or
a "presentation address" but not both. If the
"system identifier" is a "hostname", then the
character is replaced by the "Official
Hostname" associated by the name service with
the entered "system identifier".
hyphen( -)
This supports XMP SNMP object registration. It
allows an instance of the object OID in the
class field to be registered as being managed
by a SNMP Agent (agent). The protocol stack
must be OVs_ASNMP. The Password field (see
below) will be used as the community name for
the Agent.
Operation Syntax: {s ///}|*
This field identifies the operations supported by the Agent
on this object. If a wildcard ( *) is specified then all
operations (except events) are valid. s may be any of the
following values:
OVs_GETR :Get request
OVs_SETC :Set request (confirmed)
OVs_SETU : Set request (unconfirmed)
OVs_ACTC : Action (confirmed)
OVs_ACTU : Action (unconfirmed)
OVs_CREA : Create
OVs_DELE : Delete
OVs_GETN : Get Next
OVs_EVTC : Event report (confirmed)
OVs_EVTU : Event report (unconfirmed)
OVs_CANR : Cancel outstanding Get Request
Stack Syntax: [{s}]
Hewlett-Packard Company - 5 - NNM Release 4.0: August 1995
LRF(4) LRF(4)
This field identifies the network management protocol stack
to be used to communicate with the Agent. s may take any of
the following values:
o OVs_ACMOT : ARPA CMOT protocol with TCP quality
of service
o OVs_ASNMP : ARPA SNMP protocol with UDP quality
of service
o OVs_ACMIP : OSI CMIP protocol
In cases where ovaddobj is used with a system identifier
which contains both a hostname and a presentation address,
the registered system name is selected by the Stack type for
each object declared in the LRF. An object with Stack
OVs_ACMIP will be registered with a
The stack defaults to OVs_ACMOT unless the " -O" option is
used in the ovaddobj command. When this option is used, the
default is OVs_ACMIP.
Password Syntax: [{OVs_Pwd=s}]
This field identifies authentication information for access
to the object. If no Password is given then Password
defaults to an empty string.
Exception Characters
There are certain restrictions on what characters may be
included in the password value. Any eight-bit character
value is allowed, but any of the characters which are
exception characters must be encoded as detailed above. In
addition to the above exception characters, the equals (=)
and slash (/) area also to be treated as exception
characters.
EXAMPLES
The following example is applicable to HP-UX 9.x and SunOS 4.1.x only.
First Line:
netmon:/usr/OV/bin/netmon:
The official name of the Agent is netmon, and the executable for
netmon is /usr/OV/bin/netmon.
Second Line:
Hewlett-Packard Company - 6 - NNM Release 4.0: August 1995
LRF(4) LRF(4)
OVs_YES_START:ovtopmd,trapd,ovwdb:-P:OVs_WELL_BEHAVED:15:
This Agent ( netmon) is started by ovspmd by default. It depends on
the Agents ovtopmd, trapd, and ovwdb being started before it. netmon
should be started with the -Poption. It is a Well-Behaved Agent. Its
timeout is 15 seconds.
Third Line, example 1:
1.3.6.1.4.1.11.2.0.0:1.3.6.1.4.1.11.2.0.3=15.11.177.83:OVs_GETR:OVs_ACMOT:
The object class is 1.3.6.1.4.1.11.2.0.0. The object instance
1.3.6.1.4.1.11.2.0.3=15.11.177.83. is specified with a single RDN, an
AVA using an IP address. The object supports only the Get operation.
It uses the ARPA CMOT communications stack.
Third Line, example 2:
1.3.6.1.4.1.11.2.0.0:*:OVs_GETR/OVs_SETC:OVs_ACMOT::
The object class is 1.3.6.1.4.1.11.2.0.1. The object instance is
specified with *, all instances of the object class. The object
supports the operations Get and Set Confirmed. It uses the ARPA CMOT
communications stack.
Third Line, example 3:
1.3.6.1.2.1*:-:*:OVsASNMP:OVs_Pwd=public:
The object class consists of all SNMP variables subordinate to OID
1.3.6.1.2.1. The object instance specifies that the SNMP name (OID) is
specified in the class field. All operations are supported. The ARPA
SNMP communications stack is used. The SNMP community name is
"public".
AUTHOR
LRF was developed by HP.
FILES
HP-UX 9.x and SunOS 4.1.x
/usr/OV/bin/netmon
HP-UX 10.x and Solaris 2.3, 2.4
/opt/OV/bin/netmon
Universal Pathname $OV_BIN/netmon
Universal pathname paths are established according to your shell and
platform requirements. See the file that applies to your platform and
shell for more information about the script used to set HP OpenView
Hewlett-Packard Company - 7 - NNM Release 4.0: August 1995
LRF(4) LRF(4)
Network Node Manager environment variables:
HP-UX 9.x and SunOS 4.1.x
/usr/OV/bin/ov.envvars.sh (k shell)
/usr/OV/bin/ov.envvars.csh (c shell)
HP-UX 10.x and Solaris 2.3, 2.4
/opt/OV/bin/ov.envvars.sh (k shell)
/opt/OV/bin/ov.envvars.csh (c shell)
SEE ALSO
ovaddobj(1M), ovdelobj(1M), ovspmd(1M), ovstart(1M), ovstop(1M).
Hewlett-Packard Company - 8 - NNM Release 4.0: August 1995