sihadm(1M) (RM400 only) sihadm(1M)
NAME
sihadm - manage SIH monitor
SYNOPSIS
/usr/sbin/sihadm -d admdev -a adjust [-l ttylab -k linklab] [-p 'cmd']
/usr/sbin/sihadm -I [svctag] pmtag
/usr/sbin/sihadm -R [svctag] pmtag
/usr/sbin/sihadm -S [svctag] pmtag
/usr/sbin/sihadm -T level pmtag
/usr/sbin/sihadm -v type
/usr/sbin/sihadm -V
/usr/sbin/sihadm -h|-?
DESCRIPTION
The sihadm command aims to facilitate the administration of SIH moni-
tors [see sihmon(1M)]. The Service Access Facility (SAF) requires that
such a command be made available for each monitor. The administration
table for the SIH monitor (pmtab) is administered by the Service
Access Controller commands (SAC commands) sacadm(1M) and pmadm(1M). In
addition to its other functions, sihadm generates formatted output for
these commands.
In the following, an SIH driver link is understood as a port in terms
of the SAF. The link configuration is defined by an entry in the
pmtab file. An entry of this kind is identified by a unique name (SIH
monitor service ID).
The sihadm command contains the following functions:
- Formatted, SIH monitor-specific output
- Setting loading mode in SIH driver (-I)
- Reseting loading mode in SIH driver (-R)
- Status output of links monitored by the SIH monitor (-S)
- Setting of SIH monitor trace level (-T)
- Output of expected version IDs of the correctly integrated programs
and configuration files (-V and -v)
- Usage output (-h and -?)
Page 1 Reliant UNIX 5.44 Printed 11/98
sihadm(1M) (RM400 only) sihadm(1M)
If used correctly, all output is sent to stdout. Error messages or the
use of commands are output to stderr.
The use of the -I, -R, -S and -T options is only possible with root
authorization.
OPTIONS
-d admdev
This option is used to define the absolute or relative path name
link-specific admin devices of the SIH driver.
-a adjust
This option defines the time and the form of parameter settings
for the SIH monitor. For the adjust argument, exactly one of the
following characters is allowed:
c Each time a HDLC device is switched on, and following a change
in the SIH monitor status to enabled, the current HDLC parame-
ters are read from the SIH driver and stored.
Then the default HDLC parameters are set and the 'cmd' loading
program is invoked. Following successful completion of the
loading process, the previously stored HDLC parameters are
returned to the SIH driver (current).
The default HDLC parameters are, thus, only used during the
loading process. The current HDLC parameters are retained.
This setting is only useful for loadable HDLC devices.
e Each time a HDLC device is switched on, and following the
change in status of the SIH monitor to enabled, the default
HDLC parameters are set (ever).
o The default HDLC parameters are set when the status of the SIH
monitor changes to enabled. Under normal operating conditions,
this occurs only once when the SIH monitor is started on
(once).
n The default HDLC parameters are never set (never). In this
case, the -l and -k options are superfluous.
-l ttylab
This option provides a flag which refers to an entry
in/etc/ttydefs. This entry informs the SIH of the line speed.
Specification of the option is mandatory when the -ac, -ae or -ao
options are used.
-k linklab
This option provides a link flag which refers to an entry for
link-specific HDLC parameters in /etc/hdlcdefs. Specification of
the option is mandatory when the -ac, -ae or -ao options are
used.
Page 2 Reliant UNIX 5.44 Printed 11/98
sihadm(1M) (RM400 only) sihadm(1M)
-p 'cmd'
This option provides the complete call for a loading program for
connected HDLC devices. As the loading program options and argu-
ments must be distinguished from the sihadm options, the cmd
argument must be contained in inverted commas (').
Specification of the option is mandatory when the -ac option is
used.
-I [svctag] pmtag
This option is used to set the loading mode of an SIH driver's
admin device. The required admin device is taken from the pmtab
table of the SIH monitor pmtag with the SIH monitor service ID
svctag.
If svctag is omitted, all entries in the pmtab table are taken
into account.
Loading mode is not set if the relevant link is already being
monitored by an SIH monitor. In this case, a warning is output to
stderr.
-R [svctag] pmtag
This option is used to reset the loading mode of an SIH driver's
admin device. The required admin device is taken from the pmtab
table of the SIH monitor pmtag with the SIH monitor service ID
svctag.
If svctag is omitted, all entries in the pmtab table are taken
into account.
Loading mode is not reset, if the relevant link is already being
monitored by an SIH monitor. In this case, a warning is output to
stderr.
-S [svctag] pmtag
This option is used to output to stdout, the status of the svctag
link being monitored by the SIH monitor pmtag. If svctag is omit-
ted, the status of this and all other links known to the SIH mon-
itor is output.
The command requests the relevant SIH monitor to write the
/var/saf/pmtag/state status file. The required information is
taken from this file.
-T level pmtag
This option can be used to change the trace level of the SIH mon-
itor called pmtag. The argument level indicates the trace level:
Page 3 Reliant UNIX 5.44 Printed 11/98
sihadm(1M) (RM400 only) sihadm(1M)
0 no outputs (trace switched off, default)
1 output of error messages and important operating messages
2 additional output of detailed operating messages
-V This option outputs the version ID for the format of the pmtab
file, which is expected for the corresponding version of the
sihadm and sihmon(1M) commands (see options -va and -vm).
Output is sent to stdout without line feed. It is identical to
the output of the sihadm -vp command.
-v type
This option provides the version ID of the correctly integrated
programs and configuration files. The type argument can assume
one of the following values:
a Output of sihadm version ID
m Output of expected sihmon version ID
p Output of expected pmtab version ID
t Output of expected ttydefs version ID
d Output of expected hdlcdefs version ID
l Output of expected hdlclabs version ID
x Block output of the above-listed version IDs
The sihadm and sihmon version IDs are identical to the version ID
of the corresponding SIsih package.
With the exception of the -vx option, all output is sent to
stdout without line feed.
-h | -?
Returns information about the use of the sihadm command to
stderr.
pmtag
Name of an SIH monitor incarnation.
svctag
Name of an SIH monitor pmtab entry, which describes a link that
is being monitored by the SIH monitor (SIH monitor service ID).
Page 4 Reliant UNIX 5.44 Printed 11/98
sihadm(1M) (RM400 only) sihadm(1M)
NOTES
The formatted SIH monitor-specific output and the output of the -V
command are executed without line feed. They are particularly suitable
for creating an SIH monitor incarnation using sacadm -a, and for gen-
erating pmtab entries using pmadm -a. If the sihadm command -p option
is not used when pmadm -a is invoked, the activated SIH monitor pro-
vides the corresponding HDLC parameter setting, but does not initiate
loading.
The -S and -T options communicate with the current SIH monitor incar-
nation pmtag. The corresponding SIH monitor process must, therefore,
be already started.
The -I and -R options influence later communication between an SIH
monitor incarnation and the SIH driver. A corresponding SIH monitor
process must not be started.
When the system is started, the -I option should be called for all
links to be monitored before the SAC is started. This will ensure that
the SIH driver is in loading mode before a user channel (multi-device)
is opened at the SIH driver.
The default HDLC parameters consist of line and link-specific HDLC
parameters from the hdlcdefs file and are recorded with the help of
the link tag, admin device and hdlclabs file.
DIAGNOSTICS
The sihadm -S svctag pmtag call output has the following format:
service tag svctag -- internalstate [reason]
The internalstate field indicates the internal status of the svctag
link. The following entries are possible:
ENABLED The link is being monitored. No errors have occurred (nor-
mal).
LOADING Loading is currently in progress for the link.
ONRETRY A process has failed for the link (e.g. the loading of an
HDLC device with a workstation program) and will be repeated
when a specific interval has expired [see sihmon(1M)]. An
explanation can be found in the following reason error text.
DISABLED Monitoring of the link has been terminated. An explanation
can be found in the following reason error text. This type
of link can be reactivated by invoking sacadm -x -ppmtag
when the cause of the error has been eliminated.
When the sihadm -S pmtag call is used, the status of the SIH monitor
incarnation is output with the current option settings. All SIH moni-
tor service IDs are numbered.
Page 5 Reliant UNIX 5.44 Printed 11/98
sihadm(1M) (RM400 only) sihadm(1M)
If no error occurs, sihadm terminates with the return value 0. In the
event of an error, the return values have the following meanings:
1 = Incorrect option argument used (AWRARG)
2 = Incorrect combination of options (AILLOPT)
3 = Unknown SIH monitor name pmtag (AUPMTAG)
4 = SIH monitor pmtag is not started (ANOTRUN)
5 = Command not executed as root (ANOROOT)
6 = Unknown admdev, or no access rights (ANODEV)
7 = SIH monitor has written no state file (ANOSTATE)
8 = svctag not contained in pmtab or disabled (ANOSERV)
9 = pmtab cannot be opened (ANOPMTAB)
10 = Incorrect pmtab version (AWPMTAB)
11 = SIH monitor pmtag is active (AISRUN)
12 = Incorrect SIH monitor program name (AWRPNAME)
50 = Internal error (AINTERNAL)
FILES
/usr/lib/saf/sihmon
/etc/saf/pmtag/pmtab
/etc/ttydefs
/etc/hdlcdefs
/var/sadm/terms/hdlclabs
/var/saf/pmtag/state
SEE ALSO
pmadm(1M), sac(1M), sacadm(1M), sihmon(1M).
Page 6 Reliant UNIX 5.44 Printed 11/98