NAME
nettlconf — configure network tracing and logging command subsystem database
SYNOPSIS
/usr/sbin/nettlconf -L
[-console
conlog]
[-portsize
logportsize]
[-space
maxlogspace]
[-filename
logfilename]
[-option
logoptfile]
/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
nettlconf
maintains the database file
/etc/nettlgen.conf
which contains information required by the
nettl,
and
netfmt
commands (see
nettl(1M),
and
netfmt(1M)).
This database contains system logging information along with a
description of each subsystem that uses
NetTL
facility to log messages.
nettlconf
can be used to update the network 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 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
facility.
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
facility. 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
facility.
Only users with appropriate privileges can invoke
nettlconf
to modify the configuration file.
Options
The following option can be used to view the network
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.
- 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.
- -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 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
facility. 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 lines and also in the subsystem header displayed by the
formatter (see
nettl(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
facility. This is an optional field.
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.
- -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.
This is defaulted to non-kernel unless this
option is specified.
- -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.
- -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:
where
N
is the subsystem
ID
number. If a null function is needed for this subsystem, specify
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
The
nettlconf
utility is intended primarily for use by
HP
subsystems to configure themselves into the
NetTL
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.
The
nettl,
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
and
netfmt
are stopped and restarted.
AUTHOR
nettlconf
was developed by HP.
FILES
- /etc/nettlgen.conf
subsystem configuration file maintained by
nettlconf
- /etc/rc.config.d/nettl
configuration file controlling
nettl
during system startup
Printable version
