Install and Configure vFabric SQLFire Licenses

Installation is required for all licensing except the default evaluation license, which is used automatically when other licensing is not provided. You do not need to install or configure the default evaluation license.

When you obtain custom evaluation licenses or purchase production licenses, you receive one or more serial numbers to use in your SQLFire member configurations. The number of serial numbers that you receive depends on the type of licensing that you purchase. You install licensing in all members that you run as data stores. You do not need to install licensing in your clients (thin client applications or SQLFire accessors). Choose a License Option Based on Topology describes the appropriate licensing for each topology.

Note: If you obtain SQLFire as part of vFabric Suite, refer first to the license activation procedure in Getting Started with vFabric Suite in the vFabric Suite documentation. Then complete the tasks in this procedure, as necessary, to configure SQLFire-specific licensing.

Where to Install Your License

If you obtained vFabric SQLFire as a standalone product, you install licenses locally to each SQLFire member by modifying the sqlfire.properties file, or by supplying a boot property when you start the SQLFire member. See Option 1: Install Licenses Using sqlfire.properties and Option 2: Install Licenses Using Serial Number Files.

If you are installing SQLFire in a vSphere virtual machine as part of vFabric Suite, you can use the vFabric License Server to install your SQLFire licenses and then configure vFabric SQLFire to communicate with the license server. See vFabric Suite Only: Configure vFabric SQLFire for vFabric License Server.

Note: You cannot use the vFabric License Server if you purchased a standalone SQLFire license, such as vFabric SQLFire Enterprise. Install standalone licenses in sqlfire.properties or as a boot property.

Option 1: Install Licenses Using sqlfire.properties

Add a license key to the sqlfire.properties file on each data store member in your deployment, or specify the keys as a boot property when you start a SQLFire member using sqlf or the FabricServer interface.

This is the recommended way to install licensing for standalone SQLFire deployments. (For SQLFire deployments installed on vSphere virtual machines as part of a vFabric Suite deployment, VMware recommends that you use the vFabric License Server. See vFabric Suite Only: Configure vFabric SQLFire for vFabric License Server.)

For example:
# sqlfire.properties for data store or accessor member
license-serial-number=#####-#####-#####-#####-#####
If you need to specify multiple serial numbers, use a comma separated list:
# sqlfire.properties for data store or accessor member
license-serial-number=#####-#####-#####-#####-#####,#####-#####-#####-#####-#####

Option 2: Install Licenses Using Serial Number Files

Place serial numbers in serial number files in the VMware vFabric serial number directory.

To configure SQLFire to use these for licensing, you need to specify license-serial-number=dynamic as a boot property. You can specify this property in sqlfire.properties, or when starting a SQLFire member using sqlf or the FabricServer interface.

Use this procedure to install and configure serial number files for any standalone SQLFire license.
  1. Create a file named vf.sf-serial-numbers.txt and paste the serial number into it.
    Note: If you have multiple serial numbers, enter each serial number on a new line.
  2. Save the file to the appropriate serial numbers directory on each SQLFire member. See Local VMware vFabric Directories for the appropriate directory based on your operating system.
  3. On all SQLFire data store members, specify license-serial-number=dynamic in sqlfire.properties, or as a boot property. For example:
    # sqlfire.properties for dynamic licensing of data stores
    license-serial-number=dynamic

vFabric Suite Only: Configure vFabric SQLFire for vFabric License Server

You can only use this configuration method if you are running SQLFire on a vSphere virtual machine as part of vFabric Suite. This method is not applicable for installing a standalone vFabric SQLFire license, such as a vFabric SQLFire Enterprise license.

To set up vFabric License Server licensing, refer first to the license activation procedure in Activate vFabric Suite Licenses in the vFabric Suite documentation.

After you install SQLFire licenses on the vFabric License Server, configure dynamic licensing in SQLFire:


  1. Specify license-serial-number=dynamic in the sqlfire.properties file on each data store or accessor member. For example:
    # sqlfire.properties for dynamic licensing 
    license-serial-number=dynamic
  2. (Optional) Change the default timeout value (10000) to indicate the maximum time in milliseconds that the member should wait when obtaining a license dynamically from the vFabric License Server. For example, in sqlfire.properties:
    #timeout in milliseconds
    license-server-timeout=20000