NetBackup™ Web UI Red Hat Virtualization Administrator's Guide

Last Published:
Product(s): NetBackup (10.3.0.1, 10.2)
  1. Managing Red Hat Virtualization servers
    1.  
      Upgrading to NetBackup 10.3
    2.  
      Quick configuration checklist to protect Red Hat Virtualization virtual machines
    3. Configuring secure communication between the Red Hat Virtualization server and NetBackup host
      1.  
        ECA_TRUST_STORE_PATH for NetBackup servers and clients
      2.  
        ECA_CRL_PATH for NetBackup servers and clients
      3.  
        VIRTUALIZATION_HOSTS_SECURE_CONNECT_ENABLED for servers and clients
      4.  
        VIRTUALIZATION_CRL_CHECK for NetBackup servers and clients
    4.  
      About the ports that NetBackup uses to communicate with Red Hat Virtualization
    5. Add or browse an Red Hat Virtualization manager
      1.  
        Adding a backup host to the NetBackup primary server
      2.  
        Remove an Red Hat Virtualization manager
    6.  
      Configure autodiscovery of the Red Hat Virtualization virtual machines
    7.  
      Create an intelligent VM group
    8.  
      Remove an intelligent VM group
    9.  
      Setting global limits on the use of Red Hat Virtualization resources
  2. Protecting RHV virtual machines
    1.  
      Things to know before you protect Red Hat Virtualization virtual machines
    2.  
      Protect Red Hat Virtualization VMs or intelligent VM groups
    3. Customize protection settings for a RHV asset
      1.  
        Schedules
      2.  
        Backup options
    4.  
      Remove protection from VMs or intelligent VM groups
    5.  
      View the protection status of VMs or intelligent VM groups
  3. Recovering RHV virtual machines
    1.  
      Things to consider before you recover the Red Hat Virtualization virtual machines
    2.  
      About the pre-recovery check
    3.  
      Recover an Red Hat Virtualization virtual machine
    4.  
      About the supported virtual disk formats and disk provisioning during VM recovery
  4. Troubleshooting RHV VM protection and recovery
    1.  
      Troubleshooting tips for NetBackup for Red Hat Virtualization
    2.  
      Error during the Red Hat Virtualization virtual machines discovery phase
    3.  
      Error run into while backing up Red Hat Virtualization virtual machines
    4.  
      Error while restoring Red Hat Virtualization virtual machines
  5. API and command line options for RHV
    1. Using APIs and command line options to manage, protect, or recover RHV VMs
      1.  
        Additional information about the rename file
    2. Additional NetBackup options for Red Hat Virtualization configuration
      1.  
        OVIRT_IMAGEIO_INACTIVITY_TIMEOUT option for NetBackup servers
      2.  
        RHV_CREATEDISK_TIMEOUT option for NetBackup servers
      3.  
        RHV_AUTODISCOVERY_INTERVAL option for NetBackup servers

Using APIs and command line options to manage, protect, or recover RHV VMs

This topic lists the APIs and command line options to protect or recover the Red Hat Virtualization virtual machines. Only the important variables and options are mentioned in this topic.

Following sections are part of this topic:

For detailed information on the APIs and command lines, use these references:

Add the Red Hat Virtualization manager credentials

Table: Add the Red Hat Virtualization manager credentials

API or command line options

Important variables and options

POST
/netbackup/config/servers/vmservers

  • serverName is the name of the Red Hat Virtualization manager

  • vmType is RED_HAT_VIRTUALIZATION_MANAGER

tpconfig command

  • virtual_machine is the name of the Red Hat Virtualization manager.

  • vm_type is 10. The number 10 stands for Red Hat Virtualization Manager.

Validate the Red Hat Virtualization manager credentials

Table: Validate the Red Hat Virtualization manager credentials

API or command line options

Important variables and options

POST
/netbackup/config/servers/vmservers/
{serverName}/validate-credential

  • {serverName} is the name of the Red Hat Virtualization manager.

  • validationHost is a whitelisted Windows or Linux backup host.

Create an Red Hat Virtualization VM backup policy

Table: Create an Red Hat Virtualization VM backup policy

API or command line options

Important variables and options

POST
/netbackup/config/policies/

  • policyType is Hypervisor

  • backuphost is a whitelisted Windows or Linux host.

  • snapshotMethodArgs can have the following values to back up a VM using VM UUID:

    application_consistent=1
Virtual_machine_backup=1
vm_identifier=GUID (catalog uses VM UUID)
file_system_optimization=1
exclude_swap=1

    vm_identifier=[GUID:VM GUID] is the primary VM identifier

    Supported values are: DISPLAYNAME and GUID.

  • In backupSelections > selections, use the filter option as "rhv:/?filter=Displayname Contains <name_filter>" to filter Red Hat Virtualization VMs of a specific name.

    Apart from Displayname, you can use the other filter criteria mentioned for Intelligent VM groups.

admincmd command

  • In bpplclients -add <discoveryhost> Hypervisor Hypervisor, the hypervisor discovery host is a whitelisted Windows or Linux host.

  • In bpplinfo, the policy type (-pt) is Hypervisor.

  • In bpplinclude, use the filter option as "rhv:/?filter=Displayname Contains <name_filter>" to filter Red Hat Virtualization VMs of a specific name.

  • In bpplinfo

    • Value of use_virtual_machine is 5 for Red Hat Virtualization VMs.

    • Value of snapshot_method is Hypervisor_snap.

    For optimized backup, you can use:

    file_system_optimization=1
exclude_swap=1

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.

Restore the Red Hat Virtualization VM at the original location

Table: Restore the Red Hat Virtualization VM at the original location

API or command line options

Important variables and options

POST
/netbackup/recovery/workloads/rhv/
scenarios/full-vm/recover

  • client is the VM identifier of the protected VM. The VM identifier is the VM UUID.

  • recoveryHost is a whitelisted Windows or Linux host.

  • Set the following values:

    defaultVmDiskProvisioning
powerOnAfterRecovery
overwriteExistingVm
removeNetworkInterfaces
retainVmGuid
removeTagAssociations

bprestore command

  • vmproxy is a whitelisted Windows or Linux backup host.

  • vmserver is the name of the Red Hat Virtualization manager.

  • vmhypervisor specifies restore from the Hypervisor policy type

  • Use the following values to modify the VM configuration:

    • vmst to remove the VM tags.

    • vmpoweron to start the VM after the VM restore.

    • vmsn to remove the VMs network interfaces.

    • vmid to retain the original VM UUID of the VM. Alternatively, use the -K option to retain the existing VM with the same UUID and not overwrite it.

    • thickdisk to configure the restored virtual disks in the thick format. The virtual disk space is allocated when the disk is created.

    • thindisk to configure the restored virtual disks in the thin format. The populated blocks are restored but the vacant blocks are not initialized or committed.

Restore the Red Hat Virtualization VM to an alternate location

Table: Restore the Red Hat Virtualization VM to an alternate location

API or command line options

Important variables and options

POST
/netbackup/recovery/workloads/rhv/
scenarios/full-vm/recover

  • client is the VM name of the protected VM. The VM name can either be the display name (displayName) or the UUID.

  • rhvServer is the name of the alternate Red Hat Virtualization manager.

  • recoveryHost is a whitelisted Windows or Linux host.

  • vmhypervisor specifies restore from the Hypervisor policy type

  • Set the following values:

    defaultVmDiskProvisioning
powerOnAfterRecovery
overwriteExistingVm
removeNetworkInterfaces
retainVmGuid
removeTagAssociations

bprestore command

  • vmproxy is a whitelisted Windows or Linux backup host.

  • vmserver is the name of the Red Hat Virtualization manager.

  • Use the following values to modify the VM configuration:

    • vmst to remove the VM tags.

    • vmpoweron to start the VM after the VM restore.

    • vmsn to remove the VMs network interfaces.

    • vmid to retain the original VM UUID of the VM. Alternatively, use the -K option to retain the existing VM with the same UUID and not overwrite it.

  • The -R option defines the path of the rename file. Use the rename file to recover the VM to an alternate location or change the VM configuration.

    Sample rename file:

    change vmname to new_vm_name
change /storage_domain_1/disk1_UUID 
to /storage_domain_2/
change /storage_domain_1/disk2_UUID 
to /storage_domain_2/
change cluster to new_cluster_name

Note:

For a Windows NetBackup host, you must add an empty line at the end of the rename file entries.

See Additional information about the rename file.