INI Files Reference Guide for Cisco Virtualization Experience Client 2112/2212 ICA Firmware Release 7.1_118
WTOS INI files overview
Downloads: This chapterpdf (PDF - 1.2MB) The complete bookPDF (PDF - 2.4MB) | 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.

You can construct the following INI files:

  • wnos.ini file
  • {username}.ini file

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 and username 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 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 and username 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 and username 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. These parameters can be entered as necessary for reference, but are not mandatory unless changes from defaults are required or the parameter is noted as required in the tables. Every parameter 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 WTOS 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:

  • Order of Parameters—Global connect parameters should be listed before other connect parameters in a wnos.ini file.
  • Mandatory Parameters—As stated earlier, parameters can be entered as necessary for reference, but are not mandatory unless changes from defaults are required or the parameter is noted as required in the tables. For example, the Connect= parameter is mandatory.
  • Use of Backslashes and White Spaces—Placing a 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; however, white space between parameter entries must be maintained. Therefore, the line after a backslash must either start with a space (not a tab) or concatenate with the first set of characters from the previous line. To avoid confusion, starting each line with at least one white space character is recommended. Starting all parameters at the left margin and placing at least one leading space at the beginning of all continuation lines makes an INI file easier to read.
  • Use of Blank Lines—Using blank lines is recommended for making code easier to read.
  • Use of Number Signs—As stated earlier, 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.
  • Use of Quotation Marks—String parameters containing white spaces must be placed inside quotation marks (use common-practice nesting rules).
  • Use of List Separators—Use semicolons or commas for list separators.
  • Use of Equivalent Parameter Values—For parameter values of type {0, 1}, zero (0) indicates false or no, and one (1) indicates true or yes, as applicable. The format {0, 1} is equivalent to, and can be used instead of, the format {no, yes} for the parameters using these formats in the tables.
  • Use of the Home Directory—The home directory is the wnos subdirectory for the sign-in. For example, C:\Inetpub\ftproot\cisco\wnos). You can specify the username and password for file server access in the Central Configuration dialog box (see Administration Guide for Cisco Virtualization Experience Client 2112/2212 ). If a file server directive is processed, the same username and password already configured on the zero client is usable for accessing files on the new file server.
  • {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.
  • 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.
  • 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 parameter in the wnos.ini file. Although not required, it is recommended that these parameters end with an Exit=all parameter.

    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.


    Placing the include=$mac.ini statement on last line of the wnos.ini file to verify that all parameters are processed properly for terminal-specific settings is recommended.
  • Use of System Variables—Some parameters can use the system variables shown in Table 1-1 to map the string. All combinations of the variables, such as CTX&Right($IP,4)@&Left($UN,3) are supported. A replacement $SYS_VAR will be used if the statements or parameters support it.
Parameter 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 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).