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)
27
Loading...
+ 63 hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.