What command-line parameters are available for Symantec Help (SymHelp)?

Article:TECH170732  |  Created: 2011-09-29  |  Updated: 2014-06-30  |  Article URL http://www.symantec.com/docs/TECH170732
Article Type
Technical Solution


Issue



Symantec Help (SymHelp) needs to run without user visibility and/or with specific data collection and reporting goals in mind


Solution



 

 

This document explains various command-line options available for use with Symantec Help (SymHelp). These include:
·         Command-line parameters featured on the help manual page (SymHelp.exe –h)
·         Command-line parameters for extracting files
·         Command-line parameters for extracting the event logs
·         Command-line parameters that control the UI and silent mode workflow
 
Command-line parameters featured on the help manual page
The following table contains the command-line options available for Symantec Help:

Command line option
Purpose
-h
Display this help page
-noup
Do not check for an updated version of Symantec Help
-debug
Run a debug wizard to turn on product debugging and collect product debug logs.
-disable
Disable debug mode for installed products. Use -enable to enable debug mode.
-enable
Enable debug mode for installed products. Use -disable to disable debug mode.
-lang language-id
Set the display language using the two-letter ISO 639-1 language ID
-s
Run Symantec Help in silent mode.
-healthchk
Scan for the health of all installed products.
-prechk
Scan for pre-install requirements of all supported but not installed products.
-bestchk
Scan for best practices in all installed products.
-logs
Collect detailed product logs.
-forsupport
Collect standard data for support.
-alldata
Collect all data for support.
-ts
Run Threat Analysis Scan (use with "-nosys" to scan common load points only)
-prod products
Comma-delimited list of products to scan.
-open filename
Open an existing report.
-dest Destination directory. If not specified, the default destination is c:
Set the default location for saving reports.
-ftpup
Perform the update check using only FTP.
-httpup
Perform the update check using only HTTP.
-wizno
Do not run in wizard mode.
-wizprod
Deprecated, use -debug. Run in product wizard mode.
-user username
User name for proxy authentication.
-pass password
Password for proxy authentication.

 
Command-line parameters for extracting files
The command-line parameter -x provides file extraction options:
SymHelp.exe [options] -x sdbzfile.sdbz [filters]
…where [options] includes…
  • -s                 Silent mode (suppress error message boxes)
  • -dirs             Create one level of subdirs for files (default is flat)
  • -dest <dir>   Specify the output directory (default is auto-generated subdir of current working dir)
…and [filters] includes…
  • *          Matches zero or more characters in a directory or file name
  • ?         Matches exactly one character in a directory or file name
  • **       When used as the entire directory name, matches any chain of subdirectories
A filter may be relative…
Symantec*\**\*.log
Any file with the extension .log that is a descendent of any directory that begins with "Symantec" anywhere in the file system
…or absolute…
C:\ProgramData\*\*.dat
Any file with the extension .dat in any immediate subdirectory of C:\ProgramData
 
Command-line parameters for extracting the event logs
 
The command-line parameter –evt, used with the silent mode switch –s, provides the following event log (.evt) extraction options:
 
Symhelp.exe –evt <full path to .sdbz file> -s [–dest <full path to destination>]
 
…where
 
·         <full path to .sdbz file> is the drive and full path and file name of the .sdbz file the event logs are to be extracted from
 
·         -s is required in order for the extraction of the event logs to take place
 
·         -dest is optional: current directory is default
 
Extracted event logs are saved in .evt files per event log type in a folder named:
 
Eventlogs-<sdbz file name>
 
 
Command-line parameters that control the UI and silent mode workflow
The command-line parameter –prod provides the following SymHelp workflow control options:
SymHelp.exe –prod [prod1,prod2,…]
Where prod# is one of the following (product name = prod#):
         Backup Exec Media Server = be_ms
         Backup Exec Remote Agent = be_ra
         Data Loss Prevention Detection Server = detection
         Data Loss Prevention Endpoint Agent = edpa
         Data Loss Prevention Enforce Server = enforce
         Endpoint Protection Client = epclient
         Endpoint Protection Manager = epmanager
         Mail Security for Microsoft Exchange = smsmse
         System Recovery = ssr
This switch works in both silent mode and UI mode. You can add scan specifiers in both silent mode and UI mode as well:
Available scan specifying command-line parameters:
         -healthchk
         -prechk
         -logs
         -forsupport
         -alldata
         -lpa (exclusive: takes precedence over all other command-line scan options)
         -spe (exclusive: takes precedence over all other command-line scan options except lpa)
You can combine product and scan specifiers in the command-line:
         Silent mode: scans run automatically (no user input) and with the specificity desired
         UI mode: scan options are preselected and the user, after accepting the EULA, can just click the ‘Scan’ button
Example:
SymHelp.exe –prod epclient,edpa –forsupport
Result after accepting the EULA... 
 

 




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


Terms of use for this information are found in Legal Notices