azureprov_templates.json reference

The host template file for Azure lists all the templates that host factory can use to provision Azure hosts. This file must be configured with the correct values from your Azure environment.

Each host template represents a class of instances that share some attributes, such as hardware configuration, installed software stack, operating system, and security settings.

Location

The azureprov_templates.json is at:
  • %HF_TOP%\%HF_VERSION%\providerplugins\azure\sampleconf\ on Windows.
  • $HF_TOP/$HF_VERSION/providerplugins/azure/sampleconf/ on Linux®.
Tip: The azureprov_templates.json sample file is renamed to azureinstprov_templates.json when copied into the configuration directory location, for example: %HF_CONFDIR%\providers\azureinst\ on Windows or $HF_CONFDIR/providers/azureinst/ on Linux.

Parameters

Note: If you enter double values for parameter fields that expect integers, the double value is rounded down to the nearest integer.
templateId
Required. Unique name of the template. Valid value is a string of up to 64 characters, which can contain the following characters: 0-9, A-Z, a-z, -, and _.
maxNumber
Required. Maximum number of VMs of this template that can be provisioned. Valid values are an integer in the range 1 - 10000 or -1 to indicate an unlimited number of VMs, up to a maximum of 10,000. You can also set 0 to indicate that no VMs of this template must be provisioned.
Note: Ensure that you define a value that falls within your subscription quotas for the maximum number of VMs as well as cores.
attributes
Required.
type
Required. Type of the VM (string). Supported values are any EGO_MACHINE_TYPE, including X64_64 and NTX64.
ncpus
Required. Number of CPUs per VM (numeric). Valid value is a positive integer higher than 0.
nram
Required. Available RAM (MB). Valid value is a positive integer higher than 0.
rank
For more information about configuring this rank parameter, see Selecting cost-based and rank-based cloud host topic.
priceInfo
For more information about configuring this priceInfo parameter and its attributes, see Selecting cost-based and rank-based cloud host topic.
imageId
Required. Unique ID of the OS image, which is the Azure OS image with IBM Spectrum Symphony preinstalled (see Creating a custom image in Azure). Alternatively, it can be a base OS image that is provided by Azure. For a base OS image, you must enter the image's urn value (see Setting up an Azure account) as the imageId value, for example, "imageId": "CoreOS:CoreOS:Stable:latest".
storageAccountType
Required. Type of storage account.
vmType
Required. Model of the Azure VM to be provisioned.
osType
Required. OS of the Azure VM to be provisioned. Valid value is Windows or Linux.
resourceGroup
Required. A container that holds related resources for an Azure solution.
virtualNetwork
Required. Pre-created virtual network to place resource in.
subnet
Required. Pre-created subnet to place resource in. All compute hosts that connect to your IBM Spectrum Symphony cluster must use private subnets. Ensure that your cluster is configured to access these private subnets.
securityGroup
Required. Pre-created network security group for Azure VMs.
withPublicIP
Optional. Whether the network can be accessed through a public IP over the internet. Valid value is true or false.
rootUserName
Optional. User name of the VM administrator who can switch to root. The default root user name is symphony. For Linux VMs, do not use root.
hostPrefix
Optional. Prefix that must be added to names of provisioned VMs for easier identification. Valid value must start with a letter and can contain letters, numbers, and non-consecutive dashes, up to a maximum of 10 characters. Default is compute- for all Azure VMs.

When this parameter is defined (for example) as mycluster-, the provisioned host name is similar to mycluster-1a23bc4d-567e-89fg-h012-34i56789jkl0, where 1a23bc4d-567e-89fg-h012-34i56789jkl0 identifies a randomly generated host string.

Restriction: A known limitation for the Windows operating system is that the total number of characters in the hostname cannot exceed 15 characters, which increases the possibility of having repeated hostnames for the provisioned hosts. For Windows operating system, you must consider a reduced number of characters, such as 10 or less characters in the hostPrefix name.
customScriptUri
Required. Full path to a post-provisioning script, which must be run after VM provisioning is complete. For more information about customizing sample scripts, see Configuring the post-provisioning script for Azure.
instanceTags
Optional. Tags that can be applied to your Azure VMs to organize them by categories.
sshPubKeyFile
(Linux only) When the osType parameter is set to Linux, the location of the SSH key to access the VM created. To generate the SSH key, follow these steps:
  1. Use the ssh-keygen command to generate the SSH key:
    ssh-keygen -t rsa -b 2048
  2. Copy the publish key file (for example, test.pub) to your primary host.
  3. Configure the sshPubKeyFile parameter to the location of the key file. For example:
    "sshPubKeyFile": "/opt/sym/hostfactory/conf/providers/azure/conf/server-key.pub"
adminPassword
(Windows only) When the osType parameter is set to Windows, the VM administrator's password in plain text.