nettlconf(1M) nettlconf(1M)
NAME [Toc] [Back]
nettlconf - configure network tracing and logging command subsystem
database
SYNOPSIS [Toc] [Back]
/usr/sbin/nettlconf [-KL] -status
/usr/sbin/nettlconf -L [-console conlog] [-portsize logportsize]
[-space maxlogspace] [-filename logfilename] [-option logoptfile]
/usr/sbin/nettlconf [-KL] [-qmin minimumklqueuesize]
[-qmax maximumklqueuesize] [-space maxlogspace]
[-filename logfilename] [-write writelog]
/usr/sbin/nettlconf [-S] -id ssid -name ssname [-class logclass]
[-kernel|-st[reams]] -lib sslib -msg ssmsgcat [-fmtfn fmtfunc]
[-optfn optfunc] -group ssgrpname
/usr/sbin/nettlconf -delete ssid
DESCRIPTION [Toc] [Back]
nettlconf maintains the database file /etc/nettlgen.conf which
contains information required by the nettl, kl, and netfmt commands
(see nettl(1M), kl(1M), and netfmt(1M)). This database contains
system logging information along with a description of each subsystem
that uses either NetTL or KL facility to log messages.
nettlconf can be used to update the network or kernel logging
parameters or to add, update and delete subsystem descriptions. If a
subsystem already exists with the same ssid, the values given are
substituted for those in the database; otherwise a new entry is
created.
System administrators may use the nettlconf command to customize the
network or kernel logging parameters stored in the database such as
console logging behavior, the system log file name, the maximum system
log file size, and the amount of memory required by NetTL and KL
facilities.
nettlconf is also called during system startup to change the database
to reflect the values of any relevant environment variables in the
/etc/rc.config.d/nettl file.
Products use the nettlconf command during product installation to
configure subsystems into the NetTL and KL facilities. The
installation will execute the nettlconf command for each subsystem it
installs in order to provide the information necessary for the
subsystem to use the NetTL and KL facilities.
Only users with appropriate privileges can invoke nettlconf to modify
the configuration file.
Hewlett-Packard Company - 1 - HP-UX 11i Version 2: Sep 2004
nettlconf(1M) nettlconf(1M)
Options [Toc] [Back]
The following options can be used to view the network or kernel
logging parameters and all subsystem descriptions from the
nettlgen.conf database.
-status (abbrev: -s) display the contents of the database
relevant to the network logging facility only.
-KL -status display the contents of the database relevant to
the kernel logging facility only.
The following options can be used to update configuration information
about network logging.
-L This indicates that subsequent options apply to
updating network logging information. Changes to
logging information will not take effect until
nettl has been stopped and restarted. This is a
required field.
-console conlog (abbrev: -c) conlog is set to 1 if console logging
is to be enabled when nettl is started, 0 if not.
(Console logging is used to report interesting
events on the system console.) This is an
optional field.
NOTE: during system startup conlog will be changed
to match the value of the NETTL_CONSOLE variable
in the /etc/rc.config.d/nettl file.
-portsize logportsize
(abbrev: -p) logportsize determines the number of
outstanding messages possible in the log queue.
The value is in multiples of 1024 bytes. Valid
range is 1 through 64. The default is 8. This is
an optional field.
-space maxlogspace (abbrev: -s) maxlogspace is the maximum logging
file space to be allowed. This is the combined
size of the 2 ping-ponged log files. Specify the
size in multiples of 1024 bytes. Valid range is 1
through 10240. Default is 1000. This is an
optional field.
-filename logfilename
(abbrev: -f) logfilename is the path and file name
to be used as the system log file, without the
ping-pong extension (.LOGx). The default system
log file is /var/adm/nettl. This is an optional
field.
Hewlett-Packard Company - 2 - HP-UX 11i Version 2: Sep 2004
nettlconf(1M) nettlconf(1M)
-option logoptfile (abbrev: -o) logoptfile is the path and file name
to be used as the console log options file. The
information in this file will be used to select
logged events that will be reported to the system
console. The default console logging options file
is /var/adm/conslog.opts. This is an optional
field.
The following options can be used to update configuration information
about kernel logging.
-KL This indicates that subsequent options apply to
updating kernel logging information. Changes
pertinent to the writing modules of the kernel
loggin facility, such as kernel logging file name
and maximum space for kernel log file (see below)
will take effect whenever writing facility gets
turned on. Changes to the kernel logging facility
as a whole will not take effect until kl has been
stopped and started.
-qmin minimumklqueuesize
minimumklqueuesize determines the minimum number
of outstanding buffers possible in the log queue
of KL. Valid range is 8 through 1024. The default
is 64. This is an optional field.
-qmax maximumklqueuesize
maximumklqueuesize determines the maximum number
of outstanding buffers possible in the log queue
of KL. Valid range is 8 through 1024. The default
is 512. This is an optional field.
-space maxlogspace (abbrev: -s) maxlogspace is the maximum logging
file space to be allowed. This is the size of two
ping-ponged log files. Valid range is 16384 (16K)
through 1024M. Default if 8M. This is an optional
field.
Note: One can use suffixes K and M to specify
whether size is meant to be in Kilo or Mega bytes.
-filename logfilename
(abbrev: -f) logfilename is the path and file name
to be used as the kernel log file, without the
ping-pong extension (.KLOGx). The default system
kernel log file is /var/adm/kl. This is an
optional field.
-write writelog (abbrev: -w) writelog is set to 1 if writing
kernel log to disk is to be enabled when kl is
Hewlett-Packard Company - 3 - HP-UX 11i Version 2: Sep 2004
nettlconf(1M) nettlconf(1M)
started, 0 if not. Default is 0. This is an
optional field.
The following options are used to add or update a subsystem
description to the database.
-S Indicates that subsequent options apply to adding
or updating a subsystem entry. This is an
optional field.
-id ssid (abbrev: -i) ssid (subsystem ID number) is used as
the key field in the nettlgen.conf database. It
uniquely identifies a subsystem to the NetTL and
KL facilities. This is a required field.
Note: Subsystems are mutually exclusively
supported by NetTL and KL facilities. This means
that a given subsystem logs its messages either
through NetTL or KL, but not both. The following
rule applies: if the subsystem ID number is within
0 through 511 (including end numbers) range, then
NetTL facility takes care of those messages; if
the subsystem ID number is within 512 through 1023
(including end numbers) range then KL facility
takes care of those messages. Subsystem ID numbers
greater than 1023 are not allowed.
-name ssname (abbrev: -n) ssname is the subsystem-name
mnemonic. This string is used to identify the
subsystem on the nettl and kl command lines and
also in the subsystem header displayed by the
formatter (see nettl(1M), kl(1M) and netfmt(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
NetTL or KL facility. This is an optional field.
There is an important difference between the
interpretation of the logclass by NetTL and KL
facilities.
Interpretation By NetTL [Toc] [Back]
For multiple classes, the masks must be combined
into a single decimal 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 12 (disaster and
error) for an empty class field.
Hewlett-Packard Company - 4 - HP-UX 11i Version 2: Sep 2004
nettlconf(1M) nettlconf(1M)
Interpretation By KL [Toc] [Back]
For KL, the following rule applies for the
messages to log: if level x is specified then all
messages whose severity is greater or equal to the
severity of class x will be logged. For example,
if the logclass is 2, all warning, error and
disaster messages will be logged by KL. Default
is an empty field in nettlgen.conf. kl
substitutes 8 (disaster) for an empty class 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. If a subsystem is serviced by NetTL
facility, then it is defaulted to non-kernel
unless this option is specified, whereas any
subsystem serviced by KL facility is defaulted as
a kernel unless otherwise specified. This is an
optional field.
-streams (abbrev: -st) flags the given subsystem as a
streams based 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) ssmsgcat is the name of the subsystem
formatter message catalog. If the pathname and
.cat filename extension are excluded,
/usr/lib/nls/%L/%N.cat is used to locate ssmsgcat.
Otherwise, ssmsgcat must be formatted similarly to
the NLSPATH environment variable (see environ(5)).
Multiple subsystems can refer to the same message
catalog. This is a required field.
Hewlett-Packard Company - 5 - HP-UX 11i Version 2: Sep 2004
nettlconf(1M) nettlconf(1M)
-fmtfn fmtfunc (abbrev: -f) fmtfunc specifies the function to
call when formatting data from the given
subsystem. Multiple subsystems can reference the
same formatting function. 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)). Multiple
subsystems can reference the same options
processing function. 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. It is typically the product
name of the subsystem. Several subsystems can be
grouped together so that a common banner is
printed in the formatted header. This is a
required field.
The following option is used to remove a subsystem description from
the database.
-delete ssid (abbrev: -d) Deletes all information associated
with the ssid (subsystem ID) from the database.
WARNINGS [Toc] [Back]
The nettlconf utility is intended primarily for use by HP subsystems
to configure themselves into the NetTL and KL facilites 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.
The nettl, kl, and netfmt commands read the /etc/nettlgen.conf file
each time they are executed. If the file becomes corrupted these
commands cannot function.
Some changes to the /etc/nettlgen.conf file do not take effect until
nettl, kl, and netfmt are stopped and restarted.
Hewlett-Packard Company - 6 - HP-UX 11i Version 2: Sep 2004
nettlconf(1M) nettlconf(1M)
AUTHOR [Toc] [Back]
nettlconf was developed by HP.
FILES [Toc] [Back]
/etc/nettlgen.conf subsystem configuration file
maintained by nettlconf
/etc/rc.config.d/nettl configuration file controlling
nettl during system startup
SEE ALSO [Toc] [Back]
netfmt(1M), nettl(1M), kl(1M), nettlgen.conf(4), environ(5).
Hewlett-Packard Company - 7 - HP-UX 11i Version 2: Sep 2004 [ Back ] |
