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 (6806800S49E)
7
List of Tables
8
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49E)
About this Manual
Overview of Contents
This guide provides detailed information about installation, configuration, and how to work
with ViewCheck. This manual is divided into following chapters and appendix.
About this Manuallists all conventions and abbreviations used in this manual and outlines the
revision history.
Introduction provides detailed overview and features of ViewCheck.
Concepts of ViewCheck describes the concepts of ViewCheck.
Installation of ViewCheck provides instructions to install ViewCheck.
Commands Execution describes the various tests that can be executed in ViewCheck.
Related Documentation lists the relevant manuals and provides additional information.
Abbreviations
The following table lists the abbreviations used throughout the document.
AbbreviationDefinition
ATC AAdvanced Telecom Computing Architecture
BSFBlade Services Framework. A derivative of System Services Framework.
ClientThe applications used to Access ViewCheck via various Interfaces (CLI
and XML)
INSMIn Service Monitoring. Functional module in ViewCheck framework
andling the monitoring functionality of various critical parameters in
h
the blade.
OOSDOnline Out of service Diagnostics. Functional module in ViewCheck
frame
work that manages Test Management requests related to Out of
Service Diagnostics.
XMLExtensible Markup Language
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49E)
9
About this Manual
Conventions
The following table describes the conventions used throughout this manual.
NotationDescription
0x00000000Typical notation for hexadecimal numbers (digits are
0b0000Same for binary numbers (digits are 0 and 1)
boldUsed to emphasize a word
ScreenUsed for on-screen output and code related elements
Courier + BoldUsed to characterize user input and to separate it
ReferenceUsed for references and for table and figure
About this Manual
0 through F), for example used for addresses and
offsets
or commands in body text
from system output
descriptions
10
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
.
.
.
..Ranges, for example: 0..4 means one of the integers
|Logical OR
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49E)
Omission of information from example/command
that is not necessary at the time being
0,1,2,3, and 4 (used in registers)
NotationDescription
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
About this Manual
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49E)
11
About this Manual
Summary of Changes
Part NumberDateDescription
About this Manual
6806800S49A
6806800S49BDecember, 2013Changed the title of the manual.
6806800S49CMay 2014R2.6 Release.
6806800S49DSeptember 2014Added show-all-test-status on p
6806800S49ENovember 2014Updated InService Monitoring Specifics on
October, 2013Initial version
Added new commands in Generic
Commands on page 39. Added new tests in
CPU on p
NETWORK on p
Updated ViewCheck Service OS Image on
page HIDDEN.
Re-branded to Artesyn template.
show-log-level on p
page 55, RTCon p
Information on p
DmesgCheckTest in OSon p
page 77.
age 80, Memoryon page 81, and
age 82.
age 48,
age 50, switch-modeon
age 83, ViewCheck TestLog
age 37, and
age 81.
12
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49E)
Introduction
1.1Overview
ViewCheck™ is a comprehensive software service used to diagnose, manage, and monitor
Artesyn 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 Command Line Interface (CLI) and Extensible Markup
Language (XML) interfaces provided via Blade Services Framework (BSF) service.
ViewCheck provides:
InService Diagnostics
In this mode, the diagnostics service can run even while the blades are instantiated with
customer applications and are providing service.
ViewCheck can monitor key hardware parameters like CPU temperature, network
counters, and network errors. It can also be used for watching kernel critical errors logged
by various hardware devices and device drivers.
Chapter 1
Out of Service Diagnostics
In this mode, ViewCheck can execute all Out of Service Diagnostics (OOSD) tests along
with InService Diagnostics activities.
ViewCheck provides a command called switch-mode, using which you can switch from
InService to Out of Service and vice versa.
For more information on commands supported for InService and OOSD, refer Commands
Execution on page 39.
In case the blades are upgraded from ATCA-7470 to ATCA-7475, FRU info needs to be
updated.
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49E)
13
Introduction
1.2ViewCheck Access Methods
This section explains various methods for accessing ViewCheck services on Artesyn 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
Stop a diagnostic test
1.2.1CLI
Using CLI, you can start, stop, and query kind of primitives at this prompt. The ViewCheck CLI
can be accessed via a console using Secure Shell (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 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 (6806800S49E)
Introduction
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-7470/7475 Installation and Use (6806800S49E)
15
Introduction
16
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49E)
Concepts of ViewCheck
This section explains terminology and keywords used extensively in ViewCheck services.
2.1Test Identification
Unique Test identification is based on following triple key:
< Device Category, Test ID, Device Instance >
2.2Device Category
The Device Category is an enumerated value, reused from similar enumeration already defined
in the HPI-B Standard specification.
It is used to express commonly used devices, such as Storage, Network, Serial, CPU, and
Memory, available on all the blades, irrespective of function and architecture. This category is
used in commands as one of the key fields to identify uniquely a particular test.
Chapter 2
Device Category allows for:
Grouping of test cases per category for display and statistical purposes
Reuse of Test IDs across the device categories
2.3Test ID
Test ID is an integer value that uniquely identifies the actual test that can 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
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 ’0’ and increases linearly for various sub-tests in a device
category.
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49E)
17
Concepts of ViewCheck
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 provides capability to control, execute, and manage the test on a device instance in a
device category. With this mechanism, same test can be simultaneously initiated or triggered
on multiple device instances under that device category, thus providing parallel execution of
tests.
2.4Device 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, eth2 or Base 0, Base 1, Base 2 are used to identify
unique devices in networking device 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 diagnostics test identified with "< Device Category, Test ID, device Instance>" is executed on the specified device instance.
2.5Monitor ID
ViewCheck service monitors pre-identified parameters for hardware devices. These
parameters are CPU core temperature, network device counters, and errors. 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. ViewCheck uses this value to control monitoring and while reporting
events via XML on these monitors.
18
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49E)
2.6Error ID
Error ID is to provide identification for pre-determined errors/warnings of hardware devices
generated by the device driver or the kernel on the blade. These critical and error messages are
indications of abnormal behavior on part of the kernel or the hardware device on the blade.
ViewCheck functionality attempts to detect all such errors and provides 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 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 OS. For more
information on commands, refer to Commands Execution on page 39.
Note: Monitor ID and Error ID are used in InService Monitoring.
Concepts of ViewCheck
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49E)
19
Concepts of ViewCheck
20
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49E)
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-7470/7475 blade.
ViewCheck service is released as an RPM image. BSF RPMs are also distributed along with
ViewCheck RPMs.
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-7470/7475 blades, the
ViewCheck RPM is created for PNE 4.x environment.
Chapter 3
ViewCheck service RPM consists of:
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:
/etc/logrotate.dConfiguration files required for log
estutils/
3.3BSF Service RPM
BSF service is distributed as a package contains 3 RPMs, namely eMIND, BSFCore, and
Diagnostics Transport Layer Service. Following are the list of RPM:
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-7470/7475 Installation and Use (6806800S49E)
By default, the administrator user name and password are "Admin".
After logging into the ViewCheck CLI, you can list all supported commands by typing '?' on
the CLI console. Following is an example.
24
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.
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.
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49E)
Installation of ViewCheck
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.
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.
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49E)
25
Installation of ViewCheck
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
26
After logging into the CLI, you can start, stop, and query a test from the CLI. You can view the
details of the test by executing show-test-help command.
To start a test, you 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 argument as input.
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49E)
Installation of ViewCheck
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.
Using CLI, you can list all the InService diagnostics monitors in a device category. By default, all
monitors start when ViewCheck application is initialized. You can start and stop any monitor
using start-monitor and stop-monitor commands.
To exit from the ViewCheck CLI:
BSF(diag-vee0)#exit
BSF(VEE-vee0)#exit
BSF(config)#exit
#exit
3.5Access 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.5.1Authenticate
After a connection with XML Agent is established, the only command should be executed is
Authenticate. This command is for evaluating user credentials.
The Authenticate command contains user name and password for verification. Successful
authentication is signified by the success response, otherwise an error message is returned.
ViewCheck on ATCA-7470/7475 Installation and Use (6806800S49E)
27
Loading...
+ 61 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.