Getting Started: INI File Basics

In this chapter you will learn how to construct and use the supported INI files.

After you become familiar with the INI file basics, you can refer to the parameter details you need in theother chapters and appendixes of this guide.

• Supported INI Files, page 1

• Rules and Recommendations for INI Files, page 3

Supported INI FilesThe INI files contain the parameters (and associated options and values) necessary for the functionality youwant.

You can construct the following INI files:

• wlx.ini file

• {username}.ini file

• $MAC.ini file

The INI file processing hierarchy is as follows:Important

• Scenario 1—MAC.ini exists. The MAC.ini file is processed and if the Include=WLX.ini statementis included, then the WLX.ini file is processed.

• Scenario 2—MAC.ini exists and {username}.ini exists. The MAC.ini file is processed and if theInclude=WLX.ini statement is included, then the WLX.ini file is processed. Once the credentialsare provided, the {username}.ini file is processed.

• Scenario 3—WLX.ini exists. The WLX.ini file is processed.

• Scenario 4—WLX.ini exists and {username}.ini exists. The WLX.ini file processed. Once thecredentials are provided, the {username}.ini file is processed.

• Scenario 5—No ini files exist. Local configuration is applied.

INI Files Reference Guide for Cisco Virtualization Experience Client 6215 Firmware Release 9.7 1

wlx.ini FilesA wlx.ini file contains the global parameters you want that will affect all thin clients accessing the server.Parameters in both wlx.ini and $MAC.ini File Parameters Only and wlx.ini, $MAC.ini, and {username}.iniFile Parameters can be used in a wlx.ini file.

Parameters in wlx.ini and $MAC.ini File Parameters Only can only be used in a wlx.ini or $MAC.ini file;they cannot be used in a {username}.ini file.

$MAC.ini FilesA $MAC.ini file can be used instead of a wlx.ini file for device-specific configurations. If the thin clientlocates a $MAC.ini file (it is stored in the same directory as a wlx.ini file), then the wlx.ini file is not accessed,unless you use the include=wlx.ini parameter.

Note also that the placement of the include=wlx.ini parameter within the $MAC.ini file will dictate whichvalue will take priority for a same specific parameter that is contained in both the wlx.ini file and the $MAC.inifile but is defined differently (different values for the same parameter).

For example, if the wlx.ini file has parameterA=valueB, and the $MAC.ini file has the sameparameterA=valueC, then:

• If the include=wlx.ini parameter is included in the $MAC.ini file before the parameterA=valueC statement,then the wlx.ini parameterA=valueB is discarded and parameterA=valueC (from the $MAC.ini file) isthe final value used.

• If the include=wlx.ini parameter is included in the $MAC.ini file after the parameterA=valueC statement,then the $MAC.ini parameterA=valueC is discarded and parameterA=valueB (from the wlx.ini file) isthe final value used.

{username}.ini FilesA {username}.ini file contains the user-specific or user profile parameters you want that will comprise theconnection profile for an individual user. These parameters will affect only the user you specify. Parametersin wlx.ini, $MAC.ini, and {username}.ini File Parameters can be used in a {username}.ini file.

User profile parameters (found in the {username}.ini file) generally override the identically named globalparameters (found in the wlx.ini file), however, some global parameters do not allow this (for hierarchicalprecedence of one variable over another, refer to the parameter descriptions in wlx.ini, $MAC.ini, and{username}.ini File Parameters).

Note

If both PNAgent/PNLite and a user profile are being used in the environment, the username must bedefined in theWindows domain to be used, and the password used must be the same for both theWindowsdomain and the user profile.

Caution

INI Files Reference Guide for Cisco Virtualization Experience Client 6215 Firmware Release 9.72

Getting Started: INI File Basicswlx.ini Files

Rules and Recommendations for INI FilesIn general, Enhanced SLE INI files follow currently accepted standard INI file formatting conventions. TheINI files consist of parameters that you can enter as necessary for reference. When you create an INI file, theonly required parameter that you must use is the Connect parameter. You can use any of the remainingparameters if you desire, but they are not mandatory unless you require changes from the default values. Everyparameter (and the associated options) has a name and a value with the name appearing to the left of the equalsign (name=value). All parameters with the same name in the various INI files have the same meaning (thatis, a parameter named XYZ in a wlx.ini file and named XYZ in a $MAC.ini file have the same meaning).Number signs (#) indicate the start of a comment. Comments can begin anywhere on a line. Everythingbetween the # and the End of Line is ignored.

Along with these general formatting conventions, use the following guidelines when constructing the INIfiles:

1 Global Connect Parameters First

List global connect parameters before other connect parameters in a wlx.ini file.

2 Connect is the Only Required Parameter

As previously stated, when you create an INI file, the only required parameter youmust enter is the Connectparameter. You can enter other parameters as desired, but they are not mandatory unless you requirechanges from the default values.

To create a connection using an INI file, you must specify the Connect= parameter, as well as the mandatoryconnect options associated with the specified connection type (for example, forMozilla Firefox or VMWareView). For more information about the Connect= parameter, including configuration examples, see ConnectParameter Options.

3 Continue Lines by using a Space and Backslash

To indicate line continuation, place a space and backslash (\) at the end of a line. The backslash meansthat the line and the following line are, for the purposes of reading code, the same line. No white spacecan appear after the backslash; the requirement of white space between parameter entries is maintainedby the use of the space before the backslash.

Do not insert any spaces after the backslash, otherwise the device may not be able to parse the INI filecorrectly.

Note

In addition, starting all parameters at the left margin and placing at least one leading space (or tab) at thebeginning of all (and only) continuation lines makes an INI file easier to read.

Note that in circumstances where you require string concatenation, you can use a backslash without aspace before or after it to concatenate with the first set of characters from the previous line; for examplethe strings snow and ball may be concatenated to give snowball.

You must use the backslash continuation character to configure a connection with multiple parameters.For examples, see Connect Parameter Options.

4 Blank Lines Make Files Easy to Read

Use blank lines to make the code easier to read.

5 Comment by using a # Sign

INI Files Reference Guide for Cisco Virtualization Experience Client 6215 Firmware Release 9.7 3

Getting Started: INI File BasicsRules and Recommendations for INI Files

As stated previously, number signs (#) indicate the start of a comment. Comments can begin anywhereon a line. Everything between the # and the End of Line is ignored.

6 Values with White Spaces Require Quotation Marks

You must place parameter values containing white spaces inside quotation marks (use common-practicenesting rules).

7 Separate Lists by using Semicolons or Commas

Use semicolons or commas for list separators.

8 {username}.ini Files must be Write-Enabled

All {username}.ini files must be write-enabled to allow the thin client to place the encrypted user passwordsin the files.

9 Use the wlx.ini File to Set the Maximum Number of Connection Entries Allowed

The combined number of connection entries that you define in a wlx.ini file cannot exceed a defined totalmaximum number of connections. The maximum number of connections has a default limit of 216, butyou can modify this limit within a range of 100 to 1000 using the wlx.ini file.

10 Use System Variables with Some Options of the Connect Parameter

Some options of the Connect parameter can use the system variables shown in the following table to mapthe string. All combinations of the variables are supported. For options that support use of system variables,see Connect Parameter Options.

Table 1: System Variables

ValueOption

Serial number used.$SN

MAC address used.$MAC

IP Address used.$IP

Sign-on domain name used.$DN

Sign-on name used.$UN

Sign-on password used.$PW

Terminal name.$TN

INI Files Reference Guide for Cisco Virtualization Experience Client 6215 Firmware Release 9.74

Getting Started: INI File BasicsRules and Recommendations for INI Files