0% found this document useful (0 votes)
7 views

NetBackup IT Analytics DC Installation Guide for Virtualization Manager v11.5

The document is a comprehensive installation guide for the NetBackup IT Analytics Data Collector for Virtualization Manager, detailing pre-installation setups for VMware, IBM VIO, and Microsoft Hyper-V. It covers prerequisites, installation procedures, and validation methods for data collection, emphasizing the importance of user permissions and network configurations. The guide also includes legal notices, support information, and links to additional resources for users.

Uploaded by

maulet2001
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
7 views

NetBackup IT Analytics DC Installation Guide for Virtualization Manager v11.5

The document is a comprehensive installation guide for the NetBackup IT Analytics Data Collector for Virtualization Manager, detailing pre-installation setups for VMware, IBM VIO, and Microsoft Hyper-V. It covers prerequisites, installation procedures, and validation methods for data collection, emphasizing the importance of user permissions and network configurations. The guide also includes legal notices, support information, and links to additional resources for users.

Uploaded by

maulet2001
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 87

NetBackup IT Analytics

Data Collector Installation


Guide for Virtualization
Manager

Release 11.5
NetBackup IT Analytics Data Collector Installation
Guide for Virtualization Manager
Last updated: 2025-02-03

Legal Notice
Copyright © 2025 Veritas Technologies LLC. All rights reserved.

Veritas and the Veritas Logo are trademarks or registered trademarks of Veritas Technologies
LLC or its affiliates in the U.S. and other countries. Other names may be trademarks of their
respective owners.

This product may contain third-party software for which Veritas is required to provide attribution
to the third party (“Third-party Programs”). Some of the Third-party Programs are available
under open source or free software licenses. The License Agreement accompanying the
Software does not alter any rights or obligations you may have under those open source or
free software licenses. Refer to the Third-party Legal Notices document accompanying this
Veritas product or available at:

https://www.veritas.com/about/legal/license-agreements

The product described in this document is distributed under licenses restricting its use, copying,
distribution, and decompilation/reverse engineering. No part of this document may be
reproduced in any form by any means without prior written authorization of Veritas Technologies
LLC and its licensors, if any.

THE DOCUMENTATION IS PROVIDED "AS IS" AND ALL EXPRESS OR IMPLIED


CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED
WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR
NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH
DISCLAIMERS ARE HELD TO BE LEGALLY INVALID. VERITAS TECHNOLOGIES LLC
SHALL NOT BE LIABLE FOR INCIDENTAL OR CONSEQUENTIAL DAMAGES IN
CONNECTION WITH THE FURNISHING, PERFORMANCE, OR USE OF THIS
DOCUMENTATION. THE INFORMATION CONTAINED IN THIS DOCUMENTATION IS
SUBJECT TO CHANGE WITHOUT NOTICE.

The Licensed Software and Documentation are deemed to be commercial computer software
as defined in FAR 12.212 and subject to restricted rights as defined in FAR Section 52.227-19
"Commercial Computer Software - Restricted Rights" and DFARS 227.7202, et seq.
"Commercial Computer Software and Commercial Computer Software Documentation," as
applicable, and any successor regulations, whether delivered by Veritas as on premises or
hosted services. Any use, modification, reproduction release, performance, display or disclosure
of the Licensed Software and Documentation by the U.S. Government shall be solely in
accordance with the terms of this Agreement.

Veritas Technologies LLC


2625 Augustine Drive.
Santa Clara, CA 95054
http://www.veritas.com

Technical Support
Technical Support maintains support centers globally. All support services will be delivered
in accordance with your support agreement and the then-current enterprise technical support
policies. For information about our support offerings and how to contact Technical Support,
visit our website:

https://www.veritas.com/support

You can manage your Veritas account information at the following URL:

https://my.veritas.com

If you have questions regarding an existing support agreement, please email the support
agreement administration team for your region as follows:

Worldwide (except Japan) [email protected]

Japan [email protected]

Documentation
Make sure that you have the current version of the documentation. Each document displays
the date of the last update on page 2. The latest documentation is available on the Veritas
website.

Veritas Services and Operations Readiness Tools (SORT)


Veritas Services and Operations Readiness Tools (SORT) is a website that provides information
and tools to automate and simplify certain time-consuming administrative tasks. Depending
on the product, SORT helps you prepare for installations and upgrades, identify risks in your
datacenters, and improve operational efficiency. To see what services and tools SORT provides
for your product, see the data sheet:

https://sort.veritas.com/data/support/SORT_Data_Sheet.pdf
Contents

Chapter 1 Pre-Installation setup for VMware .................................. 6


Pre-Installation setup for VMware ...................................................... 6
VMware Data Collection .................................................................. 6
Prerequisites for adding data collectors (VMware) ................................. 7
Virtualization Manager: Collection of VMware Data ......................... 7
Configure VMware Access ......................................................... 8
Installation overview (VMware) ........................................................ 14
Add a VMware Data Collector policy ................................................. 15
Datastore scan collection ............................................................... 21
Reports impacted by Datastore Collection ................................... 22

Chapter 2 Pre-Installation setup for IBM VIO ................................ 24


Pre-Installation setup for IBM VIO .................................................... 24
Prerequisites for adding data collectors (IBM VIO) ............................... 24
Installation overview (IBM VIO) ....................................................... 25
Adding servers for the IBM VIO Data Collector policy ........................... 26
VIO servers (IBM Virtual I/O Servers) ............................................... 26
LPAR clients (IBM Logical Partitioning Clients) managed by VIO servers
........................................................................................... 27
HMC (IBM Hardware Management Console) ...................................... 27
Add an IBM VIO Data Collector policy ............................................... 28

Chapter 3 Pre-Installation setup for Microsoft Hyper-V ............. 32

Pre-Installation setup for Microsoft Hyper-V ....................................... 32


Prerequisites for adding data collectors (Microsoft Hyper-V) .................. 32
Installation overview (Microsoft Hyper-V) ........................................... 33
Add a Microsoft Hyper-V Data Collector policy .................................... 34

Chapter 4 Install the Data Collector software ............................... 39

Introduction ................................................................................. 39
Installing the WMI Proxy service (Windows host resources only) ............ 40
Testing WMI connectivity ................................................................ 40
Considerations to install Data Collector on non-English systems ............ 43
Install Data Collector Software on Windows ....................................... 45
Contents 5

Install Data Collector software on Linux ............................................. 54


Deploy Data Collector in native Kubernetes environment ...................... 57
Configure Data Collector manually for Veritas NetBackup ..................... 59
Install Data Collector binaries on Windows (without configuration)
........................................................................................... 61
Install Data Collector binaries on Linux host (without configuration)
........................................................................................... 65

Chapter 5 Validating data collection ................................................. 68


Validation methods ....................................................................... 68
Data Collectors: Vendor-Specific validation methods ............................ 69
Working with on-demand Data Collection .......................................... 71
View real-time logging during an on-demand collection .................. 73
Generating debug level logs during an on-demand collection .......... 74
Using the CLI check install utility ...................................................... 76
List Data Collector configurations ..................................................... 78

Chapter 6 Uninstall the Data Collector ............................................ 79


Uninstall the Data Collector on Linux ................................................ 79
Uninstall the Data Collector on Windows ........................................... 80

Chapter 7 Manually start the Data Collector ................................. 81

Introduction ................................................................................. 81

Appendix A Firewall configuration: Default ports ............................ 83

Firewall configuration: Default ports .................................................. 83


Chapter 1
Pre-Installation setup for
VMware
This chapter includes the following topics:

■ Pre-Installation setup for VMware

■ VMware Data Collection

■ Prerequisites for adding data collectors (VMware)

■ Installation overview (VMware)

■ Add a VMware Data Collector policy

■ Datastore scan collection

Pre-Installation setup for VMware


In most cases, a single instance of the Data Collector can support any number of
enterprise objects. However, each environment has its own unique deployment
configuration requirements, so it is important to understand where the Data Collector
software must be installed so that you can determine how many Data Collectors
must be installed and which servers are best suited for the deployment.

VMware Data Collection


VMware Data Collection offers two options for collecting data:
■ Collect data from vSphere (formerly vCenter) and/or
■ Collect data from specific ESX servers that are not managed by vSphere
Pre-Installation setup for VMware 7
Prerequisites for adding data collectors (VMware)

When you create a Data Collection policy, you can specify host names and/or IP
addresses or range of addresses. In addition, you can enter a comma-separated
list of any combination of host names and addresses to be probed.
In most cases, a single instance of the Data Collector can support any number of
enterprise objects. However, each environment has its own unique deployment
configuration requirements, so it is important to understand where the Data Collector
software must be installed so that you can determine how many Data Collectors
must be installed and which servers are best suited for the deployment.

Prerequisites for adding data collectors (VMware)


■ 64-bit OS. See the Certified Configurations Guide for supported operating
systems.
■ When the NetBackup IT Analytics system collects data from any vendor
subsystem, the collection process expects name/value pairs to be in US English,
and requires the installation to be done by an Administrator with a US English
locale. The server’s language version can be non-US English.
■ Supports Amazon Corretto 17. Amazon Corretto is a no-cost, multi-platform,
production-ready distribution of the Open Java Development Kit (OpenJDK).
■ For performance reasons, do not install Data Collectors on the same server as
the NetBackup IT Analytics Portal. However, if you must have both on the same
server, verify that the Portal and Data Collector software do not reside in the
same directory.
■ Install only one Data Collector on a server (or OS instance).
■ Port 443 must be open. Data collection uses HTTPS without certificates for
secure connections.

Virtualization Manager: Collection of VMware Data


■ This Data Collector policy can be incorporated with an existing Data Collector
Policy. A Data Collector can collect data from Virtual Center (vCenter) or from
specific ESX servers that are not managed by vCenter.
■ The VMware Data Collector is multi-threaded enabling it to poll up to five
vCenters in one polling cycle. Therefore, multiple vCenter collections can be
configured in one Data Collector policy.
Pre-Installation setup for VMware 8
Prerequisites for adding data collectors (VMware)

Configure VMware Access


The VMware Data Collector uses the VMware Infrastructure SDK and REST APIs
over HTTPS to retrieve data from ESX servers. The VMware Data Collector is
multi-threaded, enabling it to poll up to five vCenters in one polling cycle.
VMware requires the following access for data collection:
1. View-only VMware User ID that has a role with the following privileges:
■ Read-Only
■ Browse Datastore
■ View VM storage policies

Note: Permissions can be granted to an existing local account or domain/AD


user.

2. Assign the user to the root-level folder permissions of vSphere.


The administrator user who provisions the read-only role for collection must
be an administrator at the root level, not just at a data center or other level. If
multiple vCenters are available for administration in the client (Linked Mode),
that administrator user must be provisioned at the root level for each vCenter
Server from which data is collected.
3. Port 443 must be open. Data collection uses HTTPS without certificate validation
for encrypted connections. This allows the use of a self-signed certificate on
the VMware server.

Pre-requisites for vSAN Data Collection


Currently vSAN data collection supports only the virtual center server.
vSAN configuration should be enabled on the VMWare Cluster of Virtual Center to
perform vSAN data collection.

vSAN configurations
The following vSAN services should be enabled on the VMWare Cluster of virtual
center to collect the vSAN details of each cluster.
■ vSAN iSCSI Target Service
■ Historical Health Service
■ Data Service
■ Network
Pre-Installation setup for VMware 9
Prerequisites for adding data collectors (VMware)

■ File Service
The following service should be enabled on the VMWare cluster of virtual center
to collect the vSAN performance details.of each cluster.
■ Performance service

Creating a VMware Read-Only User with Required


Permissions
The following procedure provides the steps for creating and configuring a vSphere
user with the necessary permissions for Virtualization Manager data collection
access.

Note: Permissions can be granted to an existing local account or domain/AD user.


The following VMware user-creation steps are required only if you do not want to
grant permissions to an existing user.

1. Create a new vCenter user to be used with NetBackup IT Analytics. For the
purpose of the examples in this document, we’ll name the user aptare.
2. Log in to vSphere with Administrator credentials to create a user with new
permissions.
3. In the Home page (Alt+Home), click Roles under the Administration heading.

4. In the Roles window, right-click on Read Only and select Clone.


Pre-Installation setup for VMware 10
Prerequisites for adding data collectors (VMware)

5. Name the role NetBackup IT Analytics User.

6. Right-click on the Role you just created--NetBackup IT Analytics User-- and


select Edit Role.
Pre-Installation setup for VMware 11
Prerequisites for adding data collectors (VMware)

7. The only permission that is required beyond the Read-Only role is Browse
Datastore and View VM storage policies. Select Browse Datastore, click View
VM storage policies and then click OK.
Pre-Installation setup for VMware 12
Prerequisites for adding data collectors (VMware)

8. At the top of the vSphere window, select Administration > Inventory > Hosts
and Clusters.
Pre-Installation setup for VMware 13
Prerequisites for adding data collectors (VMware)

9. At the left of the vSphere window, right-click on the Root of the tree--in this
example, esxvsphere--and then select Add Permission.

10. In the Assign Permissions window, under Assigned Role, select NetBackup
IT Analytics User and under Users and Groups, add the user that you created
and click OK.
Pre-Installation setup for VMware 14
Installation overview (VMware)

11. Once the user has been added, you should see it listed under the Permissions
tab.

12. Now you are ready to add the user to the NetBackup IT Analytics Portal. Be
sure to enter the user name exactly as it is displayed in the Permissions tab
(it is case sensitive). If you are using a Domain account, also include the Domain
in the User ID field (for example: domain.com\aptare).

Installation overview (VMware)


Use the following list to ensure that you complete each step in the order indicated.
1. Update the Local Hosts file. This enables Portal access.
2. In the Portal, add a Data Collector, if one has not already been created.
3. In the Portal, add the VMware data collector policy.
4. On the Data Collector Server, install the Data Collector software.
5. Validate the Data Collector installation.
Pre-Installation setup for VMware 15
Add a VMware Data Collector policy

Add a VMware Data Collector policy


To improve performance, if you configure the vCenter 5-minute summaries for level
3 or higher, the Data Collector will use this configuration to reduce the load on the
Portal during data collection. In vCenter, go to Administration > vCenter Server
Settings > Statistics. Edit the 5-minute statistics interval and set the statistics to
level 3. Note that when using level 3, some per-instance data (such as CPU core)
may be missed or incomplete.
■ 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.
Pre-Installation setup for VMware 16
Add a VMware Data Collector policy

4 Click Add Policy, and then select the vendor-specific entry in the menu.
5 Configure the VMware Data Collector policy.

Table 1-1 VMware 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.
Pre-Installation setup for VMware 17
Add a VMware Data Collector policy

Table 1-1 VMware Data Collector Policy (continued)

Field Description

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, click your login name and select
My Profile from the menu. Your Domain name is displayed
in your profile settings.

ESX/Virtual Center Server* One or more IP addresses or host names to probe.


Comma-separated addresses or IP ranges are supported. If
the server requires an SSL certificate, refer to Adding a
Certificate to the Java Keystore for instructions.

Sample value: 192.168.0.1-250, 192.167.1.10, myhost

User ID* The view-only VMware user ID that has a role with the
following privileges: Read-Only and Browse Datastore.

Password* The password associated with the User ID.

ESX Servers to Exclude Enter one or more ESX server names or IP addresses.
Comma-separated names/addresses or IP ranges are
supported.

Optimization Level Select an optimization level for your VMWare data collection.
Choose from default, aggressive, or none. Each selection
impacts runtime differently. Effects will be most noticeable
when running the Datastores collection.
Pre-Installation setup for VMware 18
Add a VMware Data Collector policy

Table 1-1 VMware Data Collector Policy (continued)

Field Description

Inventory By default, this probe collects data from VMware using the
defined schedule.

VMware tags and custom attributes are collected as part of


this probe. Tags are only available when collecting from
vCenter and not directly from an ESX server. Custom
attributes are available from both vCenter and directly from
ESX server.

For performance reasons, this collection only gathers


information on files currently in use by VMs collected by this
probe. This includes VM disk files, suspended state, etc. Due
to limitations in the data returned from VMware, this probe
may miss certain files, such as ISO files that are attached to
virtual DVD drives.

To capture all datastore file information including the files


associated with VMs in the inventory, select the check box:
Datastore Scan. If the Datastore Scan probe is not regularly
run, the Datastore Usage Breakdown report is likely to have
a large Unknown category. For additional information,

See “Datastore scan collection” on page 21.

and

See “Reports impacted by Datastore Collection” on page 22.


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.
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.
Pre-Installation setup for VMware 19
Add a VMware Data Collector policy

Table 1-1 VMware Data Collector Policy (continued)

Field Description

Datastore Scan Select Datastore Scan to perform a complete scan and


capture all datastore file information. This probe may take
several hours to complete and should be configured to run
when VMWare is less active (for example on weekends).
This probe will find files that are not discoverable using the
Inventory probe but are consuming space on the datastore.
After this probe has run the Datastore Usage Breakdown
report will normally only have a small Unknown category,
however, there usually will be some Unknowndata,
representing file system overhead and internal VMWare disk
structures that are not reported as files. Only enable this
probe when actively looking for files that may be wasting
space in the datastores. For additional information,

See “Datastore scan collection” on page 21.

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

ESX Server Performance Select ESX Server Performance to collect performance data
for ESX servers.

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.
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.
Pre-Installation setup for VMware 20
Add a VMware Data Collector policy

Table 1-1 VMware Data Collector Policy (continued)

Field Description

Virtual Machine Performance Select this probe to collect performance data from virtual
machines. This probe may need to be run less often than the
ESX Server Performance probe because there are usually
more virtual machines than ESX servers. This probe may be
disabled if it is not necessary to monitor the performance of
individual virtual machines.

When the default schedule of once every 3 hours is used,


the Data Collector will use vCenter’s 5-minute summaries for
part of the data or, if collecting directly from an ESX server,
there may be gaps in the data. To ensure that real-time data
is always used (subject to the statistics level that is set), or
if collecting from an ESX server, change the schedule of this
probe to every hour (or more frequently). Click Help to view
the statistics level settings in the

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

vSAN Details Select vSAN Details probe to collect vSAN configuration


details, along with health and policy.
Schedule will execute daily at 03:00 hours by default and
collects:

■ Configuration information
■ Cluster health information
■ vSAN disk information
■ vSAN storage policy information

This probe executes on vCenter configuration and does not


perform collection for ESX configuration.
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.
Pre-Installation setup for VMware 21
Datastore scan collection

Table 1-1 VMware Data Collector Policy (continued)

Field Description

vSAN Performance Select this probe to collect vSAN performance information.


By default, the probe executes every hour at 10 minutes and
collects information from the previous one hour. If you change
the schedule to a duration less than an hour (less than 60
minutes), the probe executes at the specified schedule and
also collects information of the time specified in the schedule.

In case you set the schedule for a duration longer than one
hour, the probe executes at the scheduled interval but collects
data only of the past one hour from the time of execution.
This behavior continues for all collections scheduled more
than one hour apart. Hence as a best practice, you must
schedule the probe to execute in less than or equal to one
hour to be able to collect and report all the information within
that hour.

This probe executes on vCenter configuration and does not


perform collection for ESX configuration.
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.

Datastore scan collection


By default, Inventory collection only captures information about the files referenced
by a collected virtual machine (VM files), and only using the information available
without directly contacting the datastore. Examples of large files that will not be
collected during the default Inventory collection are .iso files (such as, DVD images)
and disk images (.vmdk) that are not attached to any collected VM. Data collection
runtime is reduced when using the default Inventory collection, but only files for
VMs in the inventory are collected. Therefore, a considerable amount of consumed
space in the datastore may not be captured. Choose the Datastore Scan option
to gain visibility into the storage that is not associated with a VM.
Pre-Installation setup for VMware 22
Datastore scan collection

When you check Datastore Scan, a more detailed collection is performed by


scanning the datastore to discover files resident on the datastore, but not associated
with a VM in the inventory. This option, although it may impact performance, finds
files that may be invisible to VMware, but that are consuming space on the datastore.
For example, a VM may have been removed without deleting files from the datastore.
Similarly, log files or user-stored files may be taking up space not apparent from
the VM inventory’s perspective.
See “Reports impacted by Datastore Collection” on page 22.

Note: If an error occurs during the Datastore Scan, then only the files available with
the default Inventory collection will be collected for the Datastore. It is also possible
that individual files may be found via the Inventory collection, but not via the
Datastore Scan.

Reports impacted by Datastore Collection


The following reports may be impacted by the Datastore Scan collection configuration
in the data collector policy.

Table 1-2 Reports impacted by Datastore Collection

Report Default Inventory Collect all files on datastore

VM Files Summary ■ No Last Modified date. Last Modified date will be missing for
(drilldown) ■ Total # files collected will usually be files not found in the datastore scan.
less than with an all files collection.

Datastore Usage ■ Non-VM Files and VM Not In The Unknown category in the pie chart
Breakdown Inventory will be zero. will usually be non-zero and will often
■ Total VM Used will be reduced by be significantly higher than the default
the amount that would have been inventory collection.
collected as VM Not In Inventory if
an all files collection had been done.
■ Unknown category in the pie chart
will often be significantly higher than
if an all files collection had been
done.

Datastore ■ VM Not In Inventory will be zero.


Utilization ■ Total VM Used will be reduced by
the amount that would have been
collected as VM Not In Inventory if
an all files collection had been done.
Pre-Installation setup for VMware 23
Datastore scan collection

Table 1-2 Reports impacted by Datastore Collection (continued)

Report Default Inventory Collect all files on datastore

Datastore Detail ■ Non-VM Files and VM Not In VMDK and Other VM Files values
Inventory will be zero. typically will not be impacted by the
■ Total VM Used will be reduced by datastore collection type.
the amount that would have been
collected as VM Not In Inventory if
an all files collection had been done.

VM Server Detail ■ VM Not In Inventory will be zero Last Modified date will be missing for
■ Total VM Used will be reduced by files not found in the datastore scan.
the amount that would have been
collected as VM Not In Inventory if
an all files collection had been done.

VM Detail ■ No Last Modified date.


■ Total # files collected will usually be
less than with an all files collection.

VM Snapshot ■ No Last Modified date.


Summary
Chapter 2
Pre-Installation setup for
IBM VIO
This chapter includes the following topics:

■ Pre-Installation setup for IBM VIO

■ Prerequisites for adding data collectors (IBM VIO)

■ Installation overview (IBM VIO)

■ Adding servers for the IBM VIO Data Collector policy

■ VIO servers (IBM Virtual I/O Servers)

■ LPAR clients (IBM Logical Partitioning Clients) managed by VIO servers

■ HMC (IBM Hardware Management Console)

■ Add an IBM VIO Data Collector policy

Pre-Installation setup for IBM VIO


In most cases, a single instance of the Data Collector can support any number of
enterprise objects. However, each environment has its own unique deployment
configuration requirements, so it is important to understand where the Data Collector
software must be installed so that you can determine how many Data Collectors
must be installed and which servers are best suited for the deployment.

Prerequisites for adding data collectors (IBM VIO)


Identify a server where the Data Collector software will be installed. Server
requirements include:
Pre-Installation setup for IBM VIO 25
Installation overview (IBM VIO)

■ 64-bit OS. See the Certified Configurations Guide for supported operating
systems.
■ When the NetBackup IT Analytics system collects data from any vendor
subsystem, the collection process expects name/value pairs to be in US English,
and requires the installation to be done by an Administrator with a US English
locale. The server’s language version can be non-US English.
■ Supports Amazon Corretto 17. Amazon Corretto is a no-cost, multi-platform,
production-ready distribution of the Open Java Development Kit (OpenJDK).
■ For performance reasons, do not install Data Collectors on the same server as
the NetBackup IT Analytics Portal. However, if you must have both on the same
server, verify that the Portal and Data Collector software do not reside in the
same directory.
■ Install only one Data Collector on a server (or OS instance).
■ Note the port used by the IBM VIO Data Collector: SSH 22, telnet 23.
■ Data Collection retrieves data from servers in the following order:
■ VIO Servers (Virtual I/O Servers): Enable Capacity, HBA, Volume Manager,
and Multi-pathing probes in Host Discovery and Collection. To use the VIO
restricted shell to execute commands to collect data, configure the advanced
parameter, USE_VIO_RESTRICTED_SHELL.
■ LPAR Clients (Logical Partitioning Clients) Managed by VIO Servers: Enable
Capacity, HBA, Volume Manager, and Multi-pathing probes in Host Discovery
and Collection.
For newly discovered LPAR Clients, probes can be configured directly from
the data collector policy.

■ Gather the following required configuration details for the VIO Data Collector
Policy:
■ LPAR Management Server: IP address or server name of the IBM LPAR
Management Server (HMC or IVM).
■ User ID & Password: Credentials for the LPAR Management Server.
■ For the VIO server: Private Key File and Known Hosts File and Path.

Installation overview (IBM VIO)


Use the following list to ensure that you complete each step in the order indicated.
1. Update the Local Hosts file. This enables Portal access.
2. In the Portal, add a Data Collector, if one has not already been created.
Pre-Installation setup for IBM VIO 26
Adding servers for the IBM VIO Data Collector policy

3. In the Portal, add the IBM VIO data collector policy.


4. On the Data Collector Server, install the Data Collector software.
5. Validate the Data Collector Installation.

Adding servers for the IBM VIO Data Collector


policy
IBM VIO Data Collection requires collection from servers in the following order:
1. See “VIO servers (IBM Virtual I/O Servers)” on page 26.
2. See “LPAR clients (IBM Logical Partitioning Clients) managed by VIO servers”
on page 27.
3. See “HMC (IBM Hardware Management Console)” on page 27.
As an Administrator, you may not have a complete list of the server combinations
in your enterprise. Enable HBA and Multipath Probes for the servers, monitor error
messages, and then disable probes, as needed.

VIO servers (IBM Virtual I/O Servers)


To configure collection for IBM VIO Servers:
1. On the VIO Servers, create a normal AIX user instead of a padmin user.
2. Access the Host Inventory window.
Admin > Data Collection > Host Discovery and Collection
3. In the Host Discovery and Collection window, either use Discover Hosts to
collect the initial data for the VIO Servers or search for the VIO Servers.
4. Configure capacity probes for each of the VIO Servers according to the following
guidelines:
■ Capacity: enable.
■ HBA Probe: enable, since the VIO Servers are connected directly to the
SAN.
■ Volume Manager: enable.
■ Multipathing:
If the VIO Servers have any third-party multipathing software such as EMC
PowerPath or Hitachi HDLM Multipathing, the Multipath Probe should be
enabled.
Pre-Installation setup for IBM VIO 27
LPAR clients (IBM Logical Partitioning Clients) managed by VIO servers

If the VIO Servers are using native AIX multipathing, the Multipath Probe
should be disabled.

LPAR clients (IBM Logical Partitioning Clients)


managed by VIO servers
By configuring collection for IBM LPAR clients through the data collector policy, all
newly discovered LPARs found using the collector policy will automatically have
the host probes activated. The eliminates the requirement of manually enabling the
probes using Host Discovery.
1. On the IBM VIO data collector policy, click the checkbox Enable Host
Collection. This activates the Configure Host Collection button.
2. Click Configure Host Collection.
3. Configure capacity probes for each of the LPAR Clients according to the
following guidelines:
■ Capacity: enable.
■ HBA Probe:
■ If the disks are given to LPAR Clients using VSCSI, the HBA Probe should
be disabled since the LPAR Clients are not connected directly to the SAN.
■ If the disks are given to LPAR Clients using NPIV, the HBA Probe should
be enabled.

■ Volume Manager: enable.


■ Multi-pathing:
■ If the LPAR Clients have any third-party multi-pathing software such as EMC
PowerPath or Hitachi HDLM Multipathing, the Multipath Probe should be
enabled.
■ If the LPAR Clients are using native AIX multi-pathing, the Multi-path Probe
should be disabled.

HMC (IBM Hardware Management Console)


To configure data collection from the HMC (the LPAR management server), refer
to the following.
See “Add an IBM VIO Data Collector policy” on page 28.
Pre-Installation setup for IBM VIO 28
Add an IBM VIO Data Collector policy

Add an IBM VIO Data Collector 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.
Pre-Installation setup for IBM VIO 29
Add an IBM VIO Data Collector policy

5 Specify Data Collector Properties.


Pre-Installation setup for IBM VIO 30
Add an IBM VIO Data Collector policy

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

LPAR Management Server* The address of the IBM LPAR Management Server of
either HMC or IVM--either the IP address or server name.

Comma-separated addresses or IP ranges are supported,


e.g. 192.168.0.1-250, 192.168.1.10, myhost.

User ID* Username and password for the LPAR Management


Server. For HMC, the username should have at least HMC
Viewer permissions.

Password*
Note: The password is encrypted prior to saving in the
database and is never visible in any part of the application.

Use Access Control Command Click the check box to indicate access control commands

Access Control Command Access control command for the IBM VIO server, either
sudo, pbrun, or sesudo.

Private Key File The private key file for the IBM VIO server

Known Hosts File Known hosts file for the IBM VIO Server.
Pre-Installation setup for IBM VIO 31
Add an IBM VIO Data Collector policy

Field Description

Path The path used by the VIO server

Host Details Host details are collected by default. Click the clock icon
to create a schedule. 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.

Enable Host Collection Click the checkbox to activate the button: Configure Host
Collection.

Configure Host Collection Enables the configuration of various host probes for each
of the newly discovered LPAR Clients. By configuring
collection for IBM LPAR clients through the data collector
policy, all newly discovered LPARs found using the
collector policy will automatically have the host probes
activated. This eliminates the requirement of manually
enabling the probes.See “LPAR clients (IBM Logical
Partitioning Clients) managed by VIO servers” on page 27.

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.

7 Click OK to save the policy.


8 On the Data Collector server, install/update the Data Collector software.
Chapter 3
Pre-Installation setup for
Microsoft Hyper-V
This chapter includes the following topics:

■ Pre-Installation setup for Microsoft Hyper-V

■ Prerequisites for adding data collectors (Microsoft Hyper-V)

■ Installation overview (Microsoft Hyper-V)

■ Add a Microsoft Hyper-V Data Collector policy

Pre-Installation setup for Microsoft Hyper-V


In most cases, a single instance of the Data Collector can support any number of
enterprise objects. However, each environment has its own unique deployment
configuration requirements, so it is important to understand where the Data Collector
software must be installed so that you can determine how many Data Collectors
must be installed and which servers are best suited for the deployment.

Prerequisites for adding data collectors (Microsoft


Hyper-V)
Identify a server where the Data Collector software will be installed. Server
requirements include:
■ 64-bit OS. See the Certified Configurations Guide for supported operating
systems.
■ When the NetBackup IT Analytics system collects data from any vendor
subsystem, the collection process expects name/value pairs to be in US English,
Pre-Installation setup for Microsoft Hyper-V 33
Installation overview (Microsoft Hyper-V)

and requires the installation to be done by an Administrator with a US English


locale. The server’s language version can be non-US English.
■ Supports Amazon Corretto 17. Amazon Corretto is a no-cost, multi-platform,
production-ready distribution of the Open Java Development Kit (OpenJDK).
■ For performance reasons, do not install Data Collectors on the same server as
the NetBackup IT Analytics Portal. However, if you must have both on the same
server, verify that the Portal and Data Collector software do not reside in the
same directory.
■ Install only one Data Collector on a server (or OS instance).
■ The collector must have WMI network access to the Hyper-V servers. User
credentials must allow access to the root\cimv2, root\virtualization\v2 and
root\MSCluster WMI namespaces.
■ The Data Collector Service that is initially installed uses the Local System as
the Log in account. Sometimes this account does not have permissions to run
remote WMI commands. You should instead change the Service configuration
to use a Log in account that has Local Administrative privileges.
■ The collector uses a PowerShell script that uses WMI to communicate with the
Hyper-V, and makes a number of read-only calls to gather the information.
PowerShell script execution must be enabled on the system running this script.
The version of PowerShell on the system must be 5.0 or above.
■ A full collection path to Hyper-V server attached SAN or NAS storage requires
that Host Resource collection be run first against the Hyper-V servers.
■ WMI uses DCOM for networking. DCOM dynamically allocates port numbers
for clients. DCOM’s service runs on port 135 (a static port) and any client
communicating with a host connects on this port. The DCOM service allocates
the specific port for the WMI service.
To set up a fixed port for WMI, see
http://msdn.microsoft.com/en-us/library/bb219447%28VS.85%29.aspx.

Installation overview (Microsoft Hyper-V)


Use the following list to ensure that you complete each step in the order indicated.
1. Update the Local Hosts file. This enables Portal access.
2. In the Portal, add a Data Collector, if one has not already been created.
3. In the Portal, add the Microsoft Hyper-V data collector policy.
4. On the Data Collector Server, install the Data Collector software.
5. Validate the Data Collector installation.
Pre-Installation setup for Microsoft Hyper-V 34
Add a Microsoft Hyper-V Data Collector policy

Add a Microsoft Hyper-V Data Collector 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.
Pre-Installation setup for Microsoft Hyper-V 35
Add a Microsoft Hyper-V Data Collector policy

5 Specify Data Collector Properties.


Pre-Installation setup for Microsoft Hyper-V 36
Add a Microsoft Hyper-V Data Collector policy

6 Enter or select the parameters. Mandatory parameters are denoted by an


asterisk (*):

Field Description Sample Value

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 yourdomain


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.
Pre-Installation setup for Microsoft Hyper-V 37
Add a Microsoft Hyper-V Data Collector policy

Field Description Sample Value

Hyper-V Server One or more Hyper-V Server


Host Names Host Names to probe. IP
Address is not supported.
Comma-separated host names
are supported. For example,
HyperV1, HyperV2.

User ID/Password View only WMI User ID for


Hyper-V Server. To include a
domain name use the format
DOMAIN\USERNAME.

Active Probes

Inventory Probe for collecting Hyper-V


server and Hyper-V guest
information.

Schedule The default is every day at 2:12.


Click the clock icon to create a
schedule. You can schedule the
collection frequency by minute,
hour, day, week and month.
Advanced use of native CRON
strings is also available.

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.
Pre-Installation setup for Microsoft Hyper-V 38
Add a Microsoft Hyper-V Data Collector policy

Field Description Sample Value

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.

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.

7 Click OK to save the policy.


8 On the Data Collector server, install/update the Data Collector software.
Chapter 4
Install the Data Collector
software
This chapter includes the following topics:

■ Introduction

■ Installing the WMI Proxy service (Windows host resources only)

■ Testing WMI connectivity

■ Considerations to install Data Collector on non-English systems

■ Install Data Collector Software on Windows

■ Install Data Collector software on Linux

■ Deploy Data Collector in native Kubernetes environment

■ Configure Data Collector manually for Veritas NetBackup

■ Install Data Collector binaries on Windows (without configuration)

■ Install Data Collector binaries on Linux host (without configuration)

Introduction
This section includes the instructions for installing the Data Collector software on
the Data Collector Server. Data Collector software is supported in various flavors
of Linux and Windows. On Windows, if you are collecting data from host resources,
you may need to install the WMI Proxy Service. The WMI Proxy Service is installed
by default, as part of the Data Collector installation on a Windows server.
A GUI based version is available for Windows and a console (command line) based
interface is available for Linux.
Install the Data Collector software 40
Installing the WMI Proxy service (Windows host resources only)

When the NetBackup IT Analytics system collects data from any vendor subsystem,
the collection process expects name/value pairs to be in US English, and requires
the installation to be done by an Administrator with a US English locale. The server’s
language version can be non-US English.

Note: Log in as a Local Administrator to have the necessary permissions for this
installation.

Installing the WMI Proxy service (Windows host


resources only)
To collect data from Windows hosts, choose a Windows host on which to install
the WMI proxy.
■ This is required only if you are collecting data from Windows Host Resources.
■ The WMI Proxy needs to be installed on only one Windows host.
■ If the Data Collector is on a Windows server, the WMI Proxy will be installed
there as part of the Data Collector installation.
■ If the Data Collector is on a Linux server, you must identify a Windows server
on which to install the WMI proxy service.
See “Install Data Collector Software on Windows” on page 45.

Testing WMI connectivity


The Windows Management Instrumentation (WMI) Proxy is used by NetBackup IT
Analytics to collect data from Windows hosts. Should you have connectivity issues,
these steps can be taken to test and troubleshoot connectivity.
To verify that WMI is working properly, take the following steps:
1. Log in to the Data Collector server as an Administrator.
2. From the Windows Start menu, type Run in the search box to launch the
following window where you will enter wbemtest.exe and click OK.
Install the Data Collector software 41
Testing WMI connectivity

3. In the Windows Management Instrumentation Tester window, click Connect.

4. In the Connect window, preface the Namespace entry with the IP address or
hostname of the target remote server in the following format:

\\<IP Address>\root\cimv2
Install the Data Collector software 42
Testing WMI connectivity

5. Complete the following fields in the Connect window and then click Connect.
■ User - Enter the credentials for accessing the remote computer. This may
require you to enable RPC (the remote procedure call protocol) on the
remote computer.
■ Password
■ Authority: Enter NTLMDOMAIN:<NameOfDomain>
where NameOfDomain is the domain of the user account specified in the
User field.

6. Click Enum Classes.


7. In the Superclass Info window, select the Recursive radio button, but do not
enter a superclass name. Then, click OK.
8. The WMI Tester will generate a list of classes. If this list does not appear, go
to the Microsoft Developer Network web site for troubleshooting help.
http://msdn.microsoft.com/en-us/library/ms735120.aspx
Install the Data Collector software 43
Considerations to install Data Collector on non-English systems

Considerations to install Data Collector on


non-English systems
This section describes the prerequisites of NetBackup IT Analytics Data Collector
installation on a non-English Windows or a non-English Linux host. Apart from
English, Data Collector installation is supported in the following locales, provided
the Data Collector host system locale is set to any one of these languages:
■ Simplified Chinese
■ French
■ Korean
■ Japanese
After you have set one of the above as system locale, the installation progress and
responses appear in the preferred locale. If the system locale is set to any other
non-supported locale, the installation progress and responses appear in English.
The OS-specific requirements mentioned below.

Non-English Linux OS
On a non-English Linux host:
■ The user locale can be one of the non-English supported locales if the Data
Collector will collect only from a Veritas product.
■ The user locale must be English if the Data Collector will be used to collect from
any non-Veritas product.
To install the Data Collector in one of the supported locales, verify whether the host
OS has multiple languages and then add the preferred locale for the installation.
The procedure below guides you to set one of the supported languages as the
system locale.
To set one of the supported languages as the system locale for Data Collector
installation, set the preferred language as described below:
1 Check the current language.

#locale

2 Check whether your system has multiple languages:

#locale -a
Install the Data Collector software 44
Considerations to install Data Collector on non-English systems

3 To change the System locale into one of the supported languages, run the
command #vi /etc/profile and add the following at the end of the file based
on your preferred language:
■ To add Simplified Chinese:

export LANG=zh_CN.utf8
export LC_ALL=zh_CN.utf8

■ To add French:

export LANG=fr_FR.utf8
export LC_ALL=fr_FR.utf8

■ To add Korean

export LANG=ko_KR.utf8
export LC_ALL=ko_KR.utf8

■ To add Japanese

export LANG=ja_JP.utf8
export LC_ALL=ja_JP.utf8

4 Reboot the host to set the desired system locale for the Data Collector
installation.
Having completed setting the system locale, proceed with the Data Collector
installation, with the appropriate user locale.
See “Install Data Collector software on Linux” on page 54.

Non-English Windows OS
Veritas recommends that the user locale to be set to English while installing the
Data Collector on a non-English Windows host, be it for a Veritas or a non-Veritas
product.
To verify the user locale and system locale respectively before the Data Collector
installation, run the get-culture and get-winsystemlocale commands from
PowerShell Windows. This way, you can decide which user locale to set for the
Data Collector installation.
If you must run the Data Collector installer in one of the supported locales, ensure
the Windows OS is installed in either Simplified Chinese, French, Korean, or
Japanese. Avoid having Windows OS in English, installed with language pack and
changing the locale later. The Data Collector installer detects the locale from the
Windows Language Settings and launches the installer in the respective locale. If
Install the Data Collector software 45
Install Data Collector Software on Windows

the Windows Time & Language Setting is set to a language other than Simplified
Chinese, French, Korean, or Japanese, the installer is launched in English.
See “Install Data Collector Software on Windows” on page 45.

Install Data Collector Software on Windows


To install your Data Collector software:
1 Login to the Data Collector server as a local administrator.
2 Go to the downloads section under Support on www.veritas.com and click the
relevant download link.
Once, downloaded, the Data Collector Installation Wizard launches
automatically. If it does not, navigate to its directory and double-click the
executable file Setup.exe.
3 Review the recommendations on the welcome page and click Next.
You are advised to close all other programs during this installation.
Install the Data Collector software 46
Install Data Collector Software on Windows

4 The installation wizard validates the system environment. On successful


validation, click Next.
Install the Data Collector software 47
Install Data Collector Software on Windows

5 Review the End User License Agreement (EULA), select I accept the terms
of the license agreement, and click Next.
Install the Data Collector software 48
Install Data Collector Software on Windows

6 Specify the directory where you would like to install the Data Collector software
and click Next. The default Windows path is C:\Program
Files\AptareC:\Program Files\Veritas\AnalyticsCollector. Accepting
the default paths is recommended.
If you specify a custom directory, the install creates the AnalyticsCollector
folder within the specified directory.

7 Provide accurate details as described below on the next page and then click
Next.

Data Collection Task Select Data Collector (includes WMI


Proxy) or WMI Proxy Server (only) from
the list.

A single Data Collector can be installed for


multiple vendor subsystem on a single
server.
Install the Data Collector software 49
Install Data Collector Software on Windows

Data Collector Registration File Enter the absolute path of the registration
file downloaded from the NetBackup IT
Analytics Portal.

If a registration file is not available,


generate and download it from the Portal
and provide its path. This will auto-populate
the next three fields.

Data Collector Name Read-only and auto-populated.

Data Collector Passcode Read-only and auto-populated.

Data Receiver URL Read-only and auto-populated.

Proxy Settings 1 HTTP/HTTPS: Enter the hostname


or IP address and a port number.

2 UserId: User ID of the proxy server.

3 Password: Password of the proxy


server.

4 No Proxy For: Enter the host names


or IP addresses separated by
commas that will not be routed
through the proxy.
Install the Data Collector software 50
Install Data Collector Software on Windows

8 Review the installation summary and the available disk space before you
proceed with the installation.
Install the Data Collector software 51
Install Data Collector Software on Windows

9 Click Next to initiate the installation.


Install the Data Collector software 52
Install Data Collector Software on Windows

10 Review the post install details and click Next.


Install the Data Collector software 53
Install Data Collector Software on Windows

11 To validate the Data Collector installation, run the C:\Program


Files\Veritas\AnalyticsCollector\mbs\bin\checkinstall.bat batch
file.
Close the terminal window once the validation is complete and then click Next.

If you wish to run checkinstall.bat later, you can run the script from the
command prompt.
Install the Data Collector software 54
Install Data Collector software on Linux

12 On successful installation of NetBackup IT Analytics Data Collector, click Finish.


Your Data Collector installation is complete.

Install Data Collector software on Linux


To install Data Collector software on Linux:
1 Login as root on the server where NetBackup IT Analytics Data Collector has
to be installed.
2 If the Data Collector system is having low entropy, it can affect the performance
of cryptographic functions and such steps can take considerable amount of
time to complete. You can identify the entropy level of the system from the
content of the /proc/sys/kernel/random/entropy_avail file using command
# cat /proc/sys/kernel/random/entropy_avail. If this value is not more
than 400 consistently, install the rng-tools and start the services as described
below on the data collector system.
Install the rng-tools and start the services as described below.
For RHEL or OEL:
■ Access the command prompt.
Install the Data Collector software 55
Install Data Collector software on Linux

■ Install the rng-tools.

yum install rng-tools

■ Start the services.

systemctl start rngd

■ Enable the services.

systemctl start rngd

For SUSE:
■ Access the command prompt.
■ Install the rng-tools.

zypper install rng-tools

■ Start the services.

systemctl start rng-tools

■ Enable the services.

systemctl enable rng-tools

3 Ensure the following rpms are present on the system:


On SUSE: libXrender1 and libXtst6 insserv-compat
On other Linux systems: libXtst and libXrender chkconfig
Since the above rpms are essential for proper functioning of the Data Collector,
you can run the below commands on the Data Collector server to check whether
the rpms are present.
On SUSE: rpm -q libXrender1 libXtst6 insserv-compat
On other Linux systems: rpm -q libXtst libXrender chkconfig
The output of the above commands will print the rpms that are present on the
system.
4 Go to the downloads section under Support on www.veritas.com and click the
relevant download link.
Install the Data Collector software 56
Install Data Collector software on Linux

5 Mount the ISO image that you downloaded.

mkdir /mnt/diska
mount -o loop <itanalytics_datacollector_linux_xxxxx.iso>
/mnt/diska

Substitute the name of the ISO image downloaded have downloaded.


6 Start the installer:

cd /
/mnt/diska/dc_installer.sh

7 Review the End User License Agreement (EULA) and enter accept to agree.
8 Provide the install location. The default location is
/usr/openv/analyticscollector. Accepting the default paths is
recommended.
If you specify a custom location, analyticscollector directory is created at
the specified location.
9 The installer requests for the following details.
■ Data Collector Registration File Path: Enter the absolute file path of the
registration file generated and downloaded from the NetBackup IT Analytics
Portal.
■ Web Proxy (HTTP) settings can be configured. Enter y to configure proxy.
The installer prompts for:
■ HTTP Proxy IP Address: Enter the hostname or IP address and a port
number.
■ HTTP Proxy Port: Enter the proxy port number for HTTP proxy.
■ Proxy UserId and password: Enter the credentials for the proxy server.
■ No Proxy For: Enter the host names or IP addresses separated by
commas that will not be routed through the proxy.

The Data Collector installation is complete. You can run the


<Data_Collector_Install_Location>/analyticscollector/mbs/bin/checkinstall.sh
file for verification.
Install the Data Collector software 57
Deploy Data Collector in native Kubernetes environment

Deploy Data Collector in native Kubernetes


environment
This procedure provides the steps to deploy Data Collector Docker image on a
Kubernetes cluster through an operator with the required configuration on Linux
hosts. This method enables efficient Data Collector installation and reduces the
human errors caused during manual or ISO-based installations.

Prerequisites and dependencies


System requirements and installation dependencies for the system on which Data
Collector will be installed are listed below:
■ Obtain the Docker image generated from the CI/CD build.
■ Kubernetes must be pre-installed on the system.
■ Assume root role on the host system.
■ Kubernetes cluster must be accessible on the system.
■ Ensure that the file system supporting the /data directory has enough free
space as recommended in the NetBackup IT Analytics Certified Configurations
Guide for Data Collector.
The /data directory in the host system will be mounted inside the container as
/usr/openv/analyticscollector.

■ Obtain the following Data Collector details. You are required to supply these
details to the installer during the installation process.
■ Registry: The name of the registry to which you want to push the installer
images.
■ Absolute path of Data Receiver Certificate file: Absolute path of the data
receiver certificate file downloaded from NetBackup IT Analytics Portal.
■ Absolute path of the Data Collector Registration File: Absolute path of the
Data Collector registration file downloaded from the NetBackup IT Analytics
Portal.
■ Proxy settings:
■ Portal IP address: IP address of the system hosting the NetBackup IT
Analytics Portal.
■ Portal HostName: aptareportal.<DOMAIN> or itanalyticsportal.<DOMAIN>
■ Agent HostName: aptareagent.<DOMAIN> or itanalyticsagent.<DOMAIN>
■ StorageClass Name: Name of the Kubernetes storage class to be used.
Install the Data Collector software 58
Deploy Data Collector in native Kubernetes environment

■ Obtain the itanalytics_k8s_artificats.tar from the Veritas Download


Center. The tarball has the container image, operater image, set of .yaml files,
and the scripts.

Deploy the Data Collector in Kubernetes environment


To deploy the Data Collector in Kubernetes environment:
1 Login to the Kubernetes cluster.
2 Run this command on the primary node and label the node on which you want
to deploy the Data Collector.

kubectl label node <worker_node_name>


itaDcNodeKey=itaDcDeploymentNode

3 From the itanalytics_k8s_artifacts.tar location, run this command to


initiate the Data Collector installation.

tar -xvf itanalytics_k8s_artifacts.tar scripts

This saves a scripts folder at the itanalytics_k8s_artifacts.tar file


location,.
4 From the scripts folder, run this script.

cd scripts/
sh itanalytics_dc_installer.sh

Note: The installation logs are saved to


itanalytics_dc_installer_<time_stamp>.log.

5 Provide the Data Collector configuration details when asked by the installer in
the following order.
■ Registry
The installer asks for a confirmation after providing the registry name to
proceed with pushing the images. You need to enter y for a fresh installation.
If for any reason, you are required to re-run the installation and this step
was successfully completed anytime before for the same cluster node, you
can enter n to avoid a rewrite and bypass this step.
■ Absolute path of Data Receiver Certificate file (if you have set an https://
URL for the data receiver)
■ Absolute path of the Data Collector registration file
■ Proxy settings
Install the Data Collector software 59
Configure Data Collector manually for Veritas NetBackup

■ Portal IP address
■ Portal HostName
■ Agent HostName
■ StorageClass Name

6 The installer asks to confirm the configuration details before proceeding with
the installation. Enter y to proceed with the data collector installation
After a successful installation, verify whether the Data Collector status appears
Online on the NetBackup IT Analytics Portal.

Connect to the pod instance


Run this command to connect to the pod instance and also to facilitate debugging
when required.

# kubectl exec -it<pod ID> -- bash

Configure Data Collector manually for Veritas


NetBackup
From NetBackup version 10.1.1 onwards, Veritas NetBackup primary server
installation will also deploy NetBackup IT Analytics Data Collector binaries
automatically on Windows ( C:\Program Files\Veritas\AnalyticsCollector)
and Linux (/usr/openv/analyticscollector) system. Also, if Veritas NetBackup
primary server is managed under Veritas Alta, the NetBackup IT Analytics Data
Collector will be automatically configured with NetBackup IT Analytics Portal.
This procedure provides the manual steps to configure the Data Collector for Veritas
NetBackup when Veritas NetBackup primary is not managed under Veritas Alta.
Note that NetBackup IT Analytics Portal must be already installed in your data
center and a Data Collector entry must be added via the Collector Administration
screen of the portal for each NetBackup primary server before you perform this
configuration.
Keep the registration file path (generated while creating the data collector on the
Portal and copied to the NetBackup primary server) handy when you configure the
Data Collector.
See Add/Edit Data Collectors section in the NetBackup IT Analytics User Guide
for more information.
Install the Data Collector software 60
Configure Data Collector manually for Veritas NetBackup

To configure the Data Collector manually on Windows:


1 Use the [responsefile.cmd] received through the installer media for this
configuration. You can configure it as described in the steps below.
2 Edit the responsefile as a batch script responsefile.cmd with the following
contents. You can also create one if required with the following content. These
are the responses to the user input required to configure the Data Collector

SET DATACOLLECTOR_REGISTRATION_FILE_PATH=<path to the .json file>


SET HTTP_PROXY_CONF=N
SET PROXY_HTTP_URL=
SET PROXY_HTTP_PORT=
SET PROXY_HTTPS_URL=
SET PROXY_HTTPS_PORT=
SET PROXY_USERID=
SET PROXY_PASSWORD=
SET PROXY_NOT_FOR=

3 Run the command:

"C:\ProgramData\Veritas\NetBackup IT Analytics\DC\configure.cmd"
/RESPFILE:<response_file_path> /INSTALL_TYPE:CONFIG

To configure the Data Collector manually on Linux:


1 Use the sample [responsefile.cmd] available on the install media and also
available at the <Data collector install location>/installer path on
the system for this configuration. You can configure it as described in the steps
below.
2 Update the response file with the following contents. You can also create one
if required with the following content.

COLLECTOR_REGISTRATION_PATH=<path to the json file>


HTTP_PROXY_CONF=N
HTTP_PROXY_ADDRESS=
HTTP_PROXY_PORT=
HTTPS_PROXY_ADDRESS=
HTTPS_PROXY_PORT=
PROXY_USERNAME=
PROXY_PASSWORD=
PROXY_EXCLUDE=
Install the Data Collector software 61
Install Data Collector binaries on Windows (without configuration)

3 Update the value for each field with appropriate data.


A sample responsefile is available on the install media as well as the <Data
collector install location>/installer path on the system.

4 Run any one of the following command:

<Install media>/dc_installer.sh -c <responsefile path>

Or

<install location>/installer/dc_installer.sh -c <responsefile


path>

Install Data Collector binaries on Windows


(without configuration)
This Data Collector installation allows you to install the collector independent of the
portal software installation. The collector remains disconnected from the portal until
you configure it using a response file, that contains credentials of the Data Collector
created on the NetBackup IT Analytics Portal and the data receiver.

Install the Data Collector


To install a Data Collector:
1 Download and mount the Data Collector installer ISO file.
2 Install the Data Collector using silentinstall.cmd and follow the installation
prompt.
You can install the Data Collector in the following options:
■ Install at default location:

<ISO_MOUNT_DRIVE>:\silentinstall.cmd /INSTALL_TYPE:INSTALL

■ Install at custom location:

<ISO_MOUNT_DRIVE>:\silentinstall.cmd /INSTALL_PATH:<custom
location for dc installation> /INSTALL_TYPE:INSTALL

The independent Data Collector installation is complete.

Configure the Data Collector using responsefile


A sample responsefile is saved when you install the Data Collector. To connect the
Data Collector with the NetBackup IT Analytics Portal, you must configure its
Install the Data Collector software 62
Install Data Collector binaries on Windows (without configuration)

responsefile with the credentials of the Data Collector created on the portal and run
a configuration command as described in the procedure below.
To configure the Data Collector:
1 Obtain the following details from the NetBackup IT Analytics Portal:
■ Registration file downloaded from the Portal.
Install the Data Collector software 63
Install Data Collector binaries on Windows (without configuration)

■ Proxy server configuration details


Install the Data Collector software 64
Install Data Collector binaries on Windows (without configuration)

2 Update the responseFile.cmd with the above values.

@ECHO OFF
REM -------------------------------------------------
SET DATACOLLECTOR_REGISTRATION_FILE_PATH=
REM -------------------------------------------------
REM Description: Enter the Data Collector's Key File path. The
file path must include name of the file that was downloaded from
the Portal.
REM Valid input values: Absolute path of key file
REM Required: True

REM -------------------------------------------------
SET HTTP_PROXY_CONF=N
REM -------------------------------------------------
REM Description: It indicate whether proxy should be configured
or not
REM Valid input values: Y,N
REM Default value: N

REM -------------------------------------------------
SET PROXY_HTTP_URL=
REM -------------------------------------------------
REM Description: IP/hostname for HTTP Proxy
REM Valid input values: 10.20.30.40, localhost

REM -------------------------------------------------
SET PROXY_HTTP_PORT=
REM -------------------------------------------------
REM Description: Port for HTTP proxy
REM Valid input values: Any number between 0 and 65535

REM -------------------------------------------------
SET PROXY_HTTPS_URL=
REM -------------------------------------------------
REM Description: IP/hostname for HTTPS Proxy
REM Valid input values: 10.20.30.40, localhost

REM -------------------------------------------------
SET PROXY_HTTPS_PORT=
REM -------------------------------------------------
REM Description: Port for HTTPS proxy
REM Valid input values: Any number between 0 and 65535
Install the Data Collector software 65
Install Data Collector binaries on Linux host (without configuration)

REM -------------------------------------------------
SET PROXY_USERID=
REM -------------------------------------------------
REM Description: Proxy UserId
REM Default value:

REM -------------------------------------------------
SET PROXY_PASSWORD=
REM -------------------------------------------------
REM Description: Proxy user password
REM Default value:

REM -------------------------------------------------
SET PROXY_NOT_FOR=
REM -------------------------------------------------
REM Description: List of IP/hostname which should be excluded
for proxy
REM Default value:

The Data Collector installation without connecting it with the portal is complete

Configure the Data Collector using responsefile


To configure the installation, run the below command from command prompt:

<ISO_MOUNT_DRIVE>:\silentinstall.cmd /RESPFILE:<responsefile_path>
/INSTALL_PATH:<Data_Collector_installation_path> /INSTALL_TYPE:CONFIG

or

<INATALL_PATH>\DC\configure.cmd" /RESPFILE:<response_file_path>
/INSTALL_TYPE:CONFIG

Uninstall Data Collector


Remove the Data Collector installation from Control Panel > Add and Remove
Programs menu.

Install Data Collector binaries on Linux host


(without configuration)
This installation allows you to install the Data Collector independent of the portal
software installation. The collector remains disconnected from the portal until you
Install the Data Collector software 66
Install Data Collector binaries on Linux host (without configuration)

configure it using a response file, that contains credentials of the Data Collector
created on the NetBackup IT Analytics Portal and the data receiver.
To install a Data Collector:
1 Download and mount the Data Collector installer
itanalytics_datacollector_linux_<version>.iso.

# mount -o loop <ISO file path> <path to mount>

2 Install the Data Collector at a custom location.

# <path to mount>/dc_installer.sh -i <user selected path>

Example:

# <path to mount>/dc_installer.sh -i /usr/openv -n

Configure the Data Collector using response file


A sample response file is saved when you install the Data Collector. To connect
the Data Collector with the NetBackup IT Analytics Portal, you must configure its
responsefile with the credentials of the Data Collector created on the portal and run
a configuration command as described in the procedure below.
To configure the Data Collector:
1 Obtain the following details from the NetBackup IT Analytics Portal:
■ Registration file downloaded from the Portal.
■ Proxy server configuration details

2 Update the above values in the responsefile.sample.

COLLECTOR_REGISTRATION_PATH=<path to the .json file>


HTTP_PROXY_CONF=N
HTTP_PROXY_ADDRESS=
HTTP_PROXY_PORT=
HTTPS_PROXY_ADDRESS=
HTTPS_PROXY_PORT=
PROXY_USERNAME=
PROXY_PASSWORD=
PROXY_EXCLUDE=
Install the Data Collector software 67
Install Data Collector binaries on Linux host (without configuration)

3 Configure the data collector using the above response file.

# <path to mount>/dc_installer.sh -c <responsefile path>

or

<install location>/installer/ dc_installer.sh -c <responsefile


path>{}

4 Start the data collector service

# <install location>/mbs/bin/aptare_agent start

Uninstall Data Collector


Run this command to uninstall the Data Collector.

<INSTALL_PATH>/UninstallerData/uninstall_dc.sh -r
Chapter 5
Validating data collection
This chapter includes the following topics:

■ Validation methods

■ Data Collectors: Vendor-Specific validation methods

■ Working with on-demand Data Collection

■ Using the CLI check install utility

■ List Data Collector configurations

Validation methods
Validation methods are initiated differently based on subsystem vendor associated
with the Data Collector policy, but perform essentially the same functions. Refer to
the following table for vendor-specific validation methods.
■ Test Connection - Initiates a connection attempt directly from a data collector
policy screen 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.
■ On-Demand data collection run - Initiates an immediate end-to-end run of the
collection process from the Portal without waiting for the scheduled launch. This
on-demand run also serves to validate the policy and its values (the same as
Test Connection), providing 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. This is initiated at the policy-level from
Admin>Data Collection>Collector Administration.
See “Working with on-demand Data Collection” on page 71.
Validating data collection 69
Data Collectors: Vendor-Specific validation methods

■ CLI Checkinstall Utility- This legacy command line utility performs both the Test
Connection function and On-Demand data collection run from the Data Collector
server.
See “Using the CLI check install utility” on page 76.

Note: NetBackup IT Analytics does not recommend using the CLI Checkinstall
utility for any Data Collector subsystem vendor which supports On-Demand
runs.

Data Collectors: Vendor-Specific validation


methods
Table 5-1 Vendor-specific validation requirements.

Vendor Name Test Connection On-Demand CLI Checkinstall


Utility

Amazon Web Services (AWS) x x

Brocade Switch x

Brocade Zone Alias x x

Cisco Switch x

Cisco Zone Alias x x

Cohesity DataProtect x x

Commvault Simpana x

Compute Resources x

Dell Compellent x

Dell EMC Elastic Cloud Storage (ECS) x x

Dell EMC NetWorker Backup & Recovery x

Dell EMC Unity x x

EMC Avamar x

EMC Data Domain Backup x x

EMC Data Domain Storage x x


Validating data collection 70
Data Collectors: Vendor-Specific validation methods

Table 5-1 Vendor-specific validation requirements. (continued)

Vendor Name Test Connection On-Demand CLI Checkinstall


Utility

EMC Isilon x

EMC Symmetrix x x

EMC VNX x x

EMC VNX Celerra x

EMC VPLEX x

EMC XtremIO x x

HDS HCP x x

HDS HNAS x

HP 3PAR x

HP Data Protector x

HP EVA x

HPE Nimble Storage x x

Hitachi Block x

Hitachi Content Platform (HCP) x x

Hitachi NAS x x

IBM Enterprise x

IBM SVC x

IBM Spectrum Protect (TSM) x

IBM VIO x x

IBM XIV x

Microsoft Azure x x

Microsoft Hyper-V x x

Microsoft Windows Server x x

NAKIVO Backup & Replication x x


Validating data collection 71
Working with on-demand Data Collection

Table 5-1 Vendor-specific validation requirements. (continued)

Vendor Name Test Connection On-Demand CLI Checkinstall


Utility

NetApp E Series x

Netapp x

Netapp Cluster Mode x

OpenStack Ceilometer x x

OpenStack Swift x x

Test Connection is
included with the Get
Nodes function.

Oracle Recovery Manager (RMAN) x x

Pure FlashArray x x

Rubrik Cloud Data Management x x

VMWare x

Veeam Backup & Replication x x

Veritas Backup Exec x

Veritas NetBackup x x

Veritas NetBackup Appliance X x

Working with on-demand Data Collection


Collections can run on a schedule or on-demand using the Run button on the action
bar. On-demand allows you to select which probes and devices to run. The
on-demand run collects data just like a scheduled run plus additional logging
information for troubleshooting. A stopped Policy still allows an on-demand collection
run, provided the policy is assigned to one of the specified vendors and the collector
is online.

Note: On-demand data collection is not available for all policies.

On-Demand data collection serves multiple purposes. You can use it to:
Validating data collection 72
Working with on-demand Data Collection

■ Validate the collection process is working end-to-end when you create a data
collector policy
■ Launch an immediate run of the collection process without waiting for the
scheduled run
■ Populate your database with new/fresh data
■ Choose to view the collection logs on the portal while performing an on-demand
run.
To initiate an on-demand data collection
1 Select Admin > Data Collection > Collector Administration. All Data
Collectors are displayed.
2 Click Expand All to browse for a policy or use Search.
3 Select a data collector policy from the list. If the vendor is supported, the Run
button is displayed on the action bar.
4 Click Run. A dialog allowing you to select servers and individual probes to test
the collection run is displayed. The following example shows the Amazon Web
Services dialog. See the vendor specific content for details on probes and
servers.

5 Select the servers and probes for data collection.


Validating data collection 73
Working with on-demand Data Collection

6 The portal enables the user to log the messages at various level during the
collection process. Following are the available options:
■ Enable Real-Time Logs: This option enables the user to log generally
useful information in real-time when the collection is in progress, select
Enable Real-Time Logs.
■ Enable Debug Logs: This option enables the user to log information at a
granular level, select Enable Debug Logs

7 Click Start. Data is collected just like a scheduled run plus additional logging
information for troubleshooting. Once started, you can monitor the status of
the run through to completion.

Note: If there is another data collection run currently in progress when you
click Start, the On-Demand run will wait to start until the in-progress run is
completed.

See “View real-time logging during an on-demand collection” on page 73.


See “Generating debug level logs during an on-demand collection” on page 74.

View real-time logging during an on-demand collection


By default, real-time logging is enabled when you initiate an on-demand collection
for a data collector. Admin > Data Collection > Collector Administration provides
a window to view the logs in real-time as the collection progresses.
Validating data collection 74
Working with on-demand Data Collection

The following steps help you to view the real-time logging:


1 Go to Admin > Data Collection > Collector Administration. All Data
Collectors are displayed.
2 Initiate an on-demand data collection as described under Working with
on-demand Data Collection with Enable Real-Time Logs selected.
The Policy State column displays status as Collecting and an icon to open
the Collection Console pop-up.
3 Click the icon next to the Collecting link to view the real-time logs in the
Collection Console. Real-time logs are visible as long as the data collection
is in progress and the Collection Console is open.

You can use the filter on the console to selectively view the logs of your choice.
The Collection Console icon is not visible if the data collection is not in
progress.

Generating debug level logs during an on-demand collection


By default, Enable Debug Logs (Backend only) option is not selected when you
initiate an on-demand collection for a data collector. The Collector Administration
provides a window to generate debug level information as the collection progresses.
Validating data collection 75
Working with on-demand Data Collection

The following steps to enable debug level log file generation:


1 Go to Admin > Data Collection > Collector Administration. All Data
Collectors are displayed.
2 Initiate an on-demand data collection as described under Working with
on-demand Data Collection with Enable Debug logs (Backend only) option
selected.
Validating data collection 76
Using the CLI check install utility

Note: The path for generated log file on data collector server:
<APTARE_HOME>/mbs/logs/validation/

Using the CLI check install utility


This legacy utility performs both the Test Connection function and On-Demand data
collection run from a command line interface launched from the Data Collector
server.

Note: NetBackup IT Analytics does not recommend using the CLI Checkinstall
utility for any Data Collector subsystem vendor which supports On-Demand runs.

The following directions assume that the Data Collector files have been installed
in their default location:
■ Windows:C:\Program Files\Veritas\AnalyticsCollector
■ Linux:/usr/openv/analyticscollector
If you have installed the files in a different directory, make the necessary path
translations in the following instructions.

Note: Some of the following commands can take up to several hours, depending
on the size of your enterprise.

To run Checkinstall
1 Open a session on the Data Collector server.
Windows: Open a command prompt window.
Linux: Open a terminal/SSH session logged in as root to the Data Collector
Server.
2 Change to the directory where you’ll run the validation script.
Windows: At the command prompt, type:

cd C:\Program Files\Veritas\AnalyticsCollector <enter>

Linux: In the SSH session, type:

cd /usr/openv/analyticscollector <enter>

3 Execute the validation script.


Windows: At the command prompt, type: checkinstall.bat <enter>
Validating data collection 77
Using the CLI check install utility

Linux: In the SSH session. type: ./checkinstall.sh <enter>


The checkinstall utility performs a high-level check of the installation, including
a check for the domain, host group and URL, Data Collector policy and database
connectivity. For a component check, specifically for Host Resources, run the
hostresourcedetail.sh|batutility.
This utility fails if :
■ The Data Collector policy has NOT been configured in the Portal.
OR
■ The version of the Data Collector doesn’t match with the version of
NetBackup IT Analytics Portal.
To upgrade Data Collector version to match with the version of NetBackup IT
Analytics Portal.
Login to portal.
Navigating to Admin > Data Collection > Collector Updates page.
Trigger the upgrade.
Ensure that the Data Collector services are online.
Checkinstall includes an option to run a probe for one or more specific devices.
Note that certain Data Collectors will not allow individual selection of devices.
Typically these are collectors that allow the entry of multiple server addresses
or ranges of addresses in a single text box.
These collectors include: Cisco Switch, EMC Data Domain, EMC VNX arrays,
HP 3PAR, IBM mid-range arrays, IBM XIV arrays and VMware.
Data Collectors that probe all devices that are attached to a management
server also do not allow individual selection of devices: EMC Symmetric, File
Analytics, Hitachi arrays and IBM VIO.
4 If the output in the previous steps contains the word FAILED and the reason
of failure is NOT because of version mismatch, then contact Support and have
the following files ready for review:
■ Windows: C:\Program
Files\Veritas\AnalyticsCollector\mbs\logs\validation\

■ Linux: /usr/openv/analyticscollector/mbs/logs/validation/
Validating data collection 78
List Data Collector configurations

List Data Collector configurations


Use this utility to list the various child threads and their configurations encapsulated
within a data collector configuration. This utility can be used in conjunction with
other scripts, such as checkinstall.[sh|bat].
On Linux: ./listcollectors.sh
On Windows: listcollectors.bat
Chapter 6
Uninstall the Data
Collector
This chapter includes the following topics:

■ Uninstall the Data Collector on Linux

■ Uninstall the Data Collector on Windows

Uninstall the Data Collector on Linux


This uninstall process assumes that the Data Collector was installed using the
standard installation process.
To uninstall the Data Collector software from a Linux host:
1 Login to the Data Collector server as root.
2 For NetBackup IT Analytics Data Collector version 10.6 or lower, execute the
Uninstall APTARE IT Analytics Data Collector Agent script located at
<Data Collector home folder>/UninstallerData

For example:

/opt/aptare/UninstallerData/Uninstall APTARE IT Analytics Data


Collector Agent

3 For NetBackup IT Analytics Data Collector version 11.0 or later, execute


uninstall_dc.sh script located at <Data Collector home
folder>/UninstallerData/uninstall_dc.sh

For example:

/opt/aptare/UninstallerData/uninstall_dc.sh
Uninstall the Data Collector 80
Uninstall the Data Collector on Windows

Uninstall the Data Collector on Windows


This uninstall process assumes that the Data Collector was installed using the
standard installation process.
To uninstall the Data Collector software from a Windows host:
1 Login to the Data Collector server as an administrator.
2 Go to Control Panel > Add and Remove Program > Programs and Features
and uninstall NetBackup IT Analytics Data Collector.
The uninstaller may not delete the entire Data Collector directory structure.
Sometimes new files that were created after the installation are retained along with
their parent directories. If the Data Collector was upgraded from version 10.6 or
older, you may find entries of Kafka and Zookeeper services on the services panel
(default C:\Program Files\Aptare), even after the uninstallation of the Data
Collector. You must manually delete the services and reboot the system.
Chapter 7
Manually start the Data
Collector
This chapter includes the following topics:

■ Introduction

Introduction
The installer configures the Data Collector to start automatically, however, it does
not actually start it upon completion of the installation because you must first validate
the installation. Follow these steps, for the relevant operating system, to manually
start the Data Collector service.
This also starts the Aptare Agent process, Zookeeper, and Kafka services on the
respective systems.

On Windows
The installer configures the Data Collector process as a Service.

To view the Data Collector Status:


1. Click Start > Settings > Control Panel
2. Click Administrative Tools.
3. Click Services. The Services dialog is displayed.
4. Start the Aptare Agent service.

On Linux
The installer automatically copies the Data Collector “start” and “stop” scripts to the
appropriate directory, based on the vendor operating system.
Manually start the Data Collector 82
Introduction

To start the data collector, use the following command:

/opt/aptare/mbs/bin/aptare_agent start
Appendix A
Firewall configuration:
Default ports
This appendix includes the following topics:

■ Firewall configuration: Default ports

Firewall configuration: Default ports


The following table describes the standard ports used by the Portal servers, the
Data Collector servers, and any embedded third-party software products as part of
a standard “out-of-the-box” installation.

Table A-1 Components: Default Ports

Component Default Ports

Apache Web Server http 80

https 443

Jetty Server on Data Collector Server 443

Kafka 9092

Linux Hosts SSH 22

Managed Applications Oracle ASM 1521

MS Exchange 389

MS SQL 1433

File Analytics CIFS 137, 139


Firewall configuration: Default ports 84
Firewall configuration: Default ports

Table A-1 Components: Default Ports (continued)

Component Default Ports

Oracle 1521

Oracle TNS listener port

Tomcat - Data Receiver 8011, 8017

Apache connector port and shutdown port for Data


Receiver instance of tomcat

Tomcat - Portal 8009, 8015

Apache connector port and shutdown port for


Portal instance of tomcat

Windows Hosts TCP/IP 1248

WMI 135

DCOM TCP/UDP > 1023

SMB TCP 445

ZooKeeper 2181
Note: NetBackup IT Analytics uses
standalone installation of single-node
Apache ZooKeeper server. For secure
communications, ZooKeeper
single-node cluster must be protected
from external traffic using network
security such as firewall. This is
remediated by ensuring that the
ZooKeeper port (2181) is only
accessible on the local host where
NetBackup IT Analytics Portal/Data
Collector is installed (that includes
Apache ZooKeeper).

Table A-2 Storage Vendors: Default Ports

Storage Vendor Default Ports and Notes

Dell Compellent 1433

SMI-S http (5988)

SMI-S https (5989)

Dell EMC Elastic Cloud Storage (ECS) REST API 4443


Firewall configuration: Default ports 85
Firewall configuration: Default ports

Table A-2 Storage Vendors: Default Ports (continued)

Storage Vendor Default Ports and Notes

Dell EMC Unity REST API version 4.3.0 on 443 or 8443

EMC Data Domain Storage SSH 22

EMC Isilon SSH 22

EMC Symmetrix SymCLI over Fibre Channel 2707

EMC VNX NaviCLI 443, 2163, 6389, 6390, 6391,


6392

EMC VNX (Celerra) XML API 443, 2163, 6389, 6390, 6391,
6392

EMC VPLEX https TCP 443

EMC XtremIO REST API https 443

HP 3PAR 22 for CLI

HP EVA 2372

HPE Nimble Storage 5392, REST API Reference Version


5.0.1.0

Hitachi Block Storage TCP 2001

For the HIAA probe: 22015 is used for


HTTP and 22016 is used for HTTPS.

Hitachi Content Platform (HCP) SNMP 161

REST API https 9090

Hitachi NAS (HNAS) SSC 206

Hitachi Vantara All-Flash and Hybrid Flash Storage Hitachi Ops Center Configuration
Manager REST API: 23450 for HTTP
and 23451 for HTTPS.

HIAA : 22015 for HTTP, and 22016 for


HTTPS

IBM Enterprise TCP 1751, 1750, 1718

DSCLI

IBM SVC SSPC w/CIMOM 5988, 5989

IBM XIV XCLI TCP 7778


Firewall configuration: Default ports 86
Firewall configuration: Default ports

Table A-2 Storage Vendors: Default Ports (continued)

Storage Vendor Default Ports and Notes

Microsoft Windows Server 2016

WMI 135

DCOM TCP/UDP > 1023

NetApp E-Series SMCLI 2436

NetApp ONTAP 7-Mode and Cluster-Mode ONTAP API

80/443

Pure Storage FlashArray REST API https 443

Table A-3 Data protection: Default ports

Data Protection Vendor Default Ports and Notes

Cohesity DataProtect REST API on Port 80 or 443

Commvault Simpana 1433, 135 (skipped files)

445 (CIFS over TCP)

DCOM >1023

Dell EMC Networker Backup & Recovery Port used for Dell EMC NetWorker
REST API connection. Default: 9090.

EMC Avamar 5555

SSH 22

EMC Data Domain Backup SSH 22

HP Data Protector 5555 WMI ports SSH 22 (Linux)

IBM Spectrum Protect (TSM) 1500

NAKIVO Backup & Replication Director Web UI port (Default: 4443)

Oracle Recovery Manager (RMAN) 1521

Rubrik Cloud Data Management REST API 443

Veeam Backup & Replication 9392

Veritas Backup Exec 1433


Firewall configuration: Default ports 87
Firewall configuration: Default ports

Table A-4 Network & Fabrics: Default Ports

Network & Fabrics Vendor Default Ports and Notes

Brocade Switch SMI-S 5988/5989

Cisco Switch SMI-S 5988/5989

Table A-5 Virtualization Vendors: Default Ports

Virtualization Vendor Default Ports and Notes

IBM VIO SSH 22

Microsoft Hyper-V WMI 135

DCOM TCP/UDP > 1023

VMware ESX or ESXi,vCenter,vSphere vSphere VI SDK

https TCP 443

Table A-6 Replication Vendors: Default Ports

Replication Vendor Default Ports and Notes

NetApp ONTAP 7-Mode ONTAP API

80/443

Table A-7 Cloud Vendors: Default Ports

Cloud Vendor Default Ports and Notes

Microsoft Azure https 443

OpenStack Ceilometer 8774, 8777

Keystone Admin 3537

Keystone Public 5000

OpenStack Swift Keystone Admin 35357


Keystone Public 5000

SSH 22

Google Cloud Platform https 443

You might also like