nettlconf(1M)

NAME

nettlconf − configure network tracing and logging command subsystem database

SYNOPSIS

/etc/conf/nettlconf -id ssid -name ssname [-class logclass] [-kernel] -lib sslib -msg ssmsgcat [-fmtfn fmtfunc] [-optfn optfunc] -group ssgrpname [-umedia media]

/etc/conf/nettlconf -delete ssid

DESCRIPTION

nettlconf maintains the database file /etc/conf/nettlgen.conf which contains information necessary for each subsystem that uses network tracing and logging. This database contains one entry for each subsystem. If a subsystem already exists with the same ID, the values given are substituted for those in the database; otherwise a new entry is created. The first form of the command shown above adds or updates a new subsystem to the database. The second form, nettlconf -d ssid, removes a subsystem entry from the database.

nettlconf is used primarily during product installation or product update. The nettlconf command should be executed from within the customize script at the end of an install or update. The customize script should execute the nettlconf command for each subsystem it installs.

Options

-id ssid (abbrev: -i) ssid (subsystem ID number) is used as the key field in the nettlgen.conf database. This is a required field.

-name ssname (abbrev: -n) ssname is the subsystem-name mnemonic. This string is used to identify the subsystem on the nettl command line and also in the header output from the formatter (see nettl(1M)). This is a required field.

-class logclass (abbrev: -c) logclass is the default log class mask assigned to the subsystem at start-up of the tracing/logging facility. For multiple classes, the masks can be combined into a single number. For example, to initially log DISASTER and ERROR events use 12 as the logclass. Default is an empty field in nettlgen.conf. nettl substitutes 8 (disaster) for an empty class field. This is an optional field.

Class	Abbreviation
informative	1
warning	2
error	4
disaster	8

-kernel (abbrev: -k) flags the given subsystem as a kernel subsystem. nettl uses this information to control certain tracing and logging properties of the subsystem. A subsystem is defaulted to non-kernel unless this option is used. This is an optional field.

-lib sslib (abbrev: -l) sslib is the name of the shared library where the subsystem formatter resides. This should be an absolute path name unless the library resides in /usr/lib. Multiple subsystems can reference the same library. This is a required field.

-msg ssmsgcat (abbrev: -m) msg is the name of the message catalog excluding the pathname and .cat filename extension. Multiple subsystems can refer to the same message catalog. This is a required field.

-fmtfn fmtfunc (abbrev: -f) fmtfunc specifies the function to call when formatting data from the given subsystem. Default is to form the function name from the subsystem ID as follows:

subsys_N_format

where N is the subsystem ID number. If a null function is needed for this subsystem, specify

-f NULL

This is an optional field.

-optfn optfunc (abbrev: -o) optfunc specifies the function used to process options in the netfmt filter configuration file (see netfmt(1M)). The default is an empty field in nettlgen.conf. netfmt assumes a NULL function for an empty optfunc field. This is an optional field.

-group ssgrpname (abbrev: -g) ssgrpname is a group name associated with the subsystem. Several subsystems can be grouped together so that a common banner is printed in the formatted header. This is a required field.

-umedia media (abbrev: -u) media is the update media information that describes the context of the product installation. This information is necessary for proper product installation in clustered environments. media is passed as a parameter to the product customize script by update (see update(1M)). The product customize script should use this option when media has a value. This is an optional field.

-delete ssid (abbrev: -d) Deletes the ssid (subsystem ID) from the database.

WARNINGS

The nettlconf utility is intended primarily for use by HP subsystems to configure themselves into the tracing and logging facility at installation time. System administrators may wish to use this command to alter the default logging class each subsystem starts up with, but no other information about the subsystem should be changed. Only an editor such as vi should be used to change the default logging information kept in the /etc/conf/nettlgen.conf file.

The nettl and netfmt commands read the /etc/conf/nettlgen.conf file each time they are executed. If the file becomes corrupted these commands cannot function.

AUTHOR

nettlconf was developed by HP.

FILES

/etc/conf/nettlgen.conf subsystem configuration file maintained by nettlconf

Museum

Related Articles