INI Files Reference Guide for Cisco Virtualization Experience Client 2112/2212 ICA Firmware Release 8.0
WTOS INI files overview
Downloads: This chapterpdf (PDF - 1.21MB) The complete bookPDF (PDF - 2.48MB) | The complete bookePub (ePub - 199.0KB) | Feedback

WTOS INI files overview

WTOS INI files overview

About WTOS INI files

WTOS INI files contain the parameters and associated values necessary for the various functionality you want.


Tip


For examples of parameters commonly used for basic deployments, see Basic deployment examples.


You can construct the following INI files:

  • wnos.ini file
  • {username}.ini file
  • $MAC.ini file
Important:

The INI file processing hierarchy is as follows:

  • Scenario 1 - WNOS.ini exists. The WNOS.ini file is processed and if the Include=MAC.ini (or Include={username}.ini) statement is included, then the relative MAC.ini (or {username}.ini) file is processed.
  • Scenario 2 - WNOS.ini exists and {username}.ini exists. The WNOS.ini file is processed and if the Include=MAC.ini statement is included, then the MAC.ini file is processed. Once the credentials are provided, the {username}.ini file is processed.
  • Scenario 3 - WNOS.ini exists and MAC.ini exists. The WNOS.ini file is processed and if the Include={username}.ini statement is included, then the {username}.ini file is processed. Once the credentials are provided, the MAC.ini file is processed.
  • Scenario 4 - No ini files exist. Local configuration is applied.

Tip


For sample INI files, see Sample INI files.


About wnos.ini files

A wnos.ini file contains the “global” parameters you want that will affect all zero clients accessing the file server. Parameters in both WNOS INI only parameters and WNOS INI, username INI, and $MAC INI parameters can be used in a wnos.ini file.


Note


Parameters in WNOS INI only parameters can only be used in a wnos.ini file; they cannot be used in a {username}.ini file.


About $MAC.ini files

A $MAC.ini file can be used for device-specific configurations. If the thin client locates a wnos.ini file, then the wnos.ini file is processed and if the Include=$MAC.ini statement is included, then the $MAC.ini file is processed (the $MAC.ini file is stored in the same directory as a wnos.ini file).

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

For example, if the wnos.ini file has parameterA=valueRED, and the $MAC.ini file has the same parameterA=valueBLUE, then:

  • If the include=$MAC.ini parameter is included in the wnos.ini file before the parameterA=valueBLUE statement, then the $MAC.ini parameterA=valueRED is discarded and parameterA=valueBLUE (from the wnos.ini file) is the final value used.
  • If the include=$MAC.ini parameter is included in the wnos.ini file after the parameterA=valueBLUE statement, then the $MAC.ini parameterA=valueBLUE is discarded and parameterA=valueRED (from the wnos.ini file) is the final value used.

About username.ini files

A {username}.ini file contains the user-specific or “user profile” parameters you want that will comprise the connection profile for an individual user. These parameters will affect only the user you specify. Parameters in WNOS INI, username INI, and $MAC INI parameters can be used in a {username}.ini file.


Tip


“User profile” parameters (found in the {username}.ini file) generally override the identically named “global” parameters (found in the wnos.ini file), however, some “global” parameters do not allow this (for hierarchical precedence of one variable over another, refer to the parameter notations in WNOS INI, username INI, and $MAC INI parameters).



Caution


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


Rules and recommendations for WTOS INI files

In general, WTOS INI files follow currently accepted “standard” INI file formatting conventions. WTOS INI files consist of WTOS parameters. If you are using an INI file, the only parameter you must use is the Connect parameter. Any other parameters can be entered as you require, but are not mandatory unless changes from defaults are required or the parameter is noted as required in the tables. Every parameter (and their options) has a name and a value with the name appearing to the left of the equals 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 wnos.ini file and named XYZ in a {username}.ini file will 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 constructing WTOS INI files:

  1. Global Connect Parameters First—Global connect parameters should be listed before other connect parameters in a wnos.ini file.
  2. Connect is the Only Required Parameter—As stated earlier the only parameter you must use is the Connect parameter. Any of the rest of the parameters can be used if you desire, but are not necessary unless you want changes from client and “other” defaults.
  3. Continue Lines by using a Space and Backslash— Placing a space and backslash ( \) at the end of a line indicates line continuation; that is, 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.
  4. Blank Lines Make Files Easy to Read—Using blank lines is recommended for making code easier to read.
  5. Comment by using a Number Sign—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 Marks—Values (of parameters and their options) containing white spaces must be placed inside quotation marks (use common-practice nesting 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 zero client to place the encrypted user passwords in the files.
  9. Use the wnos.ini File to Set the Maximum Number of Connection Entries Allowed—The combined number of connection entries defined in a {username}.ini file and a wnos.ini file cannot exceed a defined total maximum number of connections. The maximum number of connections has a default limit of 216, but can be set from 100 to 1000 using the wnos.ini file.
  10. Use of the {username}.ini and {mac}.ini Parameters—The {username}.ini and {mac}.ini parameters can appear in the wnos.ini file. However, these parameters must be below the include=$un.ini parameter or the include=<$mac.ini or {username}> parameter in the wnos.ini file. Although not required, it is highly recommended that these parameters end with the parameter Exit=all.

    Caution


    No parameter should ever be executed twice. Some WTOS hardware configuration parameters require a reboot to become active, and if the same parameters are defined more than once, the zero client may then go into an infinite reboot cycle.


    Important:

    Placing the include=<$mac.ini or {username}> statement on the last line of the wnos.ini file (to verify that all parameters are processed properly for terminal-specific settings) is recommended.

  11. Use of 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.
Option Value
$SN Serial number used
$MAC MAC address used.
$IP IP Address used.
$TN Terminal name.
$PF Platform name (the first part of image name xxx_wnos, for example, ZC0)
$UN Sign-in name used.
$PW Sign-in password used.
$DN Sign-in domain name used.
$WPUN PEAP/MSCHAPv2 username used (802.1x dependent).
$WPPW PEAP/MSCHAPv2 password used (802.1x dependent).
$WPDN PEAP/MSCHAPv2 domain used (802.1x dependent).
&Right($xx, i) or &Left($xx, i)

Specifies whether the variable is to be read from left or right.

The $xx is any of the above parameters.

The parameter i specifies left or right offset digits.

Placing the INI Files into the Folder Structure on the Server

If you have set up your environment to provide your zero clients running WTOS with automatic updates and configurations (as described in Administration Guide for Cisco VXC 2112/2212), you can use the following folder structure on your server under the C:/inetpub/ftproot folder (for FTP) or C:/inetpub/wwwroot folder (for HTTP or HTTPS) and place your INI files and other necessary files inside the structure as noted (this list describes the folder structure, starting with the root directory).

/cisco/

(Required) The root directory. It stores the wnos folder.

/cisco/wnos

(Required) The main INI configuration folder. It stores the wnos.ini file, {username}.ini file, $MAC.ini file, firmware, and the following optional folders:

  • bitmap folder
  • cacerts folder
  • font folder
  • inc folder
  • ini folder
  • locale folder
  • trace folder
/cisco/wnos/bitmap

(Optional) The folder where you can place custom images you plan to use.

/cisco/wnos/cacerts

(Optional) The folder where you can place the CA certificates that can be imported to a zero client.

Note   

Use the AddCertificate INI parameter in the wnos.ini file to import the certificates to zero clients.

/cisco/wnos/font

(Optional) The folder where you can place font files for languages that require the file (Chinese Simplified, Chinese Traditional, Japanese, Korean).

/cisco/wnos/inc

(Optional) The folder where you can place the mac.ini files (note that the use of the parameter Include=$mac.ini will load “/wnos/inc/ mac-address.ini” so that you can use inc in the folder structure and use $MAC.ini).

/cisco/wnos/ini

(Optional) The folder where you can place the {username}.ini files and {group} folder.

/cisco/wnos/locale

(Optional) The folder where you can place locale message files.

/cisco/wnos/trace

(Optional) The folder where you can place the trace files that you can capture and play back (be sure to enable the parameter, EnableTrace=yes).