Version: 2.1
Release Date: January 2006
Command Conventions: An Administrator or Root user is required to execute these commands in the "Command Prompt". This document uses the following conventions when describing commands that are specific to nbsupport.
* Curly braces { } indicate a main command option. Example: nbsupport -master. * Brackets [ ] indicate additional command line options for use with the main option. Example: nbsupport -master -simple.
* Curly braces { } within brackets [ ] indicate an association between the enclosed arguments. Example: nbsupport -master -simple -detail low * A vertical bar (or the pipe symbol) | separates optional arguments from which the user can choose. Example: nbsupport -master -simple -detail low not nbsupport -master -simple -detail low high
* Angle Brackets < > indicate that the information is user supplied. Example: nbsupport -quick PeernameReport
Name:
nbsupport - A software utility that will create a support package consisting of multiple reports most often asked for by support personnel. On Windows, the availability of the GNU tar and gzip utilities via the Administrator's PATH environment variable allows nbsupport to automate the bundling of its output into a support package.
On Unix, the availability of tar and compress utilities via the root user's PATH environment variable allows nbsupport to automate the bundling of its output into a support package.
On either platform, if these utilities are not available, the output from nbsupport will have to be manually bundled into a support package.Usage:
Options:
nbsupport {-master | -media | -client}
[-simple] [-nozip] [-html] [-nostatus]
[-detail {low | medium | high}]
nbsupport -quick <individual_report_name> [-simple] [-html]
nbsupport {-list_master | -list_media | -list_client |
-list_exception_files} [-simple] [-showdetail]
nbsupport {-help | -version}
-master Specifies that nbsupport will gather all reports for a Master Server. -media Specifies that nbsupport will gather all reports for a Media Server. -client Specifies that nbsupport will gather all reports for a Client.
nbsupport does not automatically recognize the NetBackup installation type upon nbsupport execution.
Execute nbsupport with -master, -media or -client from the command prompt.
To add or reduce a report package, include one or more command options listed below.
The combination of options will generate a tailored report package for the NetBackup type and O. S. platform.
Back to Usage.
Additional options listed below are used when departing from the default or when default reports are not required.
One example is to gather only client reports for a Master Server.
Example: nbsupport -client on the Master Server.
Note: -detail high is default for all reports unless otherwise specified.
-simple Removes header information from the output report(s). Default includes header information. -nozip Reports are individually placed in an output folder rather than a zip or tar support package file. Default is support package. -html Report are generated in .html extension. Default is text or .txt. -nostatus Executes without reporting the status of nbsupport to STDOUT. Default is to display status in STDOUT -detail Determines the number of reports generated by platform and install type. -quick Used with individual_report_name for generation of a single report. -list_master Output to screen a listing of all master reports available by platform. Displayed in STDOUT. -list_media Output to screen a listing of all media reports available by platform. Displayed in STDOUT. -list_client Output to screen a listing of all client reports available by platform. Displayed in STDOUT. -showdetail Used with -list_master, -list_media and -list_client. Provides Detail Type per report. Ex. Low, Medium and High. -help Usage Screen -version nbsupport Version
-individual_report_name Produces an individual report by name. Report Names provided in -list_master, -list_media and -list_client.
Provides a complete list of touch files that will disable individual reports.
Note: Some reports can take a long time to run in certain environments.
Use -detail low or -detail medium to limit reports.
To eliminate individual reports:
Use the -list_exception_files to show a listing of all touchfiles available to disable individual reports.
To disable a report, create the touchfile in the same folder as the nbsupport application.
Back to Usage:
Disclaimer:
The nbsupport application has not been localized: it is written and tested in English only. Using this application with a different language might produce unpredictable results.
The information contained in this publication is subject to change without notice. Symantec Corporation makes no warranty of any kind with regard to this manual, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. Symantec Corporation shall not be liable for errors contained herein or for incidental or consequential damages in connection with the furnishing, performance, or use of this manual.