Generating licensing reports manually
Run the nbdeployutil utility to gather data for a local master server, a remote master server, or a subset of clients. nbdeployutil can be run manually to generate a report for either the capacity or the traditional reporting model.
The utility generates the report in multiple steps. Data is gathered in the first step, and then analyzed and presented. The utility is located in the following directory:
On Windows: Install_dir\NetBackup\bin\admincmd\
On UNIX: /usr/openv/netbackup/bin/admincmd/
Table: nbdeployutil options to gather, analyze, and prepare reports
Task Number | Description |
|---|---|
Task 1 | The nbdeployutil utility uses the following options to gather data from one or more master servers. nbdeployutil --gather [--output=DIRECTORY]
[--capacity | --traditional] [--hoursago=N]
[--start="mm/dd/yyyy HH:MM:SS"
[--end="mm/dd/yyyy HH:MM:SS"]]
[--clientlist=FILENAME | --clients=HOSTNAME[,...]]
[--master=HOSTNAME[,...]] [--log=FILENAME]
[--runtimestats] [--nolog] [--bpimagelist=OPTIONS]
[--use-bpflist]The nbdeployutil utility gathers data remotely for multiple master servers from a central location, provided the master servers have granted the initiating server access. The utility supports collecting data remotely from back-level master servers. Load the engineering binary that is associated with this utility onto all master servers for which you want to gather information. |
Task 2 | The nbdeployutil utility uses the following options to analyze the gathered data and prepare the report: nbdeployutil --report
<--capacity | --traditional> <directory> ...
[--dirlist=FILENAME | --parentdir=DIRECTORY]
[--capacity] [--debug-inputs] [--log=FILENAME]
[--clientlist=FILENAME | --clients=HOSTNAME[,...]]
[--day-boundary=TIME] [--runtimestats] [--nolog]
[--overlap-details]For a traditional report, run: nbdeployutil --report --traditional For a capacity report, run: nbdeployutil --report --capacity |
Task 3 | Examine the results and make adjustments. |
On the master servers that have NetBackup 8.0 or later, when you manually run nbdeployutil for the gather operation in capacity licensing, you must enter the following credential information for authentication of the NetBackup web management service:
Table: Required credential information
Option | Description |
|---|---|
Domain Type | Enter a domain type value from NIS, NISPLUS, WINDOWS, vx, unixpwd, ldap. This value is case-sensitive. |
Domain Name | Name of the domain that the master server host belongs to. If the master server does not belong to any domain, enter the name of the master server. |
User name | Name of the user that has administrator privileges. |
Password | Password of the same user that has administrator privileges. When you enter the password, characters are intentionally not displayed in the command line. |
In a multi-master server scenario, you must enter the credentials for all the master servers that are mentioned with the gather command.
Note:
You must update any automation that you might have done of the nbdeployutil gather process for NetBackup master server 8.0 or later. This update is required because of the changes in nbdeployutil to accept user credentials.
The performance of the nbdeployutil utility is dependent on the system running it as well as the size of the NetBackup catalog. The --gather option only executes as quickly as the bpimagelist command can run for 90 days' worth of images. The speed of report generation is dependent on the number of images and fragments. The operating system running the command also affects the utility's performance.
Depending on the environment, the nbdeployutil utility can take from several seconds to several minutes to run the --gather or the --report options.
Veritas posts the most recent information about the nbdeployutil utility on the following website:
http://www.veritas.com/docs/TECH145972
In this example, the nbdeployutil utility is used to gather information for the local master server. Use the --capacity or the --traditional option, depending on the type of report you want to generate
C:\Program Files\Veritas\NetBackup\bin\admincmd>nbdeployutil --gather NetBackup Deployment Utility, version 8.1 Gathering license deployment information... Discovered master server master.example.com Master Server:master.example.com Domain Type (NIS, NISPLUS, WINDOWS, vx, unixpwd, ldap):WINDOWS Domain Name:example.com User Name:Administrator Password: Output for master.example.com at: C:\Program Files\Veritas\NetBackup\var\global\reports\ 20160525_151315_master.example.com Gather DONE Execution time: 9 secs To create a report for this master server, run one of the following: capacity : nbdeployutil.exe --report --capacity "C:\Program Files\Veritas\NetBackup\var\global\reports\ 20160525_151315_master.example.com" traditional: nbdeployutil.exe --report --traditional "C:\Program Files\Veritas\NetBackup\var\global\reports\ 20160525_151315_master.example.com"
The utility generates a log file named nbdeployutil-gather-timestamp.log during the gathering operation. By default, the log file is created in the directory where the gathered data resides.
nbdeployutil --gather --master=sidon.example.com
nbdeployutil --gather --client=dynamo,lettuce,marble2
or
nbdeployutil --gather --clientlist=filename.txt
Note:
When the --clients or the --clientlist option is used, some media servers may show in the report as not connectable, even though the utility can connect to them. This message does not affect the summary information.
Before you run nbdeployutil in a multi-master servers environment, complete the following steps as a one-time activity:
Create a trust relationship between the master servers.
For more information, refer to the Adding a trusted master server topic, from the Veritas NetBackup™ Administrator's Guide, Volume I.
On every remote master server in the multi-master server environment, add an entry of the master server where you plan to run nbdeployutil. From the NetBackup Administration Console, navigate to Host properties > select > right-click the remote master server > click > select > add the master server entry in the Additional Servers tab.