How to add Virtual Machine Server credentials using tpconfig command

Problem

How to use the command-line interface to add or modify Virtual Machine (VM) Server credentials with the tpconfig command. This is useful when gathering information, or when GUI access is not available.

Solution

To Display Virtual Machine Credentials:

UNIX: /usr/openv/volmgr/bin/tpconfig -dvirtualmachines
Windows: install_path\Volmgr\bin\tpconfig -dvirtualmachines

To Add Virtual Machine Credentials:

UNIX: /usr/openv/volmgr/bin/tpconfig -add -virtual_machine <virtual_machine_name> -vm_user_id <user ID> -vm_type <virtual_machine_type> -requiredport <IP port number> -password <password>
Windows: install_path\Volmgr\bin\tpconfig -add -virtual_machine <virtual_machine_name> -vm_user_id <user ID> -vm_type <virtual_machine_type> -requiredport <IP port number> -password <password>

<virtual machine type> can be one of the following:
       "1", for VMware Virtual Center Servers
       "2", for VMware ESX Servers
       "3", for VMware Converter Servers
       "4", for VMware vCloud Director
       "5", for HYPERV Server
       "6", for System Center VMM Server
       "7", for HYPERV Cluster Server
       "8", for HyperScale Server
       "9", for Nutanix Acropolis Cluster
       "10", for Red Hat Virtualization Manager
       "11", for VMware Guest Virtual Machine

To Update Virtual Machine Credentials:

UNIX: /usr/openv/volmgr/bin/tpconfig -update -virtual_machine <virtual_machine_name> -vm_user_id <user ID> -vm_type <virtual_machine_type> -requiredport <IP port number> -password <password>
Windows: install_path\Volmgr\bin\tpconfig -update -virtual_machine <virtual_machine_name> -vm_user_id <user ID> -vm_type <virtual_machine_type> -requiredport <IP port number> -password <password>

To Delete Virtual Machine Credentials:

UNIX: /usr/openv/volmgr/bin/tpconfig -delete -virtual_machine <virtual_machine_name> -vm_user_id <user ID> -vm_type <virtual_machine_type>
Windows: install_path\Volmgr\bin\tpconfig -delete -virtual_machine <virtual_machine_name> -vm_user_id <user ID> -vm_type <virtual_machine_type>

Note: Deleting credentials via tpconfig command does not remove the virtual_machine entries from the EMM database (NBDB), only the nbemmcmd can remove that entry, but deleting credentials via the NetBackup Java Administration Console should do both.