Profile parameters

/home/tdpvmware/tdpvmware/config

C:\Program Files\IBM\StorageProtect\Framework\VEGUI\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:

DERBY_HOME  /home/tdpvmware/tdpvmware

DERBY_HOME  C:\Program Files\IBM\StorageProtect\Framework\VEGUI\derby

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.

Example:

VE_DATACENTER_NAME  DataCenter1::Fin_Datacenter1
VE_DATACENTER_NAME  DataCenter2::Fin_Datacenter2
VE_DATACENTER_NAME  DataCenter3::Fin_Datacenter3

Important: The Data Protection for VMware vSphere GUI does not support datacenters with the same name in the vCenter.

This parameter is valid only in a vSphere environment.

Restrictions:

Data Protection for VMware does not support a one-to-many or many-to-one relationship between the datacenter name and the datacenter node. For example, the following relationships are not supported:

VE_DATACENTER_NAME  DataCenter1::Fin_Datacenter1
VE_DATACENTER_NAME  DataCenter1::Fin_Datacenter2
VE_DATACENTER_NAME  DataCenter1::Fin_Datacenter3

Or

VE_DATACENTER_NAME  DataCenter1::Fin_Datacenter1
VE_DATACENTER_NAME  DataCenter2::Fin_Datacenter1
VE_DATACENTER_NAME  DataCenter3::Fin_Datacenter1

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 the IBM Storage Protect node, be aware of these restrictions:

• Do not change the datacenter name in the vCenter without also creating the IBM Storage Protect node name and associating it with the new datacenter name.
• Do not change the datacenter name and the profile without also changing the IBM Storage Protect node name.
• Do not create a datacenter mapping value in the profile with a previously used IBM Storage Protect 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.

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.

VE_TSMCLI_NODE_NAME <VMCLI node>

Specify the VMCLI node. This node connects the Data Protection for VMware command-line interface to the IBM Storage Protect server and data mover node.

Example:

VE_TSMCLI_NODE_NAME  VC1_VCLI1

Restriction: The VMCLI node does not support the SSL protocol or LDAP authentication when communicating with the IBM Storage Protect server.

VE_TSM_SERVER_NAME <server host name or IP address>

Specify the host name or IP address of the IBM Storage Protect server used for backup operations. There is no default value.

Example:

VE_TSM_SERVER_NAME  tsmserver.xyz.yourcompany.com

VE_TSM_SERVER_PORT <port name>

Specify the port name to use for the IBM Storage Protect server. The default value is 1500.

Example:

VE_TSM_SERVER_PORT  1500

VE_TSM_SSL YES|NO

Specify whether to enable Secure Sockets Layer (SSL) to provide secure client and server communications. No is the default.

VE_TSM_SSLACCEPTCERTFROMSERV YES|NO

Specify whether the backup-archive client or the API application accept and trust the IBM Storage Protect server's Secure Sockets Layer (SSL) public certificate the first time they connect. YES is the default. You can use this option to connect only to an IBM Storage Protect server version 8.1.2 and later.

VE_TSM_SSLREQUIRED DEFAULT|YES|NO|SERVERONLY

Specify the conditions when SSL is or is not required when the client logs on to the IBM Storage Protect server or storage agents. DEFAULT is the default. When communicating with the IBM Storage Protect server version 8.1.2 and later, this option no longer applies since SSL is always used.

VE_VCENTER_NODE_NAME <vCenter node>

Specify the vCenter node. This virtual node represents a vCenter.

Example:

VE_VCENTER_NODE_NAME  VC1

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

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

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

VMCLI_DB_NAME <Derby database name>

Specify the name of the Derby database. The default value is VMCLIDB.

Example:

VMCLI_DB_NAME  VMCLIDB

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

VMCLI_GRACE_PERIOD <seconds>

When a backup is no longer available on the IBM Storage Protect server, 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

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

/opt/tivoli/tsm/tdpvmware/common/logs

C:\Program Files\Common Files\Tivoli\TDPVMware\logs

Example:

VMCLI_LOG_DIR  logs

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

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

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

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

VMCLI_TRACE YES|NO

Specify that tracing files are activated. Activate tracing only when instructed to do so by IBM Software Support.