HP 3000 Manuals HP 3000 Manuals
SNMPCONTROL User Defined Command
The SNMPCONTROL command allows you to control the HP SNMP/XL subsystem.
This command allows you to start and stop the subsystem manually, enable
the internal trace facility, gather version information, obtain the
current status of the subsystem, enter the help facility, dump the
internal data structures to a flat-ascii file, and update the subsystem
configuration.
To facilitate access to the SNMPCONTROL command, the SNMPUDC.NET.SYS must
be enabled for those users who require access. This is accomplished by
using the SETCATALOG command, as follows:
SETCATALOG SNMPUDC.NET.SYS;SYSTEM.
Before the initial SETCATALOG you must make sure the TZ variable is
properly set for your local time zone by adding the following set of
lines to SNMPUDC.NET.SYS after the setvar opt ups("!cmd"):
if (not(bound(TZ))) then
setvar TZ "timezonevariable"
endif
See appendix D for a list of commonly used time zones and the TZ
environment variable strings that correspond to them.
You must also have NM capability to issue the SNMPCONTROL command.
NOTE Three clock parameters must be set to the correct value for the
SNMPCONTROL STATUS command to display the correct time. They are
the "hardware" clock, set via CLKUTIL, the system start up clock,
and the SNMPCONTROL time zone variable TZ. CLKUTIL must be set at
the ISL prompt using Greenwich Mean Time (GMT). SNMP uses GMT to
print out the time, therefore if the "hardware" clock is not set or
set inaccurately the SNMPCONTROL STATUS will report the incorrect
time.
It should be noted that the CLKUTIL is linked to the system start
up clock, and when the CLKUTIL clock is changed the system start up
clock will change accordingly. The system start up clock is set by
the user when prompted by the console at start up. However, if the
system start up clock is changed during bootup, the CLKUTIL clock
is not affected. To verify that the correct time is set, ensure
that the time shown by SHOWTIME (displays system start up clock)
and SNMPCONTROL STATUS display match whenever a time change is
made.
The following are the SNMPCONTROL commands:
-----------------------------------------------------------------------------
| |
| UDC Action |
| |
-----------------------------------------------------------------------------
| |
| dump Causes the HP SNMP/XL subsystem to dump its internal |
| data structures. |
| |
| help Provides online help for the HP SNMP/XL subsystem. |
| |
| start Activates the HP SNMP/XL subsystem. |
| |
| status Reports the status of the HP SNMP/XL subsystem. |
| |
| stop Deactivates the HP SNMP/XL subsystem. |
| |
| trace Enables/disables the HP SNMP/XL internal tracing. |
| |
| updateconfig Provides dynamic update of the HP SNMP/XL |
| configuration information. |
| |
| version Reports internal version levels of the various HP |
| SNMP/XL modules. |
| |
-----------------------------------------------------------------------------
SNMPCONTROL DUMP
The SNMPCONTROL DUMP command causes the HP SNMP/XL subsystem to dump its
internal data structures to a flat-ascii file.
Syntax.
SNMPCONTROL DUMP
Parameters.
None.
Description.
This command results in a SNMPDMxx.NET.SYS dump file to be created and
all of the internal data structures of the HP SNMP/XL subsystem to be
dumped to it. The data structures are dumped by the symbolic formatting
feature of the MPE/iX debugger.
Example.
MPEXL: snmpcontrol dump
The SNMP/XL subsystem has dumped its internal data
structures to SNMPDM01.NET.SYS (SNMPINFO 1704)
MPEXL:
SNMPCONTROL HELP
The SNMPCONTROL HELP command enters the HP SNMP/XL online help facility.
Once inside the online help facility, you can access help information on
the HP SNMP/XL subsystem. The help facility is identical to the MPE/iX
help subsystem.
Syntax.
SNMPCONTROL HELP
Parameters.
None.
Description.
This command provides an online help facility for the HP SNMP/XL
subsystem.
Example.
MPEXL: snmpcontrol help
Welcome to the HP SNMP/XL HELP Facility
The HP SNMP/XL Help Facility has the same syntax and usage as the
MPE/iX HELP Facility. To receive help on either a SNMPCONTROL
command, or one of the other SNMP commands (e.g.SNMPGET, SNMPNEXT),
enter the command, or the option for the SNMPCONTROL command. You
may
also enter an optional help parameter indicating the category of help
you wish to review. Help is also available for various HP SNMP/XL
errors, warnings, and informational messages that are returned to
the
user. You can get help on a SNMP/XL error, warning, or informational
message by entering the following type of command:
help SNMPERRxxxx
Other parameters available on most help commands are:
ALL: Explains everything about the command.
PARMS: Explains parameter(s) for the command.
EXAMPLES: Typical uses of that command.
KEYWORDS: COMMAND,SYNTAX,AVAIL
MPEXL:
SNMPCONTROL START
The SNMPCONTROL START command allows you to start the HP SNMP/XL
subsystem.
Syntax.
SNMPCONTROL START
[;TRACE]
[;TFILESIZE=file_size]
[;TFILE=file_name]
[;OVERRIDE]
[;SYSFAIL]
Parameters.
TRACE This parameter is optional and specifies that you
want to start the subsystem with the internal trace
facility enabled. When this parameter is used, the
tracing remains active until the HP SNMP/XL subsystem
is stopped or the trace command is used to turn off
tracing. The tracing information is recorded in a
file named NMTCnnnn.PUB.SYS, where nnnn represents
numerically sequential trace files. This file name
is the default and is used unless the TFILE option is
specified.
The default is no tracing.
TFILESIZE=file_size This parameter is optional and is ignored unless the
TRACE parameter is specified. It allows you to
specify the number of records in the SNMP/XL trace
file as the value of file_size. The value should be
a decimal number specifying the trace file size in
number of 128 word records.
The default is 1024.
TFILE=file_name This parameter is optional and is ignored unless the
TRACE parameter is specified. It allows you to
specify the name of the trace file, instead of using
the default trace file name as the value of
file_name. File_name must be a string of characters
that define a valid MPE file name.
OVERRIDE This parameter is optional and allows you to override
HP SNMP/XL version inconsistencies which would
normally prevent successful activation of the HP
SNMP/XL subsystem. Use of this parameter requires PM
and DI capabilities in addition to the NM capability
required to issue the SNMPCONTROL command.
____________________________________________________
CAUTION The OVERRIDE parameter is intended for use
by Hewlett-Packard support engineers.
Hewlett-Packard is not responsible for
damages resulting from unauthorized use.
____________________________________________________
SYSFAIL This parameter is optional and allows you to produce
a system halt if an irrecoverable internal error
occurs within the SNMP/XL subsystem.
The default is to trap and handle all errors but you
are given the option to fail the system by specifying
this parameter.
Description.
This command is used to activate the HP SNMP/XL subsystem. It is only
needed if you stop the subsystem and wish to restart it, or if the
subsystem terminated abnormally.
Example.
MPEXL: snmpcontrol start;trace
The HP SNMP/XL subsystem was successfully started. (SNMPINFO 1705)
MPEXL:
SNMPCONTROL STATUS
The SNMPCONTROL STATUS command allows you to query the status of the
SNMP/XL subsystem. This status includes if the SNMP protocol is active,
if the internal trace facility is active, if the sysfail option is
enabled, and the status of the UDP connection.
Syntax.
SNMPCONTROL STATUS
Parameters.
None.
Description.
This command reports the status of the HP SNMP/XL subsystem.
Example.
MPEXL: snmpcontrol status
SNMP/XL Subsystem Status (As of) : Tues Aug 20 10:54:51 1991
SNMP/XL Subsystem Started : Fri Aug 16 18:32:34 1991
SNMP Protocol : Enabled
SNMP Portid : $ffffdfea
Subsystem Tracing : Disabled
Sysfail Start Option : Disabled
UDP Connection : Enabled
Port 161 Socket Descriptor : $0000000d
Port 162 Socket Descriptor : $0000000e
MPEXL:
NOTE Make sure that the "hardware" clock, set via CLKUTIL, the system
start up clock, and the SNMPCONTROL time zone variable (TZ) are set
properly. See the information under the heading "SNMPCONTROL User
Defined Command" at the beginning of this chapter. See appendix D
for a list of time zone values.
SNMPCONTROL STOP
The SNMPCONTROL STOP command allows you to shut down the SNMP/XL
subsystem. Use of this command gracefully terminates the SNMP/XL
subsystem.
Syntax.
SNMPCONTROL STOP
Parameters.
None.
Description.
This command gracefully terminates the HP SNMP/XL subsystem.
Example.
MPEXL: snmpcontrol stop
The stop request has been successfully sent to the SNMP/XL stack.
(SNMPINFO 1702)
MPEXL:
SNMPCONTROL TRACE
The SNMPCONTROL TRACE command allows you to enable or disable the
internal trace facility of the SNMP/XL subsystem.
Syntax.
SNMPCONTROL TRACE
[;ON|OFF]
[;TFILE=file_name]
[TFILESIZE=file_size]
Parameters.
ON|OFF This parameter is optional. If it is not present,
the current state of the internal trace is toggled.
For example, if tracing is enabled, the internal
trace is disabled if the parameter is not present.
The ON parameter enables the internal trace facility.
If tracing is currently active, the current trace
file is closed.
The OFF parameter disables the internal trace
facility. If tracing is currently not active, then
the command is ignored.
TFILE=file_name This parameter is optional and is ignored unless the
TRACE parameter is specified. It allows you to
specify the name of the trace file instead of using
the default trace file name as the value of
file_name. File_name must be a string of characters
that define a valid MPE file name.
TFILESIZE=file_size This parameter is optional and is ignored unless the
TRACE parameter is specified. It allows you to
specify the number of records in the SNMP/XL trace
file as the value of file_size. The value should be
a decimal number specifying the trace file size in
number of 128 word records.
The default is 1024.
Description.
This command controls the HP SNMP/XL internal trace facility. When
tracing is enabled the default trace file, created by the Node Management
Subsystem, is named NMTCnnnn.PUB.SYS, where nnnn reflects numerically
sequential trace files. If the TFILE parameter is specified, then the
file_name specified is the name of the trace file.
Example.
One of the examples below (SNMPINFO 1724) starts the internal trace
facility, specifying the number of trace records at 2048.
MPEXL: snmpcontrol trace;on; TFILESIZE=2048
The SNMP/XL subsystem trace facility has been successfully activated
on trace file. (SNMPINFO 1724)
Tracing stopped on file. (SNMPINFO 1726)
MPEXL:
SNMPCONTROL UPDATECONFIG
The SNMPCONTROL UPDATECONFIG command allows you to dynamically update the
configuration information.
Syntax.
SNMPCONTROL UPDATECONFIG
Parameters.
None.
Description.
This command provides the ability to update the SNMP configuration
information without shutting down the HP SNMP/XL subsystem. The
configuration information that is updated is contained in the
SNMPCONF.NET.SYS file.
If an error is detected, the update does not take effect and the former
configuration is retained.
Before any configuration information is updated, the format of the
configuration file is validated.
Example.
MPEXL: snmpcontrol updateconfig
The SNMP/XL subsystem has successfully updated its configuration
information. (SNMPINFO 1709)
MPEXL:
SNMPCONTROL VERSION
The SNMPCONTROL VERSION command allows you to obtain the version
information for the SNMP/XL subsystem.
Syntax.
SNMPCONTROL VERSION
Parameters.
None.
Description.
This command reports the version level of the HP SNMP/XL subsystem. Each
module comprising the HP SNMP/XL subsystem is reported. You are informed
if module versions do not match or modules are missing.
Example.
MPEXL: snmpcontrol version
HP SNMP/XL SNMP module versions:
NM program file: SNMP.NET.SYS Version: A000000
NM program file: SNMPUTIL.NET.SYS Version: A0000000
NM program file: SNMP_OMI_VERS Version: A0000000
XL procedure: SNMP_API_VERS Version: A0000000
XL procedure: SNMP_TRAP_VERS Version: A0000000
XL procedure: SNMP_UTIL_VERS Version: A0000000
XL procedure: SNMP_CMDS_VERS Version: A0000000
XL procedure: SNMP_INIT_VERS Version: A0000000
NL procedure: SNMP_IOCOMP_VERS Version: A0000000
HP SNMP/XL SNMP overall version = A.00.00
(c) Copyright 1991 Hewlett-Packard Company
(c) Copyright 1988 by Carnegie Mellon University
(c) Copyright 1988,1989, Massachusetts Institute of Technology
MPEXL: