Copyright (c) 2008, 2012, Oracle and/or its affiliates. All rights reserved. 

This software and related documentation are provided under a license agreement containing 
restrictions on use and disclosure and are protected by intellectual property laws. Except 
as expressly permitted in your license agreement or allowed by law, you may not use, copy, 
reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, 
publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, 
or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted 
to be error-free. If you find any errors, please report them to us in writing.

If this is software or related software documentation that is delivered to the U.S. Government 
or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical 
data delivered to U.S. Government customers are "commercial computer software" or "commercial 
technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific 
supplemental regulations. As such, the use, duplication, disclosure, modification, and 
adaptation shall be subject to the restrictions and license terms set forth in the applicable 
Government contract, and, to the extent applicable by the terms of the Government contract, 
the additional rights set forth in FAR 52.227-19, Commercial Computer Software License 
(December 2007). Oracle America, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

This software or hardware is developed for general use in a variety of information management 
applications. It is not developed or intended for use in any inherently dangerous applications, 
including applications which may create a risk of personal injury. If you use this software or 
hardware in dangerous applications, then you shall be responsible to take all appropriate 
fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation 
and its affiliates disclaim any liability for any damages caused by use of this software or 
hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be 
trademarks of their respective owners.

AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of 
Advanced Micro Devices. Intel and Intel Xeon are trademarks or registered trademarks of Intel 
Corporation. All SPARC trademarks are used under license and are trademarks or registered 
trademarks of SPARC International, Inc. UNIX is a registered trademark licensed through X/Open 
Company, Ltd.

This software or hardware and documentation may provide access to or information on content, 
products, and services from third parties. Oracle Corporation and its affiliates are not 
responsible for and expressly disclaim all warranties of any kind with respect to third-party 
content, products, and services. Oracle Corporation and its affiliates will not be responsible 
for any loss, costs, or damages incurred due to your access to or use of third-party content, 
products, or services.


VTS 7.0ps14 README File
-------------------------

Introduction
============

VTS is a comprehensive hardware diagnostics tool that tests and validates
the connectivity and functionality of most controllers and devices on Sun 
platforms. It consists of a multiple tests which are targeted for the different
hardware components / functionalities of the system. The tool supports three
kinds of user interfaces (UI), a Graphical UI, a terminal based UI and 
command line interface (CLI).  

VTS is supported on Solaris Operating System and on Oracle Enterprise Linux (OEL) from VTS7.0ps8. 

VTS 7.0ps14 is the next version after VTS 7.0ps13. 

The VTS Solaris support matrix at the time of the initial release of 
this version is given below. Note that this version of VTS may possibly be 
qualified on later releases of Solaris in future.

Solaris            VTS
===================================
S11		   7.0ps12, 7.0ps13, 7.0ps14
S10 8/11	   7.0ps13, 7.0ps14
S10 8/10           7.0ps11, 7.0ps12
S10 10/09          7.0ps8, 7.0ps9, 7.0ps10
S10 5/09           7.0ps7, 7.0ps6
S10 10/08          7.0ps5, 7.0ps4, 7.0ps3
S10 5/08           7.0ps2, 7.0ps1, 7.0,

VTS is only supported on Sun developed SPARC and x86 (Intel and AMD)
based systems.  

VTS 7.0 Package Information
==============================

VTS 7.0 contains 4 packages:
    
  SUNWvts - Contains test development library API(s) and VTS kernel.
  SUNWvtsts  - Contains VTS test binaries. 
  SUNWvtsmn - Contains VTS man pages.
  SUNWvtsr  - Contains Framework Configuration Files in root partition

VTS 7.0 Installation
=======================
    VTS 7.0 packages gets installed along with Solaris OS by default under 
the directory /usr/sunvts. VTS gets installed if you select either SUNWCXall 
(Entire distribution plus OEM support) or SUNWCall (Entire distribution).
They can also be installed separately.
   
How to start VTS 7.0
========================

Start VTS using User Interface (UI) of your choice:
#cd /usr/sunvts/bin
./startsunvts [options]

where [options] can be any of the following

      -t, --tty                 Start kernel & TTY UI
      -c, --commandline         Use Command Line
      -g, --gui                 Start kernel & VTS GUI
      -a, --agent               Start VTS kernel
      -d, --default testing     Start VTS default testing
      -l, --long                Start VTS Comprehensive testing
      -s, --short               Start VTS Short Testing
      -m, --memory              Start VTS Memory Testing
      -h, --help                Display help list

If you do not use any options after "startsunvts", then the
tool will prompt you with a list of options available.

VTS Overview & Usage 
=======================

Documents Available
-------------------
- VTS 7.0 User's Guide: The User's Guide is available at 
  "http://download.oracle.com/docs/cd/E19719-01/index.html"

  This document has comprehensive description of the tool and its
  capabilities.  

- Man pages: This is included in the SUNWvtsmn package and contains information
  on the various utilities that are part of the tool.  

User Interfaces Supported
-------------------------
The tool provides three different user interfaces (UI). 
- GUI: A Java based graphical UI. 
	The system needs to have minimum Java, Standard Edition Version 1.5 
	or later. 
- TTY: A terminal based UI. 
	This is a ASCII-based, screen oriented interface that does not need a 
	graphical window environment. You can use this interface from a serial 
	terminal.
- CLI: A command line interface. 
	A UNIX shell application called "vts_cmd" is provided which enables the
	user to send single commands to the VTS agent (vtsk). The harness
	processes each command and sends back the response. For using the 
	command line, it is required that the user start the VTS agent 
	(vtsk) first.  

Please refer to the User's Guide for details on each of the user interfaces. 

VTS TEST MODES
-----------------
After bringing up the desired UI, the first choice users have to make is the
selection of the "test mode". The tool allows the user to run tests in three 
different modes. The modes address different testing needs of the user. 

- Online Mode:
  The goal in this mode is to provide diagnostics capability in the presence 
of user applications. The use case for this mode is for system health
monitoring capability. The tests in this mode are non-intrusive in nature, and
test very small portions at a time. As a result they consume very little
system resources and take much longer to finish.

- System Exerciser:
  The goal in this mode is to provide overall system exercising capability, 
which will test the system as a whole with all its components. The tests 
would run in parallel in this mode. It would be assumed that in this mode no 
other application (other than VTS) would be running on the system. By
default, the test time duration for this mode is set to 4 hours (240 minutes).
This can be changed by editing the global options.

- Component Stress:
  The goal in this mode is to do targeted testing of system components and 
modules. It would be presumed that the no test will be running simultaneously 
with other  tests. In other words the tests would be run sequentially. It 
would also be assumed that no other user application is running on the system.
By default in this mode the tests are scheduled to run for 5 passes each. This
can be changed by editing the global options.

The user needs to go to the desired mode, make the selections of the tests
that they are interested in running and start testing. 

Checking Testing Status and Log files
-------------------------------------
When tests are running, the status of test pass / error is displayed on the 
UI (if you are using one of the UI). In addition, after a testing session is
complete, the status of the session is logged in VTS log files. These log 
files are accessible from UI, through the "log_file" or "Logs" tab. They can 
also be directly accessed from the location /var/sunvts/logs/ directory.
Below mentioned are the different log files that can be viewed:  

- Test Error (sunvts.err)
  This file contains the test related error messages that occured during a 
test run.

- Test session information (sunvts.info)
  This file contains all information about the testing session. Data like 
number of test passes, failures, time elapsed etc. will get reported here.
 
- VTS Kernel Error log (vtsk.err)
  This file contains error that were encountered by VTS test harness
(vtsk). These are NOT test failures, and do not indicate and problem in the 
hardware. These are mainly soft errors that the harness faced. Usually harness
logs the error and bypasses them. 

- Unix messages (/var/adm/messages)
  These are the Unix system messsages that are logged by the syslog daemon 
(do a man on syslog).  

- Test verbose (sunvts.verbose)
  This file contains the verbose logs of the VTS test runs. The verbose 
messages are ONLY logged when tests are run with the verbose flag ON.  

- Test Report (sunvts.rpt)
  This is a report file which is generated after every run of a VTS 
session. The report essentially consists of 3 things. Pass / fail status of 
VTS test session, list of faulty components that are there in the system 
currently, and the Unix system messages that are generated by syslog daemon.  

VTS is a validation tool that mainly acts as a stimulator of hardware 
failures. Predominantly the detection and reporting of these hardware failures
happen in the system (hardware and the operating system). So after every 
VTS testing session, it is very essential that the user look at the test 
report (sunvts.rpt) file to get a clear idea of what failures happened.  
