NetBackup™ Web UI Nutanix AHV Administrator's Guide

Last Published:
Product(s): NetBackup (10.2)
  1. Overview
    1.  
      Overview of configuring and protecting AHV assets in the NetBackup web UI
  2. Managing AHV clusters
    1.  
      Quick configuration checklist to protect AHV virtual machines
    2.  
      Configure secure communication between the AHV cluster and NetBackup host and Nutanix Prism Central and NetBackup host
    3.  
      Enable the iSCSI initiator service on windows backup host
    4.  
      Install the iSCSI initiator package on Linux backup host
    5.  
      Migrate Java GUI/CLI added clusters into WebUI
    6.  
      Configure Nutanix AHV cluster
    7.  
      Configure CHAP settings for iSCSI secure communication with AHV clusters
    8.  
      About the ports that NetBackup uses to communicate with AHV
    9.  
      Add or browse an AHV cluster
    10.  
      Remove AHV Clusters
    11.  
      Add a new Nutanix Prism Central
    12.  
      Add new Prism Central server credentials
    13.  
      Remove Nutanix Prism Central
    14.  
      Create an intelligent VM group
    15.  
      Assign permissions to the intelligent VM group
    16.  
      Update the intelligent VM group
    17.  
      Remove the intelligent VM group
    18.  
      Set CHAP for iSCSI
    19.  
      Add an AHV access host
    20.  
      Remove an AHV access host
    21.  
      Change resource limits for AHV resource types
    22.  
      Change the autodiscovery frequency of AHV assets
  3. Managing credentials
    1. Managing AHV cluster credentials
      1.  
        Add new cluster credentials
      2.  
        Update and validate AHV cluster credentials
    2. Managing Nutanix Prism Central credentials
      1.  
        Add new Nutanix Prism Central credentials
      2.  
        Update and validate Nutanix Prism Central credentials
    3.  
      View the credential name that is applied to an asset
    4.  
      Edit or delete a named credential
  4. Protecting AHV virtual machines
    1.  
      Things to know before you protect AHV virtual machines
    2.  
      Protect AHV VMs or intelligent VM groups
    3.  
      Protect AHV VMs within VPC
    4.  
      Customize protection settings for an AHV asset
    5.  
      Schedules and retention
    6.  
      Backup options
    7.  
      Prerequisite to Enable virtual machine quiescing
    8.  
      Remove protection from VMs or intelligent VM groups
    9.  
      View the protection status of VMs or intelligent VM groups
  5. Recovering AHV virtual machines
    1.  
      Things to consider before you recover the AHV virtual machines
    2.  
      About the pre-recovery check
    3.  
      Recover an AHV virtual machine
    4.  
      Recover an AHV VM within VPC
    5.  
      About Nutanix AHV agentless files and folders restore
    6.  
      Prerequisites for agentless files and folder recovery
    7.  
      SSH key fingerprint
    8.  
      Recover files and folders with Nutanix AHV agentless restore
    9.  
      Recovery target options
    10.  
      Pre-recovery checks for Nutanix AHV
    11.  
      About Nutanix-AHV agent-based files and folders restore
    12.  
      Prerequisites for agent-based files and folder recovery
    13.  
      Recover files and folders with Nutanix AHV agent based restore
    14.  
      Limitations
  6. Troubleshooting AHV operations
    1.  
      Troubleshooting tips for NetBackup for AHV
    2.  
      Error during AHV credential addition
    3.  
      Error during the AHV virtual machines discovery phase
    4.  
      Errors for the Status for a newly discovered VM
    5.  
      Error run into while backing up AHV virtual machines
    6.  
      Error while restoring AHV virtual machines
  7. API and command line options for AHV
    1.  
      Using APIs and command line options to manage, protect, or recover AHV virtual machines
    2.  
      Additional NetBackup options for AHV configuration
    3.  
      Additional information about the rename file

Using APIs and command line options to manage, protect, or recover AHV virtual machines

This topic lists the APIs and command line options to protect or recover the AHV 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 an AHV cluster

Table: Add an AHV cluster

API or command line options

Important variables and options

POST
/netbackup/asset-service/queries
GET
/netbackup/asset-service/queries/{aqcId}

  • clusterName is the name of the AHV cluster.

  • backuphost is hostname of a NetBackup client.

  • credentialName are credentials associated with AHV cluster.

    Note:

    The credential must exist with credentialName mentioned.

tpconfig command

  • virtual_machine is the name of the AHV cluster.

  • vm_type is 9. The number 9 stands for AHV cluster.

Set iSCSI CHAP settings APIs

Table: Set iSCSI CHAP settings APIs

API or command line options

Important variables and options

GET 
/netbackup/config/iscsi-settings/
{workloadType}

  • workloadType specify the supported workload.

  • Obtains the global iSCSI settings for the specified workload type.

POST 
/netbackup/config/iscsi-settings/
{workloadType}

  • Changes the global iSCSI setting for the specified workload type.

  • authType is the authentication type. For example:

    • ONEWAY_CHAP

    • MUTUAL_CHAP_AUTOMATIC

  • passwordRenewalIntervalDays is applicable only for Mutual CHAP Automatic option.

    Note:

    Valid value is 1 - 365 days.

Create an AHV VM backup policy

Table: Create an AHV VM backup policy

API or command line options

Important variables and options

POST
/netbackup/config/policies/

  • policyType is Hypervisor.

  • backuphost is a hostname of a NetBackup client that performs backups on behalf of the virtual machines.

  • Add Add useVirtualMachine = 6 for Nutanix AHV.

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

  • In backupSelections > selections, use the filter option as Nutanix-ahv:/?filter=uuid Equal <uuid_filter>" to filter AHV VMs of a specific UUID.

    Apart from UUID, 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 allowedlisted Windows or Linux host.

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

  • In bpplinclude, use the filter option as Nutanix-ahv:/?filter=uuid Equal <uuid_filter>" to filter AHV VMs of a specific UUID.

  • In bpplinfo

    • Value of use_virtual_machine is 6 for AHV VMs.

    • Value of snapshot_method is Hypervisor_snap.

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.

Pre-Recovery check for AHV VM at the original location

Table: Pre-Recovery check for AHV VM at the original location

API or command line options

Important variables and options

POST /netbackup/recovery/workloads
/nutanix-ahv/scenarios/full-vm
/pre-recovery-check

  • client is identifier that was used at the time of backup. It can either be the displayName or the UUID.

  • ahvCluster is the name of the alternate AHV cluster.

  • recoveryHost is server that is to be used as the VM recovery host to perform this pre-recovery check.

  • vmDisks represents one or more virtual machine disks.

  • source is the source path of the virtual machine disk. This must be of the /storage_container/disk_uuid format.

  • destination is the destination path of the virtual machine disk. This should be of the format /storage_container.

  • Set the following values:

    powerOnAfterRecovery
overwriteExistingVm
removeNetworkInterfaces
retainVmGuid
retainNicMacAddress
Pre-Recovery check for AHV VM at a different location

Table: Pre-Recovery check for AHV VM at a different location

API or command line options

Important variables and options

POST /netbackup/recovery/workloads
/nutanix-ahv/scenarios/full-vm
/pre-recovery-check

  • client is identifier that was used at the time of backup. It can either be the displayName or the UUID.

  • ahvCluster is the name of the alternate AHV cluster.

  • recoveryHost is server that is to be used as the VM recovery host to perform this pre-recovery check.

  • vmDisks represents one or more virtual machine disks.

  • source is the source path of the virtual machine disk. This must be of the /storage_container/disk_uuid format.

  • destination is the destination path of the virtual machine disk. This should be of the format /storage_container.

  • Set the following values:

    powerOnAfterRecovery
overwriteExistingVm
removeNetworkInterfaces
retainVmGuid
retainNicMacAddress
Restore the AHV VM at the original location

Table: Restore the AHV VM at the original location

API or command line options

Important variables and options

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

  • client is identifier that was used at the time of backup. It can either be the display name or the UUID.

  • recoveryHost is server that is to be used as the VM recovery host to perform this recovery.

  • Set the following values:

    powerOnAfterRecovery
overwriteExistingVm
removeNetworkInterfaces
retainVmGuid
retainNicMacAddress

bprestore command

  • vmproxy specifies the name or the FQDN of the backup host.

  • vmserver is the name of the AHV cluster.

  • 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 See Additional information about the rename file.

Restore the AHV VM to an alternate location

Table: Restore the AHV VM to an alternate location

API or command line options

Important variables and options

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

  • client is identifier that was used at the time of backup. It can either be the displayName) or the UUID.

  • ahvCluster is the name of the alternate AHV cluster.

  • recoveryHost is server that is to be used as the VM recovery host to perform this recovery.

  • vmDisks represents one or more virtual machine disks.

  • source is the source path of the virtual machine disk. This should be of the format /storage_container/disk_uuid.

  • destination is the destination path of the virtual machine disk. This should be of the format /storage_container.

  • Set the following values:

    powerOnAfterRecovery
overwriteExistingVm
removeNetworkInterfaces
retainVmGuid
retainNicMacAddress

bprestore command

  • vmproxy specifies the name or the FQDN of the backup host.

  • vmserver is the name of the AHV cluser.

  • Use the following values to modify the VM configuration:

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