NetBackup IT Analytics Data Collector Installation Guide for the Cloud

Last Published:
Product(s): NetBackup IT Analytics (11.0)
  1. Pre-Installation Setup for Amazon Web Services (AWS)
    1.  
      Pre-Installation setup for Amazon Web services (AWS)
    2.  
      Prerequisites for adding Data Collectors (Amazon Web services)
    3.  
      Prerequisite Amazon Web services (AWS) configurations
    4.  
      Configure an S3 bucket to receive billing reports
    5.  
      Select cost allocation tags
    6. Create an AWS IAM user
      1.  
        Example of a custom AWS policy for NetBackup IT Analytics AWS collection
    7. Link AWS accounts for Collection of consolidated billing data
      1.  
        Create a role for NetBackup IT Analytics Data Collection
      2.  
        Add the role to the IAM user
    8.  
      Installation overview (Amazon Web Services - AWS)
    9.  
      Add an Amazon Web Services (AWS) policy
  2. Pre-installation setup for Google Cloud Platform
    1.  
      Overview
    2.  
      Pre-installation setup for GCP
    3.  
      Prerequisites for adding Data Collectors (GCP)
    4.  
      Installation GCP
    5.  
      Adding policy
    6.  
      Testing the collection
    7.  
      Creating an IAM role
    8.  
      Billing Data Access Role
    9.  
      Cloud API
    10.  
      Project access
  3. Pre-Installation Setup for OpenStack Ceilometer
    1.  
      Pre-Installation setup for OpenStack Ceilometer
    2.  
      Prerequisites for adding Data Collectors (OpenStack Ceilometer)
    3.  
      Installation Overview (OpenStack Ceilometer)
    4.  
      Adding an OpenStack Ceilometer Data Collector policy
  4. Pre-Installation Setup for OpenStack Swift
    1.  
      Pre-Installation setup for OpenStack Swift
    2.  
      Prerequisites for adding Data Collectors (OpenStack Swift)
    3.  
      Installation overview (OpenStack Swift)
    4.  
      Adding an OpenStack Swift Data Collector policy
  5. Pre-Installation Setup for Microsoft Azure
    1.  
      Pre-Installation setup for Microsoft Azure
    2.  
      Setting up credentials for Microsoft Azure Data Collection
    3.  
      Install the Azure PowerShell client on a Windows computer
    4.  
      Find your tenant and subscription ID
    5.  
      Register a new application for the Data Collector
    6.  
      Create a principal and assign role to the application
    7.  
      Prerequisites for Adding Data Collectors (Microsoft Azure)
    8.  
      Installation overview (Microsoft Azure)
    9.  
      Add a Microsoft Azure Data Collector policy
  6. Installing the Data Collector Software
    1.  
      Introduction
    2.  
      Installing the WMI Proxy service (Windows host resources only)
    3.  
      Testing WMI connectivity
    4.  
      Install Data Collector Software on Windows
    5.  
      Install Data Collector software on Linux
    6.  
      Install Data Collector in containerized environment
  7. 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
  8. Uninstalling the Data Collector
    1.  
      Uninstall the Data Collector on Linux
    2.  
      Uninstall the Data Collector on Windows
  9. Manually Starting the Data Collector
    1.  
      Introduction
  10. Appendix A. Firewall Configuration: Default Ports
    1.  
      Firewall configuration: Default ports

Add an Amazon Web Services (AWS) policy

  • 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.

  • 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

  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 the vendor-specific entry in the menu.
  5. Enter or select the parameters. Mandatory parameters are denoted by an asterisk (*):

    Note:

    Due to limitations on API request rates, multiple simultaneous processes may interfere with collection. Multiple Amazon Web Services (AWS) Data Collection processes as well as other AWS scripts should not be scheduled for the same period.

Table: Amazon Web Services Data Collector Policy

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 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 select My Profile in the User Account menu.

Account ID or Alias

Enter the AWS account ID number, as shown in the AWS Management Console. This is the ID of the account that pays for the Amazon account. If an account alias has been created, it can be used in lieu of the account ID.

Access Key

Enter the access key ID for the AWS IAM user.

Secret Key

Enter the secret access key for the AWS IAM user.

Billing S3 Bucket

This is the name of the S3 bucket that was created to specifically collect billing records for the NetBackup IT Analytics AWS Data Collector policy.

Report Name

The name you have assigned to the billing report in the AWS billing configuration.

Report Prefix

The prefix you have assigned to the billing report in the AWS billing configuration.

EC2 Details

Collect EC2 instances, EBS volumes, and EBS volume snapshots (and the relationships among these objects), including details such as:

  • EC2 instance: name, tags, region, availability zone, when launched, status, type, virtualization, monitoring configuration.

  • EBS volumes: name, tags, region, availability zone, when created, status, type, size.

  • EBS volume snapshots: name, tags, region, when creation started, progress, status, volume size.

S3 Details

Collect S3 bucket details, such as name, tags, region, owner, when created, and version information.

Storage Usage

Collect S3 storage bucket, EFS, and glacier usages such as number of current objects, total size of current objects, number of versions, total size of all versions, number of delete markers, oldest modified current object, and newest modified current object.

Note:

For buckets that have a large number of objects, this collection may take a long time.

Tracking of storage bucket usage is supported in these AWS regions:

  • us-east-1

  • us-east-2

  • us-west-1

  • us-west-2

  • af-south-1

  • ap-east-1

  • ap-south-1

  • ap-northeast-3

  • ap-northeast-2

  • ap-southeast-1

  • ap-southeast-2

  • ap-northeast-1

  • ca-central-1

  • eu-central-1

  • eu-west-1

  • eu-west-2

  • eu-west-3

  • eu-south-1

  • eu-north-1

  • me-south-1

  • sa-east-1

  • us-gov-east-1

  • us-gov-west-1

Billing Records

Collect all fields from the detailed billing report with resources and tags, such as invoice, resource, payer, linked account, usage type, and costs.

Schedule

Note:

AWS billing records are updated once or more every 24 hours; therefore, it may take 24 hours after configuring this Data Collector Policy before billing records are available in NetBackup IT Analytics.

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.

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.

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.

Test Connection

Test Connection initiates a Data Collector process that attempts to connect to AWS 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.

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 AWS. 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.

Note:

For details about the initial data collection period, refer to the following.

See Modifying the AWS Collection Period.

Modifying the AWS Collection Period

On the first collection of Amazon Web Services (AWS) billing data, the Data Collector collects one month's worth of data. To override this period, set the AWS_BILLING_LOOKBACK_MONTHS advanced parameter to the number of months of billing history that should be retrieved during the first collection.

Note:

To set the parameter, navigate to Admin > Advanced and then click Parameters. Parameters page is displayed.