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-7470/7475 Installation and Use (6806800S49C)
7
Page 8
List of Tables
8
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
Page 9
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.
License ManagementProvides information about ViewCheck license management.
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
Lists the relevant manuals and provides additional information.
Framework.
Interfaces (CLI and XML)
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
9
Page 10
AbbreviationDefinition
HWHardware
INSMIn Service Monitoring. Functional module in ViewCheck
OOSDOnline Out of service Diagnostics. Functional module in
XMLExtensible Markup Language
Conventions
The following table describes the conventions used throughout this manual.
NotationDescription
About this Manual
About this Manual
framework handling the monitoring functionality of
various critical parameters in the blade.
ViewCheck framework that manages Test Management
requests related to Out of Service Diagnostics.
10
0x00000000Typical notation for hexadecimal numbers (digits are
0 through F), for example used for addresses and
offsets
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-7470/7475 Installation and Use (6806800S49C)
Page 11
NotationDescription
About this Manual
.
.
.
..Ranges, for example: 0..4 means one of the integers
|Logical OR
Omission of information from example/command
that is not necessary at the time being
0,1,2,3, and 4 (used in registers)
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
No danger encountered. Pay attention to important
information
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
11
Page 12
Summary of Changes
Part NumberDateDescription
About this Manual
About this Manual
6806800S49A
6806800S49BDecember, 2013Changed the title of the manual.
6806800S49CMay 2014R2.6 Release.
October, 2013Initial version
Added new commands in Generic
Commands on page 49. Added new tests in
CPU on page 87, Memory on page 88, and
NETWORK on page 89.
Updated ViewCheck Service OS Image on
page 31.
Re-branded to Artesyn template.
12
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
Page 13
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 CPU temperature, Storage devices, Ethernet counters and errors.
ViewCheck can be accessed locally using CLI and XML interfaces provided via Blade Services
Framework (BSF) service.
ViewCheck can provide both:
InService diagnostics
Out of Service diagnostics
InService Diagnostics
In this mode, the diagnostics service can run while the blades are instantiated with customer
applications and providing service.
Chapter 1
ViewCheck can monitor key hardware parameters like CPU temperature, Network Counters,
Network errors, and in addition to watching out for kernel critical errors logged by various
hardware devices and device drivers.
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 29.
For more information on commands supported for InService and OOS, refer Commands
Execution on page 49.
In case blades are upgraded from ATCA-7470 to ATCA-7475, FRU info needs to be updated.
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
13
Page 14
1.2ViewCheck Access Methods
This section explains the different methods to access ViewCheck services on the Artesyn ATCA
blades.
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
Introduction
Stop a diagnostic test
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.
Blade Services Framework, 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 29.
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-7470/7475 Installation and Use (6806800S49C)
Page 15
Introduction
In addition, XML notifications are generated with details:
State changes about the diagnostic test under execution
Pre-determined monitor crossing 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-7470/7475 Installation and Use (6806800S49C)
15
Page 16
Introduction
16
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
Page 17
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 already
defined above and available on the blade.
Following are the example of tests that can be executed on the devices:
Ping Flood test
Network connectivity test in case of Network Device Category
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
17
Page 18
Bad Blocks test in case of Storage Device category
Temperature tests in case of CPU categories
Each of these tests would be associated with a unique Test Identifier (Test ID).
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
Concepts of ViewCheck
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
described above. 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, eth2 or Base 0, Base 1, Base 2 are used to identify
unique devices in networking devices category. Similarly, hda1, hda2, and so on can identify
unique instances of devices in the storage 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.
18
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
Page 19
2.6Monitor ID
ViewCheck Service monitors pre-identified parameters for hardware devices. These
parameters are CPU Core temperature, Network Device counters, Network Device errors etc.
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.
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.
Concepts of ViewCheck
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 49.
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
19
Page 20
Concepts of ViewCheck
20
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
Page 21
License Management
3.1Overview
The permissions to use any Artesyn value-added software module is granted based on the
licenses installed on ATCA-7470/7475. To purchase license for a particular software module
and to get required instructions to use that module, contact Artesyn Sales team.
A license is node or blade locked, that is, it cannot be copied and used on another blade to
enable the value-added software module. You can obtain license for a module on a specific
blade and place the license on that blade. On reboot, the license is authorized and the module
is functionally enabled.
ViewCheck is available with two licenses:
1.Standard License: This is valid for 33 years.
2.Evaluation License: This is valid for 30 days.
Chapter 3
Figure 3-1Product Activation Work Flow
1.Sales enters the order to buy "N" number of licenses.
2.This triggers configuration of licenses in License Server and generates the product key. You
will receive a product key via E-mail.
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
21
Page 22
3.Use the product key to create finger-print.
4.Upload the finger-print information to the server to get the activation record (license key).
5.Place the activation record at a predefined persistent location on the board.
6.Application checks the local activation record every time it runs to obtain the license limits
and the locking parameters.
3.2Orion License RPM Installation
Using the following command, you can install the Orion License RPM on Board or Redhat x86
machine.
After you purchase the licenses for a value-added software module, follow the steps
mentioned in this section to obtain the activation record.
Figure 3-2Obtaining Activation Record
22
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
Page 23
License Management
1.On purchasing a license, you will be sent an e-mail with the product key.
2.Using the product key, create a finger-print of the blade. Execute the platform specific
makeSystemPrint binary placed at /opt/bladeservices/bin/license/ with
the following commands.
If you are generating the finger-print on a blade, then pick up the makeSystemPrint
binary from /opt/bladeservices/bin/license/.
If you are generating the finger-print on Redhat x86 machine, then pick up the
makeSystemPrint binary from /opt/bladeservices/bin/license/redhatx86/ to the Redhat x86 machine.
Run the following command before generating the finger-print on the blade using
-pProductName Name of the product for which you want to obtain the license. For
ViewCheck on ATCA-7470/7475, the product name is SL-DG7470-
01-001-STD. This is a mandatory parameter.
-uUsername *Username. Optional, if default user is chosen.
-aPassword *Password. Optional, if default user is chosen.
-kpubkey Public Key. The public key for ViewCheck is acpjEMw6Q6lDWL81.
This is a mandatory parameter.
-ddomkey *Domain key. This is a mandatory parameter.
-bSerialNumberBoard SerialNumber. Optional, if on-blade finger-print is being
generated.
-mMACAddressBase MAC Address. Optional, if on-blade finger-print is being
generated.
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
23
Page 24
License Management
The information about parameters marked with ’*’ is provided to you upon placing the
order for ViewCheck software. For more information, please contact Artesyn’s sales
representative.
As license manager keeps track of the system time, tampering with the system date and time
hampers the functionality of the licensed software module.
Redirect the output of these commands to fp.key file as shown above. This is the fingerprint of the blade software module for which license should be granted.
3.Upload the finger-print to the license server to obtain the activation record. The web link
of the server to obtain license key is given below:
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
Page 25
When you access this link, the following screen is displayed:
License Management
4.In the Product Name box, type name of the product. For example, SL-DG7470-01-001STD.
5.Select the Finger-print file using the Browse button.
6.In the Image Text box, type the text that is displayed in the box.
7.Click Generate Activation Record to obtain the activation record.
8.Copy the activation record on to the blade at /opt/bladeservices/etc/license/
in the following format actrec_<PRODUCT IN CAPS>.key
For example, if the product is SL-DG7470-01-001-STD, then rename the file as
actrec_SL-DG7470-01-001-STD.key and copy it to the above location.
Take a backup of the activation record.
3.4Verifying the Installation of a Value-added
Software Module
To confirm that the activation record is accepted and the functionality is enabled, check the log
file at /var/log/emerson_license.log.
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
25
Page 26
When the license is granted for a module, the log message is as follows:
<Date and time> <Log priority>: <PRODUCT> : <PID>: License is valid
There are sufficient logs in the log file to know the status of the licensed software module. If the
functionality of a software module is not enabled, then the log file is updated with the reason
for rejecting the license.
3.5Returning the License
You can return the license when:
A value-added software module is not required on a blade any longer.
The blade is not usable and the license need to be migrated to newer blade.
The following procedure describes how to return license of a software module on a blade:
License Management
Figure 3-3Returning the License
1.To generate the receipt, execute the platform specific makereceipt binary placed in
/opt/bladeservices/bin/license/.
If you are generating receipt on blade, then pick up the makereceipt binary from
/opt/bladeservices/bin/license/.
If you are generating a receipt from Redhat x86 machine, then pick up the
makereceipt binary from /opt/bladeservices/bin/license/redhatx86/.
Command Syntax
26
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
27
Page 28
When you access this link, the following screen is displayed:
License Management
28
4.In the Product Name box, type name of the product. For example, SL-DG7470-01-001-
STD.
5.Select the return receipt file using the Browse button.
6.In the Image Text box, type the text that is displayed in the box.
7.Click Return License. If successful, a message "License Returned Successfully" is displayed.
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
Page 29
Installation of ViewCheck
4.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 is packaged as part of BBS release. The License Manager and BSF service RPMs are also
distributed along with the ViewCheck RPMs. BSF service RPMs provide access to CLI and
XML.
ViewCheck Service OS image
You can download this image from SWORDS.
Chapter 4
4.2ViewCheck RPM Image
The ViewCheck RPM Image functionally comprises Diagnostics Framework, specific test cases,
and test suites. The ViewCheck RPM always use same OS variant and compile time
environment based on the BBS release of the target blade. For ATCA-7470/7475 blades, the
ViewCheck RPM is created for PNE 4.x environment. The ViewCheck RPM comes along with
latest BBS release of the blade.
This ViewCheck Service RPM contains:
Diagnostics Core - Daemon
Static Test Suite Configuration files for the Specific Blade
Start/Stop Scripts for Diagnostics Core
Using the following command, you can install the ViewCheck RPM Image:
/opt/diagnostics/etc/diag/ViewCheck configuration file and user
configuration file.
core daemon and BSF application.
Tes t scripts
estscripts/
ViewCheck daemon service log
g/service/
/etc/logrotate.dConfiguration files required for log
rotation of service logs
Utilities and Tools used by ViewCheck
estutils/
application
4.3BSF Service RPM
BSF service is distributed as part of BBS release as 3 RPM packages namely eMIND, BSFCore and
Diagnostics Transport layer service. Following are the list of RPM:
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
4.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-7470/7475, the ViewCheck service OS is created with PNE
4.x as the OS.
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
31
Page 32
Installation of ViewCheck
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
In ATCA-7470/7475, there is no provision for User Flash. Hence ViewCheck service OS is
created as Net bootable Ram Disk Image.
The following table provides details of the files that are distributed as part of this image once
the ViewCheck service OS is installed.
Table 4-2 ViewCheck Service OS Image Files
File NameRemarks
diagnostics-RELEASEBUILD.windriver.linux.7470.gz
Net bootable Ram Disk image with
ViewCheck RPM, Orion License RPM, and BSF
services package.
Installing the ViewCheck Service OS image
Before installing the ViewCheck service OS Image, you should have the knowledge of
configuring TFTP, DHCP, and PXE to perform a diskless booting on ATCA-7470/7475. For more
information, refer to the sections 2.2 and 2.3.1 in Basic Blade Services Software on ATCA-7470 Programmer's Reference.
1. Copy the diagnostics-RELEASE-
BUILD.windriver.linux.atca7470.gz image to the /tftpboot/
directory.
2. Change the PXE default configuration file ramdisk_size=819200, and reboot
the blade.
Once the blade is configured with the new ramdisk image, it will have ViewCheck,
Orion License utils, and Blade Services Framework installed.
32
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
Page 33
Installation of ViewCheck
3. Generate the Activation record to start using the ViewCheck application. For more
information, see Obtaining the Activation Record on page 22.
4. After the activation record is placed, restart the ViewCheck application using the
following script:
/opt/diagnostics/etc/init.d/diagcore restart
5. The license generated can be exported to TFTP server to avoid copying of activation
records into the blade for every reboot of OOSD image. To export license, run
/etc/rc.d/init.d/exportLicense.sh
/etc/rc.d/init.d/exportLicense.sh
Please enter the TFTP server to store the license
files[xxx.xxx.xxx.xxx]: 192.168.21.1
Please enter username: root
Please enter password:
Exporting licenses.....
License files transfer completed. For details check
/var/log/exportLicense.log log file.
The TFTP server IP mentioned while exporting the license should be same from where
OOSD image will be loaded.
4.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 Telnet connection from an already established secure shell.
telnet localhost 11001
Trying ::1...
telnet: connect to address ::1: Connection refused
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
33
Page 34
Trying 127.0.0.1...
Connected to localhost.localdomain (127.0.0.1).
Escape character is '^]'.
Welcome to Emerson's SSF CLI
By default, the administrator user name and password are "Admin".
After logging into the ViewCheck CLI, you can list all the commands supported by typing '?'
on the CLI console. For information on commands to be used to install and LOG to ViewCheck,
refer Commands Execution on page 49.
BSF(diag-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.
list-all-tests Displays all the supported tests on the
Board.
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
Page 35
Installation of ViewCheck
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 only supported at device category level.
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
35
Page 36
Installation of ViewCheck
BSF(diag-vee0)# device-category networkinterface
BSF(diag-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.
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
36
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
Page 37
Installation of ViewCheck
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 89.
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 the test is executed, the results can be viewed by show-test-result command,
which outputs the test result and the raw log generated by that test.
Using CLI, you can list all the Inservice diagnostics monitors in a device category. By default, all
the monitors are started when ViewCheck application is initialized. User can use start-monitor
and stop-monitor commands to start and stop any monitor.
To exit from the ViewCheck CLI:
BSF(diag-vee0)#exit
BSF(VEE-vee0)#exit
BSF(config)#exit
#exit
4.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.
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
37
Page 38
telnet localhost 15550
Trying 127.0.0.1...
Connected to localhost.localdomain (127.0.0.1).
Escape character is '^]'.
4.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.
Installation of ViewCheck
Request:
In the below request the user credentials “Admin”/"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>]]>]]>
4.6.2Configure
Configure command configures the XML protocol for the indentation and the events
enable/disable state. There are two configuration options are available:
38
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
Page 39
Installation of ViewCheck
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 which comes to the 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-7470/7475 Installation and Use (6806800S49C)
39
Page 40
4.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.
4.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 etc. It returns ClassDescription 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>
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
41
Page 42
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>
</MethodDesc>
42
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
Page 43
Installation of ViewCheck
<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>
<IsOptional>false</IsOptional>
</ArgDesc>
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
InvokeMethod XML command calls the method of an BSF Object. BSF methods are defined
with method parameters such as input, output and input-output.
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.
Request:
The below example invokes the method class 'diagnostics' with instance "vee0". Upon
execution of this method by the class instance, response will be sent in the output/inputoutput arguments.
Request
46
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
47
Page 48
Installation of ViewCheck
The Test result LOGS (EMR_Results.txt) and the Raw logs (Ex:-CPU_cpu0.log)
Generated by the various utilities are available at
/opt/diagnostics/var/log/diag/testlog/
48
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
Page 49
Commands Execution
5.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
5.2Generic Commands
Chapter 5
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.
5.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 5-1 configure-error-strings
ArgumentData TypeDescription
stringStringKernel error string to be added to the diagnostics
database.
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
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 5-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-7470/7475 Installation and Use (6806800S49C)
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 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-7470/7475 Installation and Use (6806800S49C)
55
Page 56
5.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 5-5 set-log-level
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>
Commands Execution
The following table lists the set-log-level command arguments.
Table 5-6 set-log-level
ArgumentData TypeDescription
XIntegerPossible values are 3, 2, 1 (3-Critical, 2-Normal, 1-Info)
The following table provides the start-diag-scan command arguments.
Table 5-9 start-diag-scan
ArgumentData TypeDescription
Dev category1-NStringSeparate device categories using comma ’,’.
Itr-numStringIterations specifies the number of times a test case can
be executed. haltOnError specifies whether to
continue or stop with test case execution on the
occurrence of any error. Both options are optional and
their default values are "1" and "YES" respectively.
Maximum number of iterations that user can specify is
The following table lists the start-test command arguments.
Table 5-11 start-test
ArgumentData TypeDescription
Test IDIntegerType the unique ID of a particular test that you want to
start
Dev InstanceEnumUse list-device-instances CLI command to get the
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",
5.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.
The following table lists the show-test-status command arguments.
Table 5-13 show-test-status
ArgumentData TypeDescription
Test IDIntegerType the unique ID of a particular test that you want to
view the status
Dev InstanceEnumUse list-device-instances CLI command to get the
equivalent enumerated value of supported Device
Instance
5.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.
The following table provides the Stop-test command arguments.
Table 5-15 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-7470/7475 Installation and Use (6806800S49C)
69
Page 70
5.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.
5.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 5-27 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
5.4.14show-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
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>]]>]]>
84
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
Page 85
5.5InService Monitoring Specifics
The In Service Monitoring of ViewCheck provides functionality to:
Monitor HW Device Status
Monitor Device Critical Errors
The functionality and access methods provided are briefly described in this section.
5.5.1Monitoring HW Device Status
In Service Monitoring also periodically polls for various devices status on the blade. These are
Storage Device HDD Health Status
Network Devices Counters Statistics
Network Devices Error Statistics
Commands Execution
Each of the above is identified by a unique Monitor ID. For more information on Monitor ID,
refer Monitor IDon page 19.
The Default Poll Interval for monitoring each of the Monitor ID is set to 10 Seconds.
Commands are provided to alter the default settings.
For more information on the commands provided for InService Monitoring, refer Monitoring
Commands on page 70.
The following table provides list of Monitor IDs and Device Instances for each of the Monitors
being monitored on ATCA-7470/7475.
Table 5-28 Monitors
Monitor
Monitor Description
CPU Core
Temperatures
ID Valid Device Instances Remarks
1000Core 0 to Core 19 (0 to
15)
Temperature of the 16 cores
available on ATCA- 7470 CPU and
20 cores available on ATCA-7475
CPU are monitored individually
and reported if crosses a Set
Threshold.
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
85
Page 86
Table 5-28 Monitors (continued)
Monitor
Monitor Description
HDD Health Status 1010sda1 to sda8
ID Valid Device Instances Remarks
sdb1 to sdb8
Commands Execution
Monitors the Health Status of the
sda1 to sda8 partitions on the
HDD and reports.
Network Errors 1020base1(70), base2(71),
fabric 1(73), fabric 2(74),
rtm1(147),
Network Counters 1021base1(70), base2(71),
fabric 1(73), fabric 2(74),
rtm1(147),
5.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 () driver sources and represented in the
form of a database.
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.
Monitors the various Error
counters for each of the Network
Device Instances and provides an
error counter exceeds the rate of
change.
Monitors the various counters for
each of the Network Device
Instances
5.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.
86
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
Page 87
5.6.1CPU
CpuSpeedTest: Checks whether the Processor(s) frequency is in between operating limits
User needs to enable CPU FREQUENCY related settings in BIOS.
CpuTempTest: Reads the Processor core(s) temperature levels and ensures that all cores
CacheSizeTest: Verifies L1, L2, and L3 Cache sizes of CPU(s) on the board.
Commands Execution
(upper and lower limits).
are operating in normal levels.
calculations are constantly checked for data integrity. If the test detects erroneous data,
the test fails.
CpuBenchMark: Test different arithmetic operations and gives the results.
5.6.2HDD
DiskBadBlksTest: Searches for bad blocks on a device (usually a disk partition). Device is the
special file corresponding to the device (e.g /dev/hsda1). The starting, ending block
numbers are selected in default.
DiskCntlrTest: 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.
DiskSelfTest: DiskSelfTest checks the electrical and mechanical performance as well as
read performance of the disk.
This test can be used to initiate short and long tests for the disk by using test arguments as
“short” and “long” respectively. The duration of the tests depends upon the size of the
hard disk being tested. For example, for a 500 GB disk, short test takes about 2 minutes and
long test may take about 2 hours and 30 minutes to complete.
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
87
Page 88
5.6.3Memory
MemCntlrTest: Randomly writes to areas of memory, then reads the memory back to
ensure the values written remain unchanged.
RandomMemoryTest: 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.
EdacErrorStatsTest: Checks for the occurrence of one bit and two bit errors in the RAM.
MemBandwidth: Test Memory Bandwidth BenchMarking.
MemLatency: Test Memory Latency BenchMarking.
5.6.4OS
MemSepTest: Ensures that user space programs cannot read and write to areas of memory
utilized by items such as Video RAM and kernel code.
Commands Execution
SupervisorInstrTest: Ensures that the enforcement of the property that privileged
instructions should only be in supervisor mode is still in effect. The set of privileged
instructions tested to confirm this is architecture dependent.
5.6.5PCI
PCIScanTest: 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.
5.6.6IPMC
IPMITest: Executes basic IPMI commands and ensures the basic IPMI controller, IPMI bus
functionalities are working properly by reading the response back.
88
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
Page 89
5.6.7NETWORK
EthLinkTest: Verifies Ethernet device (ex: eth0, eth1, eth2, etc...) link status
(active/inactive) and also captures various statistics of Ethernet device.
FloodPingTest: FloodPingTest uses the ICMP protocol’s mandatory ECHO_REQUEST
datagram to elicit an ICMP_ECHO_RESPONSE from a host or gateway. ECHO_REQUEST
datagram’s have an IP and ICMP header, followed by a structure timeval and then an
arbitrary number of ’Pad’ bytes used to fill out the packet.
EthStatsTest: 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: 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.
NetworkAdapterTest: Test executes adapter selftest (BIST) on the specified ethernet
device.
Commands Execution
SfpDetectionTest:This test will enumerate all sfpmodules connected to sfp ports of blade
and their operational speeds.
NetworkThroughputServ: This test starts the server for network throughput testing.
NetworkThroughput: Tests the network throughput.
NetworkTxBenchMark: This test checks the transmission rate of interface
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
89
Page 90
5.6.8FPGA
FpgaRegRdTest: This test Read/write FPGA resisters and also checks for the default register
values.
5.6.9I2C
I2cDetectionTest (SP): This test modprobes an i2c module and checks for default i2c
devices on board.
5.6.10USB
UsbReadTest: This test does repeated accesses to USB partition, reads and verifies the
data.
Commands Execution
90
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
Page 91
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.
2.Under SUPPORT, click TECHNICAL DOCUMENTATION.
3.Under FILTER OPTIONS, click the Document types drop-down list box to select the type of
document you are looking for.
4.In the Search text box, type the product name and click GO.
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
91
Page 92
Related Documentation
92
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49C)
Page 93
Page 94
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.