Search <book_title>...

NetBackup IT Analytics Help

Last Published: 2023-03-01

Product(s): NetBackup IT Analytics (11.0)

Add a Veritas NetBackup Data Collector policy

The User ID and Passcode configured in this step will be used later when you install the Data Collector software on the Data Collector server. This configuration enables communication between the Portal and the Data Collector server.

Before adding the policy: A Data Collector must exist in the Portal, to which you will add Data Collector Policies.
See Adding/Editing Data Collectors for more information.
For specific prerequisites and supported configurations for a specific vendor, see the Certified Configurations Guide.
After adding the policy: For some policies, collections can be run on-demand using the Run button on the Collector Administration page action bar. The Run button is only displayed if the policy vendor is supported.
On-demand collection allows you to select which probes and devices to run collection against. This action collects data the same as a scheduled run, plus logging information for troubleshooting purposes. For probe descriptions, refer to the policy.

To add the policy

Select Admin > Data Collection > Collector Administration. Currently configured Portal Data Collectors are displayed.
Search for a Collector if required.
Select a Data Collector from the list.
Click Add Policy, and then select the vendor-specific entry in the menu.
Specify Data Collector Properties.
Add or select the parameters. Mandatory parameters are denoted by an asterisk (*).
Optionally, add/edit a NetBackup Master server from the policy screen. These operations can also be completed in the Inventory.
See Table: Policy Parameters.
Click OK to save the Policy.
On the Data Collector server, install/update the Data Collector software.

Table: Policy Parameters

Field	Description
Collector Domain	The domain of the collector to which the collector backup policy is being added. This is a read-only field. By default, the domain for a new policy will be the same as the domain for the collector. This field is set when you add a collector.
Policy Domain	The Collector Domain is the domain that was supplied during the Data Collector installation process. The Policy Domain is the domain of the policy that is being configured for the Data Collector. The Policy Domain must be set to the same value as the Collector Domain. The domain identifies the top level of your host group hierarchy. All newly discovered hosts are added to the root host group associated with the Policy Domain. Typically, only one Policy Domain will be available in the drop-down list. If you are a Managed Services Provider, each of your customers will have a unique domain with its own host group hierarchy.
NetBackup Master Servers	Select the NetBackup Master Server(s) from which data will be collected. Multi-select is supported. Only available NetBackup Master Servers are displayed. For example, if a server has been decommissioned or it has been selected for use by another policy, it will not be displayed.
Add	Click Add to add a NetBackup server. Added servers are also displayed in the Inventory. See Add/Edit NetBackup Master Servers within the Data Collector policy. Note: If the hosts already exists, NetBackup IT Analytics displays a confirmation dialog box to update the Host Details (including the Host Type). Click Ok to update Host details / Host Type.
Edit	Select a server and click Edit to update the server values.
Backup Software Location on the Server (Data Collector or NetBackup Master)	Backup Software Location should point to a location on either the Data Collector server or the NetBackup Master Server. The location should either be the root folder or directory to the netbackup/volmgr folder(s) where the NetBackup software is installed. Note: If you are using the SSH/WMI remote collection method, this location is where the NetBackup software is installed on all the remote NetBackup Master Servers that are configured. Default Backup Software Home location for NetBackup: For Windows: C:\Program Files\Veritas. For Linux: /usr/openv.
Collection Method	Select from NetBackup Software on a Data Collector Server (default) or SSH or WMI protocol to NetBackup Master Server. When NetBackup Software on Data Collector Server is selected, then the probe NetBackup Event Monitor is unselected, and following probes are selected: Storage Unit Details, Storage Lifecycle Policies, and Backup Policies. When SSH or WMI protocol to NetBackup Master Server is selected, the probe NetBackup Event Monitor is unselected and disabled.
Remote Probe Login Details	These details are required for either of the following conditions: The collector is centralized and the SLP Job Details, License Details, or Backup Policies probe is selected. The collector is distributed and the Backup Policies probe is selected. The Collection Method is SSH or WMI protocol to the NetBackup Master Server.
Master Server Domain	Specify the domain associated with the NetBackup Master Server User ID. For Windows Master Servers, this domain is used, in conjunction with the User ID, for the execution of the remote lifecycle policies utility (nbstlutil) by the SLP Job Details probe, when the Data Collector is not installed on the NetBackup Master Server; unused for remote Linux Master Servers. In addition, for NetBackup 7.7.3 only, this domain is used by the License Details probe to collect plugin information (bpstsinfo). For NetBackup 8.3 and above, this domain is used by Backup Policies probe (FETB and Protection Plan collection) for REST API based authentication. This field is required when the Collection Method is SSH or WMI protocol to the NetBackup Master Server and that Master Server is a Windows Server.
Master Server User ID	This field is required when the Collection Method is SSH or WMI protocol to the NetBackup Master Server. Specify the user name with login rights on the selected NetBackup Master Server. The user name and password are used for the execution of the remote lifecycle policies utility (nbstlutil) by the SLP Job Details probe, when the Data Collector is not installed on the NetBackup Master Server. In addition, for NetBackup 7.7.3 only, the credentials are used by the License Details probe to collect plugin information (bpstsinfo). A Windows user name requires administrative privileges. In case of NetBackup 8.3 and above, these credentials are also used by the Backup Policies probe for REST API based authentication. These credentials will be used for all Master Servers. If SSH/WMI collection is specified, the username must have superuser privileges to run most NetBackup commands.
Master Server Password	This field is required when the Collection Method is SSH or WMI protocol to the NetBackup Master Server. The password associated with the NetBackup Master Server User ID. The user name and password are used for the execution of the remote lifecycle policies utility (nbstlutil) by the SLP Job Details probe, when the Data Collector is not installed on the NetBackup Master Server. In addition, for NetBackup 7.7.3 only, the credentials are used by the License Details probe to collect plugin information (bpstsinfo). In case of NetBackup 8.3 and above these credentials are also used by the Backup Policies probe for REST API based authentication. These credentials will be used for all Master Servers. If password-based login to NetBackup Master Server is not allowed, for example in cloud deployment of NetBackup, then SSH private key can be specified here in the following format: `privateKey=<path-of-private-key>\|password=<passphrase>` where: <path-of-private-key>\| is the file path of the SSH private key. <passphrase> is the password used while creating the SSH private key. See Prerequisites for collection from Veritas NetBackup deployed as a Docker image.
WMI Proxy Address	Specify the IP address or hostname of the WMI Proxy. If this field is blank, 127.0.0.1 will be used. This is used for remote nbstlutil execution of the SLP Job Details probe, when the Data Collector is not installed on the NetBackup Master Server. In addition, for NetBackup 7.7.3 only, this is used by the License Details probe to collect plugin information (bpstsinfo). For NetBackup 8.3 and above, this domain is used by Backup Policies probe (FETB and Protection Plan collection) for REST API based authentication. This field is required when the Collection Method is SSH or WMI protocol to the NetBackup Master Server and that Master Server is a Windows Server.
Active Probes
Tape Library & Drive Inventory	Select the check box to activate Tape Library data collection from your NetBackup environment. The default polling frequency is every 12 hours. Click the clock icon to create a schedule frequency for collecting data. You can schedule the collection frequency by minute, hour, day, week and month. Advanced use of native CRON strings is also available. Optimize performance by scheduling less frequent collection. Note: Explicit schedules set for a Collector policy are relative to the time on the Collector server. Schedules with frequencies are relative to the time that the Data Collector was restarted.
Tape Inventory	Select the check box to activate Tape data collection from your NetBackup environment. The default polling frequency is every 18 hours. Click the clock icon to create a schedule frequency for collecting data. You can schedule the collection frequency by minute, hour, day, week and month. Advanced use of native CRON strings is also available. Optimize performance by scheduling less frequent collection. Note: Explicit schedules set for a Collector policy are relative to the time on the Collector server. Schedules with frequencies are relative to the time that the Data Collector was restarted.
Drive Status	Select the check box to activate Tape Drive status collection from your NetBackup environment. The default polling frequency is every 20 minutes. This probe is selected by default. Click the clock icon to create a schedule frequency for collecting data. You can schedule the collection frequency by minute, hour, day, week and month. Advanced use of native CRON strings is also available. Note: Explicit schedules set for a Collector policy are relative to the time on the Collector server. Schedules with frequencies are relative to the time that the Data Collector was restarted.
Job Details	Select the check box to activate Job data collection from your NetBackup environment. The polling frequency would depend on the value of ENABLE_MINUS_T_OPTION advanced parameter. Refer to Backup Manager advanced parameters section for more details on ENABLE_MINUS_T_OPTION parameter. This probe is selected by default. Click the clock icon to create a schedule frequency for collecting data. You can schedule the collection frequency by minute, hour, day, week and month. Advanced use of native CRON strings is also available. Note: Explicit schedules set for a Collector policy are relative to the time on the Collector server. Schedules with frequencies are relative to the time that the Data Collector was restarted.
Duplication Jobs	Select the check box to activate Duplication Job data collection from your NetBackup environment. The default polling frequency is every 60 minutes. This probe is selected by default. Click the clock icon to create a schedule frequency for collecting data. You can schedule the collection frequency by minute, hour, day, week and month. Advanced use of native CRON strings is also available. Note: Explicit schedules set for a Collector policy are relative to the time on the Collector server. Schedules with frequencies are relative to the time that the Data Collector was restarted.
Backup Message Logs	Select the check box to activate Message Log (bperror) data collection from your NetBackup environment. The default polling frequency is every 60 minutes. This probe is selected by default. Click the clock icon to create a schedule frequency for collecting data. You can schedule the collection frequency by minute, hour, day, week and month. Advanced use of native CRON strings is also available. Note: Explicit schedules set for a Collector policy are relative to the time on the Collector server. Schedules with frequencies are relative to the time that the Data Collector was restarted.
SLP Job Details	Select the check box to activate SLP Job Details collection from your NetBackup environment. The default polling frequency is every 6 hours. Note: When selecting this SLP Job Details option, if you are using centralized NetBackup data collection, you must also configure the settings in the Login Details for Remote Probes section of this Data Collector policy.
Clients Detail	Select the check box to activate Client Details data collection from your NetBackup environment. This probe connects directly to each NetBackup client to collect and persist environmental details. The default polling frequency is once a week. This probe is selected by default. Click the clock icon to modify the scheduled frequency for collecting data. You can schedule the collection frequency by minute, hour, day, week, and month. Advanced use of native CRON strings is also available. The default collection is scheduled to start on Tuesday at 9:00 a.m. Note: Explicit schedules set for a Collector policy are relative to the time on the Collector server. Schedules with frequencies are relative to the time that the Data Collector was restarted.
Audit Events	The Audit Events probe collects the audit events such as user login success or failure, policy modification etc. from Netbackup Master server. Select the check box to activate Audit Events data collection from your NetBackup environment. This probes connects directly to NetBackup Master server to collect and persist the audit details. The default schedule is every 1 hour. You can configure the Advanced parameter NBU_AUDIT_LOOKBACK_DAYS for the first time collection of the NetBackpup Audit events. By default, it collects events from last 3 days for the first time. Change the value of this advanced parameter to collect events that are anything other than 3 days. See NBU_AUDIT_LOOKBACK_DAYS. Note: Explicit schedules set for a Collector policy are relative to the time on the Collector server. Schedules with frequencies are relative to the time that the Data Collector was restarted
License Details	Select the check box to activate License Details data collection from your NetBackup environment. This probes collects and persists license key information for NetBackup. The default polling frequency is monthly. This probe is selected by default. Click the clock icon to create a schedule frequency for collecting data. You can schedule the collection frequency by minute, hour, day, week and month. Note: Explicit schedules set for a Collector policy are relative to the time on the Collector server. Schedules with frequencies are relative to the time that the Data Collector was restarted.
Client Exclude/Include List Details	Select the check box to activate Client Exclude/Include List Details data collection from your NetBackup environment. This probe collects from Linux/Unix and Windows NetBackup clients. This probe connects directly to each NetBackup client to collect and persist the NetBackup client exclude/include list of files and directories. The default polling frequency is monthly. This probe is selected by default. Click the clock icon to create a schedule frequency for collecting data. You can schedule the collection frequency by minute, hour, day, week and month. Note: Explicit schedules set for a Collector policy are relative to the time on the Collector server. Schedules with frequencies are relative to the time that the Data Collector was restarted.
NetBackup Event Monitor	Collects events generated by the nb_monitor_util executable present in the NBU installation. Events include create/update/ delete for Backup Policies, Storage Unit Details, Storage Unit Groups and Storage Lifecycle Policies. This probe is selected by default for new installations. NetBackup Event Monitor is disabled if WMI/SSH collection is enabled.
Storage Unit Details	Select the checkbox to activate Storage Unit data collection from your NetBackup environment. The default polling frequency is every 4 hours. This probe is selected by default. Click the clock icon to create a schedule frequency for collecting data. You can schedule the collection frequency by minute, hour, day, week and month. Advanced use of native CRON strings is also available. Note: Explicit schedules set for a Collector policy are relative to the time on the Collector server. Schedules with frequencies are relative to the time that the Data Collector was restarted.
Storage Lifecycle Policies	When selecting this option, you must also configure settings in the Login Details for Remote Probes section of this Data Collector policy. Select the check box to activate Storage Lifecycle Policy (SLP) collection from your NetBackup environment. The default polling frequency is every 8 hours. This probe is selected by default. Click the clock icon to create a schedule frequency for collecting data. You can schedule the collection frequency by minute, hour, day, week and month. Advanced use of native CRON strings is also available. Note: Explicit schedules set for a Collector policy are relative to the time on the Collector server. Schedules with frequencies are relative to the time that the Data Collector was restarted.
Backup Policies	Performs Backup Policy data collection from your NetBackup environment. This probe also collects the FETB and protection plan data using REST APIs, provided the NetBackup version is 8.3 or later. You need to provide the REST API credentials under Remote Probe Login Details to allow the APIs to collect data. This probe is enabled by default and is not editable. The FETB data collected is also validated against the license entitlement of the subscription. The default polling frequency is every 8 hours. Click the clock icon to create a schedule frequency for collecting data. You can schedule the collection frequency by minute, hour, day, week and month. Advanced use of native CRON strings is also available. NetBackup IT Analytics supports VMware, Hyper-V, Oracle, MSSQL intelligent policies in NetBackup. As a part of Oracle and MSSQL intelligent policies, the instance details backed up by policy is displayed in NetBackup Policies Details report. Note: Explicit schedules set for a Collector policy are relative to the time on the Collector server. Schedules with frequencies are relative to the time that the Data Collector was restarted.
NetBackup Resources Monitor	Select the checkbox to activate NetBackup Resources data collection from your NetBackup environment. The probe does not have a default schedule. Once enabled, it collects data received from the NetBackup IT Analytics Exporter installed on the NetBackup Master Server. When you enable this probe, the NetBackup Master Server (Internal Name) is added to Compute Resources Data Collection Policy. If there is no existing policy, a new policy for Compute Resources is added. Note that the Internal Name of the NetBackup Master server must match the instance (Hostname) of the NetBackup Master Server. See the NetBackup IT Analytics Exporter Installation and Configuration Guide for details on exporter installation.
Notes	Enter or edit notes for your data collector policy. The maximum number of characters is 1024. Policy notes are retained along with the policy information for the specific vendor and displayed on the Collector Administration page as a column making them searchable as well.
Download SSL Certificate	Downloads the SSL certificate required to set up NetBackup IT Analytics Exporter on the NetBackup Master Server. See the NetBackup IT Analytics Data Exporter Installation and Configuration Guide for details on exporter installation.
Test Connection	Test Connection initiates a Data Collector process that attempts to connect to the subsystem using the IP addresses and credentials supplied in the policy. This validation process returns either a success message or a list of specific connection errors. Test Connection requires that Agent Services are running. Test Connection checks if the utility nb_monitor_util is installed. This is required to use the probe NetBackup Event Monitor. It also checks if the REST APIs were successfully executed against the NetBackup Master. For REST APIs to succeed, you must provide the user credentials of the NetBackup Master that has REST API access. The FETB and Protection Plan collection fails in absence of the user credentials. Several factors affect the response time of the validation request, causing some requests to take longer than others. For example, there could be a delay when connecting to the subsystem. Likewise, there could be a delay when getting the response, due to other processing threads running on the Data Collector. You can also test the collection of data using the Run functionality available in Admin>Data Collection>Collector Administration. This On-Demand data collection run initiates a high-level check of the installation at the individual policy level, including a check for the domain, host group, URL, Data Collector policy and database connectivity. You can also select individual probes and servers to test the collection run.

See Veritas NetBackup SSH: Changing the Linux Temporary Directory for Collection.