Profile parameters

Use the Data Protection for VMware command-line interface profile to configure settings for backup and restore tasks in your environment.

The profile is located in this directory on the system where the Data Protection for VMware vSphere GUI is installed:

Linux operating systems/home/tdpvmware/tdpvmware/config

Windows operating systemsC:\Program Files\Common Files\Tivoli\TDPVMware\VMwarePlugin\scripts

DERBY_HOME <path to Derby database>
This parameter specifies the location of the Derby database that is used by the Data Protection for VMware command-line interface.
Example:
Linux operating systems
DERBY_HOME  /home/tdpvmware/tdpvmware
Windows operating systems
DERBY_HOME  C:\Program Files\Common Files\Tivoli\TDPVMware\VMwarePlugin\derby

This parameter is valid in a vSphere or vCloud Director environment.

VE_DATACENTER_NAME <data_center_name::DATA_CENTER_NODE_NAME>
Specify the VMware datacenter (datacenter name) with a value that is case-sensitive and that matches the datacenter name used in the vCenter. Specify the virtual node (DATA_CENTER_NODE_NAME) that maps to the datacenter. If the vCenter manages several datacenters, you can specify this parameter for each datacenter. However, the Data Protection for VMware vSphere GUI does not support datacenters with the same name in the vCenter.
Example:
VE_DATACENTER_NAME  DataCenter1::Fin_Datacenter1
VE_DATACENTER_NAME  DataCenter2::Fin_Datacenter2

This parameter is valid only in a vSphere environment.

Restriction: Data Protection for VMware support for VM backup and restore operations is limited to VM names and datacenter names that contain English 7-bit ASCII characters only. VM names and datacenter names that use other language characters are not currently supported. Additional character restrictions are listed in Troubleshooting.
After a datacenter name is created and associated with a Tivoli® Storage Manager node, be aware of these restrictions:
  • Do not change the datacenter name in the vCenter without also creating a Tivoli Storage Manager node name and associating it with the new datacenter name.
  • Do not change the datacenter name and the profile without also changing the Tivoli Storage Manager node name.
  • Do not create a datacenter mapping value in the profile with a previously used Tivoli Storage Manager node.
When the datacenter name in the vCenter has changed, you must complete these steps before attempting any operations:
  1. Register a datacenter node for the new datacenter name.
  2. Grant proxy authority to the new datacenter node to perform tasks on behalf of the vCenter node.
  3. Update the profile with the new datacenter mapping.
  4. Grant proxy authority to the data mover nodes to perform tasks on behalf of the new datacenter node.
  5. Remove any entry from the profile that used the previous datacenter node or vCenter node name.
VE_TRACE_FILE <path and name of trace file>
Specify the full path and name of the file to be used to contain trace information. Activate tracing only when instructed to do so by IBM® Software Support.
This parameter is valid in a vSphere or vCloud Director environment.
VE_TRACE_FLAGS <flags>
Specify one or more trace flags. Multiple trace flags are separated with a space. Activate tracing only when instructed to do so by IBM Software Support.
This parameter is valid in a vSphere or vCloud Director environment.
VE_TSMCLI_NODE_NAME <VMCLI node>
Specify the VMCLI node. This node connects the Data Protection for VMware command-line interface to the Tivoli Storage Manager server and data mover node.
Example:
VE_TSMCLI_NODE_NAME  VC1_VCLI1
This parameter is valid in a vSphere or vCloud Director environment.
Restriction: The VMCLI node does not support the SSL protocol or LDAP authentication when communicating with the Tivoli Storage Manager server.
VE_TSM_MODE VCLOUD I VSPHERE
Specify the VMware environment that Data Protection for VMware protects. You can specify one of the following environments:
VCLOUD
Specify this value when Data Protection for VMware protects data in a vCloud Director environment.
VSPHERE
Specify this value when Data Protection for VMware protects data in a vSphere environment.
Example:
VE_TSM_MODE VCLOUD
This parameter is valid in a vSphere or vCloud Director environment.
VE_TSM_SERVER_NAME <server host name or IP address>
Specify the host name or IP address of the Tivoli Storage Manager server used for backup operations. There is no default value.
Example:
VE_TSM_SERVER_NAME  tsmserver.xyz.yourcompany.com
This parameter is valid in a vSphere or vCloud Director environment.
VE_TSM_SERVER_PORT <port name>
Specify the port name to use for the Tivoli Storage Manager server. The default value is 1500.
Example:
VE_TSM_SERVER_PORT  1500
This parameter is valid in a vSphere or vCloud Director environment.
VE_VCENTER_NODE_NAME <vCenter node>
Specify the vCenter node. This virtual node represents a vCenter.
Example:
VE_VCENTER_NODE_NAME  VC1
In vCloud mode, the VE_VCENTER_NODE_NAME parameter is the top-level node that represents the vCloud.
This parameter is valid in a vSphere or vCloud Director environment.
VMCLI_DB_BACKUP NO AT[day[, day[,.....]]] time TO backup location
This parameter controls the backup of the Derby database containing the metadata of the Data Protection for VMware command-line interface. Specify one of these values:
NO
This option does not perform a backup of the Derby database.
AT [day[, day[,....]]] time_in _24_H
This option creates a backup on the specified day or days at the specified time, which is triggered by the scheduler. If the day value is not specified, a daily backup is created. Specify one of these values:
MON, TUE, WED, THU, FRI, SAT, SUN.
You can separate these values by a comma or a blank space.
AFTER_BACKUP
This option creates a backup of the Derby database after each Data Protection for VMware backup operation.
The default location for the backups of the Derby database is install_dir/derby_backups. Specify TO path to set a custom path.
Example:
VMCLI_DB_BACKUP  AT 00:00
This parameter is valid in a vSphere or vCloud Director environment.
VMCLI_DB_BACKUP_VERSIONS <number>
Specify the maximum number of backup generations that are maintained for the Derby database, before the oldest version is overwritten by a new version. This parameter applies only to the backups of the Derby database containing metadata. It has no effect on the number of backup generations that are maintained for the backups of a vSphere environment. The default value is 3.
Example:
VMCLI_DB_BACKUP_VERSIONS 3
This parameter is valid in a vSphere or vCloud Director environment.
VMCLI_DB_HOST <Derby database local host name>
Specify the local host name of the Derby database. You can specify the host name (localhost) or the IP address (0.0.0.0).
Example:
VMCLI_DB_HOST localhost
This parameter is valid in a vSphere or vCloud Director environment.
VMCLI_DB_NAME <Derby database name>
Specify the name of the Derby database. The default value is VMCLIDB.
Example:
VMCLI_DB_NAME  VMCLIDB
This parameter is valid in a vSphere or vCloud Director environment.
VMCLI_DB_PORT <Derby database port number>
Specify the Derby database port on which the Data Protection for VMware command-line interface starts and connects to the database. The default value is 1527. If this port is in use by another application, specify a different port.
Example:
VMCLI_DB_PORT  1527
This parameter is valid in a vSphere or vCloud Director environment.
VMCLI_GRACE_PERIOD <seconds>
When a backup is no longer available on Tivoli Storage Manager, the backup is marked for deletion as defined by a deletion date. However, before the backup is deleted, a grace period exists. Use this parameter to specify the grace period (length of time) between the deletion date and the date the backup is deleted from the Derby database. The default value is 2592000 seconds (30 days).
Example:
VMCLI_GRACE_PERIOD  1296000
This parameter is valid in a vSphere or vCloud Director environment.
VMCLI_LOG_DIR <path of log file>
Specify the absolute location or the relative location of the installation directory where the Data Protection for VMware command-line interface writes its log files. The default value is logs. If the default value logs is used, then all logs (and trace information) are written to these locations:.

Linux operating systems/opt/tivoli/tsm/tdpvmware/common/logs

Windows operating systemsC:\Program Files\Common Files\Tivoli\TDPVMware\logs

Example:
VMCLI_LOG_DIR  logs
This parameter is valid in a vSphere or vCloud Director environment.
VMCLI_RECON_INTERVAL_TSM <seconds>
This parameter specifies the interval between reconciliation operations on the Derby database with Data Protection for VMware. Reconciliation operations delete metadata for backups that are no longer available. This action ensures the Derby database remains synchronized with the Data Protection for VMware repository. The default value is 1200 seconds.
Example:
VMCLI_RECON_INTERVAL_TSM  1200
This parameter is valid in a vSphere or vCloud Director environment.
VMCLI_RESTORE_TASK_EXPIRATION_TIME <seconds>
Specify the time that a Data Protection for VMware command-line interface restore task is stored in the Derby database. The default value is 2592000 seconds (30 days).
Example:
VMCLI_RESTORE_TASK_EXPIRATION_TIME  2592000
This parameter is valid in a vSphere or vCloud Director environment.
VMCLI_SCHEDULER_INTERVAL <seconds>
Specify the interval, in seconds, between scheduler checks for scheduled tasks due to begin. The default value is 1 second.
Example:
VMCLI_SCHEDULER_INTERVAL 60
This parameter is valid in a vSphere or vCloud Director environment.
VMCLI_TASK_EXPIRATION_TIME <seconds>
This parameter specifies the time that a task is stored in the Data Protection for VMware command-line interface Derby database. This parameter applies only to the inquire_config command. The default value is 864000 seconds (10 days).
Example:
VMCLI_TASK_EXPIRATION_TIME  864000
This parameter is valid in a vSphere or vCloud Director environment.
VMCLI_TRACE YES|NO
Specify that tracing files are activated. Activate tracing only when instructed to do so by IBM Software Support.
This parameter is valid in a vSphere or vCloud Director environment.

Example Linux profile in a vSphere environment

Linux operating systems
VE_TSM_SERVER_NAME      9.11.90.28
VE_TSM_SERVER_PORT      1500
VE_TSMCLI_NODE_NAME     my_vc1_vcli1
VE_VCENTER_NODE_NAME    my_vc1
VE_DATACENTER_NAME               Clovis Lab::MY_VC1_DC1
VMCLI_TASK_EXPIRATION_TIME         864000 # in seconds, defaults to 864000s = 10 days
VMCLI_RESTORE_TASK_EXPIRATION_TIME 2592000 # in seconds, defaults to 2592000s = 30 days
VMCLI_GRACE_PERIOD                 2592000 # in seconds, defaults to 2592000s = 30 days
VMCLI_SCHEDULER_INTERVAL           60     # in seconds, defaults to 1s
VMCLI_DB_HOST                      localhost
VMCLI_DB_PORT   1527
VMCLI_CACHE_EXPIRATION_TIME        600  # in seconds, defaults to 600s = 10 min
VMCLI_DB_NAME                      VMCLIDB
VMCLI_RECON_INTERVAL_FCM           600   # setting in seconds default 600s = 10 min
VMCLI_RECON_INTERVAL_TSM           1200  # setting in seconds default 1200s = 20 min
VMCLI_DB_BACKUP                    AT 00:00
VMCLI_DB_BACKUP_VERSIONS           3
VMCLI_LOG_DIR                      logs
DERBY_HOME      /home/tdpvmware/tdpvmware

Example Windows profile in a vSphere environment

Windows operating systems
VE_TSM_SERVER_NAME                 philadelphia                  # -s
VE_TSM_SERVER_PORT                 1500                          # -p    
VE_TSMCLI_NODE_NAME                CLI_WIN8x32                   # -n
VE_VCENTER_NODE_NAME               VC_WIN8x32                    # -v
VE_DATACENTER_NAME                 DC_CVT::DC_Win8x32
VMCLI_TASK_EXPIRATION_TIME         864000 # in seconds, defaults to 864000s = 10 days
VMCLI_RESTORE_TASK_EXPIRATION_TIME 2592000  # in seconds, defaults to 2592000s = 30 days
VMCLI_GRACE_PERIOD                 2592000 # in seconds, defaults to 2592000s = 30 days
VMCLI_SCHEDULER_INTERVAL           60  # in seconds, defaults to 1s
VMCLI_DB_HOST                      localhost
VMCLI_DB_PORT                      1527
VMCLI_CACHE_EXPIRATION_TIME        600  # in seconds, defaults to 600s = 10 min
VMCLI_DB_NAME                      VMCLIDB
VMCLI_RECON_INTERVAL_FCM           600  # setting in seconds default 600s = 10 min
VMCLI_RECON_INTERVAL_TSM           1200 # setting in seconds default 1200s = 20 min
VMCLI_DB_BACKUP                    AT 00:00
VMCLI_DB_BACKUP_VERSIONS           3
VMCLI_LOG_DIR                      logs
DERBY_HOME  C:\Program Files\Common Files\Tivoli\TDPVMware\VMwarePlugin\derby

Example Linux profile in a vCloud environment

Linux operating systems
VE_TSM_SERVER_NAME       fvtseries11esx6
VE_TSM_SERVER_PORT      1500
VE_TSMCLI_NODE_NAME      VMCLI_LNX_TEST2
VE_VCENTER_NODE_NAME     VCD_LNX_TEST2
VMCLI_TRACE                        NO
#VE_TSM_SERVER_NAME                tsmservername                 # -s
#VE_TSM_SERVER_PORT                1500                          # -p
#VE_TSMCLI_NODE_NAME               tsmclinodename                # -n
#VE_VCENTER_NODE_NAME              vcenternodename               # -v
#VE_TRACE_FILE                     tsmcli.trace                  # -x tsmcli trace file
#VE_TRACE_FLAGS                    api api_detail                # -y trace flags
#VE_DATACENTER_NAME                datacentername::datacenternodename
VMCLI_TASK_EXPIRATION_TIME         864000   # in seconds, defaults to 864000s = 10 days
VMCLI_RESTORE_TASK_EXPIRATION_TIME 2592000  # in seconds, defaults to 2592000s = 30 days
VMCLI_GRACE_PERIOD                 2592000  # in seconds, defaults to 2592000s = 30 days
VMCLI_SCHEDULER_INTERVAL           60       # in seconds, defaults to 1s
VMCLI_DB_HOST                      localhost
VMCLI_DB_PORT   1527
VMCLI_CACHE_EXPIRATION_TIME        600      # in seconds, defaults to 600s = 10 min
VMCLI_DB_NAME                      VMCLIDB
VMCLI_RECON_INTERVAL_FCM           600  # in seconds default 600s = 10 min
VMCLI_RECON_INTERVAL_TSM           1200 # in seconds default 1200s = 20 min
VMCLI_DB_BACKUP                    AT 00:00
VMCLI_DB_BACKUP_VERSIONS           3

Example Windows profile in a vCloud environment

Windows operating systems
VE_TSM_SERVER_NAME	harding
VE_TSM_SERVER_PORT	1500
VE_TSMCLI_NODE_NAME	VMCLI_WINSTR
VE_VCENTER_NODE_NAME	VCD_WINSTR
VMCLI_TRACE                        NO
#VE_TSM_SERVER_NAME                tsmservername                 # -s
#VE_TSM_SERVER_PORT                1500                          # -p    
#VE_TSMCLI_NODE_NAME               tsmclinodename                # -n
#VE_VCENTER_NODE_NAME              vcenternodename               # -v
#VE_TRACE_FILE                     tsmcli.trace                  # -x tsmcli trace file
#VE_TRACE_FLAGS                    api api_detail                # -y trace flags
#VE_DATACENTER_NAME                datacentername::datacenternodename
VMCLI_TASK_EXPIRATION_TIME         864000   # in seconds, defaults to 864000s = 10 days
VMCLI_RESTORE_TASK_EXPIRATION_TIME 2592000  # in seconds, defaults to 2592000s = 30 days
VMCLI_GRACE_PERIOD                 2592000  # in seconds, defaults to 2592000s = 30 days
VMCLI_SCHEDULER_INTERVAL           60       # in seconds, defaults to 1s
VMCLI_DB_HOST                      localhost
VMCLI_DB_PORT                      1527
VMCLI_CACHE_EXPIRATION_TIME        600      # in seconds, defaults to 600s = 10 min
VMCLI_DB_NAME                      VMCLIDB
VMCLI_RECON_INTERVAL_FCM           600 # in seconds default 600s = 10 min
VMCLI_RECON_INTERVAL_TSM           1200 # in seconds default 1200s = 20 min
VMCLI_DB_BACKUP                    AT 00:00
VMCLI_DB_BACKUP_VERSIONS           3
VMCLI_LOG_DIR                      logs
DERBY_HOME   C:\Program Files (x86)\Common Files\Tivoli\TDPVMware\VMwarePlugin\derby
VE_TSM_MODE       	VCLOUD
VE_DATACENTER_NAME	Local DC::WINMA_LOCAL_DC