Intel® is a trademark or registered trademark of Intel Corporation or its subsidiaries in the United States and other countries.
Java™ and all other Java-based marks are trademarks or registered trademarks of Oracle America, Inc. in the U.S. and other countries.
Microsoft®, Windows® and Windows Me® are registered trademarks of Microsoft Corporation; and Windows XP™ is a trademark of
Microsoft Corporation.
PICMG®, CompactPCI®, AdvancedTCA™ and the PICMG, CompactPCI and AdvancedTCA logos are registered trademarks of the PCI
Industrial Computer Manufacturers Group.
UNIX® is a registered trademark of The Open Group in the United States and other countries.
Notice
While reasonable efforts have been made to assure the accuracy of this document, Artesyn assumes no liability resulting from any
omissions in this document, or from the use of the information obtained therein. Artesyn reserves the right to revise this document
and to make changes from time to time in the content hereof without obligation of Artesyn to notify any person of such revision or
changes.
Electronic versions of this material may be read online, downloaded for personal use, or referenced in another document as a URL to
an Artesyn website. The text itself may not be published commercially in print or electronic form, edited, translated, or otherwise
altered without the permission of Artesyn.
It is possible that this publication may contain reference to or information about Artesyn products (machines and programs),
programming, or services that are not available in your country. Such references or information must not be construed to mean that
Artesyn intends to announce such Artesyn products, programming, or services in your country.
Limited and Restricted Rights Legend
If the documentation contained herein is supplied, directly or indirectly, to the U.S. Government, the following notice shall apply
unless otherwise agreed to in writing by Artesyn.
Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph (b)(3) of the Rights in
Technical Data clause at DFARS 252.227-7013 (Nov. 1995) and of the Rights in Noncommercial Computer Software and
Documentation clause at DFARS 252.227-7014 (Jun. 1995).
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
7
List of Tables
8
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
About this Manual
Overview of Contents
This guide provides detailed information about installation, configuration, and how to work
with ViewCheck. The following table gives the list of chapters described in this document.
ChapterDescription
About this ManualLists all conventions and abbreviations used in this manual and
IntroductionProvides detailed overview and features of ViewCheck.
Concepts of ViewCheckDescribes the concepts of ViewCheck.
Installation of ViewCheckProvides instructions to install ViewCheck.
Commands ExecutionDescribes about the various tests that can be executed in
outlines the revision history.
ViewCheck.
Appendix A, Related
Documentation
Abbreviations
The following tables lists the abbreviations used throughout the document.
AbbreviationDefinition
ATCAAdvanced Telecom Computing Architecture
BSFBlade Services Framework. A derivative of System Services
CLICommand Line Interface
ClientThe applications used to Access ViewCheck via the various
HWHardware
INSMIn Service Monitoring. Functional module in ViewCheck
Lists the relevant manuals and provides additional information.
Framework.
Interfaces (CLI and XML)
framework handling the monitoring functionality of
various critical parameters in the blade.
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
9
About this Manual
AbbreviationDefinition
OOSDOnline Out of service Diagnostics. Functional module in
PPPacket Processor
SPService Processor
XMLExtensible Markup Language
Conventions
The following table describes the conventions used throughout this manual.
NotationDescription
0x00000000Typical notation for hexadecimal numbers (digits are
About this Manual
ViewCheck framework that manages Test Management
requests related to Out of Service Diagnostics.
0 through F), for example used for addresses and
offsets
10
0b0000Same for binary numbers (digits are 0 and 1)
boldUsed to emphasize a word
ScreenUsed for on-screen output and code related elements
or commands in body text
Courier + BoldUsed to characterize user input and to separate it
from system output
ReferenceUsed for references and for table and figure
descriptions
File > ExitNotation for selecting a submenu
<text>Notation for variables and keys
[text]Notation for software buttons to click on the screen
and parameter description
...Repeated item for example node 1, node 2, ..., node
12
.
.
.
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
Omission of information from example/command
that is not necessary at the time being
About this Manual
NotationDescription
..Ranges, for example: 0..4 means one of the integers
0,1,2,3, and 4 (used in registers)
|Logical OR
Indicates a hazardous situation which, if not avoided,
could result in death or serious injury
Indicates a hazardous situation which, if not avoided,
may result in minor or moderate injury
Indicates a property damage message
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
No danger encountered. Pay attention to important
information
11
About this Manual
Summary of Changes
Part NumberDateDescription
6806800S51AOctober, 2013Initial version.
About this Manual
6806800S51B
6806800S51CMay, 2014R2.6 Release
6806800S51DMay, 2014Added notice in sections Orion License RPM
6806800S51ESeptember, 2014Added show-all-test-status on page 53,show-
March, 2014Updated the sections Overviewon page 21,
ViewCheck RPM Image on page 21 and BSF
Service RPM on page 23.
Added new commands in Generic
Commands on page 45, a test in Memory on
page 82 and section FPGAon page 84.
Updated ViewCheck Service OS Image on
page 25 and OOSD Tests on page 80.
Re-branded to Artesyn template.
Installation, Overview, ViewCheck RPM Image,
and BSF Service RPM.
log-level on page 56, switch-mode on page
60, ViewCheck TestLog Information on page
43, and SfpDetectionTest command.
12
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
Introduction
1.1Overview
ViewCheck is a comprehensive software service that can be used to diagnose, manage, and
monitor Artesyn ATCA blades. The diagnostic utilities of ViewCheck help in identifying,
detecting, and locating hardware issues on a blade. ViewCheck also provides mechanism to
monitor status of Storage devices, Ethernet counters and errors.
ViewCheck can be accessed locally using Command Line Interface (CLI) and Extensible Markup
Language (XML) interfaces provided via Blade Services Framework (BSF) service.
ViewCheck can provide both:
InService Diagnostics
In this mode, the diagnostics service can run while the blades are instantiated with
customer applications and providing service.
ViewCheck can monitor key hardware parameters like Network Counters, and Network
errors. In addition, watching for kernel critical errors logged by various hardware devices
and device drivers.
Chapter 1
Out of Service Diagnostics
In this mode, a service OS is provided with various Out of Service Diagnostics tests and
utilities. This Service OS has to be loaded and diagnostics utilities can be executed. To
execute these tests, CLI /XML access is provided.
Both InService and Out of Service are provided as binary images. For more information on
Binary images and installation procedures, refer Installation of ViewCheck on page 21.
For more information on commands supported for InService and OOS, refer Commands
Execution on page 45.
ViewCheck on ATCA-9405 is supported on P2020 service processor (SP) and two Cavium
OCTEON II packet processors (PP). Procedure to install and accessing ViewCheck on SP and PP
are different and is detailed in Installation of ViewCheck on page 21.
1.2ViewCheck Access Methods
This section explains the different methods to access ViewCheck services on the Artesyn ATCA
blades.
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
13
Introduction
You can access ViewCheck using the following interfaces:
CLI
XML
Using these interfaces, you can
Initiate a diagnostic test
Query available diagnostic tests
Query status of a particular diagnostic test
Start and stop monitoring
Stop a diagnostic test
Generate Hardware inventory.
1.2.1CLI
CLI is one of the interfaces provided to access the ViewCheck capabilities on the blade. Using
CLI, you can start, stop, and query kind of primitives at this prompt. The ViewCheck CLI can be
accessed via a console using SSH.
BSF, a proprietary service of Artesyn, is used to provide the CLI access to ViewCheck service.
BSF binaries are provided along with the ViewCheck binaries.
For more information on BSF RPMs and Installation procedures, refer Installation of ViewCheck
on page 21.
1.2.2XML
XML is also one of the primary interfaces to access ViewCheck capabilities on the blade. XML
interface supports methods, classes, and event notification mechanism. Using XML, you can
start, stop, query, and configure the parameters related to tests and monitors. XML interface
can be accessed in the same manner as CLI and is provided by BSF.
14
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
Introduction
In addition, XML notifications are generated with following details:
State changes about the diagnostic test under execution
Pre-determined monitor exceeding set Threshold value
Occurrence of any pre-determined hardware device error/warning generated by the
device driver (or) the kernel on the blade.
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
15
Introduction
16
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
Concepts of ViewCheck
2.1Overview
Terminology and keywords used extensively in ViewCheck services and available via the
commands are explained briefly here.
2.2Test Identification
Unique Test identification is based on following triple key:
< Device Category, Test ID, Device Instance >
2.3Device Category
The Device Category is an enumerated value, reused from similar enumeration already defined
in HPI-B Standard specification.
Chapter 2
Expresses commonly known device categories like Storage, Network, Serial, CPU, Memory,
and so on, which are available on all blades irrespective of function and architecture. This
category is used in commands as one of the key fields to identify uniquely a particular test.
Device Category allows for:
Grouping of test cases per category for display and statistical purposes
Allows reuse of Test IDs across device categories
2.4Test ID
Test ID is an integer value that uniquely identifies the actual test that could be invoked or
executed on a Hardware Device Instance, which belongs to a specific device category available
on the blade.
Following are the examples of tests that can be executed on the devices:
Ping Flood test
Network connectivity test in case of Network Device Category
Each of these tests would be associated with a unique Test Identifier (Test ID).
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
17
Concepts of ViewCheck
These Test IDs start with value of ’0’ and would increase linearly for various sub-tests in a device
category.
Some tests may be applicable to all device instances in a particular device category. The
combination of <Device category, Test ID, Device Instance> would be unique
and shall provide capability to control, execute, and manage the test on a device instance in a
device category. With this mechanism, same test can be simultaneously started or triggered
on multiple device instances under that device category, thus providing parallel execution of
tests.
2.5Device Instance
Hardware devices uniquely identified and recognized by the drivers and OS on the blade are
treated as device instances. A device instance can belong to a particular device category. Tests
can be invoked and executed on this device instance. OS and Driver support to access the
device is assumed to be readily available.
For example, device instances eth0, eth1, or eth2 are used to identify unique devices in
networking devices category. Device instances use the standard nomenclature already
defined by the OS (for instance Linux) on the blade.
A diagnostic test identified by triple < Device Category, Test ID, device Instance> would be invoked (or) executed on the unique device instance.
The Enumerations mentioned below are used extensively in the context of InService
Monitoring.
2.6Monitor ID
ViewCheck service monitors pre-identified parameters for hardware devices. These
parameters are Network Device counters, Network Device errors and so on. To periodically poll
and check these parameters, the ViewCheck service uses CLI and XML configuration. For each
parameter of interest, a Monitor ID is an enumerated constant that uniquely represents the
Monitoring entity. This value shall be used by the ViewCheck to control monitoring and also
while reporting events via XML on these monitors.
18
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
2.7Error ID
This is an attempt to provide identification to list the pre-determined hardware device
errors/warnings generated by the device driver (or) the kernel on the blade. These critical and
error messages are an indication of abnormal behavior on part of the kernel or the hardware
device on the blade. ViewCheck functionality attempts to detect all such errors and would
provide suitable information to external high-level software intelligence to act upon.
The list of messages that constitute these errors is not standardized by the hardware device
Vendor (nor) the Linux Kernel Community. Error ID attempts to standardize all such messages
on Artesyn supported blades. These messages would be OS and driver specific. Mostly, the
same ERROR ID would be associated with the same category of error, across blades and OSs.
For more information on commands, refer to Commands Execution on page 45.
Concepts of ViewCheck
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
19
Concepts of ViewCheck
20
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
Installation of ViewCheck
3.1Overview
This section explains the ViewCheck release modules and installation procedures to install and
run ViewCheck service on the Artesyn ATCA blade.
ViewCheck service is released as a set of two distinct images.
ViewCheck RPM Image
This RPM contains all ViewCheck services. BSF service RPMs are also distributed along with
the ViewCheck RPMs. BSF service RPMs provide access to CLI and XML.
If user wants to move to a newly available ViewCheck and BSF RPMs, the current set of RPMs
should be uninstalled before installing the new RPMs. For more information, see ViewCheck
RPM Image and BSF Service RPM.
Chapter 3
ViewCheck Service OS image
You can download this image from SWORDS. This also contains the ViewCheck OOS image
for PPs.
3.2ViewCheck RPM Image
The ViewCheck RPM Image functionally comprises Diagnostics Framework, specific test cases,
and test suites. The ViewCheck RPM always uses same OS variant and compile time
environment based on the BBS release of the target blade. For ATCA-9405 Service Processor
(SP) blade, the ViewCheck RPM is created for PNE 4.1 environment.
This ViewCheck Service RPM contains:
Diagnostics Core - Daemon
Static Test Suite Configuration files for the Specific Blade
Start/Stop Scripts for Diagnostics Core
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
21
Installation of ViewCheck
Using the following command, you can install the ViewCheck RPM Image:
After the installation, the BSF binary files are installed at the /opt/ssf location.
The BSF applications can be started, stopped and restarted using below script.
sh /opt/ssf/etc/config/S99SsfBsfRun.sh start/stop/restart
You need to stop the BSF services, before performing uninstallation using below script.
/opt/ssf/etc/config/S99SsfBsfRun.sh stop
The order of removal of RPMs is a reverse procedure to that of installation.
24
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
3.4ViewCheck Service OS Image
The ViewCheck Service OS Image enables you to boot into ViewCheck specific OS and execute
the OOSD tests. The ViewCheck service is not completely dependent on the blade BBS
environment. For compatibility purpose, it may use the same OS or Kernel variant that are used
by the blade BBS service. For ATCA-9405 SP, the ViewCheck service OS is created with PNE
4.x3.x4.13.0 as the OS. For 9405 PP the OOSD image is build from cavium SDK. The 9405 PP
OOSD image is packaged along with 9405 SP OOSD image. So there is a single ViewCheck OS
image for ATCA-9405 blade.
The ViewCheck service OS along with the ViewCheck RPM, test suites, and test procedures are
distributed as an ISO file that contains:
ViewCheck OS as Ram Disk image that can be Net bootable
ViewCheck OS image can be Net bootable and installable on selected Flash Partition,
provided User Flash is available on the blade
Installation of ViewCheck
The following table provides details of the files that are distributed as part of this image once
the ViewCheck service OS is installed.
Table 3-2 ViewCheck Service OS Image Files on SP and PP
ViewCheck RPM, Orion License RPM, and BSF
services package.
ViewCheck OOS image for PP with ViewCheck RPM
and BSF service packages.
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
25
Installation of ViewCheck
Installing the ViewCheck Service OS image on SP
Before installing the ViewCheck service OS Image, you should have the knowledge of
configuring TFTP Server, configuring ATCA-9405 for Network Booting and Booting ATCA-9405
using a ramdisk. For more information, refer to the section 2.3 in Blade Services Software on ATCA-9405 PR guide.
1. Once the blade is configured to boot with ramdisk image, it will have ViewCheck
and Blade Services Framework installed.
2. SP should also have the interfaces to PP1 and PP2 configured so that a
communication can be established between SP and PP's.
Installing the ViewCheck Service OS image on PP
The following procedure is to boot the ViewCheck OOS image on PP. For more information,
refer to section 2.6.5 in Blade Services Software on ATCA-9405 Programmer’s Reference Guide.
26
Before installing ViewCheck Service OS image on PP, make sure that vlans are configured
appropriately to reach Octeons.
1. On SP, go to /opt/diagnostics/etc/diag/ location and execute the
runlinux scripts.
For installing ViewCheck Service OS image on PP1, execute ./runlinux 1
command.
For installing ViewCheck Service OS image on PP2, execute ./runlinux 2
command.
Installing ViewCheck Service OS Image on USB
The ViewCheck service OS image can be installed on any external USB drive using flashprep
and flashinstall tools available on the board.
Use the flashrc tool available on the board to install the ViewCheck service OS image on USB
device.
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
Installation of ViewCheck
For more information on installation, refer section 2.6.5 in Blade Services Software on ATCA-9405
Programmer’s Reference Guide.
Before installing on USB, the image needs to be converted into tar.bz2 format using
mk_atca_9405_sp_bzip2_format.sh script provided along with this release.
Example
./mk_atca_9405_sp_bzip2_format.sh <ViewCheck service image>
For this, any Linux PC can be used.
3.5Access and Execution of a Test Using CLI
You can access ViewCheck CLI using the following procedure:
1.Establish the secure shell using SSH or Putty.
2.Start the Tel ne t connection from an already established secure shell.
telnet localhost 11001
Trying :1...
telnet: connect to address ::1: Connection refused
Trying 127.0.0.1...
Connected to localhost.localdomain (127.0.0.1).
Escape character is '^]'.
Welcome to Emerson's SSF CLI
3.Type your username and password.
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
After logging into the ViewCheck CLI, you can list all the supported commands by typing '?'
on the CLI console.
BSF(diag-SP_VEE0)#?
configure-error-strings User configurable error strings, notified
by ViewCheck when reported by the device.
configure-log-path Configures the log path where the resluts
are stored.
device-category Configure deviceCategory
diag-service Diag operation(start/stop/restart).
exit Exit from diagnostic
hw-inventory-list Provides the Inventory of Hardware (Type,
Vendor ID, Major Number, Minor Number and
any associated Details) as detected by the
Diagnostics Application.
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
Installation of ViewCheck
list-all-tests Displays all the supported tests on the
Board.
purge-all-log All log files are Zipped and stored away.
purge-log Purge specific log file.
reload User can issue this command when there
are updates to the User XML.
set-log-level Sets the Log Level of Diagnostic
Application.
show-all-monitors Displays all the supported Monitors on
the Board.
show-diag-scan-result Displays the last run result of Diagscan.
show-log-content Displays the content of log files related
to Rawlogs and ResultsLog of ViewCheck.
show-log-info List all Log files of Diagnostics
Application.
show-running-mode Displays the current running mode of
ViewCheck.
show-systemerror-log show system error log.
start-all-monitors Starts all the supported Monitors
available on the board or related to a
device category.
start-diag-scan Executes the Diagnostics tests supported
on the Board.
stop-all-monitors Stops all the supported Monitors
available on the board or related to a
device category.
stop-diag-scan stop the diag scan tests.
version Displays versions of BBS,ViewCheck and
BBS installed on the Board.
You can enter into device category mode by giving the command device-category on CLI
and view the list of commands supported only at device category level.
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
BSF(diag-SP_VEE0)# device-category networkinterface
BSF(diag-SP_VEE0-networkinterface)#?
exit Exit from deviceCategory
list-device-instances List all the possible device
instances in present
deviceCategory.
list-tests User can use this command to get
information on the available
Diagnostic tests with details like
tests and sub tests associated,
along with Test
IDs.
set-lower-threshold-info Set the Lower Threshold value for
the Monitor
set-rate set the rate of change value for
network monitors
set-poll-interval-default Set Poll Interval to default value
set-poll-interval Set the Poll Interval
set-threshold-default Set Threshold to default value
set-upper-threshold-info Set the Upper Threshold value for
the Monitor
show-lower-threshold-info Show Lower Threshold info.
show-monitor-id List all monitors for the
deviceCategory.
show-networkcounter-log show network counters log
show-networkerror-log show network errors log
show-poll-interval Show Poll Interval
show-rate show the rate of change value for
network monitors
show-test-help Brief help on the usage of the
Specific Test referred by Test ID.
30
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
Installation of ViewCheck
show-test-result Show test result
show-test-status Show test status
show-upper-threshold-info Show upper threshold info.
start-monitor Start a monitor
start-test Start a test
stop-monitor Stop a monitor
stop-test Stop a test
After logging into the CLI, user can start, stop, and query a test from the CLI.
Below is an example of FloodPingTest in the network interface device category. In network
interface category mode, test ID 1. For more information, refer to NETWORKon page 83.
You can view the details of the test by giving show-test-help command
A list of device Instances supported under a device category can be viewed by giving list-
device-instances. To start the test, user can run start-test command with testId,
deviceInstance and arguments as input to the command. The arguments can be
neglected for tests that does not take any arguments as input.
After test execution, the results can be viewed by show-test-result command, which
displays test result and a raw log generated by that test.
BSF(diag-SP_VEE0-networkinterface)#show-test-result testId 1
deviceInstance 63
Test Result: PASSED
Test Started Invocation Id: 7
Test Start Time: Mon Nov 26 09:31:22 2012
Test Stop Time: Mon Nov 26 09:31:23 2012
Test Log File:
/opt/diagnostics/var/log/diag/testlog/NETWORK_eth1.log
Using CLI, you can list all the Inservice diagnostics monitors in a device category. By default, all
monitors start when ViewCheck application is initialized. User can use start-monitor and stopmonitor commands to start and stop any monitor.
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
31
Installation of ViewCheck
BSF(diag-SP_VEE0-networkinterface)#show-monitor-id
Mon Nov 26 09:36:06 2012
BSF(diag-SP_VEE0-networkinterface)#start-monitor monitorId 1020
deviceInstance 63
MONITOR IS ALREADY STARTED
32
BSF(diag-SP_VEE0-networkinterface)#stop-monitor monitorId 1020
deviceInstance 63
MONITOR IS STOPPED
BSF(diag-SP_VEE0-networkinterface)#start-monitor monitorId 1020
deviceInstance 63
MONITOR IS STARTED
To exit from the ViewCheck CLI:
BSF(diag-SP_VEE0)#exit
BSF(VEE-vee0)#exit
BSF(config)#exit
#exit
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
Installation of ViewCheck
3.6Access and Execution of a Test Using XML
You can access ViewCheck XML interface similar to ViewCheck CLI.
1.Establish the secure shell using SSH or Putty.
2.Start the Telnet connection from an already established secure shell.
telnet localhost 15550
Trying 127.0.0.1...
Connected to localhost.localdomain (127.0.0.1).
Escape character is '^]'.
3.6.1Authenticate
After a connection with the XML Agent is established, the only command which should be
executed is Authenticate. This command is for evaluating user credentials.
The Authentication command contains user name and password for verification.
Successful authentication is indicated by the success response, otherwise an error message is
returned.
You need to send the user credentials to XML Agent using the command Authenticate. The
XML Agent forwards the authentication request to the BSF system, which validates the user
credentials and allows the XML client to access it, if the validation is successful.
Request:
In the below request the user credentials “Admin” and "Admin” are created by default in
the BSF. But, user may supply user credentials by creating them using the "CreateObject"
command as shown in the section GetClassList.
The following response is received if authentication fails.
<?xml
version="1.0"?><Response><Error><ErrorCode>1</ErrorCode><Type>O
peration not allowed</Type><Description>Authentication
error</Description><CustomError/></Error></Response>]]>]]>
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
33
Installation of ViewCheck
3.6.2Configure
This command configures the XML protocol for the indentation and the events to
enable/disable state. There are two configuration options available:
IndentOutput option controls the indentation of the XML response produced by the
MINDAgent. Its default value is ’0’, which means, by default, output indentation is off.
EnableEvents option enables or disables events that reach XML interface from the BSF
framework. Successful execution is indicated by the success response. Otherwise, an error
message is returned.
The values for the command is true/false. True option enables the events and false option
disables the events.
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
3.6.3GetClassList
This command is used to retrieve all BSF classes.
Request:
<Script ><GetClassList /></Script >]]>]]>
Response:
The response message received from the XML Agent is shown below. The response
contains all the BSF classes including the BSF framework classes along with the application
defined classes.
ViewCheck software uses classes, diagnostics and device category to start, stop and query
the status of tests and monitors.
3.6.4DescribeClass
DescribeClass XML command retrieves the description and properties of a BSF class such as
class creatability, class deletability, class writability, attributes, attributes description, attribute
types and so on. It returns class description on success or an error.
Request:
The below XML request gets the description of class 'shelf' in the BSF system.
The below XML response shows the different details of the class 'shelf' in the BSF system.
<Response>
<ClassDesc>
<Class>diagnostic</Class>
36
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
Installation of ViewCheck
<Id>1201</Id>
<Description>In Diagnostic mode, user can configure and perform
Diagnostic related tests, monitoring &
updating.</Description>
<IsSingleton>false</IsSingleton>
<IsCreatable>true</IsCreatable>
<IsDeletable>true</IsDeletable>
<IsWritable>false</IsWritable>
<MOIDDesc>
<Name>diagnosticMoid</Name>
<Id>1201</Id>
<Description/>
<MOIDItemDesc>
<Ref>
<ClassId>1102</ClassId>
<MOIDId>1102</MOIDId>
</Ref>
</MOIDItemDesc>
</MOIDDesc>
<MethodDesc>
<Name>hwInventoryList</Name>
<Id>10</Id>
<Description>Provides the Inventory of Hardware (Type, Vendor
ID, Major Number, Minor Number and any associated Details) as
detected by the Diagnostics Application. </Description>
<IsStatic>false</IsStatic>
<ArgDesc>
<Name>outputResult</Name>
<Id>0</Id>
<Description/>
<TypeDesc>
<Name/>
<Description/>
</TypeDesc>
<IsInput>false</IsInput>
<IsOutput>true</IsOutput>
<IsOptional>false</IsOptional>
</ArgDesc>
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
37
Installation of ViewCheck
</MethodDesc>
<MethodDesc>
<Name>reload</Name>
<Id>20</Id>
<Description>User can issue this command when there are
updates to the User XML .</Description>
<IsStatic>false</IsStatic>
<ArgDesc>
<Name>commandStatus</Name>
<Id>0</Id>
<Description/>
<TypeDesc>
<Name/>
<Description/>
</TypeDesc>
<IsInput>false</IsInput>
<IsOutput>true</IsOutput>
<IsOptional>true</IsOptional>
</ArgDesc>
</MethodDesc>
<MethodDesc>
<Name>setLogLevel</Name>
<Id>30</Id>
<Description>Sets the Log Level of Diagnostic
Application.</Description>
<IsStatic>false</IsStatic>
<ArgDesc>
<Name>logLevelValue</Name>
<Id>0</Id>
<Description>Valid log levels (3-Critical, 2-Normal, 1Info)</Description>
<TypeDesc>
<Name>Integer</Name>
<Description>Integer number in range (-2^32)/2 to (2^32)/2 1</Description>
</TypeDesc>
<IsInput>true</IsInput>
<IsOutput>false</IsOutput>
38
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
InvokeMethod XML command calls the method of an BSF Object. BSF methods are defined
with method parameters such as input, output and input-output.
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
41
Installation of ViewCheck
BSF Object method can be invoked with a list of input or input-output arguments. This
command returns a list of output or input-output arguments. The input arguments means it is
only an input and will not be displayed in the output. But in the case of input-output
arguments, both input and output will be displayed in the output.
Diagnostics and device category classes have different instances: SP_VEE0,
OCTEON1_VEE0, and OCTEON1_VEE1 for service and packet processors respectively. The
examples given below are with respect to service processor. In case, you want to execute
any commands on PP, use either OCTEON1_VEE0 or OCTEON1_VEE1 as instance.
Request:
The below example invokes the method class 'diagnostic' with instance "SP_VEE0". Upon
execution of this method by the class instance, response will be sent in the output/inputoutput arguments.
ViewCheck service logs are generated in EmrDiag_Debug.log file and is located at
/opt/diagnostics/var/log/diag/service/
The Test result logs and raw logs generated by various tests are available at
/opt/diagnostics/var/log/diag/testlog/
3.8ViewCheck TestLog Information
ViewCheck internally retains data related to tests invoked by the user. If the number of tests
invoked by the user exceed 1000, all this information is saved in the
Emr_TestResultsMib.txt file and the internal storage is erased.
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
43
Installation of ViewCheck
44
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
Commands Execution
4.1Overview
CLI and XML are the primary ways to access ViewCheck capabilities on the blade. These
mechanisms allows you to perform activities such as start, stop and query on the ViewCheck
software. Using CLI and XML you can also set the parameters for monitoring.
Commands are classified into:
Generic commands
Commands for test management and control
Commands for monitoring
4.2Generic Commands
Chapter 4
Following are the general functional commands provided by the ViewCheck service.
The command syntaxes for XML interface is given for the diagnostic class with instance as
vee0. This instance varies depending on the blade.
4.2.1configure-error-strings
configure-error-strings command allows to add user-defined kernel error strings to
the diagnostics database.
Syntax for CLI
configure-error-strings errorStrings <string>
The following table provides the configure-error-strings command arguments.
Table 4-1 configure-error-strings
ArgumentData TypeDescription
StringStringKernel error string to be added to the diagnostics
database.
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
configure-log-path command allows to configure the location of diagnostics logs. You
can also specify the maximum size of logs. Once the log size reaches the user specified limit, a
trap is sent to the user. Specifying log size is optional and by default, its value is 1GB.
Syntax for CLI
configure-log-path logpath <PATH> logSize <size>
The following table provides the configure-log-path command arguments.
Table 4-2 configure-log-path
ArgumentData TypeDescription
logpathStringLocation of the log path where diagnostics should place
the log files.
sizeStringOptional parameter, size of the log path. For example,
10M, 2G, 100K, 1048576.
Syntax for XML
<Script>
<InvokeMethod>
<Object>
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
hw-inventory-list command provides the detailed information of hardware
components available on the blade. The command displays the Hardware Type, Vendor ID,
Major Number, Minor Number and any other associated details that are identified by the
ViewCheck.
You can purge only raw log files. The raw log file naming convention is in the form of *.log.
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
51
Commands Execution
4.2.10set-log-level
set-log-level command sets the current log level of ViewCheck to value X. This is an
internal Debug command to be used mainly for generating detailed debug log information.
The valid log level values are listed in the following table:
Table 4-5 set-log-level Values
ValuesDescription
1-InfoAll logs are logged. Even functions like entry and exit are also logged.
2- NormalDetails of function flows are logged.
3- CriticalHigh level errors are logged.
Syntax for CLI
set-log-level logLevelValue <x>
The following table lists the set-log-level command arguments.
Table 4-6 set-log-level Arguments
ArgumentData TypeDescription
XIntegerPossible values are 3, 2, 1 (3-Critical, 2-Normal, 1-Info)
Iterations, haltonError, and timout are optional arguments.
The following table lists the start-test command arguments.
Table 4-12 start-test
ArgumentData TypeDescription
Test IDIntegerType the unique ID of a particular test that you want to
Dev InstanceEnumUse list-device-instances CLI command to get the
start
equivalent Enumerated value of supported Device
Instance
timeout-valIntegerTimeout value for the test
Itr-numIntegerNumber of iterations of the test
halt-stringString"Yes" or "No" value. if "Yes", the test halts on error. if "No",
4.3.2show-test-help
show-test-help command provides the brief information on how to use a particular test.
This command provides information such as how to start, stop, and query the specified test ID.
show-test-status command allows you to view the status of a particular test. The status
of a test can be In Progress, Test Execution Completed, Test Stopped, and Test Timed Out.
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
The following table lists the show-test-status command arguments.
Table 4-14 show-test-status
ArgumentData TypeDescription
Test IDIntegerType the unique ID of a particular test that you want to
Dev InstanceEnumUse list-device-instances CLI command to get the
4.3.5show-test-result
show-test-result command allows you to view the latest result of a particular test. This
command displays the start and end time of the test, the test status such as Passed, Failed,
Aborted, and Timed Out, and additional test arguments.
66
view the status
equivalent enumerated value of supported Device
Instance
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
The following table provides the Stop-test command arguments.
Table 4-16 stop-test
ArgumentData TypeDescription
Test IDIntegerType the unique ID of the Test that you want to stop
Dev InstanceEnumUse list-device-instances CLI command to get the
equivalent enumerated value of supported Device
Instance
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
4.4Monitoring Commands
The following list of commands are used for management of the InService Monitoring
functionality of ViewCheck.
Execute all commands related to monitors only after entering the specific device category
mode.
4.4.1show-monitor-id
show-monitor-id command displays the list of parameters that are monitored using the
InService Diagnostic. This command displays default monitor ID values of the parameters also.
The following table provides the show-rate command arguments.
Table 4-23 show-rate
ArgumentData TypeDescription
Monitor IDIntegerType the unique ID of the Monitor of which rate of
change value is to be shown
Dev InstanceEnumUse list-device-instances CLI command to get the
equivalent enumerated value of supported Device
Instance
4.4.9show-networkcounter-log
show-networkcounter-log command displays the list of network counters on devices
that have crossed the maximum rate value. For more information on command, rate, refer
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
77
Commands Execution
4.4.10show-networkerror-log
show-networkerror-log command displays the list of network counters on devices that
have crossed the maximum rate value. For more information on command, rate, refer show-
exit command allows you to exit from the ViewCheck CLI.
Syntax for CLI
exit
Syntax for XML
<Script>
<Command name="Exit"/>
<Script>]]>]]>
4.5InService Monitoring Specifics
The In Service Monitoring of ViewCheck provides functionality to:
Monitor HW Device Status
Monitor Device Critical Errors
78
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
The functionality and access methods provided are briefly described in this section.
Note: Currently monitors are supported only on Service Processor.
4.5.1Monitoring HW Device Status
In Service Monitoring also periodically polls for various devices status on the blade. They are
Storage Device HDD Health Status
Network Devices Counters Statistics
Network Devices Error Statistics
Each of the above is identified by a unique Monitor ID. For more information about Monitor ID,
refer Monitor IDon page 18.
Commands Execution
The default Poll Interval for monitoring each of the Monitor ID is set to 10 Seconds. Commands
are provided to edit the default settings.
For more information on the commands provided for InService Monitoring, refer Monitoring
Commands on page 69.
The following table provides list of Monitor IDs and Device Instances for each of the Monitors
being monitored on ATCA-9405.
Table 4-24 Monitors
Monitor
Monitor Description
HDD Health Status 1010 sda1 and sda2Monitors the Health Status of the
Network Errors 1020eth0(62),eth1(63),eth2(
ID Valid Device Instances Remarks
sda1 to sda partitions on the
HDD and reports.
Monitors the various Error
64)
counters for each of the Network
Device Instances and provides an
error counter exceeds the rate of
change.
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
79
Commands Execution
Table 4-24 Monitors (continued)
Monitor
Monitor Description
Network Counters 1021eth0(62),eth1(63),eth2(
ID Valid Device Instances Remarks
64)
4.5.2Monitoring Device Critical Errors
Under Linux OS, the Device Drivers LOG abnormal behavior and potential errors occurring in
the Hardware device with KERN_ERR or KERN_CRIT category. These notifications are
considered as potential errors as they could manifest into latent faults in the live system.
As part of monitoring the Device Critical errors, all such Kernel CRITICAL and Kernel ERROR
notifications have been extracted from the PNE Kernel (4.1) driver sources and represented in
the form of a database.
Monitors the various counters for
each of the Network Device
Instances
The In Service Monitoring Module of ViewCheck would watch out for the occurrence of these
notifications and on detection would send a notification to XML.
The Device Errors are captured and are identified uniquely by ERROR ID. For definition of
ERROR ID, refer Error ID on page 19.
4.6OOSD Tests
OOSD Tests are used to monitor and manage the performance of the hardware components of
blades. You can execute these tests only when blades are offline, that is blades are not
providing any service. Details of the test is supported on SP or PP or both is mentioned with the
test name.
Before starting any PP related OOSD diagnostics test, make sure that VLAN interface
(example, eth1.21) reaching octeon is properly configured with an IP.
80
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
OctBootTest (SP): This test boots the PPs into U-Boot. If the correct U-Boot prompt is
OctDDR2MemTest (SP): This test executes the hw-ddr2 memory test on Octeons with
Commands Execution
calculations are constantly checked for data integrity. If the test detects erroneous data,
the test fails.
detected, the test is passed.
ECC check. This includes below set of memory tests:
–Marching Rows
–Random Data Test
–Random XOR Test
–Self Address Test
–March C-Solid Bits Test
–March C-Checkerboard Test
–Walking Ones Left Test
–Walking Ones Right Test
–Walking Zeroes Left Test
–Walking Zeroes Right Test
–Random XOR Test
The OctDDR2Test (SP) tests memory up to 7692 Megabytes.
It does not check the memory range where boot loader and the test program itself resides.
OctRCStressTest (SP): This test executes the hw-rc stress test on Octeon cores for 2
minutes. This test tries to simultaneously run as much of it internal machinery as possible
by performing BIST status check of all cores.
CpuBenchMark: Tests different arithmetic operations and gives the results.
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
81
Commands Execution
4.6.2HDD
DiskBadBlksTest (SP): Searches for bad blocks on a device (usually a disk partition).
DiskCntlrTest (SP & PP): Verifies the random data written to disks remains unchanged. It
verifies only IDE and SCSI controllers that are associated with mounted file systems. Disk
controllers associated with read-only mounted file systems are not verified.
4.6.3Memory
MemCntlrTest (SP & PP): Randomly writes to areas of memory, then reads the memory
back to ensure the written values remain unchanged.
RandomMemoryTest (SP & PP): Performs stress testing on the memory subsystem. This
test is effective in finding intermittent and non-deterministic faults. The problems in other
hardware areas such as overheating CPU, out-of-specification power supply, and so on can
cause memory faults.
MemBandwidth: Measures the ability to copy, read, and writer data over a varying set of
MemLatency: Measures the time taken by the memory to respond with the data for read-
4.6.4OS
MemSepTest (SP & PP): Ensures that user space programs cannot read and write to areas
SupervisorInstrTest (SP): Ensures that the enforcement of the property that privileged
DmesgCheckTest (SP & PP): Checks for user given keywords in the kernel dmesg logs.
sizes.
request.
of memory utilized by items such as Video RAM and kernel code.
instructions should only be in supervisor mode is still in effect. The set of privileged
instructions tested to confirm this is architecture dependent.
82
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
4.6.5PCI
PCIScanTest (SP): Enumerates all active PCI devices in the blade and ensures board default
configuration is active. This test need to be executed under supervisory mode.
Executing this test in user mode may result in failure of test.
4.6.6IPMC
IPMITest (SP): Executes basic IPMI commands and ensures the basic IPMI controller, IPMI
bus functionalities are working properly by reading the response back.
status (active/inactive) and also captures various statistics of Ethernet device.
FloodPingTest (SP & PP): Uses the ICMP protocol’s mandatory ECHO_REQUEST
datagram to elicit an ICMP_ECHO_RESPONSE from a host or gateway.
EthStatsTest (SP): Tests basic network packet consistency that is checks network Rx, Tx
errors, generates a warning if errors are less than or equal to 100 and marks the test as fail
if number of errors are more than 100.
NetworkCntlrTest (SP): Verifies random data transmitted and also the data received for
each configured network device. It verifies only Ethernet and token ring devices that are
configured and active. The asynchronous devices are not verified.
SfpDetectionTest(SP): Enumerates all SFP modules connected to SFP ports of blade and
their operational speeds.
SwitchTempTest (SP): Gets the temperature (in degrees Celsius and can be negative) of
the Ethernet switch. Obtained temperature value will be compared with the minimum and
maximum values of the chipset given in the specification.
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
83
Commands Execution
NwMemAcessTest (SP): Accesses various memory areas (listed below), accessible by the
device and performs Pattern read/write operations (incremental values, random values
and 0xAA, 0x55) on the memory area. This test ensures the device is able to access those
memories for read and write operations. Frequent failures of this test can be treated as
malfunctioning hardware.
Applicable memory types:
–Buffer DRAM
–MAC table memory
–VLAN table memory
NwCntlrRegAcessTest (SP): Tests the ability to read and write into device registers that
are accessible by writing various patterns ( 0xAA_0x55, Random value, Bit Toggle,
incremental) in to them. This test ensures the accessibility of registers by Switch. Frequent
failures of this test can be treated as malfunctioning hardware.
TcamSelfTest (SP): Invokes the built-in self test of the Ternary Content Addressable
Memory (TCAM) on both policy control lists and router sections. This test does not restore
data relevant TCAM area. This test ensures TCAM accessible to the switch. Frequent
failures of this test can be treated malfunctioning hardware.
The TcamSelfTest is destructive test and cannot be run during presence of network traffic.
Board reboot is required after every run of this test.
NetworkThroughputServ: Starts the server for network throughput testing.
NetworkThroughput: Tests the network throughput.
NetworkTxBenchMark (SP): Checks the transmission rate of interface
4.6.8FPGA
CPLDTest (SP): This test checks the accessibility of the CPLD device by performing write
and read operations on scratch registers of CPLD device.
FPGATest (SP): This test checks the accessibility of the FPGA device, by performing write
and read operation on scratch registers of FPGA device.
84
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
4.6.9I2C
I2CProbeTest (SP): Mod-probes an i2c module and checks for default i2c devices on
4.6.10USB
USBTest (SP): Accesses to USB partition repeatedly, reads and verifies the data.
4.6.11RTC
RTCTest (SP): Checks for proper functioning of real time clock.
Commands Execution
board.
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
85
Commands Execution
86
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
Appendix A
ARelated Documentation
A.1Artesyn Embedded Technologies - Embedded
Computing Documentation
The publications listed below are referenced in this manual. You can obtain electronic copies of
Artesyn Embedded Technologies - Embedded Computing publications by contacting your
local Artesyn sales office. For released products, you can also visit our Web site for the latest
copies of our product documentation.
1.Go to www.artesyn.com/computing/support/product/technical-documentation.php.
2.Under FILTER OPTIONS, click the Document types drop-down list box to select the type of
document you are looking for.
3.In the Search text box, type the product name and click GO.
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
87
Related Documentation
88
ViewCheck on ATCA-9405 Installation and Use (6806800S51E)
Artesyn Embedded Technologies, Artesyn and the Artesyn Embedded Technologies logo are trademarks and service marks of Artesyn Embedded Technologies, Inc.
All other product or service names are the property of their respective owners.