10.4. Preparing Sun Ray Client Configuration Files (.parms Config)

Once a Sun Ray Client discovers the firmware server, it downloads its corresponding *.parms file. This file contains the firmware revision, which is checked against the client to make sure its firmware is up-to-date. The .parms file can also be used to centralize and provide other Sun Ray Client configuration values, such as the list of Sun Ray servers that can be used to obtain a Sun Ray session.

Since there are many .parms files to create (one for each Sun Ray model type), administrators should use the utfwadm command to build the .parms files automatically. The utfwadm command can include a template .parms file that contains key/value pairs. This file will be appended to each model-specific .parms file.

10.4.1. How to Update the .parms Files

  1. Become superuser on the Sun Ray server.

  2. Create the /tftpboot directory on the Sun Ray server.

    The utfwadm command assumes that the /tftpboot directory exists. If this directory does not exist, you must create it.

    # mkdir /tftpboot
  3. Create the template for the .parms file.

    This template is a text file with key/value pairs, and it can be located anywhere on your file system. It is common practice to store it in the /tftpboot directory. In this example, the file is named srsconfig, and it resides in the /tftpboot directory.

    # vi /tftpboot/srconfig
    
    servers=server1,server2,server3
    select=random

    At a minimum, you must specify the servers= key. This instructs the Sun Ray Clients which Sun Ray servers to use for a user session. This key accepts a comma-separated list of either hostnames or IP addresses. By default, the Sun Ray Clients will try to connect to these servers in order. Use the select= key to instruct the Sun Ray Clients to try the servers in a random order. It is not necessary to have all of the Sun Ray servers listed here, but there should be enough servers to be relatively safe during a partial outage.

  4. Use the utfwadm command to generate the .parms files.

    The utfwadm command automatically uses the latest firmware installed on the Sun Ray server. Again, the following example uses /tftpboot/srsconfig for the template file location.

    # /opt/SUNWut/sbin/utfwadm -AaV -i /tftpboot/srconfig

10.4.2. .parms Key/Value Pairs

Additional key/value pairs included in the .parms files are in key=value format, with case sensitivity and no spaces allowed. Options that take values of 0 or 1 have a default value of 0 if not specified. The following table lists the options that are allowed. For details on the options that can be used to configure the .parms files, see the utfwadm man page.

Table 10.2, “.parms Key/Value Pairs” lists the key/value pairs.

Table 10.2. .parms Key/Value Pairs

Key

Description

bandwidth=bits_per_second

Sets the maximum bandwidth limit used by the Sun Ray Client, in bits per second.

cmdcashsize=size

Sets the command cache used to store the list of recent commands, in Kbytes. Default value is 512 Kbytes, maximum value is 8192 Kbytes, and a zero value disables the command cache.

compress=[0 | 1]

When set to 1, forces compression on. Default is 1 (compression on).

fastload=[0 | 1]

When set to 1, forces the maximum TFTP transfer size if the TFTP server supports it. The default is 512-byte packets. Over a high latency connection, using this setting typically doubles the speed of firmware downloads.

fulldup=[0 | 1]

When set to 1, forces full duplex setting.

enablegui=[force | none | hashed-passwd | prompt | off]

disablegui=[force | none | hashed-passwd | prompt | off]

Enables or disables the Configuration GUI. These keywords should be changed only with the utfwadm -G or utfwadm -g command, respectively. See Chapter 11, Sun Ray Client Firmware for details.

kbcountry=code

Forces the keyboard country code number (keyboard map) for a non-U.S. USB keyboard that reports a country code value of 0. This value can also be set on the Advanced menu of the Configuration GUI. Here are the valid keyboard country code values:

  • 1 Arabic

  • 2 Belgian

  • 3 Canada_Bi

  • 4 French-Canadian

  • 5 Czech

  • 6 Denmark

  • 7 Finnish

  • 8 France

  • 9 Germany

  • 10 Greek

  • 12 Hungarian

  • 14 Italy

  • 15 Japan

  • 16 Korea

  • 17 Latin-American

  • 18 Netherland

  • 19 Norway

  • 21 Polish

  • 22 Portugal

  • 23 Russia

  • 24 Slovakian

  • 25 Spain

  • 26 Sweden

  • 27 Switzerland

  • 28 Switzerland_Ge

  • 30 Taiwan

  • 31 TurkeyQ

  • 32 UK-English

  • 33 US-English

  • 35 TurkeyF

LogXXX=

Sets the logging level for various classes of logging events, where XXX is one of Appl, Vid, USB, Net, or Kern. Valid values are 1 through 7, with 7 providing the most detailed logging output. A separate entry must be specified for each type. The logging information is saved in the /var/opt/SUNWut/log/messages file on the LogHost.

When using a shared network (LAN) with external DHCP server support (configured network using utadm -L on), logging for each event type is disabled unless the LogXXX value and the LogHost value are set.

LogHost=

The Sun Ray server where logging output is saved when one or more LogXXX entries are specified. Valid value is a resolvable DSN host name or an IP address of a Sun Ray server. When using a failover group, the primary Sun Ray server should be specified.

lossless=[0 | 1]

When set to 1, does not permit lossy compression to be used.

MTU=

Retrieves the network MTU. The value used is the minimum of those supplied from various sources.

poweroff=

Sets how much time a Sun Ray 3 Series Client will be idle before it turns off. The default power off time is 30 minutes. Setting poweroff=0 disables the power off feature. When the power off feature is enabled, the firmware enforces a minimum power off value of 10 minutes and a maximum power off value of 30 days. The value for the power off feature is in minutes.

For example, poweroff=15 sets the idle power off timer to 15 minutes.

select=

Permissible values are inorder or random. Selects a server from the server list either starting at the beginning or at random, respectively.

servers=

Specifies a comma-separated mixture of host names or IP addresses.

stopkeys=[keyn[-keyn]* | none]

Specifies an alternative combination of modifier keys to perform the same function as the Stop key on the Sun keyboard or the Ctrl-Pause key sequence. By default, this alternative combination is Ctrl-Shift-Alt-Meta. See Section 10.1, “Sun Ray Client Hot Keys” for details.

The value of keyn can be any combination of the Ctrl-Shift-Alt-Meta keys, but at least two of the keys must be used. For example, you can set this value to Ctrl-Alt or Meta-Ctrl-Shift.

If this parameter is set to none, the alternative key combination is disabled.

Note that the Meta key has different names on different keyboards: on a PC keyboard, it is the "Windows" key, and on a Mac keyboard, it is the "Command" key.

stopqon=[0 | 1]

When set to 1, enables the Stop-Q key sequence to be used to disconnect a Sun Ray Client from a server, in particular, if it's using a VPN connection.

utloadoff=[0 | 1]

When set to 1, disables the ability to use the utload program to force a Sun Ray Client to load firmware.

videoindisable=[0 | 1]

When set to 1, disables the input source on the front of a Sun Ray 270 Client, and it locks the monitor into displaying only the client output.