DOCUMENTATION AND DOWNLOAD: NetBackup Support Utility (NBSU) v1.3 Usage and Examples for 6.x. NBSU was released with 6.5, 6.0 MP6, and 5.1 MP7, and replaces what is known as "nbsupport" in previous versions.

Article:TECH77882  |  Created: 2009-01-11  |  Updated: 2013-10-24  |  Article URL http://www.symantec.com/docs/TECH77882
Article Type
Technical Solution

Product(s)

Environment

Issue



DOCUMENTATION AND DOWNLOAD: NetBackup Support Utility (NBSU) v1.3 Usage and Examples for 6.x. NBSU was released with 6.5, 6.0 MP6, and 5.1 MP7, and replaces what is known as "nbsupport" in previous versions.


Solution



Description:
The NetBackup Support Utility (NBSU) is a Symantec utility used to gather diagnostic information about the system on which the utility is run. By default, NBSU gathers appropriate diagnostic information based on the Operating System and NetBackup environment.  With the availability of many command line options, the diagnostic information gathered can be tuned as desired.


Pre-requisites:
- NBSU is designed for use with NetBackup version 3.4 and greater.

- In order for NBSU to be able to create a support package (if required), the path to the following programs must be included in the $PATH environment variable:
   tar
   gzip

Note: If gzip is not available, the "compress" program is used, if available.

Note: If these programs are not available, a single XML formatted output file is created.

- For master and media server environments, the appropriate services or daemons must be up and running.

Program Usage:
- If there are no command line options specified, NBSU selects and runs all appropriate diagnostics and gathers all available information.

- To see a list of the diagnostic commands NBSU will select, run NBSU with the -l command line option.

- If individual diagnostic commands, groups of related diagnostic commands, configuration or troubleshooting related diagnostic commands, or NetBackup or Media Manager exit status related diagnostic commands are desired, use the appropriate command line option(s) as desired.

- If individual diagnostic commands or groups of related diagnostic commands are desired to be skipped, use the -s command line option.

Phase I - Determine Operating system environment information including:
  • Operating system name and version
  • Hostname
  • Domain name
  • System root directory
  • Configured host services
Phase II - Determine NetBackup environment information including:
  • NetBackup installation path
  • NetBackup version
  • NetBackup release information
  • NetBackup NBAC authentication (interactive only)
  • NetBackup host "role"
Master server
Media server
Disk Media server
Tape Media server
Volume Database host (if applicable)
EMM server (if applicable)
Global Domain Manager
Client
Remote Administration Host

Phase III - Gather diagnostic lists:
  • Operating System (OS) related diagnostics
  • Device (DEV) related diagnostics
  • Network (NET) related diagnostics
  • NetBackup (NBU) related diagnostics
  • Media Manager (MM) related diagnostics
Phase IV - Select the diagnostic commands or procedures to execute:
  • Command line options
  • OS release level
  • NetBackup version level
  • NetBackup host role
Phase V - Execute the selected diagnostic commands or procedures:
  • Commands   = single command line diagnostic
  • Procedures = multi-step diagnostic.  Groups of related command line diagnostics.
Phase VI - NBSU final processing, including:
  • Process the  information file
  • Remove temporary files
  • Update the history file
  • If necessary, create a bundled support package


Command line options

-c   = Run only diagnostic commands or procedures that are related to the NetBackup "configuration".

-d <name>     = Run only the diagnostic command or procedure listed.  For a list of diagnostic commands or procedures, run "nbsu" with the -l command line option.
Note:  There may be multiple -d options listed. ex.  -d OS_general -d OS_env

-debug  = Run "nbsu" in debug mode.
Note:  Debug mode places additional program information into the  file.

-g <name>     = Run only the diagnostic commands or procedures related to the group name.  Diagnostic groups are "OS", "DEV", "NET", "NBU" and "MM".
Note:  There may be multiple -g options listed. ex.  -g OS -g DEV

-h            = Display terse "nbsu" command line help information.

-H            = Display full "nbsu" help information.

-help      = Display full "nbsu" help information.

-i            = "Interactive" mode.  Used to log in as a NetBackup security administrator.  

-l            = List the diagnostic commands that would be selected to run. Can be used with other command line options to display the appropriate diagnostic commands or procedures.

-L            = List all of the nbsu 1.3 diagnostics and commands.  Can be used to output a detailed report of each diagnostic to STDOUT.  Includes selection criteria and commands that will be executed.

-mm_e <###> = Run only the diagnostic commands or procedures related to the Media Manager exit status.
Note:  There may be multiple -mm_e options listed. ex. -mm_e 12 -mm_e 20

-nbu_down   = Run only the diagnostic commands or procedures that do not make use of NetBackup or Media Manager commands.
Note:  Use of this command line options results in DEV, NET, OS and select NBU and MM diagnostics being selected.

-nbu_e <###> = Run only the diagnostic commands or procedures related to the NetBackup exit status.
Note:  There may be multiple -nbu_e options listed. ex.  -nbu_e 25 -nbu_e 41

-nozip        = Do not compress the output file(s).

-no_nbu      = Run only DEV, NET and OS related diagnostics.

-r <NBU role> = Run only the diagnostic commands or procedures related to the NetBackup host role.  Accepted host role parameters are abbreviations:
                 ma = Master server
                 me = Media server
                 d_me = Disk Media server
                 t_me = Tape Media server
                 cl = Client
                 emm = EMM server
                 gdm = Global Domain Manager
                 rah = Remote Administration Host
 
              Note:  There may be multiple -r options listed. ex. -r ma -r cl

-s <name>     = Skip the diagnostic command, procedure or group listed.  For a list of diagnostic commands or procedures, run "nbsu" with the -l command line option.  Diagnostic groups are "OS", "DEV", "NET", "NBU" and "MM".
               Note:  There may be multiple -s options listed. ex. -s OS_general -s DEV

-t          = Run only diagnostic commands or procedures that are related to the NetBackup "troubleshooting".

-v          = Output the internal version of "nbsu".

-xml      = Output all "nbsu" output into a single XML formatted file.


Examples
List the diagnostics that would be selected to run on a NetBackup node:
# ./nbsu -l

Select an individual diagnostic command to run and to not zip the resulting support bundle:
# ./nbsu -d NBU_version -nozip

Select the network group of diagnostics to run, but skip the NET_dd diagnostic:
# ./nbsu -g NET -s NET_dd
Select the diagnostics associated with the Netbackup exit status code 41:
# ./<nbsu> -nbu_e 41
 

Attachments

1.3_nbsu_338509.zip (12.4 MBytes)


Legacy ID



338509


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


Terms of use for this information are found in Legal Notices