Ransomware attackers specifically target and attempt to destroy backup systems to increase the probability of payment. Hardening your system is critical. Please ensure you have reviewed your platform security using the Security Hardening Checklist
Cohesity

COHESITY Documentation

Explore our documentation to get started, discover products & new features, access troubleshooting guides, register sources, platforms support.

Products
Data Security Alliance
Visit Cohesity.com
Demos
Support
Blogs
Developers
Partner Portals
Cohesity Community
© 2026 Cohesity, Inc. All Rights Reserved.
Terms of Use|
Privacy Policy|
Legal|
  1. Home
  3. NetBackup™ Web UI RHV Administrator's Guide
  5. API and command line options for RHV
  7. Using APIs and command line options to manage, protect, or recover RHV virtual machines
NetBackup™ Web UI RHV Administrator's Guide

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

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:

  • Add the RHV manager credentials

  • Validate the RHV manager credentials

  • Create an RHV VM backup policy

  • Restore the RHV VM at the original location

  • Restore the RHV VM to an alternate location

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

  • All the NetBackup APIs are listed at the following location:

    Services and Operations Readiness Tools (SORT) > Knowledge Base > Documents

  • For more information about the commands, refer to the NetBackup Commands Reference Guide.

Add the RHV manager credentials

Table: Add the RHV manager credentials

API or command line options

Important variables and options

POST
/netbackup/config/servers/vmservers

  • serverName is the name of the RHV manager

  • vmType is RED_HAT_VIRTUALIZATION_MANAGER

tpconfig command

  • virtual_machine is the name of the RHV manager.

  • vm_type is 10. The number 10 stands for RHV Manager.

Validate the RHV manager credentials

Table: Validate the RHV 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 RHV manager.

  • validationHost is a whitelisted Windows or Linux backup host.

Create an RHV VM backup policy

Table: Create an RHV 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:

  • In backupSelections > selections, use the filter option as "rhv:/?filter=Displayname Contains <name_filter>" to filter RHV 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 RHV VMs of a specific name.

  • In bpplinfo

    • Value of use_virtual_machine is 5 for RHV 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 RHV VM at the original location

Table: Restore the RHV 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 RHV 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 RHV VM to an alternate location

Table: Restore the RHV 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 RHV 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 RHV 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.

Feedback

Was this page helpful?
Previous

API and command line options for RHV

Next

Additional information about the rename file

Feedback

Was this page helpful?