Name
netbackup_deployment_insights — usage tool that gathers, analyzes, and reports master server information regarding clients and capacity
SYNOPSIS
--debug-inputs dir1 [dir2dir3]
--gather [--bpimagelist=options] <--capacity ¦ --traditional> [--hoursago=number] [--log=filename] [--master=hostname] [--nolog] [--output=directory] [--runtimestats] [-start date [-end date]] [--client-timeout seconds] [--exclude-clients client1[,client2,...]] [--exclude-clientlist path] [--exclude-all-clients] [--credential-file filename] [--apikey-file filename]
--report <--capacity ¦ --traditional> [--day-boundary=time] [dir1 dir2 dir# | --dirsfile=filename | --parentdir=directory] [--log=filename] [--nolog] [--overlap-details] [--runtimestats]
--retry dir1 [dir2dir#]
--version
On UNIX systems, the directory path to this command is /usr/openv/netbackup/bin/admincmd/
On Windows systems, the directory path to this command is install_path\NetBackup\bin\admincmd\
DESCRIPTION
With NetBackup 9.1, nbdeployutil is renamed to netbackup_deployment_insights. Cohesity recommends that you use the netbackup_deployment_insights command when you manually generate the license reports. You can continue to use the nbdeployutil command with the same options.
The netbackup_deployment_insights tool gathers and analyzes deployment information from the master server. The tool performs a deployment analysis according to one of two NetBackup licensing models, either Traditional Licensing or Capacity Licensing. A Traditional Licensing deployment analysis counts the number of clients and servers then compares this information against licensed options. Capacity Licensing deployment analysis calculates how much source data is protected.
The command is run in two steps. netbackup_deployment_insights gathers the data in the first step and analyzes the data in the second step.
The netbackup_deployment_insights command supports incremental reporting. With this feature, netbackup_deployment_insights runs based on a specified frequency to incrementally gather data and generate capacity-based licensing reports. For more information on how to enable and use this feature, see the NetBackup Administrator's Guide Volume II.
The tool generates a log file named nbdeployutil-gather-timestamp.log during the gathering operation. The tool generates a log file named nbdeployutil-report-timestamp.log during the analysis and the report generating operation. By default the log files are created in the directory where the gathered data resides.
For more information on Traditional and Capacity based licensing, see the NetBackup Administrator's Guide Volume II.
OPERATIONS
- --apikey-file filename
Use this option to specify path to a file containing the NetBackup API keys. The format of the file is as shown:
NetBackup primary server hostname : APIKey
There can be multiple NetBackup primary server host name entries. Place each primary server and its corresponding API key file on a new line. The netbackup_deployment_insights command uses the API key that corresponds to the NetBackup primary server host that it connects to.
NetBackup primary server hostname 1 : APIKey 1 NetBackup primary server hostname 2 : APIKey 2 NetBackup primary server hostname n : APIKey n
Cohesity recommends that you use API keys to authenticate the user to the NetBackup Web Management service. If multifactor authentication is configured, you must use API keys. For multiple NetBackup domains, ensure that you provide API keys for all the primary servers.
- --client-timeout seconds
This option enforces a time-out for bptestbpcd within nbdeployutil independent of the NetBackup configuration.
This option is only applicable if the --gather option is specified. The option not applicable if --capacity is specified.
- --debug-inputs
Converts the files that are used to generate the report into human-readable format. These new files are easier to read than the raw output. You can only specify the directories that contain basic ASCII characters. Directories with extended ASCII characters are not permitted.
- --exclude-all-clients
This option lets you exclude all clients from bptestbpcd connections. The specified clients show up in the report as unconnectable.
This option is only applicable if the --gather option is specified. The option not applicable if --capacity is specified.
- --exclude-clientlist path
Use this option to specify a file that contains a list of clients to exclude from bptestbpcd connections. List each client name on a separate line within the file. The specified clients show up in the report as unconnectable.
This option is only applicable if the --gather option is specified. The option not applicable if --capacity is specified.
- --exclude-clients client1[,client2,...]
This option lets you exclude any of the specified clients from bptestbpcd connections. The specified clients show up in the report as unconnectable.
This option is only applicable if the --gather option is specified. The option not applicable if --capacity is specified.
- --gather
Collects the data for analysis with the report option. You must use either the capacity or the traditional parameter when using the --gather operation. Only data for the specified license model (capacity or traditional) is collected.
When you run the netbackup_deployment_insights --gather command in capacity or traditional licensing, you are prompted for additional information. You must enter the credential information that is shown for authentication of the NetBackup web management service:
: Enter a domain type value from NIS, NISPLUS, WINDOWS, vx, unixpwd, ldap. This value is case-sensitive.
: 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.
: Name of the user that has administrator privileges.
: The 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.
- --report
Produces a license report based on the data that is collected with the gather option. Specify the directory or list of directories for the tool to use for the report. You must use either the capacity or the traditional parameter when using the --report operation.
- --retry
Reruns the gather operation and attempts to reconnect to hosts which failed during gather process as determined by the information in the gather directory. This action is helpful with the traditional licensing model when multiple hosts are reported as unreachable.
- --version
Returns the version of the command. This option is used to identify the latest NetBackup product version the command is designed to run against. The version string also indicates special versions of the tool, such as engineering binaries. This option is useful if tool was manually copied to a pre-7.1 master server.
OPTIONS
- --bpimagelist
Use to pass specific options to bpimagelist command during the gather part of the process.
- --capacity
Specifies the license model when used with gather or report. Use capacity to report on deployment according to NetBackup's per terabyte capacity licensing model.
- --credential-file filename
Used to specify the file that NetBackup reads for the credentials for user authentication. Use of this option allows NetBackup to read this information without the need to prompt the user for it. You can also specify credentials for multiple primary servers in the file.
The credential file must have the information shown in the order specified. Each item is on its own line. Repeat this order without empty lines for each additional primary server.
Primary server name Domain type Domain name Username Password
- --day-boundary
Moves the start of the report window for creating reports. The default report window starts at midnight and runs to 11:59:59 P.M. Specify the time value as hh:mm in 24-hour notation, where 6:00 A.M. is 06:00 and 6:00 P.M. is 18:00.
- --dirsfile
A file containing a list of directories which the report parameter uses to generate a report. This parameter is an alternative to listing all the files after the report parameter. You can also use the parentdir parameter to list a parent directory for the report parameter to use.
- --end
Specifies the end date for a restricted date range of the collection period. This option is used only with the start option. The format for this parameter is "MM/DD/YYYY hh:mm:ss". Specify the time value hh:mm:ss in 24-hour notation, where 6:00 A.M. is 06:00:00 and 6:00 P.M. is 18:00:00. Double quotation marks must surround the date time value.
- --hoursago
Changes the default value for the image gather time interval. The value is specified in hours. The default value is 2160 hours (90 days).
- --log
Forces the log output to go to a specific log file. By default, the log output is written to a log file within the directory where the gathered data and report is stored.
- --master
Gathers capacity licensing data for the specified master server. This option is only used with --gather. For the local host to gather data from a remote server, the host name must appear in the server list of the remote server.
This option only supports remotely gathered capacity licensing information. Remotely gathered traditional licensing data is not supported.
- --nolog
Disable the creation of the debug log file.
- --output
Saves the results in the indicated output directory. You can only specify the directories that contain basic ASCII characters. Directories with extended ASCII characters are not permitted. If the operation is a gather, the output directory holds gathered data. For report operations, the report and log file are put in the output directory instead of co-located with the gathered data in the specified input directory. If the output option is not specified, the output is placed in the following directory:
UNIX:
/usr/openv/var/global/reports/ YYYYMMDD_hhmmss_masterserverWindows:
install_path\NetBackup\var\global\reports\YYYYMMDD_hhmmss_masterserver
- --overlap-details
Displays the duplicate backup selections in the Duplicate Selections column of the capacity licensing report. This option can only be used for ASCII or English-only characters in the backup selection data.
- --parentdir
Specifies the top level in a directory tree containing many directories with the gathered licensing data that the report parameter should use to generate a report. You can also use the dirsfile parameter to specify a file that contains a list of directories.
- --runtimestats
Displays the run time statistics for the tool. The statistics include memory and CPU usage.
Example UNIX output:
stats mem 40.1 M, cpu 27.0% after splitting t/fixture/ nbdeployutil_sidon/bpimagelist_sidon.out stats mem 40.1 M, cpu 28.0% after parsing records from t/fixture/ nbdeployutil_sidon/tmp/policy_db_arc_tab_2gig_nt_client_totem7.out stats mem 40.6 M, cpu 50.0% after calculating for UNKNOWN-1 in t/fixture/nbdeployutil_sidon/ stats mem 40.6 M, cpu 51.0% after main report loop took 1 sec
- --start
Specifies the start date for a restricted date range for the collection period. The format for this parameter is "MM/DD/YYYY hh:mm:ss". Specify the time value hh:mm:ss in 24-hour notation, where 6:00 A.M. is 06:00:00 and 6:00 P.M. is 18:00:00. Be aware the double quotation marks around the date time value are required.
- --traditional
Used with gather or report to specify the license model. Use --traditional to report on deployment according to NetBackup traditional per server licensing model. The default value is 2160 hours (90 days).
- --verbose
Outputs detailed progress information of the tool to the screen, which has no effect on the information in the debug log file. The contents of the log file are always verbose.
PREREQUISITES
The following are the prerequisites for the netbackup_deployment_insights tool:
The master server daemons or services must run in the environment to gather the data.
Confirm that sufficient disk space exists on the master server that runs the gather command. Gathering capacity licensing data collects bpimagelist output for the previous 90 days. The size of the output is a function of the number of images in the catalog for that period. The default time period can be moved or shrunk. Shorter time range analysis causes less accurate or incomplete figures.
Microsoft Excel is required to view the report. The software does not have to be installed on the master server.
EXAMPLES
Example 1 - Collect data for a capacity licensing report. The directory paths are for a UNIX system, but this example applies to a Windows system as well.
# ./netbackup_deployment_insights --gather --capacity NetBackup Deployment Insights, version 9.0.1 Gathering license deployment information... Discovered master server punnbuucsm5b38-vm80 Enter credentials for Master Server(s): Master Server:punnbuucsm5b38-vm80 Domain Type (NIS, NISPLUS, WINDOWS, vx, unixpwd, ldap):unixpwd Domain Name :punnbuucsm5b38-vm80 User Name :root Password : Data gather is in progress. This process might take some time. Output for punnbuucsm5b38-vm80 at: /usr/openv/var/global/reports/ 20210309_101511_punnbuucsm5b38-vm80 Gather DONE Execution time: 25 secs To create a report for this master server, run the following: netbackup_deployment_insights --report --capacity /usr/openv/var/global/ reports/20210309_101511_punnbuucsm5b38-vm80 #
Example 2 - Generate a capacity licensing report with the data from example 1. The directory paths are for a UNIX system, but this example applies to a Windows system as well.
# ./netbackup_deployment_insights --report --capacity /usr/openv/var/ global/reports/20210309_101511_punnbuucsm5b38-vm80 NetBackup Deployment Insights, version 9.0.1 Analyzing license deployment ... Report created at: /usr/openv/var/global/reports/ 20210309_101511_punnbuucsm5b38-vm80/report-capacity-punnbuucsm5b38- vm80-20210309_101705.xls Analysis DONE Execution time: 0 sec #
Example 3 - Collect data for a traditional licensing report. The directory paths are for a UNIX system, but this example applies to a Windows system as well.
# ./netbackup_deployment_insights --gather --traditional NetBackup Deployment Insights, version 9.0.1 Gathering license deployment information... Discovered master server punnbuucsm5b38-vm80 Output for punnbuucsm5b38-vm80 at: /usr/openv/var/global/reports/ 20210309_101809_punnbuucsm5b38-vm80 Gather DONE Execution time: 9 secs To create a report for this master server, run the following: netbackup_deployment_insights --report --traditional /usr/openv/var/ global/reports/20210309_101809_punnbuucsm5b38-vm80 #
Example 4 - Generate a traditional licensing report with the data from example 3. The directory paths are for a UNIX system, but this example applies to a Windows system as well.
# ./netbackup_deployment_insights --report --traditional /usr/openv/var/ global/reports/20210309_101809_punnbuucsm5b38-vm80 NetBackup Deployment Insights, version 9.0.1 Analyzing license deployment ... Report created at: /usr/openv/var/global/reports/ 20210309_101809_punnbuucsm5b38-vm80/report-traditional-punnbuucsm5b38- vm80-20210309_101945.xls Analysis DONE Execution time: 1 sec #
Example 5 - Collect the data with capacity licensing as specified in the credential file that has multiple primary server credentials.
#./netbackup_deployment_insights --gather --capacity - -master=nb-host1,nb-host2 --credential-file /usr/openv/var/global/cred-file
The cred-file file contains the information shown:
nb-host1 unixpwd testdomain1 user1 testpass1 nb-host2 unixpwd testdomain2 user2 testpass2