Professional Documents
Culture Documents
Hat Virtualization
Administrator's Guide
Release 10.2
Last updated: 2023-03-17
Legal Notice
Copyright © 2023 Veritas Technologies LLC. All rights reserved.
Veritas, the Veritas Logo, and NetBackup 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 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.
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:
Japan CustomerCare_Japan@veritas.com
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:
https://sort.veritas.com/documents
Documentation feedback
Your feedback is important to us. Suggest improvements or report errors or omissions to the
documentation. Include the document title, document version, chapter title, and section title
of the text on which you are reporting. Send feedback to:
NB.docs@veritas.com
You can also see documentation information or ask a question on the Veritas community site:
http://www.veritas.com/community/
https://sort.veritas.com/data/support/SORT_Data_Sheet.pdf
Contents
Things to consider before you recover the Red Hat Virtualization virtual
machines .............................................................................. 33
About the pre-recovery check ......................................................... 33
Recover an Red Hat Virtualization virtual machine .............................. 34
About the supported virtual disk formats and disk provisioning during
VM recovery .......................................................................... 36
■ About the ports that NetBackup uses to communicate with Red Hat Virtualization
■ If you have integrated with NetBackup API for Red Hat Virtualization protection,
some of the APIs are not available and are not served by NetBackup 10.2 primary
server. For details, refer to NetBackup Asset Service Getting Started Guide.
■ During the upgrade, NetBackup primary server migrates the Red Hat
Virtualization assets and intelligent groups to the new tables. Depending on the
number of VMs that were discovered earlier, the migration of this information
can take some time.
During this migration, you might not see all the VMs in the NetBackup Web UI.
The Web UI displays the following message:
The migration process is in progress. The provided data might be inconsistent
and incomplete.
This message disappears once the migration is done.
During the migration, protection of intelligent groups might not work for a short
while, but the protection of the individual VMs that are subscribed works.
■ During the migration, if you do not see the VMs in the Web UI, you cannot start
a VM restore from the backup images, but you can use the bpsrestore command
or the restore API.
Table 1-1 Configure and protect Red Hat Virtualization virtual machines
using NetBackup
Deploy NetBackup to protect Red Hat On a very high-level, to protect Red Hat Virtualization VMs, you need:
Virtualization VMs
■ NetBackup primary server
■ NetBackup media server
■ NetBackup client that can act as a backup host
Configure an Red Hat Virtualization access An Red Hat Virtualization access host acts as a backup host and a
host for backup and recovery recovery host during backup and recovery respectively. The access
host is involved in the data movement during the backup and restore
operations.
If you plan to use a backup host that is not a NetBackup media server
or an appliance, add the backup host to the NetBackup Red Hat
Virtualization Access Hosts list.
Enable secure communication between The following sections contain more information about setting up a
NetBackup and Red Hat Virtualization secure communication between NetBackup and Red Hat Virtualization:
■ Secure communication
See “Configuring secure communication between the Red Hat
Virtualization server and NetBackup host” on page 10.
■ Communication ports
See “About the ports that NetBackup uses to communicate with
Red Hat Virtualization” on page 17.
Managing Red Hat Virtualization servers 9
Quick configuration checklist to protect Red Hat Virtualization virtual machines
Table 1-1 Configure and protect Red Hat Virtualization virtual machines
using NetBackup (continued)
Consider setting global limits on the use of When you protect VMs automatically when they are created, over a
Red Hat Virtualization resources period of time the number of VMs protected concurrently can grow
large. The large number of concurrent backups can affect the Red Hat
Virtualization performance as well as backup performance.
You can set the global limits to manage the Red Hat Virtualization
resources efficiently.
See “Setting global limits on the use of Red Hat Virtualization resources”
on page 26.
Additional references
The following table describes the high-level steps or a checklist to recover the Red
Hat Virtualization virtual machines and additional information:
Removing protection from VMs See “Remove protection from VMs or intelligent VM groups” on page 31.
Managing Red Hat Virtualization servers 10
Configuring secure communication between the Red Hat Virtualization server and NetBackup host
API and command line options to protect Red You can use NetBackup APIs or command line options to protect and
Hat Virtualization VMs recover Red Hat Virtualization VMs
Troubleshooting information ■ Use the following information to troubleshoot issues regarding Red
Hat Virtualization protection or recovery
ECA_TRUST_STORE_PATH Specifies the file path to the certificate bundle file that contains
all trusted root CA certificates.
If you have not configured the option, add all the required Red
Hat Virtualization server CA certificates to the trust store and
set the option.
If you have not configured the option, add all the required
CRLs to the CRL cache and then set the option.
See “ECA_CRL_PATH for NetBackup servers and clients”
on page 14.
VIRTUALIZATION_HOSTS_ This option affects Nutanix AHV, Red Hat Virtualization, and
SECURE_CONNECT_ENABLED VMware secure communication. Without this option, the secure
or insurce communication with workload is decided by each
workload and plug-in separately.
See
“VIRTUALIZATION_HOSTS_SECURE_CONNECT_ENABLED
for servers and clients” on page 15.
Managing Red Hat Virtualization servers 13
Configuring secure communication between the Red Hat Virtualization server and NetBackup host
Usage Description
Note: For validating the revocation status of a virtualization server certificate, the
VIRTUALIZATION_CRL_CHECK option is used.
Usage Description
VIRTUALIZATION_HOSTS_SECURE_CONNECT_ENABLED for
servers and clients
The VIRTUALIZATION_HOSTS_SECURE_CONNECT_ENABLED option enables the
validation of virtualization server certificates using its root or intermediate certificate
authority (CA) certificates.
Managing Red Hat Virtualization servers 16
Configuring secure communication between the Red Hat Virtualization server and NetBackup host
Before you enable the option, review the steps from the 'Validating VMware
virtualization server certificates in NetBackup ' section in the NetBackup for VMware
Administrator's Guide.
By default, the VIRTUALIZATION_HOSTS_SECURE_CONNECT_ENABLED option is set to
UNDEFINED.
The security certificate validation is enabled for Red Hat Virtualization and Nutanix
AHV servers, but is disabled for VMware servers.
Usage Description
How to use Use the nbgetconfig and the nbsetconfig commands to view,
add, or change the option.
Use the following format to enable certificate validation for the Red
Hat Virtualization, VMware, or Nutanix AHV servers:
VIRTUALIZATION_HOSTS_SECURE_CONNECT_ENABLED = YES
Usage Description
80, 443 TCP Red Hat Virtualization Provides HTTP and HTTPS
Manager access to the Red Hat
Virtualization Manager
Managing Red Hat Virtualization servers 18
Add or browse an Red Hat Virtualization manager
Note: NetBackup recommends that you use the FQDN to add the Red Hat
Virtualization Manager. Using an IP address or short name to add the Red Hat
Virtualization Manager can create duplicate entries and cause issues during
RBAC enforcement.
All
RHV_Managers
RHV_Manager1
Cluster1
Cluster2
RHV_Manager2
Cluster3
Cluster4
Note: SSL requires that all backup hosts have ECA certificates.
Communication between Red Hat Virtualization and backup host requires an open
port.
The following operating systems are supported for your backup host:
■ Windows
■ Red Hat Linux
■ SUSE
When the backup host is not a NetBackup media server or an appliance, you need
to add the backup host to the NetBackup Red Hat Virtualization Access Hosts
list.
To add an access host
1 In the NetBackup Web UI, in the left pane, click Red Hat Virtualization.
2 At the top right, Red Hat Virtualization settings > Access hosts and click
Add to add an access host.
Note: A background task adds the newly discovered VMS that match the query to
the intelligent VM group. This background task runs 5 minutes after the start of the
Netbackup Web Management service. After that, the task runs every 30 minutes.
Note: The web UI lists the servers that you can access based on your role and
permissions (RBAC).
5 To add a condition, use the drop-downs to select a keyword and operator and
then enter a value.
See the section called “Query options for creating intelligent VM groups”
on page 24.
The following is an example query:
In this example, the query adds to the group any VM that has prod in its display
name.
To change the effect of the query, click + Condition and click AND or OR,
then select the keyword, operator, and value for the condition. For example:
This example uses AND to narrow the scope of the query: it selects only the
VMs that have prod in their display name and that also have a tag named eng.
If a VM does not have prod in its display name as well as a tag named eng,
that VM is not added to the group.
To broaden the scope of the query, use OR:
Managing Red Hat Virtualization servers 23
Create an intelligent VM group
In this example, OR causes the query to add the following to the group:
■ The VMs that have prod in their display name (regardless of any tags).
■ The VMs that have a tag named eng (regardless of the display name).
Managing Red Hat Virtualization servers 24
Create an intelligent VM group
7 To save the group without adding it to a protection plan, click Add. To save
and add it to a protection plan, click Add and protect, select the plan, and
click Protect.
Note: When you click Preview or save the group, the query options are treated
as case-sensitive when the VMs are selected for the group. Under Virtual
machines, if you click on a VM that was not selected for the group, the Member
of virtual machine groups field reads none.
However, when you add the group to a protection plan, some of the query
options are treated as case-insensitive when the protection plan’s backup runs.
As a result, the same VM may now be included in the group and is backed up.
See the section called “Query options for creating intelligent VM groups”
on page 24.
Note: If you use filters in intelligent group, NetBackup Web UI might not display
the accurate list of VMs that match the filter if the VM or the Red Hat
Virtualization server has non-English characters. However, during the backup,
correct VMs are selected even though the VM attributes are non-English. This
behavior is only in viewing the VMs in NetBackup Web UI.
Keyword Description
Keyword Description
Operator Description
Starts with Matches the value when it occurs at the start of a string.
For example: If the value you enter is box, this option matches the
string box_car but not flatbox.
Ends with Matches the value when it occurs at the end of a string.
For example: If the value you enter is dev, this option matches the
string 01dev but not 01dev99 or devOP.
Contains Matches the value you enter wherever that value occurs in the string.
For example: If the value you enter is dev, this option matches strings
such as 01dev, 01dev99, devOP, and development_machine.
For example: If the value you enter is VMtest27, this option matches
VMTest27 (same case), but not vmtest27, vmTEST27, or VMtest28.
!= Matches any value that is not equal to the value that you enter.
Managing Red Hat Virtualization servers 26
Remove an intelligent VM group
3 Select the resource type you want to change and then click Edit.
4 Choose from the following options.
Set a global limit for a Locate the Global setting and select the Limits value
VMware resource type. that you want to apply.
Example
The following example illustrates how these limits control simultaneous backups.
The settings must be done according to Red Hat Virtualization configuration in your
environment.
When NetBackup connects to the Red Hat Virtualization environment for backup,
it makes 1 connection per disk present on the VM. So, if a VM has 2 disks then
NetBackup would make 2 connections with the Red Hat Virtualization node.
So, consider a case where Red Hat Virtualization manager is managing 2 clusters
with 2 nodes in each cluster. Let’s consider every node is hosting 20 VMs with 2
disks on each VM.
When the job runs, there would be 80 concurrent jobs start if no Resource Limit is
set which is default behavior. Red Hat Virtualization recommends up to 10 disk
connections concurrently per node in the cluster. In the example of each VM with
two disks, 5 VMs per node can be ideally backed up concurrently. Hence, in this
case of a cluster with two nodes, it is recommended to backup upto 10 VMs
concurrently. When the Backup Jobs per Cluster is set to 10, this limit is enforced.
Since one data center can manage multiple clusters, Backup Jobs per DataCenter
resource limit could be higher than Backup Jobs per Cluster. You need to
determine the values by evaluating the effect of backup on overall environment.
Storage domain in Red Hat Virtualization can server multiple clusters in a data
center. It serves to protection VM as well as backup. Its performance is dependent
on type of storage technology – FC, iSCSI, NFS, gluster etc. Hence limit on storage
domain using Backup Jobs per StorageDomain can be set based on
characteristics of storage domain technology and limit can be higher than Backup
Jobs per Cluster.
Chapter 2
Protecting RHV virtual
machines
This chapter includes the following topics:
■ Things to know before you protect Red Hat Virtualization virtual machines
■ If the VM virtual disks are locked when the NetBackup services shutdown or
crash during a backup, use Red Hat Virtualization’s unlock_entity command
to unlock the disks. If the disks are not unlocked, the subsequent backups might
fail.
Protecting RHV virtual machines 29
Protect Red Hat Virtualization VMs or intelligent VM groups
See “Error run into while backing up Red Hat Virtualization virtual machines”
on page 40.
■ On a file storage (NFS), a QCOW2 disk gets restored as raw disk (thin provision)
because of an Red Hat Virtualization limitation.
■ A thin dependent cloned VM is restored as an independent cloned VM.
■ If you want to use a storage that is not available through the NetBackup Web
UI like a tape or basic disk based storage unit, you can use APIs or command
line options to protect the VMs.
■ For the minimum permissions required to perform VM backup and restore, see
https://www.veritas.com/content/support/en_US/article.100050733
Note: The RBAC role that is assigned to you must give you access to the assets
that you want to manage and to the protection plans that you want to use.
5 Click Protect.
The results of your choices appear under Virtual machines or Intelligent VM
groups.
Protecting RHV virtual machines 30
Customize protection settings for a RHV asset
Edit the settings for a VM ■ On the Virtual machines tab, click on the
VM that you want to edit.
Edit the settings for an intelligent group ■ On the Intelligent VM groups tab, click
on the group that you want to edit.
5 Click Protect.
Schedules
The following schedule settings are included in a protection plan.
Note that when you customize a protection plan for an asset, you can only edit the
following schedule settings:
■ Start window
Option Description
Keep for (retention) How long to keep the files that were backed
up by the schedule.
Protecting RHV virtual machines 31
Remove protection from VMs or intelligent VM groups
Option Description
Backup options
The user can adjust the following settings when subscribing to a protection plan.
Option Description
Select server or host to use The host that performs backups on behalf of the virtual
for backups machines. Users can choose Automatic to have NetBackup
pick the media server, based on the storage unit. Or, the user
can select another host from the list. These hosts are other
media servers in the environment or hosts that are configured
as an access host.
■ Things to consider before you recover the Red Hat Virtualization virtual machines
■ About the supported virtual disk formats and disk provisioning during VM recovery
■ Connectivity with the Red Hat Virtualization server and Red Hat Virtualization
credential validation.
■ Availability of the Red Hat Virtualization cluster.
■ Available space with the storage domain.
Overwrite existing If a VM with the same UUID or same name exists at the
virtual machine destination and if this option is selected then that VM is deleted.
Recovery host A backup host that you can use during recovery. By default, the
recovery host is the backup host that was used during a backup.
Advanced settings:
Create a new VM Restores the VM with a new UUID instead of the original UUID.
UUID
Remove tag Removes the tags which were associated with the VM at the
associations time of backup.
Original provision Restores the VM's virtual disks with their original provisioning.
Thick provision Configures the restored virtual disks in the thick format. The
virtual disk space is pre-allocated when the disk is created.
Thin provision Configures the restored virtual disks in the thin format. Restores
only the populated blocks and the new blocks are allocated as
required.
Recovering RHV virtual machines 36
About the supported virtual disk formats and disk provisioning during VM recovery
Table 3-1 Virtual disk provisioning for Red Hat Virtualization VM recovery
Table 3-1 Virtual disk provisioning for Red Hat Virtualization VM recovery
(continued)
■ Error during the Red Hat Virtualization virtual machines discovery phase
■ Error run into while backing up Red Hat Virtualization virtual machines
■ Check the Job details section for the job in Activity monitor.
■ Check the bpbkar and VxMS logs.
■ For Red Hat Virtualization-related errors, check Events section on Red Hat
Virtualization manager console.
■ For upgrades:
When you upgrade NetBackup primary server, the assets (VM and Intelligent
VM groups) are migrated from the older database tables to the new database
tables.
A background migration task runs when the NetBackup Web Management
Console starts. During this migration, the NetBackup Web UI displays the
following message:
The migration process is in progress. The provided data might be inconsistent
and incomplete.
Table 4-1 Error run into during the Red Hat Virtualization virtual machines
discovery phase
The Red Hat Virtualization assets are The maximum allowed length of the Red Hat Virtualization manager name is
not discovered after the correct Red 255 characters, however, if the characters exceed 95, the asset discovery
Hat Virtualization manager credentials fails.
are added. The VM discovery Workaround:
operation fails.
■ Ensure that the Red Hat Virtualization manager name has 95 or fewer
characters.
Troubleshooting RHV VM protection and recovery 40
Error run into while backing up Red Hat Virtualization virtual machines
Table 4-1 Error run into during the Red Hat Virtualization virtual machines
discovery phase (continued)
The discovery job fails with error 200. Ensure that the query specified in the policy or intelligent VM group is correct.
(Scheduler found no backups or clients The VMs that need protection are added recently to Red Hat Virtualization
to deploy NetBackup) manager or the VM configuration has changed and the autodiscovery or
discover now was not triggered.
■ Run discover now and retry the backup. The maximum allowed length of
the Red Hat Virtualization manager name is 255 characters, however, if
the characters exceed 95, the asset discovery fails.
Workaround:
Ensure that the Red Hat Virtualization manager name has 95 or fewer
characters.
■ The asset discovery does not work if the Red Hat Virtualization manager
credentials are added using tpconfig.
Workaround:
From NetBackup WebUI, run Discover for the specified Red Hat
Virtualization manager.
Ensure that you add the Red Hat Virtualization manager credentials using
API or NetBackup WebUI.
The GET asset API does not work NetBackup Web UI:
when you use the tolower and
For the filter in the intelligent Groups, NetBackup WebUI might not display
toupper functions.
accurate list of the Red Hat Virtualization VMs that match the filter if the VM
or the Red Hat Virtualization server has non-English characters. However,
during the backup, correct VMs are selected even though its attributes are
non-English. This behavior is only in viewing the VMs in NetBackup Web UI.
The GET Assets API does not give the desired result if the tolower or
toupper functions are used together for the assets that have non-English
characters.
There is a delay in the API response. For a large number if Red Hat Virtualization assets, if you add large and random
offsets to an API request, there is an increase in the processing time that leads
to a delay in the API response.
Table 4-2 Error while backing up Red Hat Virtualization virtual machines
After a NetBackup backup operation, If a disk attached to the VM is in an inactive state, then the Red Hat
the VM snapshot on the Red Hat Virtualization manager does not delete the VM snapshot after a backup
Virtualization manager is not deleted. operation is complete.
Workaround:
■ Before the backup operation, verify the state of the disks that are attached
to the VM and ensure that they are active.
■ Ensure that the disks are not attached while the VM is running, thus
preventing the disk to be in an inactive state.
VM backup fails with the following This temporary error might occur when the VM snapshot is not available for
error: the backup operation. The backup job is successful on the second attempt.
Accelerator option does not work. When a backup policy is created using APIs and the use Accelerator option
is enabled, the policy gets created but the NetBackup Accelerator feature does
not work.
Table 4-3 Error run into while restoring Red Hat Virtualization virtual
machines
VM recovery to alternate location fails For a Windows NetBackup primary server, ensure that the rename file ends
on a Windows primary server. with an empty line.
Pre-recovery check runs successfully Pre-recovery check compares the VM display name instead of UUID to find
when a VM with the same UUID exists out if VM already exists, hence the check completes successfully. But if the
in the Red Hat Virtualization cluster overwrite option is not set, the restore job fails if a VM with the same UUID
and the option to overwrite the VM is already exists.
not enabled, but the VM restore fails.
Workaround:
The following error message is seen:
Restore the VM with a new UUID
Info bpVMutil (pid=1196) FTL -
Virtual machine exists and overwrite 1 Start the recovery process.
option not specified, can not proceed
2 On the Recovery Options page, click Advanced.
with restore. end Restore; elapsed
time Hypervisor policy restore error. 3 Enable Create a new VM UUID.
(2822) 4 Proceed with the recovery process and click Start recovery to restore.
3 Proceed with the recovery process and click Start recovery to restore.
When you try to recover an Red Hat During the recovery of imported Red Hat Virtualization VM images, for the
Virtualization VM image that is recovery host, select the access host in the target domain as a recovery host
imported from a different domain using or select the target primary server.
the Web UI, the pre-recovery check
fails and displays that by default the
recovery host is the same access host
that was used during back up.
Chapter 5
API and command line
options for RHV
This chapter includes the following topics:
■ Using APIs and command line options to manage, protect, or recover RHV VMs
application_consistent=1
Virtual_machine_backup=1
vm_identifier=GUID (catalog uses VM UUID)
file_system_optimization=1
exclude_swap=1
file_system_optimization=1
exclude_swap=1
API and command line options for RHV 46
Using APIs and command line options to manage, protect, or recover RHV VMs
After you create the policy, other commands like creating the schedule for the policy
or triggering the policy backup remain the same. For more information about the
commands, refer to the NetBackup Commands Reference Guide.
defaultVmDiskProvisioning
powerOnAfterRecovery
overwriteExistingVm
removeNetworkInterfaces
retainVmGuid
removeTagAssociations
defaultVmDiskProvisioning
powerOnAfterRecovery
overwriteExistingVm
removeNetworkInterfaces
retainVmGuid
removeTagAssociations
API and command line options for RHV 48
Using APIs and command line options to manage, protect, or recover RHV VMs
Usage Description
How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the OVIRT_IMAGEIO_INACTIVITY_TIMEOUT option.
Example The following entry tells the NetBackup backup job to set the client inactivity timeout
period to 172800 seconds (48 hours).
OVIRT_IMAGEIO_INACTIVITY_TIMEOUT = 172800
Usage Description
How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the RHV_CREATEDISK_TIMEOUT option.
Example The following entry tells the NetBackup backup job to set the create disk timeout period
to 172800 seconds (48 hours).
RHV_CREATEDISK_TIMEOUT = 172800
Usage Description
Usage Description
How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.
The default is 28,800 seconds (8 hours). The minimum value is 300 seconds (5 minutes)
and the maximum is 31,536,000 seconds (1 year).
For example:
RHV_AUTODISCOVERY_INTERVAL = 100000