NetBackup IT Analytics Data Collector Installation Guide for File Analytics

Last Published:
Product(s): NetBackup IT Analytics (11.3)
  1. Pre-Installation setup for File Analytics
    1.  
      Pre-Installation setup for File Analytics
    2.  
      File Analytics Data Collection overview
    3.  
      File Analytics Data Collection architecture
    4.  
      File Analytics Data Collector policies
    5.  
      Prerequisites for adding Data Collectors (File Analytics)
    6.  
      CIFS shares
    7. Host Discovery and Collection File Analytics probe
      1.  
        File Analytics Probe Configurations by operating system
      2.  
        Both Windows and Linux servers
      3.  
        Best practices for host Inventory File Analytics probes
    8. Adding a File Analytics Data Collector policy
      1.  
        Importing the CIFS share configuration
    9.  
      Set up FIPS compliant Data Collector for File Analytics
  2. File Analytics Export Folder Size and Folder Depth
    1.  
      Extracting File Analytics export folder size
    2.  
      Specifying the File Analytics folder depth
  3. Installing the Data Collector software
    1.  
      Introduction
    2.  
      Installing the WMI Proxy service (Windows host resources only)
    3.  
      Testing WMI connectivity
    4.  
      Considerations to install Data Collector on non-English systems
    5.  
      Install Data Collector Software on Windows
    6.  
      Install Data Collector software on Linux
    7.  
      Deploy Data Collector in native Kubernetes environment
  4. Validating Data Collection
    1.  
      Validation methods
    2.  
      Data Collectors: Vendor-Specific validation methods
    3. Working with on-demand Data Collection
      1.  
        View real-time logging during an on-demand collection
      2.  
        Generating debug level logs during an on-demand collection
    4.  
      Using the CLI check install utility
    5.  
      List Data Collector configurations
  5. Uninstalling the Data Collector
    1.  
      Uninstall the Data Collector on Linux
    2.  
      Uninstall the Data Collector on Windows
  6. Manually starting the Data Collector
    1.  
      Introduction
  7. File Analytics Export folder size and folder depth
    1.  
      Extracting File Analytics export folder size
    2.  
      Specifying the File Analytics folder depth
    3.  
      Data export
  8. Appendix A. Firewall configuration: Default ports
    1.  
      Firewall configuration: Default ports

Adding a File Analytics Data Collector policy

One of the types of data collection that can be configured for File Analytics is collection of CIFS shares. The Data Collector will take the configuration that you specify, including the share names and credentials, and then traverse the file system structure to identify these shared resources on your network and collect the relevant metadata.

Before adding the policy: A Data Collector must exist in the Portal, to which you will add Data Collector Policies.

For specific prerequisites and supported configurations for a specific vendor, see the Certified Configurations Guide.

To add the policy

  1. Select Admin > Data Collection > Collector Administration. Currently configured Portal Data Collectors are displayed.
  2. Search for a Collector if required.
  3. Select a Data Collector from the list.
  4. Click Add Policy, and then select File Analytics policy.
  5. Enter or select the parameters. Mandatory parameters are denoted by an asterisk (*):

    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.

    To find your Domain name, click your login name and select My Profile from the menu. Your Domain name is displayed in your profile settings.

    Name*

    Enter a name that will be displayed in the list of Data Collector policies.

    Schedule*

    Click the clock icon to create a schedule. Every Minute, Hourly, Daily, Weekly, and Monthly schedules may be created. Advanced use of native CRON strings is also available.

    Examples of CRON expressions:

    */30 * * * * means every 30 minutes

    */20 9-18 * * * means every 20 minutes between the hours of 9am and 6pm

    */10 * * * 1-5 means every 10 minutes Mon - Fri.

    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.

    Shares*

    Click Add to configure the CIFS shares that the collector will probe.

    Click Edit to modify a CIFS share configuration.

    Note that the Import button in this window enables bulk loading of CIFS shares.

    See Importing the CIFS share configuration.

    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.

  6. Enter or select CIFS shares configuration parameters in the File Analytics Shares window.

    Field

    Description

    Sample Value

    Host/Device*

    Enter the host IP address or host name for the device that is being probed for CIFS shares. This also could be a non-host device, such as a NetApp array.

    172.1.1.1

    Share*

    Enter the name of the CIFS share that the Data Collector will probe.

    HOME

    Protocol*

    CIFS is currently the only option.

    Authentication

    Click either Anonymous or Use Credentials.

    If you are using credentials, click Add to configure the CIFS share credentials, or select an existing credential definition and click Edit.

  7. Enter credentials in the Credentials window.

    Field

    Description

    Sample Value

    Name*

    Assign a name to identify the set of credentials that you are defining.

    Account*

    Enter the login account name used to log in to the hosts. If the policy includes a group of Windows hosts, use the Windows Domain user ID. This user ID must have administrative privileges.

    For Linux hosts, super-user root privileges are required. You also could use an access control command, such as sudo, sesudo, or pbrun. If using any of these access commands, ensure that the user ID has sudo, sesudo, or pbrun privileges. Some enterprises prefer to create a new user and provide access to commands via an access control command.

    root

    Description

    Enter a note to help identify the credential.

    Password

    Enter the password for the account

    OS Type*

    Select either Windows, Linux, or NAS

    Windows Domain*

    For Windows hosts only: Specify the Windows domain name. If the host is not a member of a domain, or to specify a local user account, use a period (.)

    Private Key File

    For Linux hosts only: If you have configured a Public/Private Key between your Data Collector server and the hosts you intend to monitor, specify the location of the Private Key file on the Data Collector Server.

    Known Hosts File

    For Linux hosts only: If you have configured a Public Key/Private Key between your Data Collector server and the hosts you intend to monitor, specify the location of the Known Hosts file on the Data Collector Server.

  8. Click OK to close and save the configuration in each window.