Skip to content

W
White Rabbit Switch - Software
Commit f6f67f78 authored by Adam Wujek's avatar Adam Wujek 💬
Browse files
Options

doc/wrs-user-manual: Update information exported via SNMP 

Signed-off-by: Adam Wujek's avatarAdam Wujek <adam.wujek@cern.ch>
parent a6e1d574
Hide whitespace changes
Inline Side-by-side
Showing with 152 additions and 51 deletions
doc/wrs-user-manual.in
View file @ f6f67f78
......@@ -1342,25 +1342,26 @@ options:
@node SNMP Support
@chapter SNMP Support
The White Rabbit Switch supports SNMP, although some more work is needed
in this respect. The default read-only ``community'' name is @t{private},
The White Rabbit Switch supports SNMP. The default read-only ``community'' name
is @t{private},
but you can change it from the @t{Kconfig} interface before building.
The default read-write community is @t{private}.
The switch supports all the standard information through the @i{net-snmp}
installation. We'll remove some of the items in a later release, because
nobody wants to check running processes or disk space usage.
The additional, switch-specific information are in the
installation. The additional, switch-specific information are in the
``enterprise.96.100 subtree, where @t{96} is CERN and @t{100} is White
Rabbit. The associated MIB is in the directory @t{userspace/snmpd},
where related source files live as well.
As in version 4.2 there is no traps support.
@c ==========================================================================
@node The WRS MIB
@section The WRS MIB
This a summary of the available tables and scalars:
This section contain a summary of the available groups and tables.
Objects from 96.100.2 to 96.100.5 are obsolete, they were used during early
implementation of switch's snmp.
@table @code
......@@ -1370,26 +1371,113 @@ This a summary of the available tables and scalars:
that is incremented each time you access it. It can be used to
test basic functionality.
@item 96.100.2
@item 96.100.6
@b{wrsStatus} -- MIB's branch with collective statuses of entire
switch.
@item 96.100.6.1
@b{wrsGeneralStatusGroup} -- Group containing collective statuses of
particular subsystems and main system status, describing status of
entire switch.
@item 96.100.6.2
@b{wrsDetailedStatusesGroup} -- Branch with collective statuses of
switch's subsystems.
@item 96.100.6.2.1
@b{wrsOSStatusGroup} -- Group with collective statuses of
switch's Operating System.
@item 96.100.6.2.2
@b{wrsTimingStatusGroup} -- Group with collective statuses of
switch's timing subsystem.
@item 96.100.6.2.3
@b{wrsNetworkingStatusGroup} -- Group with collective statuses of
switch's networking subsystem.
@item 96.100.6.3
@b{wrsVersionGroup} -- Hardware, gateware and software versions.
Additionally switch's serial number and other hardware information.
@item 96.100.7
@b{wrsExpertStatus} -- Branch with detailed statuses of switch
subsystems.
@item 96.100.7.1
@b{wrsOperationStatus} -- Branch with internal switch's statuses.
@item 96.100.7.1.1
@b{wrsCurrentTimeGroup} -- The internal White Rabbit time, as a number
and a string.
@item 96.100.7.1.2
@b{wrsBootStatusGroup} -- Group with statuses of switch's boot. It
contains boot counter, restart reason, config source, result of loading
FPGA and LM32, number of not started processes and not loaded kernel
modules.
@item 96.100.7.1.3
Port statistics, as an SNMP table. The first column is the
name of each counter, and further columns represent interfaces
@t{wr0} through @t{wr17}. Each counters is shown in a table line,
as the number and names of the counters may change in the future.
@b{wrsTemperatureGroup} -- Group with temperature values and
thresholds.
@item 96.100.3
@item 96.100.7.1.4
White Rabbit specific information. Subid @t{.1} is the global
items, and subid @t{.2} is a table with per-port items.
@b{wrsMemoryGroup} -- Group with memory usage values.
@item 96.100.4
@item 96.100.7.1.5
Hardware, gateware and software versions, plus serial
number and other hardware information.
@b{wrsCpuLoadGroup} -- Group with load average values, for 1, 5 and 15
minutes.
@item 96.100.5
@item 96.100.7.1.6
@b{wrsDiskTable} -- Table containing switch's disks usage.
@item 96.100.7.2
@b{wrsStartCntGroup} -- Group with start counters of switch's
proccesses.
@item 96.100.7.3
@b{wrsSpllState} -- Branch with Soft PLL status.
@item 96.100.7.3.1
@b{wrsSpllVersionGroup} -- Group with version details of Soft PLL.
@item 96.100.7.3.2
@b{wrsSpllStatusGroup} -- Group with status details of switch's Soft PLL.
@item 96.100.7.4
@b{wrsPstatsTable} -- Port statistics, as an SNMP table. The first
column is the name of each interface, and further columns represent
various counters' values.
@item 96.100.7.5
@b{wrsPtpDataTable} -- Table containing information about PTP servo.
@item 96.100.7.6
@b{wrsPortStatusTable} -- Table containing details about switch's
ports, whether link is up, configured mode, SFPs, PTP RX and TX frames
passed.
The internal White Rabbit time, as a number and a string.
@end table
......@@ -1416,41 +1504,54 @@ the software commit in this example is my own development version while writing
this section:
@smallexample
WR-SWITCH-MIB::wrsScalar.0 = INTEGER: 2
WR-SWITCH-MIB::pstatsDescr.1 = STRING: TX Underrun
WR-SWITCH-MIB::pstatsDescr.2 = STRING: RX Overrun
WR-SWITCH-MIB::pstatsDescr.3 = STRING: RX Invalid Code
WR-SWITCH-MIB::wrsScalar.0 = INTEGER: 1
WR-SWITCH-MIB::wrsMainSystemStatus.0 = INTEGER: ok(1)
WR-SWITCH-MIB::wrsOSStatus.0 = INTEGER: ok(1)
WR-SWITCH-MIB::wrsTimingStatus.0 = INTEGER: ok(1)
[...]
WR-SWITCH-MIB::wrsConfigSource.0 = INTEGER: tftp(4)
WR-SWITCH-MIB::wrsConfigSourceHost.0 = STRING: 192.168.1.1
WR-SWITCH-MIB::wrsConfigSourceFilename.0 = STRING: config-192.168.1.10
WR-SWITCH-MIB::wrsBootConfigStatus.0 = INTEGER: ok(1)
WR-SWITCH-MIB::wrsBootHwinfoReadout.0 = INTEGER: ok(1)
WR-SWITCH-MIB::wrsBootLoadFPGA.0 = INTEGER: ok(1)
WR-SWITCH-MIB::wrsBootLoadLM32.0 = INTEGER: ok(1)
[...]
WR-SWITCH-MIB::wrsPstatsPortName.1 = STRING: wr0
WR-SWITCH-MIB::wrsPstatsPortName.2 = STRING: wr1
[...]
WR-SWITCH-MIB::wrsPstatsTXFrames.1 = Counter32: 232
WR-SWITCH-MIB::wrsPstatsTXFrames.2 = Counter32: 543
[...]
WR-SWITCH-MIB::wrsPstatsRXFrames.1 = Counter32: 255
WR-SWITCH-MIB::wrsPstatsRXFrames.2 = Counter32: 544
[...]
WR-SWITCH-MIB::wrsPtpServoState.1 = STRING: TRACK_PHASE
WR-SWITCH-MIB::wrsPtpServoStateN.1 = INTEGER: trackPhase(4)
WR-SWITCH-MIB::wrsPtpPhaseTracking.1 = INTEGER: tracking(2)
WR-SWITCH-MIB::wrsPtpSyncSource.1 = STRING:
WR-SWITCH-MIB::wrsPtpClockOffsetPs.1 = Counter64: 0
WR-SWITCH-MIB::wrsPtpClockOffsetPsHR.1 = INTEGER: 0
WR-SWITCH-MIB::wrsPtpSkew.1 = INTEGER: -1
WR-SWITCH-MIB::wrsPtpRTT.1 = Counter64: 943893
WR-SWITCH-MIB::wrsPtpLinkLength.1 = Gauge32: 91
WR-SWITCH-MIB::wrsPtpServoUpdates.1 = Counter32: 33
[...]
WR-SWITCH-MIB::wrsPortStatusPortName.1 = STRING: wr0
WR-SWITCH-MIB::wrsPortStatusPortName.2 = STRING: wr1
[...]
WR-SWITCH-MIB::wrsPortStatusLink.1 = INTEGER: up(2)
WR-SWITCH-MIB::wrsPortStatusLink.2 = INTEGER: up(2)
[...]
WR-SWITCH-MIB::pstatsDescr.38 = STRING: Forwarded
WR-SWITCH-MIB::pstatsDescr.39 = STRING: TRU Resp Valid
WR-SWITCH-MIB::pstatsWR0.1 = Counter32: 0
WR-SWITCH-MIB::wrsPortStatusConfiguredMode.1 = INTEGER: slave(2)
WR-SWITCH-MIB::wrsPortStatusConfiguredMode.2 = INTEGER: auto(4)
[...]
WR-SWITCH-MIB::pstatsWR17.38 = Counter32: 50819
WR-SWITCH-MIB::pstatsWR17.39 = Counter32: 0
WR-SWITCH-MIB::pstatsEntry.20 = Counter32: 0
WR-SWITCH-MIB::ppsiGrandmaterID.0 = Hex-STRING: 00 00 00 00 00 00 00 00
WR-SWITCH-MIB::ppsiOwnID.0 = Hex-STRING: 00 00 00 00 00 00 00 00
WR-SWITCH-MIB::ppsiMode.0 = INTEGER: unknown(0)
WR-SWITCH-MIB::ppsiServoState.0 = STRING:
WR-SWITCH-MIB::ppsiPhaseTracking.0 = INTEGER: not-tracking(0)
WR-SWITCH-MIB::wrsPortStatusSfpVN.1 = STRING: Axcen Photonics
WR-SWITCH-MIB::wrsPortStatusSfpVN.2 = STRING: Axcen Photonics
[...]
WR-SWITCH-MIB::portLink.14 = INTEGER: down(0)
WR-SWITCH-MIB::portLink.15 = INTEGER: up(1)
WR-SWITCH-MIB::portLink.16 = INTEGER: down(0)
WR-SWITCH-MIB::wrsPortStatusSfpPN.1 = STRING: AXGE-3454-0531
WR-SWITCH-MIB::wrsPortStatusSfpPN.2 = STRING: AXGE-3454-0531
[...]
WR-SWITCH-MIB::portPeer.18 = Hex-STRING: FF FF FF FF FF FF FF FF
WR-SWITCH-MIB::ppsiPort.5 = Hex-STRING: FF FF FF FF FF FF FF FF
WR-SWITCH-MIB::wrsVersionSw.0 = STRING: v4.0-rc1-42-gcec7805+
WR-SWITCH-MIB::wrsVersionGw1.0 = STRING: 7cce708
WR-SWITCH-MIB::wrsVersionGw2.0 = STRING: 5118070
WR-SWITCH-MIB::wrsVersionGw3.0 = STRING: 7efeb16
WR-SWITCH-MIB::wrsVersionHw1.0 = STRING: 3.30
WR-SWITCH-MIB::wrsVersionHw2.0 = STRING: LX240T
WR-SWITCH-MIB::wrsManufacturer.0 = STRING: Seven Solutions
WR-SWITCH-MIB::wrsSerialNumber.0 = STRING: 12345
WR-SWITCH-MIB::wrsScbVersion.0 = STRING: 3.3
WR-SWITCH-MIB::wrsDateTAI.0 = Counter64: 1406623390
WR-SWITCH-MIB::wrsDateString.0 = STRING: 2014-07-29-08:43:10
@end smallexample
Another example is to print all objects exported by switch.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment