3 steps to use the SORT Data Collector to collect and submit and enhanced vxexplorer troubleshooting archive

Article:HOWTO32575  |  Created: 2010-10-19  |  Updated: 2015-02-18  |  Article URL http://www.symantec.com/docs/HOWTO32575
Article Type
How To



Subject


The SORT Data Collector is a script that will gather OS and Symantec software environment information (mainly configuration and logs) from one or more servers (NOT user data or configuration other than OS and Symantec software).  It is designed to be run during production with negligible to minimal performance impact.  The Data Collector will produce an archive file that can then be transferred to Symantec to aid Technical Support in analyzing and troubleshooting an issue.  The Data Collector (SORT vxexplorer) has replaced the legacy VRTSExplorer tool (currently undergoing staged deprecation).

 

3 steps to using Data Collector to collect an enhanced vxexplorer troubleshooting archive

 

1)  get Data Collector shell archive script; choose one of options in step 1 below
2)  run Data Collector archive (think of it as self-extracting .tar.gz file)
3)  run the Data Collector script (the current version will auto-upload if connection to Internet is available)
 
Complete details are available in the SUMMARY and DETAILED procedures below.
 

QUICK SUMMARY 

 

Using the SORT Data Collector to gather logs for Storage Foundation Technical Support

http://www.symantec.com/docs/TECH203525

 

Enhancements to vxexplorer in SORT Data Collector

 

  • shipped with Storage Foundation (6.0 and later); available for download from SORT website
  • the Data Collector is installed on the system during Storage Foundation installation (see step A below)
  • VRTSExplorer script is deprecated and no longer shipped with Storage Foundation (6.0 and later)
  • ability to gather vxexplorer data from more than 1 server (using remote protocols explained below)
  • enabling Volume Manager debug during data collection will NOT cause vxconfigd reset (Storage Foundation 5.1SP1 or later)
  • remote: uses CPI-likw rsh or ssh functionality for remote data collection (additionally, hacli can be used in a cluster environment)
  • remote: xprtld may automatically be used in Veritas Operation Manager (VOM) domains (ability to run sortdc on 1 host in a VOM domain and have the ability to collect data from the local machine and/or 1 or more hosts in the same VOM domain)
  • ability to perform cross-platform data collection (within like OS's; Windows or Unix)
  • privilege control is supported (sudo)
  • includes embedded vomgather in vxexplorer archive for VOM troubleshooting if necessary
  • automatic ftp upload; site: ftp.entsupport.symantec.com: directory: /incoming/script/sort
  • ability to check to see if specified server is part of a cluster and prompt to automatically add the other nodes of the cluster to the data collection/vxexplorer process (partial cluster check) *1
  • ability to run Risk Assessment simultaneously (optional)
  • allows Technical Support Engineer to retreive summary diagnostic report
  • same Data Collector script that is used to generate SORT Custom Reports
  • automatic upgrade of Data Collector script (can be disabled) *2
  • standardized functionality that will be enhanced going forward (the legacy VRTSExplorer script is undergoing a staged deprecation)
  • the Data Collector/vxexplorer is written in a standard readable perl script (similar to CPI)
  • a response file may be used (similar to CPI)
  • logs are available in standard Data Collector format (similar to CPI; (~/sort/log/)
 
*1  not available when running when using the 'vxexplorer' command line option (ie ... 'sortdc -vxexplorer')
 
*2  this functionality is automatically disabled if the server does not have a connection to the Internet; can also be manually disabled via a configuration file (sortdc.conf)
 
 

BACKGROUND

 

While the Data Collector has reporting capabilities in conjunction with SORT (web portal administration tool), it also has the capabilities to generate a vxexplorer troubleshooting archive.  The Data Collector/vxexplorer functionality has replaced the legacy VRTSexplorer script.
 
A Data Collector is available for each supported "flavor" of Unix (see below), and one for the supported versions of the Windows server.  Most statements in this document are Unix-centric but will apply to the Windows Data Collector as well; some Windows specific links or information is referenced here (see Related Articles below for Windows specific TechNote).  The Unix and Windows Data Collectors are specific to their respective environments.  The term Unix refers to both Unix and Linux.
 
Solaris examples are used in this document however the Data Collector script supports all supported Storage Foundation OS's.
 
While a GUI interface is offered for the Data Collector (see step D below), this "version" does not contain a vxexplorer module and is used for system report generation.
 
 

STEP 1

 

The first step is to get the Data Collector archive (think of it as a self-extracting .tar.gz file).  While this has a shell script file extension (.sh), this is an OS archive consisting of script and binary code.
 

1)  There are 4 ways to get the Data Collector archive script.  Use one of the following 4 methods (A, B, C or D).

(NOTE: step D is included for completeness however A, B or C are more direct)
 
A)  If the server is running any product variation of Storage Foundation version 6.0 or later, the Data Collector has been pre-installed (VRTSspt package) and can be found as follows:
 
# cd /opt/VRTSspt
# ls
CVM             FS              README.VRTSspt  VRTSexplorer
DataCollector   FirstLook       VCS             VVR
# ls DataCollector
README.data_collector  sort_sol_sparc.sh
 
Skip to the SUMMARY PROCEDURE below.
 
 
B)  If the freeware utility wget exists on the Unix server and the server has a connection to the Internet, the Data Collector archive can be downloaded directly to the Unix server instead of through the SORT web site to a workstation.  Browse to https://sort.symantec.com/dc_download/readme and search for the string "www.gnu.org" to see the appropriate URLs to use.
 
Example
 
# wget https://sort.symantec.com/data/sort/collectors/sort_sol_sparc.sh
Resolving sort.symantec.com... 216.10.195.50
Connecting to sort.symantec.com|216.10.195.50|:80... connected.

... 

Saving to: `sort_sol_sparc.sh' 100%[=============================>] 18,521,293  1.64M/s   in 11s 2011-12-30 14:36:55 (1.63 MB/s) - `sort_sol_sparc.sh' saved [18521293/18521293] 100%                                    

 

Some situations may require using the command line option.

--no-check-certificate

Example

 

# wget --no-check-certificate https://sort.symantec.com/data/sort/collectors/sort_sol_sparc.sh 

 
Set execute permission for the owner
 
# ls -l *.sh
-rw-r--r--   1 root     root     21423154 Jul  9 13:24 sort_sol_sparc.sh
# chmod u+x *.sh
# ls -l *.sh
-rwxr--r--   1 root     root     21423154 Jul  9 13:24 sort_sol_sparc.sh
 
Skip to the SUMMARY PROCEDURE below.
 
 
C)  The Data Collector can be downloaded from the SORT website at:
 
 
1)  Click Downloads / SORT Data Collectors
  
 

 

2)  Click on the appropriate OS name of the system where you will be running the Data Collector

 

 

3)  Use SCP, FTP or some other file transfer mechanism to put the file on the Unix server
(the downloaded archive is not a software package and when run, it will create a sort subdirectory in whatever location it is placed in to extract itself)
(it is important that the transfer be done in image or binary mode; normally default for SCP)
 
Example (using Winscp):
 
 
4)  Set execute permission for the owner
 
# ls -l *.sh
-rw-r--r--   1 root     root     21423154 Jul  9 13:24 sort_sol_sparc.sh
# chmod u+x *.sh
# ls -l *.sh
-rwxr--r--   1 root     root     21423154 Jul  9 13:24 sort_sol_sparc.sh
 
Skip to the SUMMARY PROCEDURE below.
 
 
D)  The Data Collector can be downloaded from the Custom Reports widget (panel) at http://mysort.symantec.com (select SORT / My Sort on the gray navigation bar; select the Data Collectors tab at the Custom Reports widget).  If a browser exists on the Unix server and it is connected to the Internet, the Data Collector archive will be downloaded directly to the server.  Otherwise, if a browser is used at a PC workstation, the Data Collector archive must be transferred to the Unix server.  Please ensure the transfer is done in Image or Binary mode (most GUIs are "automatic" and may choose ascii mode and may need the transfer to be forced to transfer in binary mode).  The 2 steps below demonstrate this process.
 
1)  On a PC workstation or the Unix server, browse to http://sort.symantec.com; select SORT from the gray navigation bar menu then MySORT (or browse to http://mysort.symantec.com directly).


 
2)  In the Custom Reports panel (widget) on the My SORT web page, select the Data Collector tab, Command line interface and the Operating System of the server where the Data Collector (DC) will run.  This will download the DC archive script (*.sh file).
(think of this as a self-extracting ".tar.gz" archive)

 
3)  If downloaded to a workstation, use a SCP, FTP client some other file transfer mechanism to put the file on the Unix server
(the downloaded archive is not a software package and when run, it will create a sort subdirectory in whatever location it is placed in to extract itself)
(it is important that the transfer be done in image or binary mode; normally default for SCP)
 
Example: Winscp
 
 

 

4)  Set execute permission for the owner
 
# ls -l *.sh
-rw-r--r--   1 root     root     21423154 Jul  9 13:24 sort_sol_sparc.sh
# chmod u+x *.sh
# ls -l *.sh
-rwxr--r--   1 root     root     21423154 Jul  9 13:24 sort_sol_sparc.sh
 

SUMMARY PROCEDURE

 

1)  Use 1 of the 4 methods (A, B, C or D) in step 1 above to get the Data Collector

2)  Set the archive script execute permissions and run it (./*.sh).  Unnecessary if using pre-installed copy.

3). After the script has run, a ~/sort subdirectory will be created which will contain the SORT Data Collector script and its supporting hierarchy and files.  Cd to this directory and run the command:

 # ./sortdc

  • this will start the Data Collector; follow the on-screen instructions and prompts; if unsure, the default response is normally OK (example provided below)
  • if the server has access to the Internet, the SORT Data Collector script will contact the SORT servers to check for upgrades and download a new archive script if appropriate.  This feature can be disabled by changing a variable in the sortdc.conf file; RUN_LIVE_UPGRADE
  • the script will determine if the host(s) specified are part of a cluster where the other nodes have not been specified; answer "yes" to this question only if a vxexplorer is required from any non-specified nodes; the typical response is "no" for a single node vxexplorer 
  • in the event that a vxexplorer output is required from more than one system, the SORT Data Collector can use remote protocols (ssh/rsh/hacli/xprtld; sudo can also be configured) to collect data from a remote server (like the other node of a cluster) so that a vxexplorer output file can be generated for the local server and/or any remote server(s); the script will provide a menu to enter the host(s) to collect data from
  • if connectivity to the Internet is available, the script will prompt to upload the vxexplorer archive to: ftp.entsupport.symantec.com:/incoming/script/sort (option 3; upload anonymously).  If option 4 is selected (share later), the filename displayed here should be manually transferred to Symantec per the instructions of the TSE working the case; please email all uploaded filename(s) to the current case owner (reply to an active case email from enterprise_technical_support@symantec.com)

 

DETAILED PROCEDURE

 

1)  Use 1 of the 4 methods (A, B,C or D) in step 1 above to get the Data Collector

2)  Set the archive script execute permissions and run it (./*.sh).  Unnecessary if using pre-installed copy.

(Solaris script used in the example)


#   ls -l *sh
-rw-r--r--   1 root     root     15810971 Aug 10 08:38 sort_sol_sparc.sh
#   chmod u+x sort_sol_sparc.sh
#   ls -l *sh
-rwxr--r--   1 root     root     15810971 Aug 10 08:38 sort_sol_sparc.sh
#   ./sort_sol_sparc.sh

"sort" directory already exist. Do you want to backup it? [y,n] (y)   y

Uncompressing SORT data collector: 100% |***************************|

Would you like to run the data collector now? [y,n] (y)  n

 

The Symantec Operations Readiness Tools (SORT) data collector has been extracted to the current directory. To run it, use:

cd sort
./sortdc

 

If the Data Collector archive was transferred from a workstation to the server (step 1C above) and the transfer used ftp ascii mode, the following error may be displayed:

 

# ./sort_sol_sparc.sh
Warning: An internal checksum has been corrupted. This is likely due to the use of ascii-mode FTP during a file transfer. Please re-download the tool or re-transfer it to this host using binary-mode FTP. The correct md5 checksum for this file can be found at <https://sort.symantec.com/> and can be checked using the md5sum tool.

 

In this case, re-transfer the .sh archive from the workstation making sure that binary or image transfer mode is used.

 

3). After the script has run, a ~/sort subdirectory will be created which will contain the SORT Data Collector script and its supporting hierarchy and files.  Cd to this directory and run the command:


# cd sort

# ./sortdc

  • this will start the Data Collector (SORT Data Collector); follow the on-screen instructions and prompts; if unsure, the default response is normally OK (example provided below)
  • if the server has access to the Internet, the SORT Data Collector script will contact the Symantec SORT servers to check for upgrades and download a new archive script if appropriate.  This feature can be disabled by changing a variable in the sortdc.conf file; RUN_LIVE_UPGRADE
  • the script will determine if the host(s) specified are part of a cluster where the other nodes have not been specified; answer "yes" to this question only if a vxexplorer is required from any non-specified nodes; the typical response is "no" for a single node vxexplorer 
  • in the event that a vxexplorer output is required from more than one system, the SORT Data Collector can use remote protocols (ssh/rsh/hacli/xprtld; sudo can also be configured) to collect data from a remote server (like the other node of a cluster) so that a vxexplorer output file can be generated for the local server and/or any remote server(s); the script will provide a menu to enter the host(s) to collect data from
  • if connectivity to the Internet is established, the script will prompt to upload the vxexplorer archive to ftp.entsupport.symantec.com:/incoming/script/sort .  If option 4 is selected, the filename displayed here should be manually transferred to Symantec per the instructions of the TSE working the case; please email all uploaded filename(s) to the current case owner (reply to an active case email from enterprise_technical_support@symantec.com)

 

 The following is a sample run of the SORT Data Collector as it run at the time of this writing.

 

1)  Extracting the Data Collector archive (self-extracting.tar.gz)

(to be repeated only when a Data Collector archive has been manually downloaded)

 

maztoy.spr.spt.symantec.com# chmod u+x sort_sol_sparc.sh

maztoy.spr.spt.symantec.com# ./sort_sol_sparc.sh

 

Uncompressing SORT data collector: 100% |*******************************************|


Would you like to run the data collector now? [y,n] (y) n


The Symantec Operations Readiness Tools (SORT) data collector has been extracted to the current directory. To run it, use:


    cd sort

    ./sortdc


maztoy.spr.spt.symantec.com#

 

2)  Running the Data Collector (this can be repeated when a new vxexplorer/Data Collector report is needed.

 

maztoy.spr.spt.symantec.com# cd sort
maztoy.spr.spt.symantec.com# ./sortdc
===========================================================================
| Checking available driver (maztoy.spr.spt.symantec.com) resources
===========================================================================
Working directory file system type: ufs
Open files limit: 256
Virtual memory limit: unlimited
Free swap: 4059 MB

Loading data collector...

                         Symantec Operations Readiness Tools

Copyright (c) 2014 Symantec Corporation. All rights reserved.  Symantec and the
Symantec logo are trademarks or registered trademarks of Symantec Corporation or
its affiliates in the U.S. and other countries. Other names may be trademarks of
their respective owners.

The Licensed Software and Documentation are deemed to be "commercial computer
software" and "commercial computer software documentation" as defined in FAR
Sections 12.212 and DFARS Section 227.7202.


Press [Return] to continue:

The data collector writes logs to /var/tmp/sortdc-201502101202JHc.

Starting the data collector [Build: 3.14.2.20150112]...

                         Symantec Operations Readiness Tools

    Connecting to Symantec to check for the latest data collector version ... Connected
    You have the most current data collector version.

                         Symantec Operations Readiness Tools

The tier sheet version on local machine is 77.
An updated tier sheet version (79) is available on the Symantec Update Server.

Do you want to download the latest tier sheet? [y,n,q] (n) n

The End of Supported Life (EOSL) information for the Symantec product on the local
machine is version 3.14.20141130 with release date 2014-11-30 00:00:00.
An updated EOSL version (3.14.20150201 updated on 2015-02-01 00:00:00) is
available on the Symantec Update Server.

Do you want to update the local EOSL data in the data collector? [y,n,q] (n) n
(editor note: updated tier sheet and EOSL are not necessary for a vxexplorer)
 
                         Symantec Operations Readiness Tools


Main Menu:

Choose the Symantec enterprise product family:
     1)  NetBackup Family
     2)  Storage Foundation and HA Solutions

Choose your option: [1-2,q] (1) 2

                         Symantec Operations Readiness Tools


Main Menu->Storage Foundation and HA Solutions:

What task do you want to accomplish?
     1)  Installation/Upgrade report
     2)  Risk Assessment report
     3)  License/Deployment report
     4)  VxExplorer report
     5)  Other tasks
     b)  Back to previous menu

Choose your option (separate multiple selections with commas): [1-5,b,q] (1,2,3) 4

                         Symantec Operations Readiness Tools


Main Menu->Storage Foundation and HA Solutions->VxExplorer report:

On which systems do you want to run and report?
     1)  This system only(<maztoy>)
     2)  One or more remote systems
     3)  IP Address Range
     b)  Back to previous menu

Choose your option: [1-3,b,q] (1) 1

                         Symantec Operations Readiness Tools

Logs are being written to /var/tmp/sortdc-201502101202JHc while sortdc is in
progress

    Partial clusters check: 100%

    Estimated time remaining: 00:00:00                                      1 of 1

    Checking for partial clusters among input systems ....................... Done

Missing Cluster Nodes
---------------------
Note: This includes nodes which failed during host discovery/authentication

* Node missing for cluster [ ncc ]: karena

As per the detected partial clusters, would you like to include missing cluster
nodes for data collection: [y,n,q] (y) n

                         Symantec Operations Readiness Tools


                         Symantec Operations Readiness Tools

Generating report for VRTSexplorer:

Do you want to run all VRTSexplorer modules? [y,n,q] (y) y

Specify a report directory excluding the /(root) path to store the collected data
by VRTSexplorer: (/var/tmp) /space
Storing all the data collected from maztoy to
maztoy:/space/VRTSexplorer_8340ad4b_maztoy_20150210120413.

You can run a set of Risk Assessement checks on your system(s), which will analyze
your environment and make configuration recommendations. These checks can uncover
potential issues and suggest ways to fix them.
Do you want to run Risk Assessement checks on maztoy? [y,n,q] (n) n

                         Symantec Operations Readiness Tools

The data collector writes logs to maztoy:/var/tmp/sortdc-201502101202JHc


Do you want to collect core files in / on maztoy? [y,n,q] (n) n
maztoy: Core file collection skipped.

Do you want to collect VxVM core files in the root directory (/) on maztoy?
[y,n,q] (n) n
VxVM Core file collection skipped.

Note: answer yes to the following question only if

specifically advised by Symantec                     


Set the VxVM Configuration daemon debugging level on maztoy? [y,n,q] (n) n
Debugging level setting skipped.
maztoy: Collecting system configuration information for SunOS system.
/...
maztoy: Collecting Veritas package version information.
/...
maztoy: Collecting loadable module information.
/...
maztoy: Collecting zone information.
/...
maztoy: Collecting Patch Logs information.
/...
maztoy: Collecting pkgchk information for Veritas packages.
/...
maztoy: Determining current VxVM operating mode.
/...
maztoy: Collecting VxVM configuration information.
/...
maztoy: Collecting VRAS configuration information.
/...
maztoy: Collecting VxFS configuration information.
/...
maztoy: Collecting vxfen specific data...
/...
maztoy: Collecting console logs...
/...
maztoy: Collecting I/O Fencing related VM data...
/...
maztoy: Collecting VVR configuration information.
/...
maztoy: Collecting VOM configuration information.
/...
maztoy: Collecting SFM configuration information.
/...
maztoy: Collecting SIG licensing information.
/...
maztoy: Collecting VCS configuration information.
/...
maztoy: Collecting VBS information.
/...
maztoy: Collecting ISIS configuration information.
/...
maztoy: Collecting DCLI configuration information.
/...
maztoy: Collecting Cross Product/Platform Installation (CPI) information.
maztoy: Generating the summary report...
maztoy: Script finished, creating output tar file...
/...
The output file is
maztoy:/space/VRTSexplorer_8340ad4b_maztoy_20150210120413.tar.gz.
The checksum and size in bytes for the tarfile on maztoy are
4023208408      1577573665      /space/VRTSexplorer_8340ad4b_maztoy_20150210120413.tar.gz

To expedite the solution to your issue, share your report with Symantec Technical
Support:

     1)  Create a new support case
     2)  Update an existing support case
     3)  Upload the explorer log anonymously
     4)  Share it later

Choose your option: [1-4,q] (1) 3
Uploading /space/VRTSexplorer_8340ad4b_maztoy_20150210120413.tar.gz to
ftp.entsupport.symantec.com/incoming/script/sort/...

##############################################################################
Upload successfully.
(editor note: the display of  the pound sign is slower than a manual ftp but the upload timing is fine)
 
Upload  /space/VRTSexplorer_8340ad4b_maztoy_20150210120413.tar.gz anonymously.
Note: You need to contact Symantec Technical Support to link the file(s) to a
case.


Your tasks are completed. Would you like to exit the data collector? [y,n,q] (y) y

VxExplorer was skipped on node <karena>, run sortdc locally on <karena> to get the
desired output.

Would you like to provide feedback for the data collector? [y,n,q] (y) n
SORT data collector current session log files are saved at
maztoy:/var/tmp/sort/sort/log/sortdc-201502101202JHc
 

IMPORTANT: if the vxexplorer archive (.tar.gz) has been transferred to Symantec anonymously or manually (options 3 or 4), please reply to any case email from the current case with the name(s) of the uploaded file(s) even if the file(s) are uploaded by the data collector script.

 

The Data Collector has more command line options available but they normally don't need to be used for basic operation see README or usage message: ./sortdc -? or SORT online help page (link below)


  • UNIX Data Collector (sortdc) command syntax

 

https://sort.symantec.com/public/help/wwhelp/wwhimpl/common/html/wwhelp.htm?href=SORT_0092.html

 

See the following links on using the Data Collector for additional details.

 

  • Downloading the UNIX Data Collector to your local computer

https://sort.symantec.com/public/help/wwhelp/wwhimpl/common/html/wwhelp.htm?href=SORT_0029.html

  • Downloading and running a Windows Data Collector

https://sort.symantec.com/public/help/wwhelp/wwhimpl/common/html/wwhelp.htm?href=SORT_0099.html

  • Collecting and Analyzing Data
https://sort.symantec.com/public/help/wwhelp/wwhimpl/common/html/wwhelp.htm?href=SORT_0025.html
  • UNIX data collector's system requirements
https://sort.symantec.com/public/help/wwhelp/wwhimpl/common/html/wwhelp.htm?href=SORT_0027.html
  • Working with the UNIX data collector - basic tasks
https://sort.symantec.com/public/help/wwhelp/wwhimpl/common/html/wwhelp.htm?href=SORT_0026.html
  • Windows data collector system requirements
https://sort.symantec.com/public/help/wwhelp/wwhimpl/common/html/wwhelp.htm?href=SORT_0096.html
  • Working with the Windows data collector
https://sort.symantec.com/public/help/wwhelp/wwhimpl/common/html/wwhelp.htm?href=SORT_0095.html
  • Symantec™ Operations Readiness Tools help (home)
https://sort.symantec.com/public/help/wwhelp/wwhimpl/js/html/wwhelp.htm
 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 





Article URL http://www.symantec.com/docs/HOWTO32575


Terms of use for this information are found in Legal Notices