The file | Teradata Vantage on VMware - The File - Teradata Vantage on VMware

Teradata Vantageā„¢ on VMware Base, Advanced, Enterprise Tiers Getting Started Guide

Teradata Vantage on VMware
Release Number
Deployer 3.04
October 2021
English (United States)
Last Update
Product Category

The file defines the VMware vSphere configuration settings common across all Vantage on VMware deployments. Configure the settings in this file initially, and verify or reconfigure each time something in the virtual environment changes.

Unless otherwise indicated, all property settings are required.

Property Category Properties Description
Teradata System Name TDsystemname Up to 15 alphanumeric characters, but cannot begin with a number. The system name is visible in Viewpoint.
Domain Setting domain The domain of the system being deployed which is placed into the /etc/hosts file.
Public (Customer) Port Groups public_vswitch The physical adapter with port group for the virtual network. The default setting is VM Network. This label is the name specified when you created the port group on the vSwitch.
  • public_vswitch:VM Network
BYNET Port Groups
  • byn_vswitch1
  • byn_vswitch2
BYNET port group labels. BYNET is required in MPP systems. The first port group is required in MPP systems. The second is for redundancy and performance in MPP systems. This label is the name specified when you create the port group on vSwitch in vSphere. The field must be empty for single-node/SMP systems.
CMIC Port Groups cmic_vswitch1


The labels of the Server Management (CMIC) port groups. The first is the primary connection to the CMIC. The second is for redundancy. This label is the name specified when you created the port group on the vSwitch.
DSC Port Group dsu_vswitch The label of the DSC switch. This label is the name specified when you created the port group on the vSwitch.
Public (Customer) Submask Setting public_submask The public submask name in dot-decimal notation.
  • public_submask:
Public (Customer) Gateway Setting gateway The gateway name or IP address.
  • gateway:
Domain Name System Settings



The DNS name or IP address.
  • dns1:
  • [Optional] dns2:
External NTP Server Settings



The host name or IP address of the ntp1 server is required; the ntp2 server is optional.
  • [Optional]

You must configure the NTP servers if you plan to use the Temporal feature.

Time Zone Setting OSTimeZone [Optional] The time zone of the VM. Enter either a fixed time zone displacement from GMT or the time zone file name. See the file LinuxTimeZoneStrings.txt for the valid settings for OSTimeZone.

If Temporal is enabled and OSTimeZone is not enabled, then OSTimeZone will be automatically set to match the database time zone.

If you are not enabling Temporal, the database time zone syncs with the operating system.

The default time zone is US/Pacific.

  • OSTimeZone=GMT+11
  • OSTimeZone=US/Eastern
PDisk Datastore Match Criteria PDisk_Datastore_Match Use this property to find the database datastores to attach data disks (pdisks). The default setting is _data, which detects any datastores that contain _data in their name to be usable for database storage. Change this setting to match your datastores.
Make sure the value of PDisk (TPA) Datastore Match Criteria does not match the pattern of the OS Datastore property in the properties file by choosing different naming conventions for PDisk Datastore Match Criteria and OS Datastore.

Example: If you name the pdisk datastores LUN_01 and LUN_02, and the OS datastore LUN_OS, and enter LUN as the value of PDisk_Datastore_Match, the scripts cannot differentiate internally between the pdisk datastores and the OS datastore. To resolve this issue, rename the OS datastore so LUN is not in the name.

Physical Disk Settings pdiskSizeGB The size of the Vantage system pdisks.
  • pdiskSizeGB:800
Physical Disk Settings uniqueDisks Knowledge of Vantage systems and vSphere storage set up is necessary to use this setting.

Teradata recommends keeping the default setting to true. Do not change the default setting if you do not plan to use this feature.

Change the setting to false if you want more than one Vantage system data disk to be placed into each Vantage datastore. The deployment executable file enumerates the datastores found on a given ESXi host using the PDisk_Datastore_Match expression. If set to false, the SQL Engine (TPA) nodes create pdisks without considering ownership when deploying on shared storage, SANs, or when there is not enough disks available. Database performance may be impacted. You can create as many Vantage system data disks of pdiskSizeGB that fit into the first one and then move to the next one.

  • If each of the enumerated datastores were 900 GB and the pdiskSizeGB was set to 300 GB, then during deployment three Vantage system data disks would be placed in each datastore until each vnode has three Vantage system data disks.
System Setting PhysicalCoresPerTPA Changes the number of physical cores assigned to each SQL Engine (TPA) VM. This does not affect the other node types.

The total physical cores consumed by your Teradata entitlement (license) equals the PhysicalCoresPerTPA setting times the number of TPA nodes.

Teradata Intelligent Memory (TIM) Tim If you plan to use TIM, change the setting to TRUE. If you do not plan to use it, accept the default of FALSE.
Temporal Settings Temporal






If you plan to use Temporal, change the setting to true. If you do not plan to use it, accept the default of false. See Temporal Settings.
Temporal can be set either during deployment, or after deployment with Customer Service support. Additional charges will apply; please contact your Teradata Sales team.
  • Temporal:false
  • TemporalDaylightSavings:false
  • TemporalTimeDateWZControl:0
  • TemporalTimeZoneHour:0
  • TemporalTimeZoneMinute:0
  • TemporalTimeZoneString:America Pacific
Other Vantage Feature Settings
  • Columnar
  • RowLevelSecurity
  • SecureZones
[Optional] Columnar, Row Level Security, and Secure Zones are Vantage features that can be enabled by setting the field values to true. If you do not plan to use a feature, accept the default value of false.
Site ID SiteID The site ID representing this system. This is optional.
Mainframe Settings MainframeLHID The logical host ID for mainframe connectivity. The default is -1 to indicate the deployed system does not connect to a mainframe.
  • MainframeLHID:-1
Public (Customer) SSH Key PublicSshKey Use this property to pass your public SSH key to a Vantage system.

The key you provide will be added to the authorized keys file on every database node, except CMIC, and can be used for passwordless SSH.

Use the full path. For example:

PublicSshKey: C:\path_to_the_key\

Folder Setting Folder Folder name where the VM is being deployed on the vSphere server.
IP Address Setting IPAddressSetting Indicates whether to use a static or dynamic IP address.
For a two-node MPP deployment, the IP address must be static.
Host-Based Authentication (HBA) enableHBA

[Optional] Authenticates each node participating in internode communication and makes sure that data exchange/communication between the nodes is secure.

HBA is not in the file by default. It can be added by entering the variable, and then enabled by setting it to TRUE.

License Settings Tier Database license tier that matches the software package you ordered.
  • ET - Enterprise tier (default)
  • AT - Advanced tier
  • BT - Base tier

Obtain this value from the email you received when you purchased the license.

EntitlementID Unique string of characters that enable you to use the licensed software.

Obtain the EID from the email you received when you purchased the license.

LicensePeriodInYears Valid values for the duration of license period are:
  • 1 (year, default)
  • 3 (years)
  • POC (30 days)

Obtain this value from the email you received when you purchased the license.

The license period is visible as a suffix to the Part# in the Product column after you log in to For example, an Enterprise license with a 1 Year term contains a Part# of Enterprise1YearVMware.

TeradataEmsURL URL used to verify Teradata license, assuming you are deploying on a system with Internet access. The default is