Veritas NetBackup™ Commands Reference Guide
- Introduction
- Appendix A. NetBackup Commands
Name
nbsu — run the NetBackup Support Utility
SYNOPSIS
[-c] [-d diag] [-debug] [-g diag_group] [-h] [-H] [-i] [-l] [-L] [-mm_e ###] [-nbu_down] [-nbu_e ###] [-no_nbu] [-nozip] [-odir destination_directory] [-r NBU_host_role] [-s diag_group] [-t] [-use_reg_cmd [32 | 64]] [-v] [-xml]
On UNIX systems, the directory path to this command is /usr/openv/netbackup/bin/support/
On Windows systems, the directory path to this command is <install_path>\NetBackup\bin\support\
DESCRIPTION
The nbsu command is a Veritas utility that gathers a wide range of diagnostic information. By default, nbsu gathers the appropriate diagnostic information that is based on the operating system and NetBackup environment. Several command line options enable the diagnostic information that is gathered to be customized as desired.
If necessary, create a bundled support package. nbsu creates the following nbsu and output directories:
/usr/openv/netbackup/bin/support/nbsu
/usr/openv/netbackup/bin/support/output/nbsu
If Technical Support supplies you with a case ID of the form ########, save the log files with the case ID number. Then manually upload the files to the Veritas Evidence server. More information is available:
PREREQUISITES
The following items are needed before you can use the nbsu command:
nbsu is designed for use with NetBackup version 3.4 and greater.
If you use the -no_nbu command line option, nbsu can be run without NetBackup installed.
For nbsu to create a support package (if required), the path to the tar and gzip programs must be included in the $PATH (UNIX) environment variable. If gzip is not available, the utility uses the compress program, if available.
To run NetBackup or media manager diagnostics, the appropriate services or daemons must be running in the master server and media server environments.
Use the -nbu_down option to select only the diagnostics that do not use any NetBackup or media manager commands.
PROGRAM USAGE
Consider the following items when you program using the nbsu command:
With no command line options, nbsu selects all appropriate diagnostics to run and gather information.
To view a list of the diagnostic commands that nbsu selects, run nbsu with the -l command line option.
Use the appropriate command line options for the following items:
Individual diagnostic commands
Groups of related diagnostic commands
Configuration or troubleshooting-related diagnostic commands
NetBackup or Media Manager exit status-related diagnostic commands
To omit individual diagnostic commands or groups of related diagnostic commands, use the -s command line option.
OPTIONS
- -c
Runs only NetBackup configuration-related commands or procedures. This option is the default condition.
- -d diag
Runs only the diagnostic command or procedure listed. For a list of diagnostic commands or procedures, run nbsu with the -l command line option. Multiple -d options may appear in the list. For example:
-d OS_general -d OS_env
- -debug
Runs nbsu in debug mode. Debug mode places additional program information into the file.
- -g group_name
Runs only the diagnostic commands or procedures that are related to the group name. Diagnostic groups are "OS", "DEV", "NET", "NBU", and "MM". Multiple -g options may be listed. For example:
-g OS -g DEV
- -h
Displays the terse nbsu command-line help information.
- -H
Displays the full nbsu command-line help information.
- -i
Interactive mode. Used to log on as a NetBackup security administrator.
- -l
Lists the diagnostic commands to be selected to run. Use with other command line options to display the appropriate diagnostic commands or procedures.
- -L
Lists all of the nbsu 1.0 diagnostics and commands. Can be used to output a detailed report of each diagnostic to STDOUT. Includes the selection criteria and commands to be executed.
- -mm_e ###
Runs only the diagnostic commands or procedures that are related to the Media Manager exit status. Multiple -mm_e options may be listed. For example:
-mm_e 12 -mm_e 20
- -nbu_down
Runs only the diagnostic commands or procedures that do not make use of NetBackup or media manager commands. This command line option selects DEV, NET, and OS diagnostics and a subset of NetBackup and media manager diagnostics.
- -nbu_e ###
Runs only the diagnostic commands or procedures that are related to the NetBackup exit status. Multiple -nbu_e options may be listed. For example:
-nbu_e 25 -nbu_e 41
- -no_nbu
Runs only DEV, NET, and OS-related diagnostics.
- -nozip
Specifies that the output files are not to be compressed.
- -odir destination_directory
Redirects the nbsu diagnostic output to the specified directory. If the directory does not exist, nbsu tries to create it. If the directory path contains space characters, use leading and trailing double quote characters to identify the path. nbsu does a cursory check for invalid characters in the destination directory path name.
- -r host_role
Runs only the diagnostic commands or procedures that are related to the NetBackup host role. The following are the accepted host role parameter 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
Multiple -r options may be listed. For example:
-r ma -r cl
- -s name
Skips 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. Multiple -s options may be listed. For example:
-s OS_general -s DEV
- -t
Runs only the diagnostic commands or procedures that are related to the NetBackup troubleshooting.
- -use_reg_cmd [32 | 64]
This option operates only on Windows systems.
This option enables the use of the Reg.exe utility to query the Windows registry. The version of Reg.exe that supports the /reg:32 or the /reg:64 command line parameters must be installed so that this option works correctly.
- -v
Outputs the internal version of nbsu.
- -xml
Outputs all nbsu output into a single XML formatted file.
EXAMPLES
Example 1 - List the diagnostics to be selected to run on a NetBackup node:
# nbsu -l
Example 2 - Select an individual diagnostic command to run; do not compress the resulting support bundle:
# nbsu -d NBU_version -nozip
Example 3 - Select the network group of diagnostics to run, but skip the NET_etc_hosts diagnostic:
# nbsu -g NET -s NET_etc_hosts
Example 4 - Select the diagnostics that are associated with the NetBackup exit status code 41:
# nbsu -nbu_e 41
Example 5 - List the diagnostics that would be selected to run for the network diagnostic groups and operating system diagnostic groups on a NetBackup node:
# nbsu -l -g NET -g OS
Example 6 - Select an individual diagnostic command to run and to not compress the resulting support bundle:
# nbsu -d NBU_version -nozip
Example 7 - Select the network and operating system groups of diagnostics to run, but skip the NET_dd diagnostic:
# nbsu -g NET -s NET_dd -g OS
Example 8 - Select the diagnostics that are associated with the NetBackup exit status codes 21, 25, and 41:
# nbsu -nbu_e 21 -nbu_e 25 -nbu_e 41