Customizing node names

You can add a prefix, suffix, or both to default node names. In this way, you can customize the node names that are generated automatically by the configuration wizard.

About this task

When you use the configuration wizard to configure Data Protection for Microsoft Hyper-V, the nodes that are created conform to the following default naming conventions:

hostname_HV_TGT (or clustername_HV_TGT for clusters)
hostname_HV_DM
hostname_HV_MP_WIN (if the file restore feature is enabled)
hostname_HP_MP_LNX (if the file restore feature is enabled)

However, you can customize the node names. For example, you might have to customize node names to support a multitenant environment in which multiple tenants host their virtual machines on the same server. To differentiate the nodes based on tenant, you can add a prefix, suffix, or both to the default node names.

You can customize the node names for a new Data Protection for Microsoft Hyper-V configuration or for an existing configuration.

Procedure

To customize node names, complete the following steps:

Create a text file named hvConfig.props in the C:\IBM\SpectrumProtect\webserver\usr\servers\veProfile\tsmVmGUI directory on the Hyper-V host in a stand-alone or cluster environment.
Edit the hvConfig.props file and add the following two statements to the file:
```
node_prefix=prefix
node_suffix=suffix
```
where prefix is the text string that you want to add to the beginning of the node name, and suffix is the text string that you want to append to the node name.

You can specify only the prefix, only the suffix, or both a prefix and a suffix. The total length of the node name (including the prefix, suffix, or both) cannot exceed 64 characters.

If you leave the text string blank or remove the statement, the default node name remains unchanged. If you do not want to use any prefix or suffix, do not create the hvConfig.props file.
The resulting customized node names follow this pattern:
- prefix_hostname_HV_TGT_suffix (or prefix_clustername_HV_TGT_suffix for clusters)
- prefix_hostname_HV_DM_suffix
- prefix_hostname_HV_MP_WIN_suffix (if the file restore feature is enabled)
- prefix_hostname_HP_MP_LNX_suffix (if the file restore feature is enabled)
For a cluster environment, create the C:\IBM\SpectrumProtect\webserver\usr\servers\veProfile\tsmVmGUI\hvConfig.props file on each host in the cluster and specify the same properties on each host.
Important: All hosts in the cluster must have this file before you can run the configuration wizard.
If you previously configured Data Protection for Microsoft Hyper-V with the default node names, you must rename the nodes on the IBM Spectrum Protect™ server.
For instructions, see Renaming nodes on the IBM Spectrum Protect server.
Run the configuration wizard on the Hyper-V host. The prefix, suffix, or both are added to the naming convention of the nodes.

Results

For example, you want to add the prefix "SP" and suffix "DEPT1" to the Data Protection for Microsoft Hyper-V node names. You added the following statements to the C:\IBM\SpectrumProtect\webserver\usr\servers\veProfile\tsmVmGUI\hvConfig.props file:

node_prefix=SP
node_suffix=DEPT1

For a stand-alone host named MYHOST, the following nodes are created when you run the configuration wizard (if the file restore feature is enabled):

SP_MYHOST_HV_TGT_DEPT1
SP_MYHOST_HV_DM_DEPT1
SP_MYHOST_HV_MP_WIN_DEPT1
SP_MYHOST_HV_MP_LNX_DEPT1

If you have a cluster with cluster name MYCLUSTER, hosts HOSTA and HOSTB, the following nodes are created (if the file restore feature is enabled):

SP_MYCLUSTER_HV_TGT_DEPT1
SP_HOSTA_HV_DM_DEPT1
SP_HOSTA_HV_MP_WIN_DEPT1
SP_HOSTA_HV_MP_LNX_DEPT1
SP_HOSTB_HV_DM_DEPT1
SP_HOSTB_HV_MP_WIN_DEPT1
SP_HOSTB_HV_MP_LNX_DEPT1

What to do next

You can verify the values for the node_prefix and node_suffix parameters by running the Get-DpHvHostConfiguration Windows PowerShell cmdlet.

For example, from a PowerShell prompt, issue the following cmdlet:

PS C:\Users\administrator> Get-DpHvHostConfiguration -Session $session