INI Files Reference Guide for Cisco Virtualization Experience Client 6215 Firmware Release 9.0
Getting started: INI file basics
Downloads: This chapterpdf (PDF - 1.1MB) The complete bookPDF (PDF - 2.22MB) | Feedback

Getting started: INI file basics

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 the other chapters and appendixes of this guide.

INI parameter updates using Cisco VXC Manager

Cisco VXC Manager is the standard tool used to push and schedule INI configuration updates to your thin clients. Cisco VXC Manager allows you to push the common INI file configurations to all of the thin clients in your environment.


Caution


Do not modify INI files directly on the Cisco VXC 6215 as doing so can cause configuration issues and operational errors.


For detailed information about configuring thin clients using Cisco VXC Manager, see Administration Guide for Cisco Virtualization Experience Client Manager and the Administration Guide for Cisco Virtualization Experience Client 6215 .

Supported INI files

The INI files contain the parameters (and associated options and values) necessary for the functionality you want.

You can construct the following INI files:


Note


The INI file processing hierarchy is as follows:

  • Scenario 1 - $MAC.ini exists. The $MAC.ini file is processed and if the include=wlx.ini statement is included, then the wlx.ini file is processed.
  • Scenario 2 - wlx.ini exists. The wlx.ini file is processed.
  • Scenario 3 - No ini files exist. Local configuration is applied.

wlx.ini files

A wlx.ini file contains the global parameters you want that affect all thin clients accessing the server.

$MAC.ini files

A $MAC.ini file contains device-specific configuration parameters. If the thin client locates a $MAC.ini file (stored in the same directory as a wlx.ini file), the thin client uses the $MAC.ini file for its configuration rather than the wlx.ini file. In this case, the thin client does not access the wlx.ini file unless you specify the include=wlx.ini parameter in the $MAC.ini file.


Note


If the wlx.ini and the $MAC.ini files each define the same parameter with different values, the thin client assigns higher precedence based on which parameter appears last in the $MAC.ini file: either the repeated parameter or the include=wlx.ini parameter.

For example, assume the following parameter definitions:

  • The wlx.ini file contains parameterA=valueB
  • The $MAC.ini file contains parameterA=valueC

The following table describes the final value for parameterA based on its placement relative to the include=wlx.ini parameter in the $MAC.ini file.

Parameter placement in $MAC.ini Final value for parameterA
parameterA=valueC appears earlier and wlx.ini appears later ParameterA=ValueB (from wlx.ini file)
wlx.ini appears earlier and parameterA=valueC appears later ParameterA=valueC (from $MAC.ini file)

INI file construction rules and recommendations

In general, Enhanced SLE INI files follow currently accepted standard INI file formatting conventions. The INI files consist of parameters that you can enter as necessary for reference. When you create an INI file, the only required parameter that you must use is the Connect parameter. You can use any of the remaining parameters if you desire, but they are not mandatory unless you require changes from the default values. Every parameter (and the associated options) has a name and a value with the name appearing to the left of the equal sign (name=value). All parameters with the same name in the various INI files have the same meaning (that is, 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. Everything between the # and the End of Line is ignored.

Along with these general formatting conventions, use the following guidelines when you construct Enhanced SLE INI files:

  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 you must enter is the Connect parameter. You can enter other parameters as desired, but they are not mandatory unless you require changes from the default values. To create a connection using an INI file, you must specify the Connect= parameter, as well as the mandatory connect options associated with the specified connection type (for example, for Mozilla Firefox or VMWare View). For more information about the Connect= parameter, including configuration examples, see Connect Parameter Options.
  3. Continue Lines Using Space and Backslash To indicate line continuation, place a space and backslash (\) at the end of a line. The backslash means that the line and the following line are, for the purposes of reading code, the same line. No white space can appear after the backslash; the requirement of white space between parameter entries is maintained by the use of the space before the backslash. In addition, starting all parameters at the left margin and placing at least one leading space (or tab) at the beginning 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 a space before or after it to concatenate with the first set of characters from the previous line; for example the 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 Number Sign As stated previously, number signs (#) indicate the start of a comment. Comments can begin anywhere on a line. Everything between the # and the End of Line is ignored.
  6. Values with White Spaces Require Quotation MarksYou must place parameter values containing white spaces inside quotation marks (use common-practice nesting rules).
  7. Separate Lists by Using Semicolons or Commas Use semicolons or commas for list separators.
  8. 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 total maximum number of connections. The maximum number of connections has a default limit of 216, but you can modify this limit within a range of 100 to 1000 using the wlx.ini file.
  9. 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 map the string. All combinations of the variables are supported. For options that support use of system variables, see Connect Parameter Options.
Table 1 System Variables
Option Value

$SN

Serial number used.

$MAC

MAC address used.

$IP

IP Address used.

$DN

Sign-on domain name used.

$UN

Sign-on name used.

$PW

Sign-on password used.

$TN

Terminal name.