********************************************

******* CALYPSO VERSION README *******

********************************************

*********************************************************************************
****** IMPORTANT NOTICE !
******
****** Calypso uses SSH for connecting to hosts. Therefore, if there are
******
****** Windows binary installations in the setup, Calypso will not collect
******
****** diagnostics from them
******

*********************************************************************************

NOTICE OF COPYRIGHT:
THIS PROGRAM CONTAINS MAINTENANCE AIDS AND IS THE CONFIDENTIAL UNPUBLISHED
INTELLECTUAL PROPERTY OF EMC CORPORATION. IT INCLUDES WITHOUT LIMITATION EXCLUSIVE
COPYRIGHT AND TRADE SECRET RIGHTS OF EMC THROUGHOUT THE WORLD.
ZIP.EXE IS PACKAGED IN CALYPSO UNDER FREE DISTRIBUTIVE RIGHTS.
PuTTY IS PACKAGED IN CALYPSO UNDER THE PuTTY COPYRIGHT INCLUDED IN THE DISTRIBUTION

================================================================================
FOR ENHANCEMENT REQUESTS OR ISSUES WITH CALYPSO, CONTACT Jarra.Voleynik@emc.com
================================================================================

PURPOSE:
========

Calypso was designed to simplify collection of diagnostic output from SRM, SA suite
and Watch4net hosts.
It uses SSH to connect to the specified frontend host and obtain information on the
other
hosts registered with the Centralized Management. Then it uses SSH to run
diagnostic2.sh
and detect.sh on each of the registered hosts.

Calypso basically performs 2 operations:

1) run diagnostic2.sh (our customised copy of the default diagnostic.sh) on each

host registered with the Centralized Management and move it
to the out\DiagnosticFiles_<hostname>.tar.gz file on your PC.
2) excecute a detect.sh script on each host and put the output in file
out\detect_<hostname>.txt
and out\metrics_<hostname>.txt
(all the detect outputs are eventually zipped up into file
out\Diagnostic_support.zip)

INSTALLATION:
============

unzip calypso_<version>.zip into a folder on your PC and execute calypso.bat

USAGE:
=====

CMD>calypso.bat 0
or
CMD>calypso.bat

!!! For Windows SRM installations, use calypso_win.bat

When invoked with a parameter of 0, calypso will only run the detect.sh script on
all the hosts registered with the Centralized Management. No diagnostic.sh output
will be collected.

To minimize the size of the whole collection, you are prompted to list the FQDN of
hosts from which diagnostic.sh output will be collected. You can press ENTER at
this
point and diagnostic.sh output will be collected from all the hosts registered
with
the Centralized Management. Note that even though you can choose that
diagnostics2.sh
output is collected from a few hosts only, detect.sh output is always collected
from
all hosts.

!!! To only get health reports, run getHealth.bat. It works on both, Linux and
Windows installations

diagnostic2.sh
--------------
As the DiagnosticFiles output on many hosts is too large and in many cases only the
recent
logs are necessary for troubleshooting or analysis in Vipr SRM Workbench, Calypso
runs a
customized diagnostic.sh script called diagnostic2.sh. This customized script only
collects
logs not older than a specified number of days (as prompted by Calypso). The
default is 3 days.

CALYPSO OUTPUT:
===============

Calypso will produce the following files in its out directory:

- Diagnostic_support.zip
- Health_Reports.zip
- DiagnosticFiles_<hostname>.tar.gz

----------------------------------------------------
Diagnostic_support.zip contains the following files:
----------------------------------------------------

out\info.txt
------------
This file contains the calypso version and the version of Tomcat on the frontend
host,
which should correspond to the installation version.
The NSLOOKUP section contains the IP address for each host.
The HOST PERSONALITY section allows to determine if the host is a Frontend, Backend
or Collector.

detect_<hostname>.txt
---------------------
The layout of this files is as follows:

COLLECTORS
(here you will find all the installed solution pack instances and their
configurations on the host)

EVENT PROCESSING
(Event processing - Smarts SPs)

BACKENDS
(here you will find all the installed backend instances and their configurations on
the host)

FRONTEND
(here you will find all the installed frontend instance and its configuration on
the host)

SERVICES
(list of SRM services and their status)

CHANGED MODULE FILES

(list of files that differ from the module repositotry)

MODULES
(list of available and installed modules)

TASKS
(list of scheduled tasks and their status)

LOG ANALYSIS
(here you will find a list of 20 ERROR and WARNING messages from the current log
files for the Frontend, Collectors and Backends.
Also, a line following the ERROR or WARNING is included as this line usually
contains useful relevant information)

MANAGE RESOURCES
(list of resources in the resource table of the master database)

metrics_<hostname>.txt
----------------------
This file contains the number of "active" (vstatus == 'active') objects of various
types in each mysql database on the specified host.
E.g. the number of VMAX arrays, VMAX devices and VMAX pools is shown. This is for
future use in the Vipr SRM Workbench.
The second number is the number of objects irrespective of vstatus setting.

Also, the number of events of each type is shown from the events database

lb_balancing_lists.txt
----------------------
This file contains a list of Backends, their locations and balancing keys for each
Backend.

device_versions_<hostname>.txt
------------------------------
this file lists VMAX, VNX and switch entries, some properties and the vstatus flag.

healthcheck_<hostname>.txt
--------------------------
This file checks for some configuration information pertaining to the personality
of the SRM host
and shows possible configuration problems, such as collectors not sending data to
their local LBC
or collectors not sending sparql queries to the PBE host.
Also, file etc/healtcheck_strings.txt lists some error strings and their meaning.
These are checked
for in the collectors logs and warnings shown in healthcheck_<hostname>.txt

host_sp_object.txt
------------------
This file contains the number of Solution Packs per and the number of objects per
Solution Pack
for each host

-----------------------------------------------------
Diagnostic_support.zip contains the following files:
-----------------------------------------------------

A selection of health reports in PDF format

File scalability_report.txt that can be used to match against the Vipr SRM
Scalability guide to check
if the installation has sufficient number of SRM hosts

PACKAGE CONTENTS:
=================
calypso.bat
calypso_win.bat
calypso_howto.txt
getHealth.bat
bin\awk.exe
bin\grep.exe
bin\date.exe
bin\sed.exe
bin\zip.exe
bin\plink,exe
bin\pscp.exe
bin\psftp.exe
bin\getpass.exe
bin\libcurl.dll
bin\libeay32.dll
bin\libssl32.dll
bin\PuTTY_LICENCE.txt
bin\convert_input_hosts.awk
etc\healtcheck_strings.txt
lib\convert_input_hosts.awk
lib\echoArgs.bat
lib\wingetAPGlocation.bat
lib\wingetIPaddresses.bat
lib\wingetPersonality.bat

HISTORY:
========
24 July 2017 - release 3.0
- fixed a few bugs in the healthcheck reports
- made Calypso work with SRM 4.1
- added scalability_report.txt in the health reports for scalability checks against
the Scalability guide
- added host_sp_object.txt in the detect reports for scslability checks

28 February 2017 - release 2.3

- fixed https communication for GetHealth.bat
- implemented CHANGED MODULE FILES in detect_<hostname>.htm to show module files
that differ from the initial module package
- healthcheck_<hostname>.txt in the out directory shows healthcheck warnings for
each SRM host
- device_versions_<hostname>.txt shows some proprerties and vstatus for VMX, VNX
and switch devices

07 September 2016 - release 2.2

- fixed adding lb_lists_<hostname>.txt and manage_resources to Calypso
- SRM version is now retrieved from the Frontend on SRM 3.7 and 4.x and put into
info.txt
- The health reports contains Storage and Switch reports from the Explore report
folder. These reports also
show the last discovered time for storage and switch devices
- added more SPs into the detect report.
- sparql configuration is shown in the detect report for SPs that use it
- adjustmens made for SRM 4.0

09 March 2016 - release 2.1

- added file lb_lists_<hostname>.txt that will be created for the Primary backend
host and can be found in the out dierctory
- corrected the working directory references in the code
- included manage_resources output in the calypso report for the Primary Backend
host
- added option to opt out of running Health Reports
- the FE host doesn't have to use DNS to resolve hostnames, the hosts file works
just fine

02 November 2015 - release 1.9

- the Log analysis now scans for ERRORS and WARNINGS in the most recent log in the
logs directory rather than the *0-0-.log one
- there is now a separate BACKLOGS section that lists the sizes of all the backlogs
on each host. The old BACKLOG sections
have been removed from the Calypso report
- the Event manager instances are now also scanned for ERRORS and WARNINGS in the
LOG ANALYSIS section
- the diagnostic logs contain the SuSe Firewall config files so that we can check
open ports

17 October 2015 - release 1.8

- the DiagnosticFiles.tar.gz now contains the SRM installation logs in
/var/log/runonce
- the DiagnosticFiles.tar.gz now doesn't include the data directory for the Module
Manager, which reduces its
size significantly
- the Load Balancer balancing lists in Collecting/Load-Balancer/Load-Balancer/data
are now collected
in DiagnosticFiles.tar.gz
- licensing information is included in the detect report for each SRM host
- the FE password prompt now has a note on how to escape special DOS characters

1 June 2015- release 1.7

- adjustments for SRM 3.6 which moved some SPs (or parts of) to the stream
collector
- calypso now show the list of Linux hosts that have been discovered from the
servers.xml file
and the user can use this to select just some hosts to collected diagnostics from
- detect files are in HTML format with an easy to use index at the top. Brackets
from XML
formating are replaced with a ! sign to avoid conflicts with html tags

24 Feb 2015 - release 1.6

- the detect report includes information on some of the Smarts Solution Pack
configurations
- numbers of events in the tables of the events database are shown
- diagnostic2.sh is invoked in parallel on all SRM hosts if collection is done on
all SRM hosts
- diagnostic output is downloaded in parallel from all SRM hosts if collection is
done on all SRM hosts

21 Nov 2014 - release 1.5

- the detect report now shows the list of grants for each user on BE hosts
- the detect report shows the TASKS report. It can also be used to indicate
performance status as the time each task
took to run is shown.
- the detect report shows the SERVICE status.
- the metrics report now show 2 values: <# of objects with vstatus==active>|<total
# of objects irrespective of vstatus>
- when using the FTP upload feature, the new SR directory is created under the SRM
directory (ftp.emc.com/incoming/SRM/<SR>)
- the collected files have a string prefix specifying collection time (<day of
week><day of month><hour>minute>)

30 Oct 2014 - release 1.4

- added diagnostic2.sh script to be pushed to and executed on each host
the user is prompted for the age of logs to collect
- added metrics dump into metrics_<hostname>.txt for each backend host
- a list of Windows hosts for which collection is not done is displayed

10 Sep 2014 - release 1.3

- added prompt for Vipr SRM installation directory (if the install directory
differs from /opt/APG)
- check for Vipr SRM Windows hosts and skip them (a list of the Windows hosts is
also shown)
- the detect_<host> file now shows both Load Balancer Arbiter and Load Balancer
Connector information
- for each database, the number of variables and number of metrics are displayed in
detect_<host>
- the collector, load balancer and Backend backlogs are shown (as the # of files in
the backlog directory)

07 Aug 2014 - release 1.2

- added prompt for username
- now the Frontend is used for hosts resolution rather than the PC Calypso is
running on.
- if diagnostic.sh doesn't exist, Calypso displays a Warning and continues to the
next host
- out\info.txt now contains information on HOST PERSONALITY
- added prompt for Service Request # and FTP upload to ftp.emc.com/incoming/<SR#>
-----------------------------------------------------------
20 Jul 2014 - Initial release 1.1
-----------------------------------------------------------

CREDITS
-------
Thanks to
Marcus.Gunther@emc.com for contributing a piece of code to resolve all hostnames on
the Frontend host
Shane.Lee@emc.com suggested inclusion of the HOST PERSONALITY section in
out\info.txt.
Louie.Cavaliere@emc.com suggested handling of the out directories.
George.Abraham@emc.com suggested the Calypso name and checking access to
ftp.emc.com
Scott.Davidson@emc.com extended the Detect report by Smarts information. Also,
Scott added metrics on the events database tables
Yoshiya.Tanaka@emc.com suggested to include manage_resources in the calypso report
available from SRM 3.7