Sun Ray Software Man Page Reference Guide (Oracle Linux)
Version 5.2
Published: December 2011
Part number: E26956-01
Copyright © 2011, Oracle and/or its affiliates. All
rights reserved.
This software and related documentation are provided under a
license agreement containing restrictions on use and disclosure
and are protected by intellectual property laws. Except as
expressly permitted in your license agreement or allowed by law,
you may not use, copy, reproduce, translate, broadcast, modify,
license, transmit, distribute, exhibit, perform, publish, or
display any part, in any form, or by any means. Reverse
engineering, disassembly, or decompilation of this software,
unless required by law for interoperability, is prohibited.
The information contained herein is subject to change without
notice and is not warranted to be error-free. If you find any
errors, please report them to us in writing.
If this is software or related software documentation that is
delivered to the U.S. Government or anyone licensing it on
behalf of the U.S. Government, the following notice is
applicable:
U.S. GOVERNMENT RIGHTS Programs, software, databases, and
related documentation and technical data delivered to U.S.
Government customers are "commercial computer software" or
"commercial technical data" pursuant to the applicable Federal
Acquisition Regulation and agency-specific supplemental
regulations. As such, the use, duplication, disclosure,
modification, and adaptation shall be subject to the restrictions
and license terms set forth in the applicable Government
contract, and, to the extent applicable by the terms of the
Government contract, the additional rights set forth in FAR
52.227-19, Commercial Computer Software License (December 2007).
Oracle America, Inc., 500 Oracle Parkway, Redwood City, CA
94065.
This software or hardware is developed for general use in a
variety of information management applications. It is not
developed or intended for use in any inherently dangerous
applications, including applications which may create a risk of
personal injury. If you use this software or hardware in
dangerous applications, then you shall be responsible to take
all appropriate fail-safe, backup, redundancy, and other
measures to ensure its safe use. Oracle Corporation and its
affiliates disclaim any liability for any damages caused by use
of this software or hardware in dangerous applications.
Oracle and Java are registered trademarks of Oracle and/or its
affiliates. Other names may be trademarks of their respective
owners. Intel and Intel Xeon are trademarks or registered trademarks of
Intel Corporation. All SPARC trademarks are used under license
and are trademarks or registered trademarks of SPARC
International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are
trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark licensed
through X/Open Company, Ltd.
This software or hardware and documentation may provide access
to or information on content, products, and services from third
parties. Oracle Corporation and its affiliates are not
responsible for and expressly disclaim all warranties of any
kind with respect to third-party content, products, and
services. Oracle Corporation and its affiliates will not be
responsible for any loss, costs, or damages incurred due to your
access to or use of third-party content, products, or services.
Abstract
AThis guide provides the output for all the man pages delivered with the Sun Ray Software release for the Oracle Linux operating system.
Sun Ray Server Software Man Pages
man1
man3
man4
man5
man8
Sun Ray Windows Connector Man Pages
man1
man8
Sun Ray Kiosk Man Pages
man1
man5
man8
Sun Ray Server Software Man Pages
Sun Ray User Commands utaction(1)
NAME
utaction - Sun Ray DTU connect/disconnect/exit action
SYNOPSIS
/opt/SUNWut/bin/utaction [ -c ccmd ] [ -d dcmd ] [ -x xcmd
] [ -e ] [ -D display ] [ -i ] [ -t sec ]
DESCRIPTION
The utaction program provides a way to execute commands when
a Sun Ray DTU session is connected or disconnected or
when the session terminates. The ccmd is invoked using sh(1)
whenever the session is connected to a DTU, the dcmd is
invoked using sh(1) whenever the session is disconnected
from a DTU, and the xcmd is invoked using sh(1) whenever the
session exits. Normally, action is not taken on the initial
state of the session (when utaction is first run) unless the
-i option is used.
Note: In earlier releases, this command resided in
/opt/SUNWut/lib/utaction ; now, however, it resides in
/opt/SUNWut/bin/utaction .
OPTIONS
The following options are supported.
-c ccmd
Run this command when the current session is connected
to a DTU.
-d dcmd
Run this command when the current session is discon-
nected from a DTU.
-x xcmd
Run this command when the current session exits. utac-
tion will always exit after running this command.
-D display
This option will set the X display variable that is to
be used in determining the Sun Ray DTU session. Other-
wise the DISPLAY environment variable is used.
-e This option causes utaction to exit after encountering
a command.
-i Run the connect or disconnect command immediately,
whichever is appropriate. The session exit command
will never be run immediately, it will only be run
when the session exits.
-t sec
This option specifies a time-delay in seconds for the
SRSS 4.3 Last change: 1
Sun Ray User Commands utaction(1)
actions. In that case, the ccmd or dcmd will not be
invoked unless the session remains in the connected or
disconnected state, respectively, for at least sec
seconds. This option does not apply to the session
exit action.
EXAMPLES
Example 1: This command invokes the CDE screen lock whenever
the session is disconnected
% utaction -d '/usr/dt/bin/dtaction LockDisplay' &
Example 2: This command shuts down the system whenever the
session exits
% utaction -x '/usr/sbin/halt' &
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuto |
|_____________________________|_____________________________|
NOTES
The ccmd, dcmd and xcmd are each only one argument to
utaction. Quotes should be used if a command contains multi-
ple words.
SRSS 4.3 Last change: 2
Sun Ray User Command utaudio(1)
NAME
utaudio - Sun Ray audio services connection utility.
SYNOPSIS
/opt/SUNWut/bin/utaudio
csh
setenv AUDIODEV `utaudio`
ksh
export AUDIODEV=`utaudio`
sh
AUDIODEV=`utaudio`;export AUDIODEV
DESCRIPTION
utaudio enables standard Solaris audio services using the
utadem(7D) audio device emulator driver. After connecting to
a Sun Ray session, utadem(7D) creates a new audio device for
which utaudio creates device files in the /tmp/SUNWut/dev
directory. utaudio then echoes the root device name to stan-
dard output, setting the AUDIODEV environment variable.
Standard audio applications can then open the new audio
pseudo-device and perform audio play and record operations.
OPTIONS
There are no options for utaudio.
API
Applications that use the /dev/audio interface may open the
device indicated by the AUDIODEV environment variable and
use the AUDIO_GETDEV ioctl to determine which audio device
is being used. The utaudio driver returns the string
"SUNW,CS4231" in the name field of the audio_device struc-
ture to indicate compatibility with other Ultra platforms.
The version field contains "a" and the config field contains
"pseudo."
The AUDIO_SETINFO ioctl controls device configuration param-
eters. When an application modifies the record.buffer_size
field using the AUDIO_SETINFO ioctl, the daemon will con-
strain it to be non-zero and up to a maximum of 8180 bytes.
Audio Data Formats
The utaudio daemon supports u-law and A-law with 8-bit
precision or 16-bit linear PCM at any sample rate from
8000 Hz to 48 kHz for one or two channels. The Sun Ray
standard sampling rate is 48 kHz as this yields the
best quality. The input and output data formats for
playing and recording do not have to match. Some input
devices do not provide 2-channel capture, but two
channels will be reproduced by duplication in the case
SRSS 4.3 Last change: 1
Sun Ray User Command utaudio(1)
where two channels are requested and the device sup-
ports only one.
Audio Ports
The record.avail_ports and play.avail_ports fields of
the audio_info structure report the available input
and output ports for the currently connected Sun Ray
DTU. Only AUDIO_MICROPHONE and AUDIO_LINE_IN are sup-
ported and most devices will have both inputs. The Sun
Ray audio model supports individual volume controls
for the two, so it is possible that the volume setting
will change with input.
For output, AUDIO_LINE_OUT is always selected and does
not have variable gain. AUDIO_SPEAKER and
AUDIO_HEADPHONE are supported and they share a level
control. In general, comfortable settings for the
speaker will also be comfortable for headphone use.
Either or both outputs can be selected simultaneously.
The Sun Ray specification supports a third, automatic
switching mode that is accessed by deselecting both
speaker and headphone or by selecting only line out.
The utsettings(1) command may also be used to control
the device's outputs. In automatic mode, the settings
track the physical connection of the headphone.
FILES
The following files are used:
o /tmp/SUNWut/dev/utaudio/n
Numbered audio data pseudo-device file nodes.
o /tmp/SUNWut/dev/utaudio/nctl
Matching numbered control pseudo-device file nodes.
ENVIRONMENT VARIABLES
utaudio requires the DISPLAY environment variable contain an
X11(7) display for which the user's session has access. This
is set-up automatically in the Sun Ray environment.
An alternate driver emulator or different unit number can be
specified in the UT_ADEM environment variable.
The results of utaudio should be placed in the AUDIODEV
environment variable.
EXIT STATUS
SRSS 4.3 Last change: 2
Sun Ray User Command utaudio(1)
The following exit values are returned:
0 Normal completion -- daemon back grounded
1 Either the X11 server, or the session could not be
contacted, or there was a problem creating the new
pseudo audio device.
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuto |
|_____________________________|_____________________________|
SEE ALSO
utsettings(1), X11(7), utadem(7D), audio(7I), steamio(7I),
ioctl(2), priocntl(2), attributes(5), environ(5)
NOTES
The audio(7I) interface does not have an interface for
dynamically changing audio devices such as that offered by
the Sun Ray software. It is not possible to track the move-
ment of sessions or changes in audio hardware using this
device interface. The utaudio daemon makes a best-effort
attempt to report changes in device control ability and to
make the device appear as flexible as possible, matching
that ability to the actual Sun Ray hardware being used.
If a session is disconnected, audio output continues as if
there was an actual hardware connection, even though no sam-
ples are actually being transmitted or played. Conversely,
audio input stops when there is no connected device.
SRSS 4.3 Last change: 3
Sun Ray User Commands utdetach(1)
NAME
utdetach - Detach the current session from the Sun Ray DTU.
SYNOPSIS
/opt/SUNWut/bin/utdetach
DESCRIPTION
The utdetach command disconnects the current session from
its respective Sun Ray DTU. The session is not destroyed,
but rather put into a disconnected state. The session can be
accessed if the same user token is presented to the Sun Ray
server.
This command is primarily executed by users of the non-smart
card mobility feature so as to disconnect their "mobile"
sessions.
The Sun Ray server starts an instance of utslaunch (1M) for
each session whenever a user logs into a Sun Ray DTU via
dtlogin. This makes the utdetach command available to users
as a hotkey sequence. The default hotkey sequence is Shift +
Pause and can be configured in the utslaunch.properties
file.
OPTIONS
There are no options for utdetach.
EXAMPLES
Example 1: This command disconnects the current session from
the DTU the user is currently using.
% utdetach
FILES
The following files are used:
o /etc/opt/SUNWut/utslaunch_defaults.properties
site-wide defaults
o ~/.utslaunch.properties
user's defaults
o /etc/opt/SUNWut/utslaunch_mandatory.properties
site-wide mandatory defaults
SRSS 4.3 Last change: 1
Sun Ray User Commands utdetach(1)
EXIT STATUS
The following exit values are returned:
0 Success
1 Failure
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Types | Attribute Values |
| Availability | SUNWuto |
| Stability Level | Evolving |
|_____________________________|_____________________________|
SEE ALSO
utslaunch(1M), utslaunch.properties(4)
SRSS 4.3 Last change: 2
Sun Ray User Commands utdiskadm(1)
NAME
utdiskadm - Sun Ray Mass Storage device management utility
SYNOPSIS
/opt/SUNWut/bin/utdiskadm -c device_name
/opt/SUNWut/bin/utdiskadm -e device_name
/opt/SUNWut/bin/utdiskadm -h
/opt/SUNWut/bin/utdiskadm -l [-a]
/opt/SUNWut/bin/utdiskadm -m partition_name [-p mount_path]
/opt/SUNWut/bin/utdiskadm -r device_name
/opt/SUNWut/bin/utdiskadm -s [-a]
/opt/SUNWut/bin/utdiskadm -u mount_path
DESCRIPTION
The utdiskadm command allows the user to perform administra-
tion tasks on mass storage devices connected to the Sun Ray
DTU with which the current login session is associated. This
command does not work on devices belonging to any other user
except for some options available only to root. It also
cannot be used on devices connected directly to the Sun Ray
server.
OPTIONS
The following options are supported.
-c device_name
Check device for existence of media
-e device_name
Eject media from devices with removable media
-h
Show usage information
-l
List all storage devices of current session and
their mount points. This option will show the
device_name, partition_name and mount_path for a
device.
-l -a
SRSS 4.3 Last change: 1
Sun Ray User Commands utdiskadm(1)
List all storage devices of on system. This option
combination can be used by root only
-m partition_name
Mount partition partition_name on default mount
point in $DTDEVROOT/mnt.
-m partition_name -p mount_path
Mount partition partition_name on directory
mount_path
-r device_name
Prepare device device_name for removal by unmount-
ing all its partitions
-s
List stale mount points for which physical devices
do not exist
-s -a
List stale mount points on entire system All stale
mount points on the Sun Ray server are displayed.
Only root is allowed to use this option.
-u mount_path
Unmount mount_path
EXIT STATUS
The following exit codes are returned:
0
The operation was successful
1
The operation was unsuccessful
FILES
The following files are used:
$UTDEVROOT/dev/dsk
The directory containing links to block dev-
ice names for each partition on the device.
SRSS 4.3 Last change: 2
Sun Ray User Commands utdiskadm(1)
ENVIRONMENT VARIABLES
UTDEVROOT points to a symbolic link of the device root for
the Sun Ray appliance associated with a user's session.
DTDEVROOT points to a temporary directory associated with
the user's session. The directory's lifetime is equal to the
lifetime of the login session. It is removed, along with its
contents, when the user logs out.
SEE ALSO
utmountd(8), utstoraged(8), utdisk(4)
SRSS 4.3 Last change: 3
Sun Ray User Command uteject(1)
NAME
uteject - Sun Ray Mass Storage media eject utility
SYNOPSIS
/opt/SUNWut/bin/uteject device_name
DESCRIPTION
The uteject command has the same functionality as utdiskadm
-e. It ejects media from removable media devices associated
with the user's current Sun Ray session. If a filesystem is
mounted on the device, the eject operation attempts to
unmount it first.
OPTIONS
The following options are supported.
device_name
Eject media from device_name
EXIT STATUS
The following exit codes are returned:
0
The operation was successful
1
The operation was unsuccessful
FILES
The following files are used:
$UTDEVROOT/dev/dsk
The directory containing links to block dev-
ice names for each partition on the device.
ENVIRONMENT VARIABLES
UTDEVROOT points to a symbolic link of the device root for
the Sun Ray DTU associated with a user's session.
SEE ALSO
utdiskadm(8), utmount(8), utumount(8), utmountd(8),
utstoraged(8), utdisk(4)
SRSS 4.3 Last change: 1
Sun Ray User Commands utmount(1)
NAME
utmount - Sun Ray Mass Storage media mount utility
SYNOPSIS
/opt/SUNWut/bin/utmount -m partition_name[-p mount_path]
DESCRIPTION
The utmount command has the same functionality as utdiskadm
-m. It is used to mount partition_name on either the
default mount point in $DTDEVROOT/mnt, or on a user supplied
mount point mount_path.
OPTIONS
The following options are supported.
-m partition name
Mount partition partition_name on default mount
point in $DTDEVROOT/mnt.
-m partition_name -p mount_path
Mount partition partition_name on directory
mount_path
EXIT STATUS
The following exit codes are returned:
0
The operation was successful
1
The operation was unsuccessful
FILES
The following files are used:
Table 1
$UTDEVROOT/dev/dsk The directory containing links
to block device names for each
partition on the device.
ENVIRONMENT VARIABLES
UTDEVROOT points to a symbolic link of the device root for
the Sun Ray DTU associated with a user's session.
SRSS 4.3 Last change: 1
Sun Ray User Commands utmount(1)
DTDEVROOT points to a temporary directory associated with
the user's session. The directory's lifetime is equal to the
lifetime of the login session. It is removed, along with its
contents, when the user logs out.
SEE ALSO
utdiskadm(8), uteject(8), utumount(8), utmountd(8),
utstoraged(8), utdisk(4)
SRSS 4.3 Last change: 2
Sun Ray User Command utselect(1)
NAME
utselect - Sun Ray failover group server selection tool.
SYNOPSIS
/opt/SUNWut/bin/utselect [ -L ] [ -R ] [ -S ] [ -X ]
DESCRIPTION
The utselect command is a graphical user interface (GUI) to
the utswitch command. It allows the user to select manually
to which Sun Ray server or session the Sun Ray DTU is to
connect. The sessions in the GUI are sorted in order of most
current. The second item in the list is highlighted by
default to allow easy switching between two servers. The
Refresh button executes the utswitch -l command and updates
the information displayed in the GUI. The OK button executes
a utswitch -h command to the server highlighted.
OPTIONS
The following options are supported.
-L Configures utselect to run in "login" mode before the
log in screen is displayed. Where:
o If only one server is available, the command
exits.
o The current server is set as the default.
o Selecting the current server causes the command
to exit
o The locale is determined in a manner similar to
CDE
o The screen is centered in the display
-R Remote server selection is enabled. This enables an
entry field where a networked server name can be
entered.
-S Remote server selection is disabled.
-X Exit after making a selection from the list.
EXAMPLES
Example 1: This command enables users to select which Sun
Ray server or session to connect. The GUI exits after selec-
tion
% /opt/SUNWut/bin/utselect -X
SRSS 4.3 Last change: 1
Sun Ray User Command utselect(1)
FILES
Two properties in the auth.props(4)file impact the operation
of utselect:
selectAtLogin=true This setting will cause utselect to
run before dtlogin and allow users
to start their session on a partic-
ular machine. The default value is
"false"
remoteSelect=true This setting will cause utselect to
behave as if the -R option were
specified. This will allow users to
input the name of a server outside
of the default HA group, if the Sun
Ray DTU can connect to it (i.e. the
Sun Ray can be routed to the
server, such as in a LAN deploy-
ment). The default value is false.
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuto |
|__________________________________|________________________|
SEE ALSO
utswitch(1), attributes(5), auth.props(4)
SRSS 4.3 Last change: 2
User Commands utset(1)
NAME
utset - view or change the Sun Ray DTU device settings.
SYNOPSIS
/opt/SUNWut/bin/utset [-d arg[,...] [-f]] [-i arg[,...]]
[-o arg[,...]] [-v arg[,...]]
/opt/SUNWut/bin/utset -l
DESCRIPTION
The utset command reports or modifies Sun Ray device set-
tings. utset executed with no options prints the current
status of all device settings to the standard output stream.
utset executed with the -d, -i, -o or -v options modifies
the values of the specified settings. utset executed with
the -l option prints a list of predefined display timing
names to the standard output stream.
Sun Ray device settings are grouped into four categories:
Display, Audio Input, Audio Output, and Video Input. The
setting to be modified is selected by an option letter,
which identifies the category, and an argument consisting of
a list of individual parameter settings within that category
and the values that are desired for each of those parame-
ters. The argument is a comma separated list of
'name=value' pairs, where name specifies a device parameter
and value specifies the desired value of that parameter.
Parameters reported as read only by utset may not be modi-
fied. Read-only status usually reflects some limitation of
a particular model of DTU. For instance, the Sun Ray 150
supports only one display timing and therefore reports its
display timing setting as a read-only parameter.
The utsettings(1) command provides equivalent device parame-
ter reporting and modification capabilities in a GUI format.
The xset(1) command provides control over device parameters
such as mouse acceleration which are reported by utset but
may not be modified by utset.
OPTIONS
The following options are supported.
-d arg[,...] [-f]
Set the Display timing:
r[vonum]=timing
Display timing: vonum is the number of the
monitor video output whose timing will be
modified. The DTU's first (and perhaps
only) monitor video output is number 1.
SRSS 4.3 Last change: 1
User Commands utset(1)
Additional outputs, if present, are identi-
fied by successively higher numbers. If
vonum is omitted then output number 1 is
assumed. timing is the name of a timing.
The -l option gives the list of available
timings. Timing names are usually of the
form WxH@R where W is the resulting on-
screen width (in pixels), H is the resulting
on-screen height (in pixels) and R is the
resulting refresh rate (in Hz).
utresdef(1m) provides additional information
on monitor timings.
If -f is not given then after the new timing is put
into effect the user is asked to confirm that the new
Resolution/Refresh Rate is acceptable. If no confir-
mation is provided within a certain interval
(currently 15 seconds) then the timing is returned to
its previous setting.
-i arg[,...]
Set the Audio Input settings:
s={m|l} Input Select: microphone, line.
g=<0:75> Microphone Gain: a range of 0 to 75.
l=<0:15> Line In Gain Left: a range of 0 to 15.
r=<0:15> Line In Gain Right: a range of 0 to 15.
v=<0:64> Volume: a range of 0 to 64.
-l Show the list of predefined display timing names.
-o arg[,...]
Set the Audio Output settings:
s={a|h|s|hs}
Output Select: auto, headphone, speaker,
headphone and speaker.
v=<0:31> Volume: a range of 0 to 31.
b=<-32:32>
Balance: a range of -32 to +32.
m={on|off}
Mute: on, off (also: 1, 0 respectively).
e={on|off}
Stereo Enhance: on, off (also: 1, 0
SRSS 4.3 Last change: 2
User Commands utset(1)
respectively).
T=<-6:6> Treble: a range of -6 to +6.
B=<-6:6> Bass: a range of -6 to +6.
-v arg[,...]
Set the Video Input settings:
b=<0:255> Brightness: a range of 0 to 255.
c=<0:63> Contrast: a range of 0 to 63.
C=<0:127> Color: a range of 0 to 127.
t=<0:255> Tint: a range of 0 to 255.
f=<0:3> Filter: a range of 0 to 3.
T={on|off}
Color Trap: on, off (also: 1, 0 respec-
tively).
EXAMPLES
Example 1: This command displays the current device settings
for the Sun Ray DTU to which your session is attached:
% utset
Version: SunRayP3-3.1_10,REV=2005.03.30.15.44 (read only)
Audio Input Mic Gain: 58
Audio Input Line In Gain L: 0
Audio Input Line In Gain R: 0
Audio Input Select: Microphone
Audio Input Monitor Volume: 0
Audio Output Volume: 15
Audio Output Balance: 0
Audio Output Treble: 0
Audio Output Bass: 0
Audio Output Select: Auto
Audio Output Headphone Detected: no
Audio Output Mute: off
Audio Output Stereo Enhance: off
Mouse Threshold: 4
Mouse Acceleration: 2.0
Display Timing 1: 1024x768@60 (read only)
Display Blanking: off
Video Brightness: 128
Video Contrast: 7
Video Color: 46
Video Tint: 128
Video Filter: 3
Video Color Trap: on
SRSS 4.3 Last change: 3
User Commands utset(1)
This session happens to be attached to a Sun Ray 150, which
has only one (internal) monitor video output whose whose
display timing is fixed and is therefore reported as a
read-only parameter.
EXIT STATUS
The following exit values are returned:
0 Success
1 Failure
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuto |
|_____________________________|_____________________________|
SEE ALSO
utresdef(1m), utsettings(1), xset(1)
SRSS 4.3 Last change: 4
Sun Ray User Command utsettings(1)
NAME
utsettings - View or change the Sun Ray DTU settings.
SYNOPSIS
/opt/SUNWut/bin/utsettings
DESCRIPTION
The utsettings command opens a Sun Ray Settings dialog box
that allows the user to view or change audio and video
interface settings for the Sun Ray DTU.
The utsettings application is sensitive to session hotdesk-
ing. As the user moves a session from one Sun Ray DTU to
another, the utsettings application refreshes itself to show
the current DTU's configuration.
Modifications made through utsettings affect only the
session's current DTU. Hotdesking to another DTU does not
cause the previous DTU's settings to be applied to the new
DTU.
If the DTU's monitor timing is modified by utsettings in a
session that is associated with a personal mobile token (a
smart card or an NSCM credential), then utsettings offers to
make the selected timing permanent. If the user accepts that
offer, then the timing is retained and reused on that user's
subsequent personal mobile token sessions on the same DTU.
For shared session token types, such as pseudo, users are
not allowed to establish long-term resolution settings
because their choice might interfere with other people's use
of the DTU.
By default, the Sun Ray server starts an instance of
utslaunch(8) for each session created by the user logging in
via dtlogin. This enables the Sun Ray Settings dialog box to
be available at the press of a hotkey or key combination.
Subsequent presses toggle the dialog box on and off. See
the utslaunch(8) man page for guidance on how to configure
the key combination that is used to launch and dismiss
utsettings.
OPTIONS
No command-line options are supported.
EXAMPLES
Example 1: This command displays the settings for the Sun
Ray DTU that is currently presenting your session:
% utsettings
EXIT STATUS
SRSS 4.3 Last change: 1
Sun Ray User Command utsettings(1)
The following exit values are returned:
0 Success
1 Failure
SEE ALSO
utslaunch(8), utslaunch.properties(5), utset(1)
SRSS 4.3 Last change: 2
Sun Ray User Command utswitch(1)
NAME
utswitch - Sun Ray server selection and session listing
utility.
SYNOPSIS
/opt/SUNWut/bin/utswitch { -l | -t | -h hostname } [ -k
token ] [ -p port ] [ -r ]
DESCRIPTION
The utswitch command allows switching a Sun Ray DTU among
Sun Ray servers in a failover group. It can also list the
existing sessions for the current token. One of the fol-
lowing option flags must be specified: -l, -t, or -h. The
utselect(1) command implements a GUI-based interface to this
command.
OPTIONS
The following options are supported.
-h hostname
Force an explicit switch to the server with hostname.
-k token
Specify the token ID token to be used in collecting
session information from the servers in the failover
group. The token normally used is the one connected to
the current session.
-l List the servers accessible from the current Sun Ray
DTU for the current token and show any existing ses-
sions on those servers. This output is considered
``volatile'' and may change by the addition of new
columns.
o The first field of the output is the server
name.
o The second field is the X display number for an
active user session. If no active user session
exists, then -1 is printed or -2 is printed if
the login screen is being displayed.
o The third field is the last connection time to
an existing session, as a time value from the
time(2) system call. If there is no session, the
third field indicates status from the host as:
-1 Server is up, but there is no session.
-2 No response received from the server.
-3 No path from the Sun Ray to the
SRSS 4.3 Last change: 1
Sun Ray User Command utswitch(1)
server.
o The fourth field is 1 if the server is offline
and 0 otherwise.
o The fifth field is an alternative to the last
connection time to an existing session that
takes care of clock skew between servers.
Instead of the absolute time of access, it is
the time since the last access. If not sup-
ported, or there is no session, the value is -1.
o The sixth field is optional and if present is
the IP address of the interface that should be
used to connect the current session's Sun Ray to
the server.
-p port
Sets the port number of the Authentication Manager on
the Sun Ray server to port, instead of the default
7009.
-r Forces a remote redirection outside of the current
failover group to search for an existing session
within an external failover group. If no session is
available, load balancing is performed. Without this
option, the Sun Ray DTU is bound explicitly to the
target Sun Ray server, rather than to an appropriate
server within the target failover group. This option
may only be used with the -h option
-t Switch to the server whose session has the latest con-
nection time among the existing sessions for the
current token. Normally this would switch to the
current session, so it has limited usefulness. How-
ever, it is useful in the case of logging out of an
existing X session and back to the login screen. The
connection time of a logged out session is biased back
in time so that the session will not be selected if
there is an existing logged-in X session on another
server. From a CDE login screen, it is possible to
force a call to utswitch -t by selecting Reset Login
Screen from the Options menu. This allows switching
back to a logged-in session from the login screen
without having to log in.
FILES
The following files are used:
o /var/opt/SUNWut/displays/*
SRSS 4.3 Last change: 2
Sun Ray User Command utswitch(1)
X display files
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuto |
|_____________________________|_____________________________|
SEE ALSO
utselect(1), attributes(5)
SRSS 4.3 Last change: 3
Sun Ray User Commands utumount(1)
NAME
utumount - Sun Ray Mass Storage unmount utility
SYNOPSIS
/opt/SUNWut/bin/utumount -u mount_path
DESCRIPTION
The utumount command has the same functionality as utdiskadm
-u. It attempts to unmount the filesystem on mount_path if
the related device is a Sun Ray storage device belonging to
the user.
OPTIONS
The following options are supported.
-u mount_path
Unmount mount_path
EXIT STATUS
The following exit codes are returned:
0 Success.
1 Failure.
FILES
The following files are used:
$UTDEVROOT/dev/dsk The directory containing links to
block device names for each partition
on the device.
ENVIRONMENT VARIABLES
UTDEVROOT points to a symbolic link of the device root for
the Sun Ray DTU associated with a user's session.
SEE ALSO
utdiskadm(8), uteject(8), utmount(8), utmountd(8),
utstoraged(8), utdisk(4)
SRSS 4.3 Last change: 1
Sun Ray User Command utxconfig(1)
NAME
utxconfig - Sun Ray DTU X server configuration utility.
SYNOPSIS
/opt/SUNWut/bin/utxconfig [ -a|-A ] [ -d display ] [ -k
xkb-value ] [ -l ] [ -m multihead ] [ -n xrender-value ]
[ -p pcolor ] [ -r res ] [ -R geom ] [ -S screen-order ] [
-t token ] [ -v ] [ -x xinerama ] [ -b Xserver ] [ -q quick-
Abort ]
/opt/SUNWut/bin/utxconfig -e [ -d display ] [ -t token ]
/opt/SUNWut/bin/utxconfig [ -o ] [ -f file ]
/opt/SUNWut/bin/utxconfig [ -i ] [ -f file ]
DESCRIPTION
utxconfig displays and configures X server parameters for
Sun Ray sessions. Changes to the X server settings made
through utxconfig are not applied until a new X server pro-
cess is launched, as happens after logging out and then log-
ging back in again.
utxconfig can also specify the particular X server implemen-
tation to be launched for each Sun Ray session. Currently,
there is only one X server choice on Linux, the Xorg-based
Xnewt X server. If the configured preferred X server is not
installed on the Sun Ray server, one of the other available
X server implementations will be launched.
OPTIONS
The following options are supported.
-a Allows the setting or listing of the default values.
These values will override internal program defaults
for settings that are not explicitly configured for
the individual user. Only a suitably privileged user
may change the default settings.
-A Allows the setting or listing of the mandatory values.
Settings configured with the mandatory flag will take
precedence over all user configured and system default
settings and will be enforced when listing the set-
tings with the -l option. Only a suitably privileged
user may change the mandatory settings.
-b Xserver
Establish the X server preference for the specified
token. Possible Xserver values are "Xnewt" or
"reset". If not defined, it will fall back to the
default utxconfig preference (i.e. the preference
added with the -a option). If the default utxconfig
SRSS 4.3 Last change: 1
Sun Ray User Command utxconfig(1)
preference is also not defined, then it will fall back
to the program default which is Xnewt. Specify the
value "reset" if you want to reset the preference
value back to the default.
-d display
Sets the X display variable used to determine the Sun
Ray DTU session. Otherwise, the DISPLAY environment
variable is used. Users must have access to an X
server attached to their session before they can read
or change the settings for that session.
-e Erases all specific settings for the session. All set-
tings return to their default values.
-f file
Specifies a file to be used in conjunction with -o or
-i.
-i Populates the system settings database from a collec-
tion of comma-delimited text records such as the one
produced by -o. Input is taken from the standard input
unless -f is specified. Only a suitably privileged
user may use this option.
-k xkb-value
Enable or disable the XKB extension. To enable use of
XKB specify "on". To disable XKB specify "off". To
revert to the system default specify "reset". The
default is "on".
-l Lists the current settings for the session. If
specific values have not been set for particular
attributes, default values are printed. The mandatory
settings will be enforced and will take precedence
over both the user configured and system default set-
tings.
-m multihead
Enables or disables multihead mode for X session
startup. By default, if a session is started on a mul-
tihead terminal group, then the session starts in mul-
tihead mode to match the terminal group with an
appropriate number of screens and geometry. Specify
"off" to disable this behavior and the session starts
on a single terminal with one screen. The keyword
"reset" may be specified to reset to the system
default.
-n xrender-value
Enable or disable the Xrender extension. To enable use
of extension specify "on". To disable extension
SRSS 4.3 Last change: 2
Sun Ray User Command utxconfig(1)
specify "off". To revert to the system default specify
"reset". The default is "on".
-o Output all system settings in a comma-delimited text
record. Intended for use with -i. Outputs to standard
output unless -f is specified.
-p pcolor
Parameter that specifies the level of support for the
PseudoColor (8-bit) visual in the X server. The Pseu-
doColor visual is not enabled by default. The accepted
values for pcolor are "off", "on", "default", and
"reset". A pcolor value of "off" will disable the
PseudoColor visual. A pcolor value of "on" will
enable the PseudoColor visual, but the TrueColor
visual (24-bit) will remain the default. A pcolor
value of "default" will enable the PseudoColor visual
and make it the default visual, although the TrueColor
visual will still be available. A pcolor value of
"reset" will revert to the system default. The Pseu-
doColor visual is available only on Solaris and only
when the Xsun X server is used. A PseudoColor setting
is ignored by the Xnewt X server.
-q quickAbort
Enable or disable the ability of a user to abruptly
terminate his own Sun Ray X session by typing the
CTRL-ALT-BKSP-BKSP key sequence into the session. To
enable the quick abort feature specify "on". To dis-
able the quick abort feature specify "off". To revert
to the system default specify "reset". The default is
"on".
-r res
Parameter that specifies the resolution (number of
pixels) of the X desktop canvas for the session. The
format of res is WIDTHxHEIGHT, for example 1280x1024.
utxconfig enforces restrictions on the possible widths
and heights that can be specified. The keyword "auto"
may also be specified, which will enable selection of
a resolution that best matches the resolution capabil-
ities of the terminal on which the X session is
started. The keyword "reset" may be specified to
revert to the system default.
-R geom
Specify a preferred screen geometry in the form COLSx-
ROWS. At X server startup this geometry overrides the
terminal group geometry on which the session is
started. See -m. The keyword "auto" may also be speci-
fied as a value, which will cause the geometry of the
terminal group on which the X session is started to
SRSS 4.3 Last change: 3
Sun Ray User Command utxconfig(1)
be used. The keyword "reset" may be specified to
revert to the system default.
-S screen-order
Specify a preferred screen number order for the
session's screen group. The order must be a legal X
server screen placement, or the keyword "auto" which
will cause a default screen ordering to be chosen.
Manipulating the geometry via the -R option will
automatically change the screen order to an appropri-
ate value.
-t token
Identifies the specific token whose settings will be
the target of this invocation of utxconfig .
-x xinerama
Enable or disable XINERAMA extension. To enable use of
XINERAMA specify "on". To disable XINERAMA specify
"off". To revert to the system default specify
"reset". The default is "off".
-v Verbose output for -l option. When both -l and -v are
specified attributes with default values are labeled
as such.
The following options are RESERVED for use by the Sun Ray
Server Software: -c, -D, -L. The use of these options is
beyond the scope of this manual:
DEPRECATED OPTION
The following option has been deprecated.
-X Xserver
EXAMPLES
Example 1: This command selects the Xsun X server, enables
the PseudoColor visual and forces the desktop size to
1024x768:
% /opt/SUNWut/bin/utxconfig -b Xsun -r 1024x768 -p on
Example 2: This command configures a multihead group with
two screens arranged horizontally, right and left:
% /opt/SUNWut/bin/utxconfig -m on -R 2x1 -S 0,1
Example 3: This command sets the screen geometry and order-
ing to automatic:
SRSS 4.3 Last change: 4
Sun Ray User Command utxconfig(1)
% /opt/SUNWut/bin/utxconfig -R auto
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Types | Attribute Values |
| Availability | SUNWuta |
| Interface Stability | Evolving |
|_____________________________|_____________________________|
SEE ALSO
Xnewt(8), Xserver(1)
NOTES
The -X option has been deprecated and might be removed from
a future release.
The settings are actually maintained on the basis of an
authentication token and do not remain specific to a single
X display number.
SRSS 4.3 Last change: 5
Sun Ray User Commands utxlock(1)
NAME
utxlock - Sun Ray utility for locking a window session.
SYNOPSIS
/opt/SUNWut/bin/utxlock
DESCRIPTION
The utxlock utility locks the current display in a manner
specific to the current windowing environment. If the
current environment is Gnome, it uses xscreensaver-command;
if the current environment is CDE, it uses dtsession; other-
wise utxlock is used.
Note:
Although some users may find screen locking an incon-
venience, overriding it has security implications that
should be obvious. Override at your own risk.
A user may disable any screen lock behavior by setting the
environment variable SUN_SUNRAY_UTXLOCK_PREF to NULL. Any
other value will be used as a command line to use for invok-
ing a screen lock command instead of the default behavior.
SRSS invokes utxlock on any session disconnect. To disable
this behavior, add the following line to your
$HOME/.dtprofile:
SUN_SUNRAY_UTXLOCK_PREF=; export SUN_SUNRAY_UTXLOCK_PREF
As another example, if a user had their own screenlock pro-
gram called mylock, and they wanted to pass it the argument
-l, they should add the following line to their
$HOME/.dtprofile :
SUN_SUNRAY_UTXLOCK_PREF="$HOME/bin/mylock -l"; export
SUN_SUNRAY_UTXLOCK_PREF
OPTIONS
No options are supported.
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWutu |
|_____________________________|_____________________________|
SRSS 4.3 Last change: 1
Interface library libusbut.so.1(3)
NAME
libusbut.so.1 - Sun Ray libusb library for Linux
SYNOPSIS
/opt/SUNWut/lib/libusbut.so.1
DESCRIPTION
The Sun Ray libusb library provides Sun Ray specific support
for libusb.
SUNWlibusbut rpm delivers the Sun Ray libusb library
libusbut.so.1 in /opt/SUNWut/lib. For building apps the
usb.h header file from the existing server side linux libusb
rpm is used. Also reference libusb docs delivered as part of
the server side libusb rpms.
If you wish to develop libusb applications or build open
source libusb applications then it is recommended that you
refresh or upgrade your server side libusb rpm.
Please use libusb version 0.1.8 or greater. To find version
of curent server side libusb do as follows:
/usr/bin/libusb-config --version
this should be >= 0.1.8
Please find the libusb 0.1.8 rpms for Suse and RedHat in
sdlc (sun download center)
For Sun Ray users to be able to use the Sun Ray libusb
library instead of the server side libusb a few options are
available. Any *One* of these options needs to be employed
to provide access to the Sun Ray libusb library by libusb
applications.
1) One can use the utusbrun wrapper script to run libusb
applications. This will automatically set the
LD_PRELOAD and will be limited to the Sun Ray users
wishing to run libusb apps.
Eg. To run the gphoto binary instead of using
%gphoto2 --T
do
%/opt/SUNWut/bin/utusbrun gphoto2 --T
2) Or one may also considering doing their own wrapper
around the commonly used apps and set the variable
SRSS 4.3 Last change: 1
Interface library libusbut.so.1(3)
there.
If the server side support of libusb is not required (i.e
usb devices are not expected to be attached to the Sun Ray
*Server* usb port and driven by libusb) the admin can dis-
able this by unlinking /usr/lib/libusb.so and creating a new
link to Sun Ray libusb library as follows:
ln -s /opt/SUNWut/lib/libusbut.so.1 /usr/lib/libusb.so
With this approach utusbrun script will no longer be
required nor will LD_PRELOAD need to be set.
If one is going to modify sym links please bear in mind that
this may have unintentional side effects when trying a
refresh/upgrade of linux server side libusb rpms.
3) Or one can set LD_PRELOAD to
/opt/SUNWut/lib/libusbut.so.1 so that the Sun Ray libusb
library interface implementations can interpose the
linux server side library implementations. This will
however affect *all* Sun Ray users and can be done in an
xinit rc script. Please write your own script to do this
and put it in
/etc/X11/xinit/xinitrc.d
( Please ensure that both audio and libusb work after this
as this is global and affects *all* Sun Ray users )
See the txt file in /opt/SUNWut/doc/usb/libusb.txt for addi-
tional info.
NOTES
The Sun Ray libusb library currently does not support:
o usb_interrupt_write
o timeouts for the I/O calls.
Note: Do not fork processes to do I/O. Use threads instead.
The existing libusb rpms provided with the distros are out
of date. To develop libusb applications and make use of the
compatible header files please user version 0.1.8 of libusb
provided in sdlc.
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
SRSS 4.3 Last change: 2
Interface library libusbut.so.1(3)
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWlibusbut |
| MT-Level | UnSafe |
| Interface Stability | External |
|_____________________________|_____________________________|
SRSS 4.3 Last change: 3
Sun Ray System APIs ut_amgh_get_server_list(3)
NAME
ut_amgh_get_server_list, ut_amgh_free_server_list - APIs for
Automated Multi-Group Hotdesking also known as Regional Hot-
desking.
SYNOPSIS
cc [flag ...] file ... [library ...]
#include
int ut_amgh_get_server_list(const struct ut_amghargs *amghargs, struct ut_amghret *amghret);
int ut_amgh_free_server_list(struct ut_amghret *amghret);
DESCRIPTION
The ut_amgh_get_server_list() function is called for
retrieving a list of servers associated with the input
parameters for the purposes of Automated Multi-Group Hot-
desking. The underlying AMGH PAM services will invoke this
function to obtain a list of servers which the Sun Ray
should be redirected to. The first server in the list which
is alive and online will be utilised.
The ut_amghargs structure has the following entries:
struct ut_amghargs {
int amghversion; /* the version of the customer API */
char *username; /* the user name e.g. 'fred'*/
char *token; /* the token id e.g. 'Payflex.50045fda00130100'*/
char *terminal_cid; /* the canonical terminal id e.g. 'IEEE802.0800201e2347'*/
char *terminal_ip_addr; /* the terminal ip address e.g. '10.23.146.12'*/
char *insert_token; /* the token id inserted e.g. 'Payflex.50045fda00130100'*/
char *display; /* the display number e.g. ':12'*/
};
The ut_amghret has the following entries:
struct ut_amghret {
char **server_list; /* the reference to a server array */
char *username; /* iff the implementation returns one else NULL */
char *errorstr; /* the error message */
int chain_amgh; /* RESERVED for future use */
int use_firstserver; /* Use firstServer prop as the host */
};
The amghversion field is filled by the underlying PAM ser-
vice before ut_amgh_get_server_list() is called.
ut_amgh_get_server_list() should verify that amghversion is
>= UT_AMGH_VERSION to protect itself from being deployed on
old and potentially incompatible versions of AMGH. If the
test fails it should return UT_AMGH_INCOMPATIBLE_VERSION
before accessing other fields in the ut_amghargs or
ut_amghret structures.
SRSS 4.3 Last change: 1
Sun Ray System APIs ut_amgh_get_server_list(3)
ut_amgh_get_server_list() may use the values of the
ut_amghargs structure to determine the list of hosts to
return to the AMGH service. It should set server_list to
point to storage containing an array of pointers to fully-
qualified hostnames or IP address strings expressed in the
IPv4 standard `.' notation, with a NULL pointer as its last
element. If no suitable hosts are found,
ut_amgh_get_server_list() should assign NULL to the
server_list field in the structure ut_amghret. If an error
is encountered it should set errorstr in the ut_amghret
structure to a suitable error string, set server_list to
NULL and return one of the valid error codes listed below.
ut_amgh_get_server_list() may allocate dynamic storage for
use in the ut_amghret structure, which will be freed by a
later call to ut_amgh_free_server_list().
ut_amgh_get_server_list() may also return a username. If a
NULL username is supplied by the PAM service and a username
is returned it will be used to initialize PAM_USER in the
PAM context.
ut_amgh_free_server_list() frees up any memory dynamically
allocated in the ut_amghret structure. It is the responsi-
bility of the calling application to invoke
ut_amgh_free_server_list() to free the memory returned by
ut_amgh_get_server_list().
RETURN VALUES
Upon successful completion, UT_AMGH_SUCCESS must be
returned. In addition, the following values may be returned
:
UT_AMGH_INCOMPATIBLE_VERSION
The version filled in struct ut_amghargs field amghver-
sion by the customer is not compatible with
UT_AMGH_VERSION value.
UT_AMGH_NO_PERMISSION
No permission to access the back-end database for the
server lookups.
UT_AMGH_DB_ERROR
Error accessing the back-end database.
UT_AMGH_NULL_USERNAME
The implementation requires a username to perform its
lookup, but the AMGH system was not configured to pass
in a username and hence the ut_amghargs username field
was NULL.
UT_AMGH_ERROR
Unknown error encountered by the implementation.
SRSS 4.3 Last change: 2
Sun Ray System APIs ut_amgh_get_server_list(3)
UT_AMGH_NOMEM
Unable to allocate memory.
UT_AMGH_USERNAME_CONFLICT
More than one non-NULL user names found for the token.
NOTES
A reference Makefile and source code for a file-based imple-
mentation of the AMGH APIs are available under
/opt/SUNWutref/amgh/, as a learning aid for potential imple-
mentors. 32 bit library is needed for 32 bit linux systems
and 64 bit library is needed for 64 bit linux systems
SEE ALSO
ut_amgh_script_interface(3)
SRSS 4.3 Last change: 3
Sun Ray System APIs ut_amgh_script_interface(3)
NAME
ut_amgh_script_interface - executable API for Automated
Multi-Group Hotdesking (also known as Regional Hotdesking)
SYNOPSIS
< input > output
input:
[username=username]
[token=token]
[terminal_cid=macaddr]
[terminal_ip_addr=dtu_IP]
[insert_token=token]
[display=display_number]
output:
[username=username]
[host=host]
[use_firstserver=true/false]
DESCRIPTION
The Sun Ray Server Software Automated Multi-Group Hotdesking
(AMGH) system utilizes an API to obtain information about a
username and/or a set of servers for a Sun Ray to be
directed to. See the ut_amgh_get_server_list man page for
more details.
AMGH also can be configured to run a customer-supplied exe-
cutable to produce information for this API. This man page
documents the interface that such an executable should
implement.
The executable will be executed with no arguments. On its
standard input stream (see intro(3)), stdin, data represent-
ing the ut_amghargs structure contents will be written. This
data will be in the form of key/value pairs, one per line on
stdin. The key name will be from the beginning of the line
to the first character and continue to the next newline.
Valid lookup keys are :
username /* the user name e.g. 'fred' */
token /* the token id e.g. 'Payflex.50045fda00130100'*/
terminal_cid /* the canonical terminal id e.g. 'IEEE802.0800201e2347'*/
terminal_ip_addr /* the terminal ip address e.g. '10.23.146.12'*/
display /* the display number e.g. ':12'*/
insert_token /* the token id inserted e.g. 'Payflex.50045fda00130100'*/
/* This is useful in cases where inserted token is different */
/* from the session token, for eg when the registered policy */
SRSS 4.3 Last change: 1
Sun Ray System APIs ut_amgh_script_interface(3)
/* is in effect */
Lines containing keys which are unrecognized should simply
be discarded from stdin and the executable should continue
parsing the remaining input until EOF is reached.
At that point the executable should perform its lookup. If a
username is to be returned, it should write a key/value to
standard output (stdout) of the form:
username=USERNAME
where USERNAME is the value returned by the lookup. It may
also return any number of lines of the form:
host=HOST
where each HOST represents either a fully-qualified hostname
or an IP address.
The script could also return the following values :
use_firstserver=[true | false]
The usage of these options is beyond the scope of this man
page and will be discussed in details in the software docu-
mentation. These are documented here for completeness. The
return values for these options can also be a non-zero
number (true) or 0 (false).
ERRORS
If an error is encountered during the lookup, the executable
may write a descriptive error message to standard error
(stderr), which will be included in the error log and exit
with a suitable error code (see EXIT VALUES).
EXIT VALUES
Exit values should correspond to the error codes in
/opt/SUNWut/include/utamgh.h.
If no errors are encountered during the lookup, the execut-
able should exit with a status of 0 (UT_AMGH_SUCCESS).
Note that if the lookup does not produce a match, this is
not considered an error. In this case, no stdout should be
generated, and the executable should exit with a status of 0
(UT_AMGH_SUCCESS).
If the executable exits with a non-zero exit status, an
error will be logged corresponding to the value of the exit
status.
SRSS 4.3 Last change: 2
Sun Ray System APIs ut_amgh_script_interface(3)
SEE ALSO
ut_amgh_get_server_list(3)
SRSS 4.3 Last change: 3
Sun Ray System APIs ut_ati_script_interface(3)
NAME
ut_ati_script_interface - executable API for Automatic Token
Importation
SYNOPSIS
/etc/opt/SUNWut/site/bin/ati < input > output
input:
insert_token=token
[terminal_cid=macaddr]
output:
registered=0
or
registered=1
name=Full 'user' name
[otherInfo=Other Information]
DESCRIPTION
The Sun Ray Server Software Automatic Token Importation
(ATI) system utilizes an API to obtain information about a
token for use in registration of that token, when a
registered-only policy is in effect.
When a new card token is inserted, if a registered-only pol-
icy is in effect for cards, ATI will run a customer-supplied
executable (with root privilege) to produce information for
this API. This man page documents the interface that such an
executable should implement.
The executable should be copied to
/etc/opt/SUNWut/site/bin/ati. It must be owned by root and
have a mode that does not permit writing by group or other
(see chmod(1)). It must not be a symlink.
It will be executed with no arguments. On its standard input
stream (see intro(3)), stdin, data will be written in the
form of key/value pairs, one per line on stdin. The key
name will be from the beginning of the line to the first '='
character, and the value string will begin after the first
'=' character and continue to the following newline.
INPUT
Provided input keys are :
insert_token /* the token id inserted e.g. 'Payflex.50045fda00130100' */
In addition, the following key is provided when a token is
being checked for importation. It will not be provided when
SRSS 4.3 Last change: 1
Sun Ray System APIs ut_ati_script_interface(3)
the previously-imported token is being checked for deletion.
terminal_cid /* the canonical terminal id e.g. 'IEEE802.0800201e2347' */
Lines containing keys which are unrecognized should simply
be discarded from stdin and the executable should continue
parsing the remaining input until EOF is reached.
OUTPUT
After parsing the provided input the executable should per-
form its lookup. If the token should not be allowed access
to a session, it should write a key/value to standard output
(stdout) of the form:
registered=0
If the token should be allowed access, it should emit
key/value strings to standard output (stdout) of the form:
registered=1
name=Full name for token 'user'
It may also emit information to be used in the registration,
using the following key:
otherInfo=Additional information for token
See the utuser(1m) man page description of the -a option for
a discussion of treatment of these values. These values are
not utilized by SRSS and are for customer use.
If the executable emits registered=1 and is invoked due to
an unrecognized token being presented to the system, a local
registration for the token will be created and a session
will be granted for the token.
If the executable emits registered=0 and is invoked due to
utatiscrub(1m), then if the token is registered locally due
to ATI the local token registration will be deleted and ses-
sions will be denied for the token when presented in future.
This will not affect any active session connections to the
token.
NOTES AND BEST PRACTICE
It's likely that customers will want to install the same
site script on all members of a FOG, otherwise unpredictable
behavior may result.
Reference source which can be used as an example when writ-
ing an executable that implements this API can be found in:
/opt/SUNWutref/ati/utatiref_script
SRSS 4.3 Last change: 2
Sun Ray System APIs ut_ati_script_interface(3)
ERRORS
If an error is encountered during the lookup, the executable
may write a descriptive error message to standard error
(stderr) and exit with a non-zero status. The message writ-
ten to stderr will be included in the error log.
EXIT VALUES
Exit values should be non-zero if an error prevents success-
ful execution.
If no errors are encountered during the lookup, the execut-
able should exit with a status of 0.
Note that if the lookup does not produce a match, this is
not considered an error. In this case, a string of the form
"registered=0" should be written to stdout, and the execut-
able should exit with a status of 0.
EXAMPLE
ATI scripts can easily be hand-tested to verify that they
work properly, as follows:
% echo "insert_token=MicroPayflex.12345" | /etc/opt/SUNWut/site/bin/ati
name="Fred Shalestone"
otherInfo="Rubble Mining Company"
registered=1
% echo $?
0
SEE ALSO
utatiscrub(1m), utuser(1m), ut_amgh_script_interface(3)
SRSS 4.3 Last change: 3
Sun Ray Device Driver utadem(4)
NAME
utadem - Sun Ray audio driver emulator.
SYNOPSIS
/dev/utadem
DESCRIPTION
utadem provides a generic virtual audio interface to Sun Ray
DTU's. The actual interface to the DTU is through a daemon
that is session-aware. The daemon connects to utadem through
a master port and is responsible for creating the slave dev-
ice nodes which connect to normal audio applications.
API
The exact capabilities of the audio device emulated depend
on the OS and audio daemon.
Solaris Applications that normally open /dev/audio may use
utadem as long as they have some way of selecting
the audio device, such as through the -d device
switch, or the AUDIODEV environment variable. Com-
pliance to the standard audio(7I) interface is han-
dled in the following manner:
Audio Data Formats
The data formats supported depend on the dae-
mon. Please refer to the daemon documentation
for its capabilities.
Audio Ports
Input and output audio ports are directly
dependent on the Sun Ray DTU and not on the
daemon. The daemon is capable of discovering
the type and quantity of input ports available
and report them in the record.avail_ports and
play.avail_ports fields of the audio_info
structure. Although the ports can be con-
trolled directly, the actual audio output is
generally a mix of multiple services, so the
play.gain setting is the contribution of this
audio device to the total experience. Since
recording is exclusive of a single service,
the record.gain and record.balance controls
directly affect the hardware gain.
Sample Granularity
Since the utadem driver is working through a
daemon which transfers the audio data over an
interconnect, larger granularities and jitter
in the reporting of sample counts is possible.
At any given time, the reported input and out-
put sample counts will vary from the actual
SRSS 4.3 Last change: 1
Sun Ray Device Driver utadem(4)
sample count by no more than the size of the
buffers it is transferring. Programs should
not rely upon the absolute accuracy of the
play.samples and record.samples fields of the
audio_info structure.
Audio Status Change Notification
As described in audio(7I), it is possible to
request asynchronous notification of state
changes in an audio device.
Linux Compliance to the standard Open Sound System (OSS)
interface is handled in the following manner:
Audio Data Formats
Same as Solaris.
Audio Ports
Input and output audio ports are directly
dependent on the Sun Ray DTU and not on the
daemon. The daemon is capable of discovering
the type and quantity of input ports avail-
able. Use the OSS mixer interface to deter-
mine which ports are available
Sample Granularity
Same as Solaris.
The following OSS features are unsupported:
SNDCTL_DSP_REALTIME
Realtime capabilities are not supported.
SNDCTL_CAP_MMAP
Device DMA memory mapping is not sup-
ported.
/dev/audio
/dev/audio interface is not currently
supported. Use /dev/dsp with appropriate
format settings instead
ERRORS
Solaris utadem errors are defined in the audio(7I) man
pages. If the daemon has exited, further audio
operations are no longer possible on the slave
ports. Audio programs must exit in order to clear
this error. New opens will return ENODEV. Data
writes and ioctl operations will return ENXIO. Data
reads will complete normally and then return end-
of-file.
SRSS 4.3 Last change: 2
Sun Ray Device Driver utadem(4)
Linux are there any?
FILES
The following file is used:
o /dev/utadem
Master port for daemons.
The logical device name of the slave port depends on the
daemon.
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Solaris | |
| Availability | SUNWutu |
| MT-Level | Safe |
| Linux | |
| Availability | SUNWutkau |
|_____________________________|_____________________________|
SEE ALSO
Solaris and Linux
utaudio(1), ioctl(2)
Solaris attributes(5), audio(7I), streamio(7I)
SRSS 4.3 Last change: 3
Sun Ray Device Driver utdisk(4)
NAME
utdisk, utdiskctl - Sun Ray Mass Storage device and con-
troller drivers.
SYNOPSIS
$UTDEVROOT/dev/dsk/partition_name
DESCRIPTION
The utdisk and utdiskctl drivers provide a block interface
to mass storage devices connected to Sun Ray appliances
(DTUs).
The actual interface to the DTU for each of these drivers is
through the Sun Ray interconnect via the utstoraged(8) dae-
mon.
The utmountd(8) daemon mounts devices with OS-recognizable
filesystems on them.
API
Applications open a device link created by utstoraged.
Links to block device nodes are created in the
$UTDEVROOT/dev/dsk directory.
ERRORS
EACCES Permission denied.
EBUSY The partition was opened exclusively by another
thread.
EFAULT The argument features a bad address.
EINVAL Invalid argument.
ENOTTY The device does not support the requested ioctl()
function.
ENXIO The device did not exist when attempting opera-
tion.
EAGAIN Resource temporarily unavailable.
EINTR A signal was caught during the execution of the
ioctl() function.
ENOMEM Insufficient memory.
EROFS The device is read-only.
EPERM Insufficient access rights.
EIO An I/O error occurred.
SRSS 4.3 Last change: 1
Sun Ray Device Driver utdisk(4)
FILES
The following files are used:
o /var/log/messages
System messages file.
o $UTDEVROOT/dev/dsk/name
Block interface to disk or partition.
Where name is a string descriptive of the device type with a
suffix denoting the partition number or UNIX slice number.
EXAMPLES
Example 1:
The block device link for the full disk is given by
$UTDEVROOT/dev/dsk/disk1
Example 2:
The block device link for the 2nd partition is given by
$UTDEVROOT/dev/dsk/disk1p2
ENVIRONMENT VARIABLES
UTDEVROOT points to a symbolic link of the device root for
the Sun Ray appliance associated with a user's session.
SEE ALSO
utstoraged(8), utmountd(8), utdiskadm(8)
WARNINGS
On Linux, writes to some filesystems are asynchronous. If
the device is unplugged without unmounting the filesystem
first, some data could get lost.
Users are strongly advised to use the utdiskadm(8) command
to prepare the device for removal before unplugging the dev-
ice or disconnecting their session.
NOTES
Users have access rights only to storage devices connected
to the Sun Ray DTU on which their session is active and only
for as long as it is active. When the session is discon-
nected from the Sun Ray DTU whether through logout, hotdesk-
ing, server switching, or any other reason, ownership of the
storage device is lost and all pending data transfers are
aborted. This can result in the filesystem on the media get-
ting corrupted and data getting lost.
SRSS 4.3 Last change: 2
Sun Ray Device Driver utdisk(4)
NAME
utdisk, utdiskctl - Sun Ray Mass Storage device and con-
troller drivers.
SYNOPSIS
$UTDEVROOT/dev/dsk/partition_name
DESCRIPTION
The utdisk and utdiskctl drivers provide a block interface
to mass storage devices connected to Sun Ray appliances
(DTUs).
The actual interface to the DTU for each of these drivers is
through the Sun Ray interconnect via the utstoraged(8) dae-
mon.
The utmountd(8) daemon mounts devices with OS-recognizable
filesystems on them.
API
Applications open a device link created by utstoraged.
Links to block device nodes are created in the
$UTDEVROOT/dev/dsk directory.
ERRORS
EACCES Permission denied.
EBUSY The partition was opened exclusively by another
thread.
EFAULT The argument features a bad address.
EINVAL Invalid argument.
ENOTTY The device does not support the requested ioctl()
function.
ENXIO The device did not exist when attempting opera-
tion.
EAGAIN Resource temporarily unavailable.
EINTR A signal was caught during the execution of the
ioctl() function.
ENOMEM Insufficient memory.
EROFS The device is read-only.
EPERM Insufficient access rights.
EIO An I/O error occurred.
SRSS 4.3 Last change: 1
Sun Ray Device Driver utdisk(4)
FILES
The following files are used:
o /var/log/messages
System messages file.
o $UTDEVROOT/dev/dsk/name
Block interface to disk or partition.
Where name is a string descriptive of the device type with a
suffix denoting the partition number or UNIX slice number.
EXAMPLES
Example 1:
The block device link for the full disk is given by
$UTDEVROOT/dev/dsk/disk1
Example 2:
The block device link for the 2nd partition is given by
$UTDEVROOT/dev/dsk/disk1p2
ENVIRONMENT VARIABLES
UTDEVROOT points to a symbolic link of the device root for
the Sun Ray appliance associated with a user's session.
SEE ALSO
utstoraged(8), utmountd(8), utdiskadm(8)
WARNINGS
On Linux, writes to some filesystems are asynchronous. If
the device is unplugged without unmounting the filesystem
first, some data could get lost.
Users are strongly advised to use the utdiskadm(8) command
to prepare the device for removal before unplugging the dev-
ice or disconnecting their session.
NOTES
Users have access rights only to storage devices connected
to the Sun Ray DTU on which their session is active and only
for as long as it is active. When the session is discon-
nected from the Sun Ray DTU whether through logout, hotdesk-
ing, server switching, or any other reason, ownership of the
storage device is lost and all pending data transfers are
aborted. This can result in the filesystem on the media get-
ting corrupted and data getting lost.
SRSS 4.3 Last change: 2
Sun Ray Device Driver utparallel(4)
NAME
utparallel, utserial - Sun Ray serial and parallel port dev-
ice driver emulators.
SYNOPSIS
#include
#include
utserial
#include
#include
utparallel
#include
DESCRIPTION
utserial is a tty-style interface that provides a generic
virtual interface to USB serial adaptors connected to the
Sun Ray DTU.
utparallel is a parallel-style interface that provides a
generic virtual interface to USB parallel adaptors connected
to the Sun Ray DTU.
utserial and utparallel are each loadable STREAMS drivers.
EXTENDED DESCRIPTION
The actual interface to the DTU for each of these drivers is
through the Sun Ray interconnect via either the utseriald
daemon or the utparalleld daemon, each of which is session-
aware. The daemons are connected to either utserial or
utparallel through a master port and each is responsible for
creating the slave device nodes through which normal appli-
cations will connect.
API
Applications open a device file created by either utseriald
or utparalleld. Device files created by utseriald comply to
the termio(7I) interface and device files created by
utparalleld comply to the ecpp(7D) interface. Hardware limi-
tations in USB adaptors might prevent compliance with these
interfaces.
FILES
The following files are used:
o /dev/utserial
SRSS 4.3 Last change: 1
Sun Ray Device Driver utparallel(4)
Master port for utserial
o /dev/utparallel
Master port for utparallel
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWutu |
| MT-Level | Safe |
|_____________________________|_____________________________|
SEE ALSO
utseriald(1M), utparalleld(1M), termio(7I), ecpp(7D)
SRSS 4.3 Last change: 2
Sun Ray Device Driver utserial(4)
NAME
utserial, utparallel - Sun Ray serial and parallel port dev-
ice driver emulators.
SYNOPSIS
#include
#include
utserial
#include
#include
utparallel
#include
DESCRIPTION
utserial is a tty-style interface that provides a generic
virtual interface to USB serial adaptors connected to the
Sun Ray DTU.
utparallel is a parallel-style interface that provides a
generic virtual interface to USB parallel adaptors connected
to the Sun Ray DTU.
utserial and utparallel are each loadable STREAMS drivers.
EXTENDED DESCRIPTION
The actual interface to the DTU for each of these drivers is
through the Sun Ray interconnect via either the utseriald
daemon or the utparalleld daemon, each of which is session-
aware. The daemons are connected to either utserial or
utparallel through a master port and each is responsible for
creating the slave device nodes through which normal appli-
cations will connect.
API
Applications open a device file created by either utseriald
or utparalleld. Device files created by utseriald comply to
the termio(7I) interface and device files created by
utparalleld comply to the ecpp(7D) interface. Hardware limi-
tations in USB adaptors might prevent compliance with these
interfaces.
FILES
The following files are used:
o /dev/utserial
SRSS 4.3 Last change: 1
Sun Ray Device Driver utserial(4)
Master port for utserial
o /dev/utparallel
Master port for utparallel
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWutu |
| MT-Level | Safe |
|_____________________________|_____________________________|
SEE ALSO
utseriald(1M), utparalleld(1M), termio(7I), ecpp(7D)
SRSS 4.3 Last change: 2
Sun Ray File Format auth.props(5)
NAME
auth.props - Sun Ray authentication daemon configuration
file.
SYNOPSIS
/etc/opt/SUNWut/auth.props
DESCRIPTION
The auth.props file contains the Sun Ray Authentication
Manager's configuration properties. Changes to many of these
properties are not supported and should not be set to other
than the default values.
OPTIONS
The following options are available:
adminConfigFile=filename
This file contains the administrative database confi-
guration information.
allowAnnotations=boolean
UNSUPPORTED. When set true, any application can con-
nect from any IP address and annotate a session. Anno-
tations are restricted to keywords prefixed by "x_".
Values are not restricted.
allowFWLoad=boolean
Specifies whether or not the utload command is allowed
to download firmware to DTUs connected to this Authen-
tication Manager.
allowLANConnections=boolean
When set true the DTU connections are allowed from
public LAN interfaces, as well as from private Sun Ray
interconnect interfaces.
cbport=portNumber
UNSUPPORTED. The Authentication Manager listens on
this port for connections from the utsessiond daemon
and other programs, such as utload.
cbtimeout=seconds
UNSUPPORTED. Specifies the read timeout in seconds for
programs that connect to the cbport.
controllers=maximum
UNSUPPORTED. Specifies the maximum number of spare
threads that are available for handling new connec-
tions from applications such as utload(8).
enableGroupManager=boolean
UNSUPPORTED. Flag to turn on the group manager
SRSS 4.3 Last change: 1
Sun Ray File Format auth.props(5)
function.
enableLoadBalancing=boolean
Flag to turn on group manager load balancing.
enableMulticast=boolean
UNSUPPORTED. Flag to enable/disable use of multicast
in group manager. If disabled, group manager will use
broadcast.
forceSessionLocation=boolean
UNSUPPORTED. Flag to force use of sessionHost and ses-
sionPort settings from this file regardless of the
various authentication modules.
gmDebug=level
UNSUPPORTED. Group manager debugging level.
gmKeepAliveInterval=seconds
UNSUPPORTED. The group manager uses this as the time
in seconds between broadcast keepalive messages.
gmport=port
UNSUPPORTED. The group manager uses this port to send
and receive keepalive/discovery messages from other
Authentication Managers.
gmSignatureFile=file
The group manager can "sign" messages to other group
managers based on the contents of a signature file.
Other group managers with the same signature file con-
tents are "trusted". To be usable, the file must be
owned by 'root' and must not be readable, writable, or
executable by anyone else; it must contain at least 8
bytes, at least two of which are letters and at least
one which is a non-letter printable character.
gmTargets=hostlist
The group manager will send unicast group announce-
ments to all hosts specified in the hostlist list.
The list is a comma-separated sequence of server names
and IP addresses. Unicast group announcements, when
configured, are sent in addition to multicast or
broadcast announcements. The utgmtarget(8) command
may be used to maintain a group-wide list of unicast
targets.
log=filename
UNSUPPORTED. This option specifies a file that con-
tains the log messages.
logAddTimeStamp=boolean
SRSS 4.3 Last change: 2
Sun Ray File Format auth.props(5)
UNSUPPORTED. Add your own timestamp to syslog mes-
sages. This may be appropriate for debugging or in
cases where a remote syslog server is being used and
higher resolution timestamps are required.
logFacility=value
The logFacility can be one of the following:kern,
user, mail, daemon, auth, syslog, lpr, news, uucp,
cron, local0, local1, local2, local3, local4, local5,
local6, local7
Log files
Log priorities for different utauthd message classes
can be one of the following: emerg, alert, crit, err,
warning, notice, info, debug, OFF.
The message classes are:
logPriClientError=value
logPriDebug=value
logPriNotice=value
logPriWarning=value
logPriConfigError=value
logPriUnexpectedError=value
maxStarting=maximum
UNSUPPORTED. Specifies the maximum number of threads
that can be simultaneously initiating a session. Addi-
tional threads wanting to start or verify a session
wait for previous threads to finish starting or veri-
fying a session.
moduleDir=directoryName
UNSUPPORTED. Specifies the location of the authentica-
tion modules.
multicastTTL=integer
UNSUPPORTED. Time-to-live parameter for forwarding
multicast packets. If set above one, keepalive mes-
sages can pass through routers.
noClaimSleepTime=seconds
UNSUPPORTED. The amount of time in seconds to sleep
after a token has been offered to all of the authenti-
cation modules and before notifying the DTU that the
authentication failed.
SRSS 4.3 Last change: 3
Sun Ray File Format auth.props(5)
policy=filename
Specifies the location of the authentication policy
specification.
port=portNumber
The utauthd daemon listens on this port for connec-
tions from Sun Ray DTUs.
quickTimeout=seconds
DTUs are required to respond to a message from the
server within the time specified by seconds. This time
is used to detect whether a request for access to a
currently connected session is an attempt to take over
this session with a spoofed token or if the DTU to
which the session is connected had a device or network
failure. Protection against malicious session take-
over, especially on heavily loaded servers, can be
improved by raising the value of this timeout. The
regular mechanism to detect and expire 'dead' termi-
nals, controlled by the timeout setting, will be used
independently, so setting quickTimeout to a value
greater than timeout is not meaningful. For maximum
protection the value zero (0) can be used for quick-
Timeout to completely disable the quick timeout
mechanism and use only the regular 'dead' terminal
detection.
remoteSelect=boolean
If true, the remote server selection option of the
utselect(1) command is enabled by default.
reportAllDesktopEvents=boolean
UNSUPPORTED. When true, all desktop events are
reported instead of being filtered to just those
events that change the "exists" state of the DTU.
selectAtLogin=boolean
If true, activates a utselect -L GUI allowing the user
to select a Sun Ray server before logging into CDE. If
only one server is available, the GUI exits automati-
cally. Refer to the utselect man page for more infor-
mation on the -L option.
sessionHost=hostname
UNSUPPORTED. Specifies the host name of the server
that is running the default utsessiond for this
Authentication Manager.
sessionPort=portNumber
UNSUPPORTED. Specifies the port number of the server
that is running the default utsessiond for this
Authentication Manager.
SRSS 4.3 Last change: 4
Sun Ray File Format auth.props(5)
sessionTypesFile=filename
Specifies a file that contains mappings from session
types to the associated session startup and shutdown
commands.
smartcardConfigSource =
The keys in this property specify the order in which
to search for the configuration files. The special
reserved key LDAP means go to the configured LDAP
database. Any other value refers to a local probe
order file.
smtimeout=seconds
UNSUPPORTED. Specifies the read timeout in seconds for
reading messages from the utsessiond daemon.
termAddrIsSecret=boolean
UNSUPPORTED. When true, the IP address and port of
DTUs are not reported in the dynamic status informa-
tion provided on port cbport in response to the
string.
terminalokens =
UNSUPPORTED. Define the types of tokens that are han-
dled by the terminal rather than by the auth manager.
If a token of this type is seen, the auth manager will
use the ID value generated by the terminal rather than
trying to determine the ID on the server.
terminateEnable=boolean
UNSUPPORTED. Enable the cleanup of empty sessions
based on notification from the session manager. The
default is enabled.
timeout=seconds
UNSUPPORTED. DTUs are required to send a message to
the Authentication Manager at least once every time
period specified by seconds.
tokenDir=directory
UNSUPPORTED. Specifies a directory that contains the
mappings from logical token names to session identif-
iers. The persistent storage of these mappings allows
the utauthd daemon to recover its state after restart-
ing. This state is reset on reboot of the system.
token.equiv=filename
UNSUPPORTED. Specifies a file that contains mappings
from one raw token name to another.
workers=maximum
UNSUPPORTED. Specifies the maximum number of spare
SRSS 4.3 Last change: 5
Sun Ray File Format auth.props(5)
threads that are available for handling new connec-
tions from Sun Ray DTUs.
FILES
The following files are used:
/etc/init.d/utsvc
This is the system startup script that invokes
the daemon /opt/SUNWut/lib/utsessiond. The ses-
sion manager performs the actual session switch-
ing function.
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWutr |
|_____________________________|_____________________________|
SEE ALSO
utauthd(8), utpolicy(8), utsessiond(8), utselect(1),
utgmtarget(8)
SRSS 4.3 Last change: 6
Sun Ray File Format utadmin.conf(5)
NAME
utadmin.conf - Sun Ray server administration configuration
file.
SYNOPSIS
/etc/opt/SUNWut/utadmin.conf
DESCRIPTION
The utadmin.conf file is a contains configuration parameters
for the Sun Ray server administration database.
The admin.defaultlocale parameter (see below) is the only
parameter that should be changed once the Sun Ray server is
configured and in use. All other parameters are reserved.
PROPERTIES
The supported configuration parameters are listed below. For
each one, the name, description, and an example are given.
Name Description
admin.defaultlocale
The default locale for Web-based Administration Tool.
Supported values:
Solaris "en_US" (US English), "fr" (French), "ja"
(Japanese), "zh" (Simplified Chinese).
Linux "en_us" (US English), "fr_FR" (French),
"ja_JP.eucjp" (Japanese), "zh_CN" (Simpli-
fied Chinese).
admin.dstatus.dbfile
The name of the NDBM data files where the desktop
status is stored.
admin.http.cfile
Configuration file for the Sun Ray Administration
Server.
admin.http.port
The webserver port used by the Administration Tool.
admin.server.name
The name of the server where the administration data-
base LDAP server process is running. This is usually
the host name of the Sun Ray server.
admin.subtree
The subtree within the LDAP hierarchy where Sun Ray
administration data for this server resides. This is
an entry under the UT root entry that was specified by
SRSS 4.3 Last change: 1
Sun Ray File Format utadmin.conf(5)
utconfig.
admin.user.name
The LDAP user that the administration clients should
bind as to perform privileged operations.
admin.ustatus.dbfile
The name of the NDBM data files where the user status
is stored.
EXAMPLES
Example 1: Configuration parameters for the LDAP and NDBM
databases:
Solaris and Linux
admin.server.name = sray-139
admin.server.port = 7012
admin.user.name = cn=utadmin,utname=sray-139,o=v1,o=utdata
admin.subtree = utname=sray-139,o=v1,o=utdata
admin.defaultlocale = en_US
admin.dstatus.dbfile = /var/opt/SUNWut/ndbm/dstatus
admin.ustatus.dbfile = /var/opt/SUNWut/ndbm/ustatus
admin.http.port = 1660
admin.ssl.enable =
Solaris
admin.http.cfile = /usr/apache/httpd.conf
Linux
admin.http.cfile = /usr/apache/conf/httpd.conf #(on JDS only)
admin.http.cfile = /etc/httpd/conf/httpd.conf #(on RHAS only)
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWutr |
|_____________________________|_____________________________|
SEE ALSO
utinstall(1M), utconfig(1M), utuser(1M), utdesktop(1M)
Sun Ray Server Software 4.3 Administrator's Guide
SRSS 4.3 Last change: 2
Sun Ray File Format utdialog_responses.props(5)
NAME
utdialog_responses.props - Sun Ray Automatic Installation
and Configuration configuration file.
SYNOPSIS
/var/opt/SUNWut/utdialog.d/*.utdialog_responses.props
DESCRIPTION
The utdialog_responses.props files contain the Sun Ray
Automatic Installation and Configuration system's configura-
tion properties. They are partitioned into a number of files
all prefaced with a string identifying which component of
Sun Ray Software they configure.
The contents of these files are created by running AIC
Clients (see AIC(8)-fR), most notably through use of the
utsetup command. The user responses to the installation
and/or configuration prompts are stored in these files,
which can then be copied to another system to automate its
installation and configuration by using the utsetup -a com-
mand.
Note that the contents of these files may contain security-
sensitive information such as passwords, so appropriate care
should be taken when copying them on disk or across a net-
work.
This man page is not intended to provide comprehensive docu-
mentation for all the properties required to completely
automate installation or configuration.
OPTIONS
The following most significant options are available:
Component: SRSS
utsetup.LAN_EnableYN=response
response should be Y or N
utsetup.FirmwareConfigYN=response
response should be Y or N
utinstall.JavaPathname=pathname
The path to the directory containing the JRE to use
for Sun Ray Software
utconfig.srwa.ConfigureWebAdminYN=response
response should be Y or N
utconfig.srwa.EnableSecureConnectionsYN=response
response should be Y or N
utconfig.srwa.EnableRemoteServerAdministrationYN=response
SRSS 4.3 Last change: 1
Sun Ray File Format utdialog_responses.props(5)
response should be Y or N
utconfig.srwa.TomcatInstallDirectory=pathname
pathname should be the path to the installation direc-
tory for Tomcat
utconfig.srwa.HTTPPortNumber=port
port should be the port number to use for HTTP
utconfig.srwa.HTTPSPortNumber=port
port should be the port number to use for HTTPS
utconfig.srwa.TomcatProcessUsername=username
username should be the username to be created for use
with the Tomcat daemon processes.
Component: SRCS
utconfig.ConfigureFailover=response
response should be Y or N
utpw.Password=password
password should be the administration password (in
ROT13-encoded text)
utgroupsig.Signature=signature
signature should be the HA group signature (in ROT13-
encoded text)
utpolicy.PolicyString=policy
policy should be the policy specification as would be
specified on the utpolicy command line (see utpol-
icy(8)).
utreplica.PrimaryList=primary
primary should be the name of the SRDS replication
Primary for the HA group
utreplica.SecondaryList=secondaries
secondaries should be the names of the SRDS replica-
tion Secondaries for the HA group, separated by spaces
utreplica.ReplicationPort=port
port should typically be 7012
Component: SRCS.kiosk
utconfig.kiosk.ConfigureKiosk=response
response should be Y or N
utconfig.kiosk.UserPrefix=prefix
prefix should be the prefix to be applied to Kiosk
usernames
SRSS 4.3 Last change: 2
Sun Ray File Format utdialog_responses.props(5)
utconfig.kiosk.Group=groupname
groupname should be the group name to be created for
use with Kiosk
utconfig.kiosk.UIDRangeStart=uid
uid should be the lowest UID number to utilize for
Kiosk users
utconfig.kiosk.NumUsers=num
num should be the number of Kiosk users to be created
Component: SRWC
utconfig.uttscadm.Groupname=groupname
groupname should be the group name to be created for
use with SRWC
utconfig.uttscadm.GroupID=gid
gid should be the group ID to be used with SRWC
SEE ALSO
utsetup(8), utconfig(8), utpolicy(8), utreplica(8),
uttscadm(8), utpw(8), utgroupsig(8), utinstall(8), AIC(8)
SRSS 4.3 Last change: 3
Sun Ray File Format utslaunch.properties(5)
NAME
utslaunch.properties - Default hotkey key combinations for
various applications supported by utslaunch.
SYNOPSIS
/etc/opt/SUNWut/utslaunch_defaults.properties
~/.utslaunch.properties
/etc/opt/SUNWut/utslaunch_mandatory.properties
DESCRIPTION
The files listed above are standard Java properties files
that can contain defaults which customize the operation of
the utslaunch application. Each file contains entries in the
format of:
name=value
where name is the property name and value is the value set.
EXTENDED DESCRIPTION
When the utslaunch application starts, it looks for and
reads the properties files in the order listed below. Note
that a hotkey key combination specified in a file can be
overridden by a file read later in the search order.
1. /etc/opt/SUNWut/utslaunch_defaults.properties
This file contains site-wide default properties which are
used if the user has not specified any. These properties
override any application defaults.
2. ~/.utslaunch.properties
This file contains the user's default properties. These
properties override application and site-wide default
properties.
3. /etc/opt/SUNWut/utslaunch_mandatory.properties
This file contains site-wide mandatory default properties
which supersede any application, site-wide, or user
defaults.
PROPERTIES
The supported application properties are listed below. For
each property, the name, description, application default,
and some examples are given.
Name - utdetach.hotkey
SRSS 4.3 Last change: 1
Sun Ray File Format utslaunch.properties(5)
Description - Specifies the hotkey or key combination that
disconnects the current session from the DTU the user is
currently using. The value is a valid X keysym name preceded
by one or more of the supported modifiers (Ctrl, Shift, Alt,
Meta).
Application Default - Shift Pause (Hold down Shift and press
the Pause key)
Name - utsettings.hotkey
Description - Specifies the hotkey or key combination that
invokes the Sun Ray Settings dialog box. The value is a
valid X keysym name preceded by one or more of the supported
modifiers (Ctrl, Shift, Alt, Meta).
Application Default - Shift SunProps (Hold down Shift and
press the Props key)
Examples:
o F3
o Shift F4
o Ctrl Shift Alt F5
EXAMPLES
Example 1: The following is a sample of the contents of a
properties file.
utdetach.hotkey=Shift Pause
utsettings.hotkey=Shift SunProps
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Types | Attribute Values |
| Availability | SUNWutr |
| Stability Level | Evolving |
|_____________________________|_____________________________|
SEE ALSO
utslaunch(1M), utdetach(1M)
SRSS 4.3 Last change: 2
Standards, Environments, and Macros AIC(8)
NAME
AIC - Automatic Installation and Configuration
DESCRIPTION
AIC is a framework for automating dialogs for Sun Ray
Software applications. Applications utilizing the framework
are referred to as AIC clients. By default, AIC clients will
prompt the user for input in the standard fashion (but util-
izing stderr instead of stdout), read a response, and record
the response to a COMP.utdialog_responses.props file in
/var/opt/SUNWut/utdialog.d/, where COMP is used to categor-
ize responses depending on the area of the product which
delivers the client. Currently defined areas are SRSS, SRCS,
SRCS.kiosk, and SRWC. Every dialog prompt has an associated
key, and that key is used with the response value to iden-
tify and locate the response in the future. The most signi-
ficant keys and the specific files they reside in are docu-
mented on the utdialog_responses.props(5) man page.
AIC clients can be invoked to use responses from the
utdialog_responses.props files. This is typically indicated
by the -a option, but it may be a different option for some
commands. If no response is available for the prompt, the
user will be prompted for input, and the response will be
recorded in the utdialog_responses.props file.
Most AIC clients can be invoked to use default responses.
This is typically indicated by the -d option, but it may be
a different option for some commands. If the -a option is
provided in addition to the -d option, responses from the
utdialog_responses.props files are used first. If no
response is available for the prompt, the user will be
prompted for input, and the response recorded in the
utdialog_responses.props file.
Prompts that ask for passwords and similar data have special
behavior. For interactive prompting, echoing of the
responses on the terminal is suppressed and the user is
prompted twice. This is repeated until both responses match.
The responses for such prompts are stored in the
utdialog_responses.props file using ROT13 encoding.
At this time, the following Sun Ray administration applica-
tions utilize the AIC framework:
SRSS 4.3 Last change: 1
Standards, Environments, and Macros AIC(8)
____________________________________________________________________
| AIC Client | use responses | use defaults |
|_____________________________|_______________|_____________________|
| utsetup | -a | -d |
|_____________________________|_______________|_____________________|
| utinstall | -A | -c |
|_____________________________|_______________|_____________________|
| utconfig | -a | -d |
|_____________________________|_______________|_____________________|
| utpolicy | -A | -Z |
|_____________________________|_______________|_____________________|
| utpw | -a | No default available|
|_____________________________|_______________|_____________________|
| utgroupsig | -a | No default available|
|_____________________________|_______________|_____________________|
| utreplica | -A | -D |
|_____________________________|_______________|_____________________|
NOTES
If a user prompt is needed, when an AIC client is invoked
non-interactively (standard input is not a terminal), the
behavior is not specified and may change in a future
release.
SEE ALSO
utsetup(8), utinstall(8), utconfig(8), utpolicy(8), utpw(8),
utgroupsig(8), utreplica(8), utdialog_responses.props(5)
SRSS 4.3 Last change: 2
Sun Ray System Administration Xnewt(8)
NAME
/opt/SUNWut/lib/Xnewt - standalone X server for Sun Ray
SYNOPSIS
/opt/SUNWut/lib/Xnewt :display [ option ... ]
DESCRIPTION
Xnewt is a standalone X server used only for Sun Ray
servers. It replaces Xsun as the default Xserver for Sun
Ray, and it does not support any non-Sun Ray devices.
Because Xnewt requires internal system setup in order to
start up properly, it should only be invoked internally from
a Sun Ray startup script.
Xnewt is based on the release 7.2 of the Xorg Community
source. It is not a loadable module system and does not
depend on the xorg.conf(4) file. Instead, Xnewt relies on
utxconfig(1) to configure the server. Similar to Xorg,
Xnewt does not provide 8-bit visual support.
OPTIONS
All the options for Xnewt are reserved for internal use.
However, you can configure some Xnewt options using the utx-
config(1) command. The available configuration options are
described in the utxconfig(1) manual page.
EXTENSIONS
Xnewt supports the following X extensions:
RANDR The X Resize and Rotate Extension (XRandR) allows
clients to change X screens dynamically, for example,
to change the size and resolution. If a desktop
environment doesn't provide a graphical tool for
interfacing with this functionality, use the xrandr
command line tool. This extension is always enabled.
RENDER
The X Rendering Extension (Render) allows clients to
use a new rendering model based on Porter-Duff compo-
siting. This extension is managed thru utxconfig(1).
Please refer to utxconfig(1) man page for more info.
GLX An OpenGL extension to make OpenGL rendering available
in the X window system. Xnewt only provides software
rendering support since Sun Ray DTUs do not provide
graphic hardware accelerators. This extension is
always enabled.
XKB The X keyboard extension (XKB) extends the ability to
control the keyboard beyond what is offered by the X
Window System core protocol. This extension is
managed thru utxconfig(1). Please refer to
SRSS 4.3 Last change: 1
Sun Ray System Administration Xnewt(8)
utxconfig(1) man page for more info.
DPMS Display Power Management Services (DPMS) manages the
power supply of video monitors on Sun Ray DTUs. It
shuts off the monitor to save power after the DTU has
been unused (idle) for some time. This extension is
always enabled.
XINERAMA
Xinerama is an extension to the X Window System that
enables multi-headed X applications and window
managers which use two or more physical displays as
one large virtual display. This extension is managed
thru utxconfig(1). Please refer to utxconfig(1) man
page for more info.
XVIDEO
This extension is a video output mechanism for the X
Window system. Its main use is to offload part of the
video processing to the Sun Ray DTU. This extension
is always enabled.
SEE ALSO
utxconfig(1), Xserver(1)
NOTES
Xorg is copyrighted software, provided under licenses that
permit modification and redistribution in source and binary
form without fee. Xorg is copyrighted by numerous authors
and contributors from around the world. Licensing informa-
tion can be found at .
Refer to the source code for specific copyright notices.
XFree86(TM) is a trademark of The XFree86 Project, Inc.
X11(TM) and X Window System(TM) are trademarks of The Open
Group.
SRSS 4.3 Last change: 2
Standards, Environments, and Macros pam_sunray_hotdesk(8)
NAME
pam_sunray_hotdesk - PAM module for use with Sun Ray Remote
Hotdesk Authentication
SYNOPSIS
/opt/SUNWut/lib/pam_sunray_hotdesk.so.1
/opt/SUNWut/lib64/pam_sunray_hotdesk.so.1
DESCRIPTION
The pam_sunray_hotdesk module should always be present on
Display Manager PAM service stacks used by Sun Ray Server
Software, such as dtlogin-SunRay or gdm. It is used by Sun
Ray software to label sessions as candidates for Remote Hot-
desk Authentication. It should appear at the very top of
the "auth" and "session" stacks, as "requisite". It does
not support any other stacks.
No options are supported
SEE ALSO
pam.conf(5)
SRSS 4.3 Last change: 1
Sun Ray System Administration utadm(8)
NAME
utadm - Sun Ray network and DHCP configuration utility.
SYNOPSIS
/opt/SUNWut/sbin/utadm -a interface-name
/opt/SUNWut/sbin/utadm -c
/opt/SUNWut/sbin/utadm -d interface-name
/opt/SUNWut/sbin/utadm -f
/opt/SUNWut/sbin/utadm -l
/opt/SUNWut/sbin/utadm -n
/opt/SUNWut/sbin/utadm -p
/opt/SUNWut/sbin/utadm -r
/opt/SUNWut/sbin/utadm -x
/opt/SUNWut/sbin/utadm -A subnetwork
/opt/SUNWut/sbin/utadm -D subnetwork
/opt/SUNWut/sbin/utadm -L on | off
/opt/SUNWut/sbin/utadm -m 6 | 4 | both
DESCRIPTION
The utadm command manages the network and DHCP configuration
for a dedicated Sun Ray interconnect or a shared subnet on a
LAN. It configures the name lookup, host, network, netmask,
and DHCP database files so that Sun Ray DTUs can be con-
nected to a central server host over one or more private
interconnects or shared subnets. One of the following option
flags must be specified: -a, -c, -d, -f, -l, -n, -p, -r,
-x, -A, -D, -L, or -m. The command is run with superuser
privileges.
OPTIONS
The following options are supported.
-a Configure the network interface specified by
interface-name as a dedicated interconnect. In the
default case, an available private address is selected
from the range 192.168.128.0 to 192.168.254.0. If the
subnet selected is 192.168.N.0, entries for the hosts,
networks, and netmasks files are generated using the
hostname of the server and interface-name:
File Entry
SRSS 4.3 Last change: 1
Sun Ray System Administration utadm(8)
/etc/hosts 192.168.N.1 hostname-interface-name
/etc/networks SunRay-interface-name 192.168.N.0 SunRay
/etc/netmasks 192.168.N.0 255.255.255.0
Once the appropriate entries are established, the network
interface is activated as hostname-interface-name using
ifconfig(1M). If the interface is already up and configured,
the user will be given the option to bypass configuration of
the network interface and only configure DHCP on the inter-
face. This allows configuration of a Sun Ray interconnect on
the primary interface of the server. IP addresses on the Sun
Ray subnets are managed using the DHCP protocol, which
requires the addition of several macro entries to the DHCP
table to control parameters on Sun Ray subnets. A pool of IP
addresses for assignment to Sun Ray DTUs is created. It is
possible to disable offering IP addresses by entering 0 as
the first unit address or entering N to the query to offer
IP addresses for the interface when prompted. Once the
interface is configured and activated, utfwadm(1M) is
invoked to add the current version of the firmware to the
DHCP macros for the new network. The user is prompted for
approval of all the default options, and may change them as
desired. The auth server list is the list of IP addresses
of Sun Ray servers. The value input overrides the default
value prompted for. The auth server list can also be pro-
vided in a file as a list of IP addresses separated by
spaces.
The -a option implies the -c option if the initial
configuration has not yet been performed.
-c Initialize the basic configuration files for a Sun Ray
interconnect or shared subnet without setting up any
networks. This involves making sure that the network
database files and framework for DHCP exist, and set-
ting the /etc/nsswitch.conf file so that network
information for the local Sun Ray interconnect or
shared subnets is obtained from local files.
-d Delete the network interface specified by interface-
name from the list of configured Sun Ray private
interconnects. The specified interface must have been
previously configured using the -a option.
-f Take this server offline, preventing the creation of
new sessions on this server when it is within a fail-
over group. Existing sessions are not killed, but load
balancing does not select this server for new ses-
sions. Note: The GroupManager updates the host inter-
face list (if there have been any changes) after every
keep alive interval. So in order for the changes to be
effective, the user has to wait at least the keepalive
time interval.
SRSS 4.3 Last change: 2
Sun Ray System Administration utadm(8)
-l Print the current configuration for all the Sun Ray
dedicated interconnects or shared subnetworks. This
includes remote subnetworks.
-n Bring this server back online. This restores normal
operation of the server and allows new sessions to be
created on this server. Note: The GroupManager updates
the host interface list (if there have been any
changes) after every keep alive interval. So in order
for the changes to be effective, the user has to wait
at least the keepalive time interval.
-p Print the current Sun Ray interconnect configuration,
showing for each interface the hostname, network, net-
mask, and number of IP addresses out of an available
pool of addresses assigned to Sun Ray DTUs by DHCP.
-r Unconfigure all active Sun Ray interfaces and remove
all Sun Ray entries from the configuration databases.
If LAN connection support is on, will prompt the user
if it should be turned off. Default is yes (turn it
off).
-x Print the current configuration in a machine-readable
format
-A Configure the subnetwork specified as a Sun Ray sub-
network. This option only configures the DHCP service
to allocate IP address and/or to provide Sun Ray
parameters to Sun ray clients. It also will automati-
cally turn on support for LAN connections from a
shared subnetwork.
-D Delete the subnetwork specified form the list of con-
figured Sun Ray subnetworks.
-L on| off
Turn support for LAN connections from a shared subnet-
work on or off.
-m 6 | 4 | both
Set IPv6 and/or IPv4 multicast mode for server commun-
ications, and specify acceptable client IP address
types.
EXAMPLES
Example 1: The following example configures the Sun Ray
private network on hme1
# /opt/SUNWut/sbin/utadm -a hme1
SRSS 4.3 Last change: 3
Sun Ray System Administration utadm(8)
FILES
The following files are used:
o /etc/nsswitch.conf
Name service switch configuration file.
o Solaris: /var/dhcp/dhcptab Linux: /etc/dhcp.conf
Solaris files or NIS+ table
o /etc/inet/hosts
o /etc/inet/networks
o /etc/inet/netmasks
o /etc/hostname.*
Linux DHCP service configuration files
o /etc/sysconfig/dhcpd
o /var/lib/dhcp/dhcpd.leases
o /etc/sysconfig/network-scripts/ifcfg -
Interface information for Red Hat AS 3.0
o /etc/sysconfig/network/ifcfg -
Solaris: Hostname for each interface
Linux: Interface information for JDS and SuSE
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
|_____________________________|_____________________________|
| Availability | SUNWuto |
|_____________________________|_____________________________|
SRSS 4.3 Last change: 4
Sun Ray System Administration utadm(8)
SEE ALSO
Solaris:
dhtadm(1M), pntadm(1M), dhcpconfig(1M), dhcp(4),
dhcp_network(4), dhcptab(4), networks(4), netmasks(4)
Solaris and Linux:
ifconfig(1M), syslogd(1M), syslog(3), nsswitch.conf(4),
hosts(4), syslog.conf(4), attributes(5), utfwadm(1M)
Alexander, S., and Droms, R., DHCP Options and BOOTP Vendor
Extensions, RFC 1533, Lachman Technology, Inc., Bucknell
University, October 1993.
Droms, R., Dynamic Host Configuration Protocol, RFC
1541,Bucknell University, October 1993.
SRSS 4.3 Last change: 5
Sun Ray System Administration utadminuser(8)
NAME
utadminuser - Command used to manage authorized user list to
administer the Sun Ray services through the Admin GUI.
SYNOPSIS
/opt/SUNWut/sbin/utadminuser
/opt/SUNWut/sbin/utadminuser -h
/opt/SUNWut/sbin/utadminuser -a username [ username ... ]
/opt/SUNWut/sbin/utadminuser -d username [ username ... ]
/opt/SUNWut/sbin/utadminuser -r
DESCRIPTION
This command is used to add, list and delete authorized
users from the list which is stored in the datastore.
When invoked without any option, it prints the list of
authorized users, one name per line.
The username must be a string consisting of characters from
the set of alphabetic characters, numeric characters, period
(.), underscore (_), and hyphen (-). The first character
should be alphabetic.
When the Administration GUI is configured to use the default
Sun Ray Datastore Authentication mechanism, only the "admin"
user is supported and it is added automatically to the list
of authorized users by utconfig. When the Administration
GUI is configured to use the Unix Login Authentication
mechanism, you can add any valid Unix username to the
authorized user list.
Only super-user can add and delete entries.
OPTIONS
The following options are supported.
-a Adds specified users to the list
-d Deletes specified users from the list
-r Removes all authorized users
-h Prints the usage
EXAMPLES
Example 1: List all current authorized users:
SRSS 4.3 Last change: 1
Sun Ray System Administration utadminuser(8)
# /opt/SUNWut/sbin/utadminuser
Example 2: add a specific user "user1" into the list
# /opt/SUNWut/sbin/utadminuser -a user1
Example 3: removes all authorized users.
# /opt/SUNWut/sbin/utadminuser -r
EXIT STATUS
0 if operation performed successfully 1 if error found
SEE ALSO
useradd(1M), utconfig(1M)
SRSS 4.3 Last change: 2
Sun Ray System Administration utamghadm(8)
NAME
utamghadm - Command used to configure Automated Multi-Group
Hotdesking (AMGH), also known as Regional Hotdesking.
SYNOPSIS
/opt/SUNWut/sbin/utamghadm
/opt/SUNWut/sbin/utamghadm -d
/opt/SUNWut/sbin/utamghadm -l
/opt/SUNWut/sbin/utamghadm -s
/opt/SUNWut/sbin/utamghadm -x
DESCRIPTION
This command is used by administrators to configure or dis-
able the AMGH feature. AMGH can be configured with backend
implementations which are either executable scripts or
shared libraries, depending on the site specific implementa-
tion. This command provides a means to set the appropriate
backend to be used. Setting up the backend implementation
implicitly enables AMGH.
The scripts/libraries used to configure AMGH by this command
must be owned by root only and should not have write permis-
sions for others or group.
Only super-user can change the AMGH configurations using
this command.
OPTIONS
The following options are supported.
-d Disable AMGH configurations
-l Specify the library to be used as the AMGH backend
implementation. This should be the complete path to
the library. 32 bit libraries should be used for 32
bit systems and 64 bit libraries should be used for 64
bit systems. For a mixed 32/64 bit group @ISA could be
used instead of lib/lib64 in the path which would be
resolved automatically to lib/lib64 on 32/64 bit sys-
tems respectively.
-s Specify the script to be used as the AMGH backend
implementation This should be the complete path to the
script.
-h Prints the usage
-x Prints the AMGH parameters in machine readable output
(key/value form).
SRSS 4.3 Last change: 1
Sun Ray System Administration utamghadm(8)
EXAMPLES
Example 1: Display current AMGH configuration
# /opt/SUNWut/sbin/utamghadm
Example 2: Configure AMGH to use the script backend called
utamghref_script which is available in /opt/SUNWutref/amgh
directory.
# /opt/SUNWut/sbin/utamghadm -s
/opt/SUNWutref/amgh/utamghref_script
Example 3: Configure AMGH to use the library backend called
libutamghref_token.so which is available in
/opt/SUNWutref/amgh/lib directory.
# /opt/SUNWut/sbin/utamghadm -l
/opt/SUNWutref/amgh/lib/libutamghref_token.so
Note: It is available in /opt/SUNWutref/amgh/lib64 for 64
bit linux systems. For a mixed 32/64 bit group, "@ISA"
could be used as follows:
# /opt/SUNWut/sbin/utamghadm -l
/opt/SUNWutref/amgh/@ISA/libutamghref_token.so
The library path will resolve to
/opt/SUNWutref/amgh/lib/libutamghref_token.so on a 32 bit
system and /opt/SUNWutref/amgh/lib64/libutamghref_token.so
on a 64 bit system
Example 4: Disable AMGH.
# /opt/SUNWut/sbin/utamghadm -d
EXIT STATUS
0 if operation performed successfully 1 if error found
SEE ALSO
ut_amgh_get_server_list(3), ut_amgh_script_interface(3)
SRSS 4.3 Last change: 2
Sun Ray System Administration utatiscrub(8)
NAME
utatiscrub - Delete stale imported registrations
SYNOPSIS
/opt/SUNWut/sbin/utatiscrub
DESCRIPTION
The Sun Ray Server Software Automatic Token Importation
(ATI) system utilizes a customer-supplied executable in
order to import registrations from site-external data
sources to the Sun Ray Data Store and allow local session
access when a registered-token policy is in effect.
In order to remove such imported registrations when the
customer-supplied executable indicates that the token should
no longer be locally registered, the utatiscrub script must
be run.
This script will iteratively call the customer-supplied exe-
cutable for each registered token which has been imported
due to ATI. If the customer-supplied executable returns
"registered=0" then the local registration for that token
will be deleted.
This utility can only be invoked with root privileges.
NOTES AND BEST PRACTICE
Many customers will want to install this utility into a root
crontab so that it is run regularly in order to ensure that
stale token registrations are removed.
This utility only needs to be run on a single member of a
FOG in order to remove the registration for the group. It
is recommended that it be run on the SRDS primary, although
that is not required.
EXIT STATUS
A 0 exit value indicates that no errors were encountered
during processing.
SEE ALSO
utuser(1m), ut_ati_script_interface(3)
SRSS 4.3 Last change: 1
Sun Ray System Administration utauthd(8)
NAME
utauthd - Sun Ray DTU authentication daemon.
SYNOPSIS
/opt/SUNWut/lib/utauthd -b | -e | -n | -s
DESCRIPTION
The utauthd daemon is responsible for authentication and
access control for the Sun Ray DTUs attached to a server.
This command should not be executed directly. It is invoked
by a system startup script.
OPTIONS
The following options are supported.
-b Begin execution of the daemon.
-e End execution of the daemon.
-n Number of file descriptors to make available
-s Signal to send to utauthd
Without arguments, the default is -b.
FILES
The following files are used by the daemon:
o /etc/init.d/utsvc
This is the system startup script that invokes the daemon.
/opt/SUNWut/utsessiond, the Session Manager, performs the
actual session switching function.
o /etc/opt/SUNWut/auth.props
The Authentication Manager's configuration file.
o /etc/opt/SUNWut/policy/utpolicy
This file determines what policy is used by the Sun Ray
server.
To start the authentication manger, it is customary to run
utstart; however, to kill existing user sessions and restart
services, it is preferable to use utstart -c.
ATTRIBUTES
SRSS 4.3 Last change: 1
Sun Ray System Administration utauthd(8)
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuto |
|_____________________________|_____________________________|
SEE ALSO
auth.props(5), utpolicy(8), utstart(8)
SRSS 4.3 Last change: 2
Sun Ray System Administration utcapture(8)
NAME
utcapture - Capture packet information from the Authentica-
tion Manager.
SYNOPSIS
/opt/SUNWut/sbin/utcapture -h
/opt/SUNWut/sbin/utcapture [ -r ] [ -s server ] [ deskto-
pID1 desktopID2 ... ]
/opt/SUNWut/sbin/utcapture -i filename
DESCRIPTION
The utcapture command connects to the Authentication Manager
and monitors latency, packets sent, and packets dropped
between the Sun Ray server and the Sun Ray DTU's.
utcapture writes the captured information to stdout in the
following format:
TERMINALID TIMESTAMP TOTAL PACKET TOTAL LOSS BYTES SENT PER-
CENT LOSS LATENCY
OPTIONS
The following options are supported.
-h Help for using the command.
-i filename
Use an input file to search for Sun Ray DTU's that
experienced dropped packets. A file is created using
utcapture:
# /opt/SUNWut/sbin/utcapture -r > /tmp/filename
The process is allowed to run for several minutes or
hours. The utcapture command is used again:
# /opt/SUNWut/sbin/utcapture -i /tmp/filename
The output is only the DTU's that experienced dropped
packets.
-r Write captured data to stdout every 15 seconds in raw,
continuous format.
-s server
Specify the Sun Ray server from which to capture data.
If outside of the domain of the host running utcap-
ture, the Sun Ray server hostname must be fully quali-
fied. By default, the server monitored is the host
running utcapture.
SRSS 4.3 Last change: 1
Sun Ray System Administration utcapture(8)
When no option is specified, utcapture writes to stdout at
15 second intervals if there is any change in packet loss or
latency exceeds 10 ms for any Sun Ray DTU.
OPERANDS
The following operands are supported:
desktopID
Capture data for the specified Sun Ray DTU's
only. Appliances are specified by their Ethernet
address (desktopID) separated by spaces. By
default, data for all DTU's is displayed.
EXAMPLES
Example 1: This command captures data from the Authentica-
tion Manager running on localhost every 15 seconds and then
writes it to stdout if there is any change in packet loss
for any Sun Ray DTU.
% utcapture
Example 2: This command captures data from the Authentica-
tion Manager running on localhost every 15 seconds and then
writes it to stdout regardless if there is any change in
packet loss.
% utcapture -r
Example 3: This command captures data from the Authentica-
tion Manager running on netraj118.eng every 15 seconds and
then writes it to stdout if there is any change in packet
loss for DTU's with the Ethernet address of 080020a893cb or
080020b34231.
% utcapture -s netraj118.eng 080020a893cb 080020b34231
EXIT STATUS
The following exit values are returned:
0 Successful completion
1 Error
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
SRSS 4.3 Last change: 2
Sun Ray System Administration utcapture(8)
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuta |
|_____________________________|_____________________________|
SEE ALSO
utauthd(1M), utdesktop(1M)
NOTES
utcapture does not report packet information for Sun Ray
DTU's using firmware versions of 1.1 or less.
utcapture does not report latency for Sun Ray DTU's using
firmware versions of 1.3 or less.
When using -r 0.000 will listed for PERCENT LOSS as 0.000
for every interval that has no loss. When not using -r this
column will be blank. If the output is to be processed by
commands that are column oriented, you must use -r.This
includes using it as input to utcapture -i.
SRSS 4.3 Last change: 3
Sun Ray System Administration utcard(8)
NAME
utcard - Sun Ray server smart card configuration utility
SYNOPSIS
/opt/SUNWut/sbin/utcard -a filename
/opt/SUNWut/sbin/utcard -d name,version
/opt/SUNWut/sbin/utcard -h
/opt/SUNWut/sbin/utcard -l
/opt/SUNWut/sbin/utcard -p name,version
/opt/SUNWut/sbin/utcard -r name,version,new-position
/opt/SUNWut/sbin/utcard -u
DESCRIPTION
The utcard command allows configuration of different types
of smart cards in the Sun Ray administration database.
The administrator must first place a configuration file for
a specific smartcard in the /etc/opt/SUNWut/smartcard direc-
tory. This file must have a .cfg extension. The smartcard
definition in the option. When a smartcard definition is
added, it is automatically assigned the last position in the
probe order.To modify the probe order, use the -r option.
OPTIONS
The following options are supported.
-a filename
Add the card specified within filename that is in the
/etc/opt/SUNWut/smartcard directory
-d Delete the card specified with name, version.
-h Show usage information
-l List all configured cards
-p Show the standard properties for the card specified
with name, version.
-r Reorder the card specified with name, version, to
new-position.
-u List unconfigured cards available for configuration as
determined by the .cfg files in
/etc/opt/SUNWut/smartcard
SRSS 4.3 Last change: 1
Sun Ray System Administration utcard(8)
USAGE
Use this command only on a Sun Ray server that has been con-
figured for administration by the utconfig command.
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuto |
|_____________________________|_____________________________|
SEE ALSO
utconfig(1M)
SRSS 4.3 Last change: 2
Sun Ray System Administration utconfig(8)
NAME
utconfig - Sun Ray server software configuration utility.
SYNOPSIS
/opt/SUNWut/sbin/utconfig [ -u ] [ -k ] [-w ] [ -c ]
/opt/SUNWut/sbin/utconfig [ -a ] [ -d ] [-n ]
DESCRIPTION
The utconfig command performs initial configuration of Sun
Ray server, its supporting administration framework as well
as Windows Connector software. The command prompts the user
for configuration parameters for every major component of
the supporting software packages, then configures it and
moves to the next component. The command must be run with
superuser privileges.
OPTIONS
The following option is supported.
-u Unconfigure the Sun Ray server and administration
software returning the mode of operation back to the
default zero administration mode.
-k Configure or unconfigure (with -u) only the Sun Ray
Kiosk Mode software. Using this option requires that
Sun Ray server and administration software has been
configured already.
-w Configure or unconfigure (with -u) only the Sun Ray
Web Administration software. Using this option
requires that Sun Ray server and administration
software has been configured already.
-c Configure or unconfigure (with -u) only the Sun Ray
Windows Connector software. Using this option requires
that Sun Ray server and administration software has
been configured already.
-a AIC: Use previously-specified responses, utilizing
responses from
/var/opt/SUNWut/utdialog.d/SRCS.utdialog_responses.props.
If no entry exists for a particular key, prompt the
user in the standard fashion. See
utdialog_responses.props(5) for a specification of the
most significant keys affecting utconfig.
-d AIC: Use default responses, utilizing defaults from
/opt/SUNWut/lib/utdialog.d/SRCS.utdialog_defaults.props.
If no entry exists for a particular key, prompt the
user in the standard fashion. See
utdialog_responses.props(5) for a specification of the
SRSS 4.3 Last change: 1
Sun Ray System Administration utconfig(8)
most significant keys affecting utconfig.
-n AIC: If required to prompt the user, exit with bad
status.
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuto |
|_____________________________|_____________________________|
SEE ALSO
Packaging related commands.
utinstall(8), utdialog_responses.props(5), AIC(8)
NOTES
Note that the responses for Web Server configuration are in
/var/opt/SUNWut/utdialog.d/SRSS.utdialog_responses.props
rather than
/var/opt/SUNWut/utdialog.d/SRCS.utdialog_responses.props.
SRSS 4.3 Last change: 2
Sun Ray System Administration utcrypto(8)
NAME
utcrypto - Sun Ray privacy administration utility.
SYNOPSIS
/opt/SUNWut/sbin/utcrypto
/opt/SUNWut/sbin/utcrypto -a key=value ...
/opt/SUNWut/sbin/utcrypto -d
/opt/SUNWut/sbin/utcrypto -e [-f filename]
/opt/SUNWut/sbin/utcrypto -h
/opt/SUNWut/sbin/utcrypto -m key=value ...
/opt/SUNWut/sbin/utcrypto -o [-f filename]
DESCRIPTION
The utcrypto command allows the administrator to configure
privacy options for the Sun Ray server. These settings
include upstream/downstream encryption and
upstream/downstream authentication. These settings will
affect all sessions.
utcrypto operations that only display information may be run
by any user. Operations that change or delete data must be
run as superuser.
OPTIONS
The following options are supported.
-a Add the privacy settings for all sessions. The -a
option must be followed by a series of key=value pairs
separated by spaces. Valid key=value pairs are
described below. If a key=value pair is not passed in,
the value for that key will be set to a default value.
At least one key=value pair must be specified.
-d Delete the privacy settings for all sessions.
-e Take the privacy settings from stdin or a file and
add/modify the settings for all sessions. This will be
a comma-delimited list of key=value pairs. If the -f
option is specified with a filename, the settings will
be read from filename.
To replicate utcrypto settings, run utcrypto -o on the
"source" server, then use the stdout string as an
argument to utcrypto -e on the "target" server or
servers.
SRSS 4.3 Last change: 1
Sun Ray System Administration utcrypto(8)
-f Specifies a filename for the -e or -o option.
-h Displays the usage message.
-m Modify a privacy settings for all sessions. The -m
option must be followed by a series of key=value pairs
separated by spaces. Valid key=value pairs are
described below. If a key=value pair is not passed in,
the value for that key will remain unchanged.
-o Dump all privacy settings in comma-delimited format to
stdout. If followed by the -f option and a filename,
the settings will be dumped to the file. If the file
specified by filename exists, then a warning message
is generated and the script exits.
If an asterisk (*) appears in the Inherited column,
then no value pair was specified, so it has been set
to a hard-coded default value.
To replicate utcrypto settings, run utcrypto -o on the
"source" server, then use the stdout string as an
argument to utcrypto -e on the "target" server or
servers.
The following are valid key=value pairs:
enc_up_type
ARCFOUR | none | default
enc_down_type
ARCFOUR | none | default
auth_up_type
DSA | none | default
auth_down_type
simple | none | default
mode hard | soft | default
auth_mode
hard | soft | default
The keyword default can be used for all keys to unset the
value, so that the default value is used. The hard-coded
default values are DSA for the auth_up_type key, none for
the auth_down_type, enc_up_type and enc_down_type keys and
soft for the mode and auth_mode keys.
EXAMPLES
SRSS 4.3 Last change: 2
Sun Ray System Administration utcrypto(8)
This adds the configuration for upstream ARCfour encryption
and simple downstream authentication.
Note: Since enc_down_type and auth_up_type are not
specified, they take on the default values:
# /opt/SUNWut/sbin/utcrypto -a enc_up_type=ARCFOUR auth_down_type=simple
This command modifies the default configuration. Only
clients that support DSA upstream authentication get access.
/opt/SUNWut/sbin/utcrypto -m auth_up_type=DSA auth_mode=hard
This command modifies the default configuration. Upstream
authentication is turned off and downstream encryption is
set to ARCfour.
/opt/SUNWut/sbin/utcrypto -m auth_up_type=none enc_down_type=ARCFOUR
This command removes the default configuration.
/opt/SUNWut/sbin/utcrypto -d
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuto |
|_____________________________|_____________________________|
SRSS 4.3 Last change: 3
Sun Ray System Administration utdesktop(8)
NAME
utdesktop - Sun Ray DTU administration utility.
SYNOPSIS
/opt/SUNWut/sbin/utdesktop -a
"desktopID,location,otherinfo"
/opt/SUNWut/sbin/utdesktop -a -f filename
/opt/SUNWut/sbin/utdesktop -d desktopID
/opt/SUNWut/sbin/utdesktop -d -f filename
/opt/SUNWut/sbin/utdesktop -e
"desktopID,location,otherinfo"
/opt/SUNWut/sbin/utdesktop -e -f filename
/opt/SUNWut/sbin/utdesktop -h
/opt/SUNWut/sbin/utdesktop -l [ -c | -g | -w [ -t
timeout ] ]
/opt/SUNWut/sbin/utdesktop -L { -c | -w [ -t timeout ]
}
/opt/SUNWut/sbin/utdesktop -l -i substring
/opt/SUNWut/sbin/utdesktop -o
/opt/SUNWut/sbin/utdesktop -p desktopID
DESCRIPTION
The utdesktop command allows the user to manage Sun Ray
DTU's connected to the Sun Ray server the command is run on.
The information that utdesktop displays and allows the user
to add, edit, or delete is stored in the Sun Ray administra-
tion database. Other information is obtained from the Sun
Ray authentication manager.
utdesktop operations that only display information may be
run by any user. Operations that add, edit, or delete data
must be run by the superuser.
OPTIONS
The following options are supported.
-a desktopID,location,otherinfo
Add DTU with the specified desktop-ID, location, and
other information properties. Note that the 3 comma-
delimited values should be enclosed within quotes. You
must be root to use this option.
SRSS 4.3 Last change: 1
Sun Ray System Administration utdesktop(8)
-a -f filename
Batch add multiple DTU's using input from the speci-
fied filename. The format of each line in the input
file is: desktop-ID,location,other-info. You must be
root to use this option.
-d desktopID
Delete the DTU with the specified desktop-ID. You must
be root to use this option.
-d -f filename
Batch delete multiple DTU's using input form the
specified filename. The format of each line in the
input file is: desktop-ID. You may use the output of
the -o option to feed this option as all arguments
after the first comma are ignored. You must be root to
use this option.
-e desktopID,location,otherinfo
Edit properties for the specified DTU by changing the
location and other information properties to the
specified values. Note that the 3 comma-delimited
values should be enclosed within quotes. You must be
root to use this option.
-e -f filename
Batch edit properties for multiple DTU's using input
from the specified filename. The format of each line
in the input file is: desktop-id,location,other-info
You must be root to use this option.
-h Show usage information (this message).
-l List all DTU's currently registered in the admin data-
base.
-l -c List all DTU's that are currently connected to the
server (and note any that have been deleted with ques-
tion marks in the Location field).
-L -c List all DTU's that are currently connected (long for-
mat).
-l -g List all currently connected DTU's and the servers
they are connected to.
-l -w [-t timeout]
List all DTU's waiting for a session during the set
timeout (short format). The default value of the
timeout is 60 seconds.
-L -w [-t timeout]
SRSS 4.3 Last change: 2
Sun Ray System Administration utdesktop(8)
List all DTU's waiting for a session during the set
timeout (long format). The default value of the
timeout is 60 seconds.
-l -i substring
List all DTU's with desktop IDs that contain the
specified substring.
-o Dump DTU list in comma-delimited format. The format of
each line output by this option is: desktop-
id,location,other-info
-p Show desktop properties for the DTU with the specified
ID.
EXAMPLES
Example 1: This command clears the location and the other
information properties for DTU 080020a85112:
# utdesktop -a "080020a85112,,"
Example 2: This command changes the location and the other
information properties for DTU 080020a85112 to "SFO12-2103"
and "John's Office", respectively:
# utdesktop -e "080020a85112,SFO12-2103,John's Office"
Example 3: This command edits the properties of multiple
DTU's using input from the file /tmp/desktops:
# utdesktop -e -f /tmp/desktops
Example 4: This command displays all DTU's that contain
"a851" in their desktop IDs:
% utdesktop -l -i a851
Example 5: This command lists all DTU's in an error state
without sessions within the default timeout:
% utdesktop -l -w
Example 6: For a busy or slow network, this command lists
(in long format) all DTU's in an error state without ses-
sions for at least five minutes:
% utdesktop -L -w -t 300
Example 7: This command displays the current properties for
DTU's 080020a85112:
SRSS 4.3 Last change: 3
Sun Ray System Administration utdesktop(8)
% utdesktop -p 080020a85112
FILES
The following file is used:
/etc/opt/SUNWut/utadmin.conf
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuta |
|_____________________________|_____________________________|
SEE ALSO
utuser(1M), utadmin.conf(4), the Sun Ray Server Software 4.3
Administrator's Guide
NOTES
The -G option has been deprecated. Use the -l -g option pair
instead.
SRSS 4.3 Last change: 4
Sun Ray System Administration utdevadm(8)
NAME
utdevadm - Enable or disable Sun Ray device services.
SYNOPSIS
/opt/SUNWut/sbin/utdevadm
/opt/SUNWut/sbin/utdevadm [ -e | -d ] -s service
/opt/SUNWut/sbin/utdevadm -h
DESCRIPTION
The utdevadm command is used to enable/disable Sun Ray dev-
ice services. This includes USB devices connected through
USB ports, Embedded serial ports and Internal smartcard
readers on the Sun Ray DTU.
After Sun Ray Server Software installation, by default all
the device services will be enabled. utdevadm command can
be used to enable/disable device services only in the con-
figured mode, i.e. it is available only after utconfig(1M)
has been run to activate Sun Ray data store. This is a
site-wide property. When configured, it affects all units
connected to the failover group.
It is required to do a cold restart of Sun Ray services
before the change can take effect. When a successful change
is made, the command reminds the administrator to restart
services using the following command:
/opt/SUNWut/sbin/utstart -c
utdevadm command with no options or arguments shows the
current state of the device services.
OPTIONS
The following options are supported:
-e Enables specific service.
-d Disables specific service.
-s Specify a service.
internal_serial | internal_smartcard_reader | usb | all
When internal_serial service is disabled, users will
not be able to access embedded serial ports on the Sun
Ray DTU. Sun Ray 170 has two embedded serial ports.
When internal_smartcard_reader service is disabled,
users will not be able to access internal smartcard
reader through PC/SC or SCF interface for
reading/writing. It does not affect session access,
SRSS 4.3 Last change: 1
Sun Ray System Administration utdevadm(8)
hotdesking using unauthenticated smartcards.
When usb service is disabled, users will not be able to
access any devices connected to USB ports. It does not
affect HID devices such as keyboard, mouse, barcode
reader.
Specifying all will enable/disable all device services.
-h Print the usage.
EXAMPLES
Example 1: The following command shows the current state of
the device services.
# /opt/SUNWut/sbin/utdevadm
Sun Ray Device Service Status
------------------------------ ------------
internal_serial enabled
internal_smartcard_reader enabled
usb enabled
Example 2: The following command disables usb service.
# /opt/SUNWut/sbin/utdevadm -d -s usb
Example 3: The following command enables usb service.
# /opt/SUNWut/sbin/utdevadm -e -s usb
ENVIRONMENT VARIABLES
None
EXIT STATUS
The following exit values are returned:
0 on success
1 on error
FILES
None
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
SRSS 4.3 Last change: 2
Sun Ray System Administration utdevadm(8)
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuto |
| Interface Stability | Public Evolving |
|_____________________________|_____________________________|
SEE ALSO
utstart(8), utconfig(8)
SRSS 4.3 Last change: 3
Sun Ray System Administration utdevmgrd(8)
NAME
utdevmgrd - Sun Ray device manager daemon.
SYNOPSIS
/opt/SUNWut/lib/utdevmgrd [ -a authlist ] [ -c authfile ]
[ -d ] [ -k authprops ] [ -o optroot ] [ -p port ] [ -r
] [ -s sigfile ] [ -t ]
DESCRIPTION
The utdevmgrd daemon is responsible for brokering devices
that are attached to Sun Ray DTU's on the interconnect
fabric for the purpose of remotely accessing the devices for
various services. It is also responsible for approving ser-
vices, keeping an inventory of devices and their controlling
services, and locating devices on the interconnect.
If either the -a or the -c option is specified, the device
manager daemon operates exclusively in call-back mode. In
this mode, the device manager only communicates to authenti-
cation managers that are explicitly enabled by authlist or
authfile and that have requested a call-back. The call-back
feature provides a mechanism by which the device manager and
the authentication manager establish each other's identity.
The optroot directory (default /tmp/SUNWut) is shared with
other Sun Ray server components. Primarily it provides the
location for a compatible device tree for each Sun Ray DTU's
devices in the sessions and units subdirectories.
The units subdirectory contains a directory for each DTU on
the interconnect named by the DTU's serial number. Within an
DTU's directory, there are the familiar dev and devices
directories that list logical names for devices and geo-
graphically hierarchical names for devices.
The sessions directory contains symbolic links into the dev-
ices directory that indicate which sessions are connected to
which Sun Ray DTU's. The symbolic links are named after the
X-Windows server display corresponding to a user's session
by display number only (in other words, after removing the
server name, which is always a name local to the current
host, and the screen numbers). The user's DISPLAY environ-
ment variable can then be used to find the devices on the
'current' DTU. The user's UTDEVROOT environment variable
achieves this, and can be used to find devices that are
'currently' accessible. The optroot directory also includes
the named pipe with which the device manager communicates to
device driver services and the session_info directory, which
contains user information important to internal workings of
the device manager.
SRSS 4.3 Last change: 1
Sun Ray System Administration utdevmgrd(8)
The device manager works within a Sun Ray server group
environment, which enables rapid switching to other servers
and user load distribution. In order for device managers on
each server in a group to communicate, the device manager
must gain access to the group signature file. If the signa-
ture does not match the one used by other device managers in
the group, then grouping will fail and not all devices on
all DTU's on the interconnect will be available on the
server, including devices on some DTU's being used by users
on the server.
Normally, the device manager finds the group signature file
by looking into the authentication manager's configuration
file (/etc/opt/SUNWut/auth.props), but this can be changed
by using the -s and -k options. If -s is specified, then
sigfile is read and used as the group signature. If -k is
specified, then the authprops file is scanned for the gmSig-
natureFile key and the listed file is used for the group
signature.
Error messages from utdevmgrd are logged using syslog(3),
with a facility value of LOG_DAEMON.
OPTIONS
The following options are supported.
-a authlist
Add the host and port pairs specified in authlist to
the list of allowed authentication managers. The for-
mat of authlist is a comma separated list of
hostname:port pairs.
-c authfile
Add the host and port pairs specified in the ASCII
file authfile to the list of allowed authentication
managers. The file contains a list of authentication
manager specifications, one per line. The specifica-
tions take the form of hostname followed by port
number, separated by white space. Blank lines and any
line whose first printable character is ``#'' are
ignored.
-d Enable debugging output.
-k authprops
Set the location for the authentication manager's con-
figuration file to authprops. This file is used to
find the group signature file in case the sigfile key
was not specified. The default for this parameter is
/etc/opt/SUNWut/auth.props. The key in this file that
specifies the group signature is gmSignatureFile.
SRSS 4.3 Last change: 2
Sun Ray System Administration utdevmgrd(8)
-o optroot
Set the device information root directory to optroot.
This directory contains the service named pipe, and
the units, sessions, and session_info directories.
optroot is generally shared with other Sun Ray server
components.
-p port
Set the device manager's listen port to the specified
port value. The device manager defaults to port 7011.
This is the port by which device services and authen-
tication managers contact the device manager.
-r Automatically restart the device manager daemon if it
exits. With this option, the device manager daemon
creates two processes: a child that performs all the
actual work and a parent monitoring process. The
parent process will restart a child if the previous
one exits. This enables existing services to re-attach
to a new child device manager.
-s sigfile
Set the path of the group signature file to sigfile.
-t Test mode. Relax checking for error returns for files
that are root access. Could cause unpredictable
results on an operational device manager in case of
true failure.
FILES
The following files are used:
/etc/opt/SUNWut/auth.permit
The customary location of the authfile for a system.
/tmp/SUNWut
The customary location for temporary files used by Sun
Ray enterprise server managers, designated by optroot.
/tmp/SUNWut/.utdevmgr
The named pipe used for communication between the dev-
ice manager and device driver services.
/tmp/SUNWut/units
The directory containing device directories for each
DTU. The directory names are after the DTU's serial
numbers. Each directory contains a dev directory and a
devices directory.
/tmp/SUNWut/sessions
The directory containing links to DTU's in the units
directory, named by X-Windows display number for each
SRSS 4.3 Last change: 3
Sun Ray System Administration utdevmgrd(8)
session. These links change as users move from one Sun
Ray DTU to another.
/tmp/SUNWut/session_info
The directory containing information internal to the
device manager for handling session mobility.
/etc/opt/SUNWut/auth.props
The customary location of the authprops file contain-
ing the authentication manager settings. The device
manager looks for the gmSignatureFile key to extract
the location of the group signature file.
/etc/opt/SUNWut/gmSignature
The customary location of the sigfile file containing
the group signature.
ENVIRONMENT VARIABLES
The following environment variables are used:
DISPLAY
Use to get the default X-Windows display number from
within the user's environment.
UTDEVROOT
Use to get the devices for the current session from
within the user's environment.
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuto |
|_____________________________|_____________________________|
SEE ALSO
utauthd(1M), syslog(3), syslogd(1M), syslog.conf(4)
SRSS 4.3 Last change: 4
Sun Ray System Administration utdssync(8)
NAME
utdssync - Converts and synchronizes Sun Ray datastore ser-
vice port.
SYNOPSIS
/opt/SUNWut/sbin/utdssync [ -v ]
DESCRIPTION
The utdssync command converts the Sun Ray datastore service
port on the primary datastore server to the default port
7012. It also synchronizes all the secondary servers to use
the same port number.
utdssync is intended for use after software upgrades to Sun
Ray Server Software 3.0 (SRSS 3) have been completed on all
the servers within the data sharing group.
Note:
The command must be run with superuser privileges on
the primary datastore server.
OPTIONS
The following option is supported.
-v verbose mode
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuta |
|_____________________________|_____________________________|
SEE ALSO
utreplica(1M), utrcmd(1M), utinstall(1M)
SRSS 4.3 Last change: 1
Sun Ray System Administration utfwadm(8)
NAME
utfwadm - Sun Ray DTU firmware version management.
SYNOPSIS
/opt/SUNWut/sbin/utfwadm -A { -a | -e enetAddr } [ -f
firmware ] [ -G { hashed-password | prompt | off | none |
force } ] [ -g { hashed-password | prompt | off | none |
force } ] { -n intf | -N subnetwork | -V } [ -d ] [ -F ] [
-u ] [ -i filename ] ...
/opt/SUNWut/sbin/utfwadm -D { -a | -e enetAddr} { -n
interface | -N subnetwork | -V } ...
/opt/SUNWut/sbin/utfwadm -P [ -V ]
/opt/SUNWut/sbin/utfwadm -R
DESCRIPTION
The utfwadm command manages firmware upgrades to Sun Ray
DTUs. The DTUs are capable of loading firmware upgrades and
programming new firmware into their flash PROM (Programmed
Read-Only Memory).
When a DTU is powered on, the firmware obtains an IP address
and other configuration information using the DHCP protocol.
Part of the configuration information is a firmware version
identifier. If this identifier does not match the DTU's
existing firmware, the DTU initiates an upgrade which
replaces the current firmware with the new version.
The utfwadm command must be run when a new firmware version
is installed to update the firmware version identifier and
force the DTUs to load the new version on their next power
cycle. utfwadm allows firmware identifiers to be set on
either a per-network or per-unit basis enabling firmware
upgrades to be targeted at entire Sun Ray subnetworks or
individual DTUs.
In the SRSS 3.1 release, a new mechanism has been introduced
to manage firmware without using DHCP alone. With increased
deployment of Sun Rays remote from their servers, it became
difficult to supply DHCP parameters from the server to the
Sun Ray. Thus, a different mechanism that uses TFTP to
access a firmware configuration file on the firmware server
was developed. This mechanism involves the creation of
Model.parms or Model..parms files for the firmware
files corresponding to each Sun Ray Model (e.g.,
``CoronaP1'') that utfwadm installs in the /tftpboot direc-
tory. The files containing are unit-specific, where
is the value defined using the -e option.
SRSS 4.3 Last change: 1
Sun Ray System Administration utfwadm(8)
The modifications to utfwadm to support this have been made,
and a few additional options have been defined to support
control of firmware downloads through the creation of these
configuration files. These options allow the forcing of a
firmware downgrade where that would normally be prevented,
the generation of only these files, without updating DHCP,
the use of the frame buffer to hold the downloaded firmware
file, and the inclusion of an additional file that specifies
parameters other than firmware related ones, such as a list
of servers to choose from.
It is possible to determine the firmware versions that are
available and in use by each Sun Ray connected to the
current server. See the utfwload(1M) command.
o In the /tftpboot directory are the firmware files. To
verify the version of a firmware file, type:
/opt/SUNWut/lib/lzd < /tftpboot/firmware-filename | what
o To identify the version of the firmware that a partic-
ular connected Sun Ray DTU is using, type:
/opt/SUNWut/sbin/utdesktop -p desktopID
Where desktopID is the full MAC address. To display the MAC
address, press the three audio keys on the Sun Ray DTU key-
board simultaneously.
Any Sun Ray subnetworks specified must have been previously
set up using the utadm(1M) command. However, such configura-
tion is no longer necessary for firmware maintenance when
.parms files are used. (See the -V option below.) The
utfwadm command must be run under super-user privileges.
OPTIONS
The following options are supported.
-A Add a unit or units to the list of DTUs to be
upgraded. The -A option must be followed by either
the -a or -e suboption.
-D Remove the defined DTUs from the list of units to be
upgraded. This option causes the firmware version
identifier to be unset. The -D option must be fol-
lowed by either the -a or -e suboption.
-a Add or delete all units from the list of DTUs to be
upgraded.
SRSS 4.3 Last change: 2
Sun Ray System Administration utfwadm(8)
-e enetAddr
Apply the operation to only the specified unit with
Ethernet address given by enetAddr, where all six hex
bytes of the address are specified.
-f firmware
This option gives the pathname for the firmware to be
downloaded to the DTUs. If firmware refers to a file,
the hardware version is extracted from the version
string within the file, and the file is copied to the
/tftpboot directory to be downloaded only to that ver-
sion of the hardware. If firmware refers to a direc-
tory, then all files in the directory are copied to
the /tftpboot directory with their version strings
appended. If the -f option is not given, a default
location is used.
The 4.0 release of Sun Ray firmware introduced two
varieties of firmware: one that supported limited
local configuration of the Sun Ray, and one that did
not. The default was to install the so-called "non-
GUI" firmware, while the "GUI" firmware (supporting
the local configuration) was installed using "-f
/opt/SUNWut/lib/firmware_gui".
In the 4.3 release, these two versions are collapsed
back into a single version, and a different mechanism
for enabling the GUI capability is provided. See the
-G and -g options explained below.
-N subnetwork
Apply the given operation to units attached on the
specified subnetwork. Multiple subnetworks may be
given. It can also specify the special keyword all to
apply the operation to all configured Sun Ray subnet-
works.
-N all
Apply the given operation to all subnetworks.
-n intf
Apply the given operation to units connected to the
Ethernet interface intf. Multiple interfaces may be
given, or the special keyword all, which applies the
operation to all configured Sun Ray interfaces.
-V With -A, generate the .parms files, but do not update
DHCP. Note that this option should not be used if
DHCP is still being used to provide firmware parame-
ters to DTUs with old firmware. With -P, include a
listing of the versions specified in the .parms files.
SRSS 4.3 Last change: 3
Sun Ray System Administration utfwadm(8)
-F Force the Sun Rays to download this firmware, even
though the barrier for this firmware is less than the
barrier defined in the current firmware. This is
accomplished by adding a BarrierLevel=barrier value to
the .parms file. This is equivalent to setting the
BarrierLevel DHCP vendor option.
-u Turn on firmware load through the frame buffer. This
is primarily for debugging purposes, to show the pro-
gression of the firmware loading process.
-i parmfile
Include the values contained in parmfile at the end of
the .parms file for each firmware model. This file
contains a set of key/value pairs that replace most of
the parameters that would have previously been config-
ured using DHCP. These values are not saved across
successive invocations of this command, so to retain
them, the -i option must be specified each time. The
list of key/value pairs is described below.
-G,-g control
These options are used to control the contents of the
enablegui and disablegui entries in the .parms files.
These entries are used to control the circumstances
under which the local configuration GUI on a Sun Ray
may be enabled or disabled. In the case of the
hashed-password and prompt values of the control
option, enabling or disabling the GUI feature must be
accompanied by the entry of a password on the Sun Ray.
Except for the prompt option, which reads the value of
a password on the standard input of the program, and
substitutes a hashed version of that password, the
value of the control option is assigned to the
corresponding .parms file keyword. The uthashpwd(1M)
program must be used to create the hashed version of
the password from the clear text version, and is
invoked by utfwadm when prompt is specified. See the
description below of how these .parms file entries are
interpreted. Only one of -G or -g can have force as
the value of control. When force is given for one of
the options, it fixes the value of the other as off.
In addition to setting the values of the .parms file
entries, there are two control files included in the
firmware directory that may be installed in the
/tftpboot directory. These files are named
SunRay.enableGUI and SunRay.disableGUI, and are
required by the firmware to be present and readable
when the GUI is either enabled or disabled, respec-
tively. They can be thought of as keys that must be
used to turn a lock. If the value of the -G or -g
SRSS 4.3 Last change: 4
Sun Ray System Administration utfwadm(8)
option is not off, the corresponding file is copied
over as part of the firmware installation.
-d Explicitly disable firmware download by creating
.parms files with version=_NONE_, used with -A. This
is different from -D which removes the .parms files
completely. This is most useful with -e to prevent a
particular Sun Ray from being upgraded. It also makes
sense to use this to disable firmware upgrade com-
pletely, but provide a server list using the -i
option.
-n all
Apply the given operation to all interfaces.
-P This variant of the command prints out the version to
which each domain should be upgraded on the next power
cycle. A domain may be either an interconnect subnet
or individual DTU. If it is a subnet, then the Intf
column lists the interface device. If it is an indivi-
dual DTU, then its Ethernet address is given in the
Domain column, and the Intf column contains the inter-
face name. If -V is specified, the versions from the
.parms files are printed.
-R Remove the firmware files that were copied into the
boot directory.
The -z option is RESERVED for use by the Sun Ray server
software and should not be used.
The key/value pairs included in the parmfile supplied with
the -i option are of the form "=", with case
sensitivity and no spaces allowed. Options which take values
of 0 or 1 have a default value of 0 if not specified. The
values of the parameters below can be examined by viewing
the contents of the various /tftpboot/*.parms files. The
following options are allowed:
servers=
specifies a comma-separated mixture hostnames and/or
IP addresses. This is a generalization and replacement
for the AltAuth list.
select=
allows either inorder or random, and selects a server
from the server list either starting at the beginning,
or at random, respectively.
MTU= sets the network MTU. The value used is the minimum of
those supplied from various sources.
SRSS 4.3 Last change: 5
Sun Ray System Administration utfwadm(8)
LogXXX=
sets the logging level for various classes of logging
events, where XXX is one of Appl, Vid, USB, Net, or
Kern. These correspond to the equivalent DHCP vendor
options.
LogHost=
is a dotted-decimal IP address used as the logging
host, equivalent to the corresponding DHCP vendor
option.
bandwidth=
sets the bandwidth limit used by the Sun Ray, in bits
per second.
compress={ 0 | 1 }
when set to 1, forces compression on.
lossless={ 0 | 1 }
when set to 1, does not permit lossy compression to be
used.
stopqon={ 0 | 1 }
when set to 1, enables the STOP-Q key sequence to be
used to disconnect a Sun Ray from a server, in partic-
ular, 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 to load firmware.
fulldup={ 0 | 1 }
when set to 1, forces the network port connection to
be full duplex. This is to aid in situations where
switch ports are not set to autonegotiation mode.
kbcountry=code
forces the keyboard country code number for a non-U.S.
keyboard that reports a country code value of 0. This
value can also be set using the Advanced menu of the
Sun Ray configuration GUI. Some possible values for
the country code, from USB keyboard maps, are:
6 Danish
7 Finnish
8 French
9 German
14 Italian
15 Roman/Kana
16 Korean
18 Dutch
19 Norwegian
22 Portugese
SRSS 4.3 Last change: 6
Sun Ray System Administration utfwadm(8)
25 Spanish
26 Swedish
27 Swiss French
28 Swiss German
30 Taiwanese
32 UK English
33 U.S. English
For a current list of configured keyboards on Solaris,
consult the keytable.map file, which can be found in
the /usr/openwin subtree.
fastload={ 0 | 1 }
when set to 1, forces the use of a larger blocksize
for TFTP transfers, if supported by the TFTP server.
videoindisable={ 0 | 1 }
when set to 1, turns off the input source on the front
of a Sun Ray 270, and locks the monitor into display-
ing only the Sun Ray output.
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.
stopkeys={ key1-key2[-keyn}* | none }
where keyn is chosen from the set of modifier keys
ctrl, shift, alt, and meta. This option specifies an
alternative combination of modifier keys that behaves
the same as the STOP key on the Sun keyboard. If set
to none, the alternative key combination is disabled.
The default value if this keyword is not present, is
the set of all four modifier keys. (The "Meta" key has
different names on different keyboards: on a PC key-
board, it is the "Windows" key, and on a Mac keyboard,
it is the "Program" key.)
cmdcachesize=size
gives the size, in Kbytes, of the command cache look-
back buffer. This area is used to store a list of
recent commands. When the server finds a command or
series of commands in this buffer, it sends a command
that tells the Sun Ray to replay these commands from
the buffer, rather than sending the commands verbatim.
The default value is 512 Kbytes. It can also be set
from the Advanced submenu of the Sun Ray GUI.
enablegui= { hashed-password | off | none | force }
SRSS 4.3 Last change: 7
Sun Ray System Administration utfwadm(8)
disablegui= { hashed-password | off | none | force }
where these two keywords control the enabling or disa-
bling of the Sun Ray's local configuration GUI. If the
value is a hashed-password produced as the output of
the uthashpwd(1M) command, then the corresponding
password must be entered on the Sun Ray's keyboard
before the GUI can be enabled or disabled. If the
value is none, then no password is required, if off
then the enable or disable is disallowed, and if
force, then the Sun Ray will attempt to turn the GUI
on or off. If both values are set to force, the GUI
will remain in its current state. Be very careful when
setting disablegui to force (-g force), as this could
disable the GUI on a Sun Ray that requires the use of
a local configuration for correct operation.
In all cases, any attempt to transition from one state
to another succeeds only if the corresponding control
file (SunRay.enableGUI or SunRay.disableGUI) can be
read from the current firmware server, and its signa-
ture verified. If there is no password set, the utload
command may be used to force the loading of the enable
or disable file, which will enable or disable the GUI,
as long as the value of utloadoff is not 1.
The prompt to enable the GUI, and for the password if
required, will be done when there is an attempt to
bring up the GUI menu (STOP-M or STOP-S) and the GUI
is disabled. For disabling, there is a menu selection
in the STOP-C menu to disable the GUI.
FILES
The following files are used:
o /etc/dhcpd.conf
File or NIS+ table
o /tftpboot
Default location of firmware boot file
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
SRSS 4.3 Last change: 8
Sun Ray System Administration utfwadm(8)
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuto |
|_____________________________|_____________________________|
SEE ALSO
dhcpd.conf(5), dhcpd(8), dhcpd.leases(5), dhcp-options,
what(P), utadm(8), utdesktop(8), utquery(8), uthashpwd(1M)
SRSS 4.3 Last change: 9
Sun Ray System Administration utfwload(8)
NAME
utfwload - Provide a compact summary of sessions and
firmware maintenance.
SYNOPSIS
/opt/SUNWut/sbin/utfwload [ -a ] [ -l ] [ -L ] [ -H ]
DESCRIPTION
Without an argument, the utfwload command provides the
display number of the current session for each connected
Sun Ray in use, as well as the logged-in user, IP address,
Model, MAC address, and firmware revision level. Options
allow forcing the download of firmware to Sun Rays that
are not running the current version supplied by the Sun
Ray server.
Note:
utfwload upgrades Sun Rays that have been loaded with
firmware from the SRSS 2.0 114880-04 patch or later or
from SRSS 3.0 only. This command cannot force an
upgrade of earlier firmware.
OPTIONS
The following options are supported.
-a In combination with other options, this option con-
trols the selection of Sun Rays or sessions to
display. Without-a , only sessions that have logged in
users are displayed. With -a, all sessions or Sun Rays
are displayed, and those with no logged in user have a
user id field of "????".
-l,-L With utfwload, force Sun Rays that are not running
the version of firmware installed on the current
server to upgrade. The command compares the "System
Version" as provided by running utfwadm -P with the
value that would be displayed with no option or with
utfwload -a. If the version is different, a download
is forced. The -l form of the command forces loading
only on Sun Rays that are connected to sessions
with no user logged in, while the -L form forces a
download on all Sun Rays that are out of date. This
option is available only to users with root
privileges.
-H Output column headings above the regular output.
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
SRSS 4.3 Last change: 1
Sun Ray System Administration utfwload(8)
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuto |
|_____________________________|_____________________________|
SEE ALSO
utwho(1M), attributes(5)
SRSS 4.3 Last change: 2
Sun Ray System Administration utfwsync(8)
NAME
utfwsync - Synchronizes Sun Ray DTU firmware downloads.
SYNOPSIS
/opt/SUNWut/sbin/utfwsync [ -d ] [ -v ]
DESCRIPTION
The utfwsync command refreshes the firmware level on the Sun
Ray DTUs (DTUs) with the default firmware version for the
current Sun Ray Server Softrware release and patch level. It
then forces all the Sun Ray DTUs connected to that Sun Ray
server to restart. If the Sun Ray server is part of a fail-
over group, then all Sun Ray DTUs within the failover group
are forced to restart. The result is that each DTU tries to
download the latest firmware offered by the primary Sun Ray
server as it restarts, as described in the utfwadm(1M)man
page.
This command is intended for use after software upgrades or
after new firmware has been installed on all hosts as part
of a patch.
As the command executes, access to user sessions is inter-
rupted, but the sessions are not lost and are returned after
the command completes.
The command must be run with superuser privileges.
OPTIONS
The following option is supported.
-d Disables system reconfiguration and forces all con-
nected DTUs to load the currently configured version
of the firmware. The currently configured version of
the firmware may or may not be the default version for
the current release and patch level.
-v Verbose mode. Additional messages regarding what is
being done are written to stdout.
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuta |
|_____________________________|_____________________________|
SEE ALSO
SRSS 4.3 Last change: 1
Sun Ray System Administration utfwsync(8)
utgstatus(1M), utauthd(1M), utfwadm(1M), utinstall(1M)
SRSS 4.3 Last change: 2
Sun Ray System Administration utgmtarget(8)
NAME
utgmtarget - manage a group-wide list of explicit destina-
tions for Sun Ray group membership announcements
SYNOPSIS
/opt/SUNWut/sbin/utgmtarget
/opt/SUNWut/sbin/utgmtarget -a host ...
/opt/SUNWut/sbin/utgmtarget -c
/opt/SUNWut/sbin/utgmtarget -d host ...
DESCRIPTION
The utgmtarget command is used to designate a collection of
Sun Ray servers as explicit targets of Sun Ray group member-
ship announcements.
Sun Ray group membership announcements are usually sent as
multicast or broadcast announcements, according to the value
of the enableMulticast property in the auth.props(5) file.
On networks that disallow multicasts or broadcasts, or that
do not provide dependable multicast or broadcast service, it
is possible that these announcements will not reach the
other servers in the intended Sun Ray host group. On such
networks the host group will not form or will sporadically
become partitioned. utgmtarget allows group membership
announcements to be sent as unicast traffic to specific
hosts, allowing the group to form and remain stable despite
problematic multicast or broadcast propagation.
Unicast announcements, when configured, are sent in addition
to multicast or broadcast announcements. If your network
provides reasonable multicast or broadcast service then uni-
cast announcements are unnecessary.
utgmtarget maintains a group-wide list of unicast targets.
The list is held in the Sun Ray group-wide data store. All
servers that have been configured (by utreplica(8)) to share
the data store will see, and will send unicast announcements
to, the identical list of target servers. A per-server list
of unicast targets may be defined in each server's
auth.props(5) file. If both a group-wide and per-server
target list are defined then the server will send unicast
announcements to both lists.
Note:
After the target list has been modified, a restart of
Sun Ray services must be performed to put the new con-
figuration into operation.
SRSS 4.3 Last change: 1
Sun Ray System Administration utgmtarget(8)
When invoked with no options utgmtarget shows the current
group-wide unicast target list.
OPTIONS
The following options are supported.
-a host ...
Adds the specified hosts to the group-wide list of
unicast group announcement targets.
-c Clears (deletes all hosts from) the group-wide list of
unicast group announcement targets.
-d host ...
Deletes the specified hosts from the group-wide list
of unicast group announcement targets.
EXAMPLES
Example 1: This command adds servers "fred" and "wilma" to
the group-wide list of unicast group announcement targets:
# utgmtarget -a fred wilma
After the next Sun Ray service restart servers fred and
wilma will be sent individual unicast copies of each group
announcement that this Sun Ray server sends to the multicast
or broadcast address.
Example 2: This command removes all group-wide unicast group
announcement targets:
# utgmtarget -c
After the next Sun Ray service restart no unicast group
announcements will be transmitted by this Sun Ray server
(unless a per-host target list exists on this server). It
will continue to send multicast or broadcast announcements.
EXIT STATUS
The utgmtarget command reports 0 on success, non-zero on
failure.
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuta |
|_____________________________|_____________________________|
SRSS 4.3 Last change: 2
Sun Ray System Administration utgmtarget(8)
SEE ALSO
utstart(8), utconfig(8), utreplica(8), utgstatus(8),
auth.props(5)
NOTES
utgmtarget is available only after utconfig(8) has been run
to activate the Sun Ray data store.
The number of unicast targets that may be present in the
group-wide target list at any one time may be limited by the
implementation. This implementation guarantees that at
least 100 targets will be supported at one time. It is pos-
sible that more than 100 targets may be configured in some
circumstances but a site should not depend on being able to
exceed 100 in future SRSS releases.
SRSS 4.3 Last change: 3
Sun Ray System Administration utgroupsig(8)
NAME
utgroupsig - Sets the group signature for Sun Ray servers in
a failover group.
SYNOPSIS
/opt/SUNWut/sbin/utgroupsig [-a [-n]]
DESCRIPTION
The utgroupsig command sets the failover group signature.
When run interactively, the utgroupsig command prompts for
the new signature twice. The group signature file must be at
least 8 bytes long and has similar content diversity charac-
teristics as required by passwd(1).
When run non-interactively without options, utgroupsig
accepts a signature from standard input.
If any AIC options are specified, when utgroupsig is run
non-interactively, behavior is as described in AIC(8).
The signature is stored in clear in the location specified
in the auth.props file with the gmSignatureFile property.
The group signature file is created with owner root and mode
600 (read-write by root).
Upon successful input, utgroupsig stores the signature in
the /var/opt/SUNWut/utdialog.d/SRCS.utdialog_responses.props
file using the key "utgroupsig.Signature".
OPTIONS
-a AIC: Use previously-specified responses, utilizing
responses from
/var/opt/SUNWut/utdialog.d/SRCS.utdialog_responses.props.
If no entry exists for a particular key, prompt the
user in the standard fashion. See
utdialog_responses.props(5) for a specification of the
most significant keys affecting utgroupsig.
-n AIC: If required to prompt the user, exit with bad
status.
FILES
The following files are used:
o /etc/opt/SUNWut/gmSignature
Sun Ray group signature default file.
o /etc/opt/SUNWut/auth.props
SRSS 4.3 Last change: 1
Sun Ray System Administration utgroupsig(8)
Sun Ray authentication properties file.
EXIT STATUS
The following exit values are returned:
0 Success
1 Invalid input to command.
2 Unexpected failure. Signature file unchanged.
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuta |
|_____________________________|_____________________________|
SEE ALSO
AIC(8), utdialog_responses.props(5), AIC(8), utrcmd(8),
passwd(8), auth.props(5)
SRSS 4.3 Last change: 2
Sun Ray System Administration utgstatus(8)
NAME
utgstatus - Display failover group status.
SYNOPSIS
/opt/SUNWut/sbin/utgstatus [ -s server ] [ -v ]
DESCRIPTION
The utgstatus command allows the user to view the failover
group status information for the local server or for the
named server. The information that the command displays is
specific to that server at the time the command is run.
utgstatus displays information only and so can be run by any
user.
OPTIONS
The following options are supported.
-s server
Display all the failover group status information for
the specified server.
-v Display all the failover group status information
vertically. This is especially useful when displaying
IPv6 addresses.
EXAMPLES
Example 1: This command displays the failover group status
for the local Sun Ray server
% /opt/SUNWut/sbin/utgstatus
Example 2: This command displays the failover group status
for the server sunray3:
% /opt/SUNWut/sbin/utgstatus -s sunray3
Information returned from this command looks like the fol-
lowing for a typical LAN-based configuration:
Or like this for a typical interconnect-based configuration:
host flags interface flags
192.24.0.0/24
-------------- -------------------
sunray3 TN 192.24.0.136 UAM
sunray1 T- 192.24.0.93 UA-
sunray2 TN 192.24.0.95 UAM
sunray-sras TN 192.24.0.96 U--
For proper viewing, make sure the window is wide enough.
SRSS 4.3 Last change: 1
Sun Ray System Administration utgstatus(8)
Explanation of utgstatus information:
The Network/Netmask values are denoted in CIDR (Classless
Inter Domain Routing) network address notation, where the
initial value (192.24.0.0) is the network address itself and
the '/24' suffix signifies the number of bits that are the
network identifier of the address. The remaining 8 bits are
for specific host addresses.
Host Status Flags
T Trusted - The trusted hosts are members of this
failover group because they share the same group
signature. As of the SRSS 4.0 release, the pro-
cessing of failover group messages has been
changed. Messages from hosts that are not
trusted are discarded and ignored, as these
present a possible Denial-of-Service attack.
Thus, only host entries for trusted hosts will
be printed by this command.
N oNline - The server is configured to participate
in load balancing (see the utadm man page for a
description of the -n option).
Interface Status Flags
U Up - The interface is currently reachable by
this host.
A Available - The interface is available for Sun
Rays to connect to it and get service.
M Managing - The interface is configured to manage
Sun Rays on its local subnet (in other words,
utadm -a was run to configure the interface for
Sun Ray service).
In the first example above, all hosts are part of the same
failover group. All hosts but sunray1 are "online", which
means they will participate in creating in normal session
creation. sunray1 is "offline", which means it will not par-
ticipate in session creation during load balancing for this
failover group, although sessions can still be created on
it, either explicitly through the use of utswitch or
utselect -R, or implicitly if all other servers are down.
The LAN interfaces for all of the hosts are Up, and all but
sunray-sras are Available to Sun Rays (sunray-sras did not
have utadm -a run to configure its interface for Sun Ray
SRSS 4.3 Last change: 2
Sun Ray System Administration utgstatus(8)
service, and it does not have allowLANConnections=true set
in auth.props. It is a dedicated SRAS server for the fail-
over group). Both sunray2 and sunray3 are Managing Sun Rays,
because utadm -a was run for their LAN interfaces. They will
offer DHCP parameters and possibly addresses during the Sun
Ray bootup phase for Sun Rays on their local subnets.
In the second example above, all of the hosts are Trusted
and Online, meaning that they will all participate in fail-
over and load balancing for their Available interfaces.
193.25.0.0/24 is the LAN network, and the other networks are
Sun Ray interconnects. All of the LAN interfaces are Up,
meaning that they are reachable, but none are Available for
Sun Ray service, and none are Managing Sun Rays on the local
subnet. All of the interconnect interfaces are Up and Avail-
able, and all are Managing Sun Rays.
SEE ALSO
utadm, auth.props, utswtich, utselect
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuta |
|_____________________________|_____________________________|
SRSS 4.3 Last change: 3
Sun Ray System Administration uthashpwd(8)
NAME
uthashpwd - create a hashed version of a password
SYNOPSIS
/opt/SUNWut/sbin/uthashpwd
DESCRIPTION
This program reads a password string on standard input,
applies a one-way hash function and writes the result on
standard output, as a printable string.
This hashed password is used in order to authenticate the
enabling or disabling of the GUI configuration capability of
a Sun Ray. As such, the same hash function is implemented in
the firmware when a password is entered, and the result is
compared with the hashed version that was transferred to the
Sun Ray from the server.
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuto |
|_____________________________|_____________________________|
SEE ALSO
utfwadm(1M)
SRSS 4.3 Last change: 1
Standards, Environments, and Macros uthotdesk(8)
NAME
uthotdesk - PAM service name for Sun Ray Remote Hotdesk
Authentication
SYNOPSIS
uthotdesk
DESCRIPTION
The uthotdesk PAM service can be used to configure the
authentication, account management, and password stacks to
be used when reconnecting to a logged-in Sun Ray session
(aka hotdesking) via the Remote Hotdesk Authentication
interface.
No options are supported
SEE ALSO
pam.conf(5)
SRSS 4.3 Last change: 1
Sun Ray System Administration utinstall(8)
NAME
utinstall - Sun Ray Software installation, upgrade, and
removal utility.
SYNOPSIS
/cdrom/cdrom0/utinstall [ -a admin-file ] [ -d media-dir ]
[ -u ] [ -j jre ]
/cdrom/cdrom0/utinstall [ -A ] [ -c ] [ -n ] [ -D
dialog_dir ]
/opt/SUNWut/sbin/utinstall [ -a admin-file ] [ -d media-dir
] [ -u ] [ -j jre ]
DESCRIPTION
The utinstall command installs, upgrades, and removes Sun
Ray Software including Sun Ray Server Software and Sun Ray
Windows Connector. All software required to support the Sun
Ray server is installed.
The utinstall command is run under superuser privileges and
prompts the user before taking any action. The use of
defaults is recommended.
OPTIONS
The following options are supported.
-d media-dir
Instead of the default, use media-dir as the installa-
tion media root directory.
-j jre
Instead of the default, use the particular jre speci-
fied in the argument.
-u Remove previously installed Sun Ray Software.
-A AIC: Use previously-specified responses, utilizing
responses from
/var/opt/SUNWut/utdialog.d/SRSS.utdialog_responses.props.
If no entry exists for a particular key, prompt the
user in the standard fashion. See
utdialog_responses.props(5) for a specification of the
most significant keys affecting utinstall.
-c AIC: Use default responses, utilizing defaults from
/opt/SUNWut/lib/utdialog.d/SRSS.utdialog_defaults.props.
If no entry exists for a particular key, prompt the
user in the standard fashion. See
utdialog_responses.props(5) for a specification of the
most significant keys affecting utinstall.
SRSS 4.3 Last change: 1
Sun Ray System Administration utinstall(8)
-n AIC: If required to prompt the user, exit with bad
status.
-D dialog_dir
AIC: Read AIC utdialog_responses.props files from
dialog_dir, and copy them into the standard location
after product installation.
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuti |
|_____________________________|_____________________________|
SEE ALSO
utdialog_responses.props(5), AIC(8)
SRSS 4.3 Last change: 2
Sun Ray System Administration utkeyadm(8)
NAME
utkeyadm - Utility to manage Sun Ray device keys.
SYNOPSIS
/opt/SUNWut/sbin/utkeyadm -a -c [-k ]
/opt/SUNWut/sbin/utkeyadm -a -U
/opt/SUNWut/sbin/utkeyadm -d [-c ]
-k
/opt/SUNWut/sbin/utkeyadm -d -c [-CUI]
/opt/SUNWut/sbin/utkeyadm -l [-c ] [-k ] [-
HCUI]
/opt/SUNWut/sbin/utkeyadm -L [-c ] [-k ] [-
HCUI]
/opt/SUNWut/sbin/utkeyadm -i [-f ]
/opt/SUNWut/sbin/utkeyadm -o [-f ] [-c ] [-k
] [-CUI]
/opt/SUNWut/sbin/utkeyadm -i [-f ] -b -c
/opt/SUNWut/sbin/utkeyadm -o [-f ] -b -c -k
/opt/SUNWut/sbin/utkeyadm -h
DESCRIPTION
utkeyadm is a utility to administer device keys for Sun
Rays. Every Sun Ray device or other client has a unique
private DSA key, which the server uses to authenticate the
device when it connects.
When a Sun Ray device connects to a server (or replication
group of servers) for the first time, its key is registered
in the Sun Ray Data Store. On subsequent connections, the
client authentication key is compared to the key stored for
the client to confirm authenticity.
Note that client authentication can be disabled using
utcrypto(8).
Every stored client key is assigned a trust status. When a
key is initially registered, it is assigned a status of
"unconfirmed". When the authenticity of a given key for a
given Sun Ray device is established by other means, an
administrator can use utkeyadm to assign a "confirmed"
status. Some possible ways to ascertain authenticity of a
SRSS 4.3 Last change: 1
Sun Ray System Administration utkeyadm(8)
key are:
- Compare the key fingerprint with the key fingerprint
shown by the client, for example on the Stop-K display
of a Sun Ray device.
- Ensure that the client device is currently connected
through a tamper-proof network (for example direct
link) with a fully authenticated connection.
Sun Ray server access policy can be set to restrict access
to clients whose keys have been confirmed as authentic (see
utpolicy(8). If a client submits a key that is different
from the key already registered for that client, the outcome
depends on the status of the stored key. If that key is
"confirmed", the client submitting a different key is
rejected. If the stored key is "unconfirmed", the new key is
also added to the Data Store, but the client will be locked
out until one of the conflict keys is confirmed as the
authentic one.
OPTIONS
The following options are supported.
-a Confirm authenticity of a key for a specific DTU or of
all non-conflicting unconfirmed keys for their DTUs.
For confirming a single key, the desktop ID (terminalCID) of
the client to which the key belongs must be specified. For
best control over the authenticity of the key being con-
firmed, the key ID (fingerprint) should be specified expli-
citly as well. If multiple keys are associated to a DTU, the
key ID must be specified. Any conflicting keys for the same
DTU are deleted from the data store when a specific key is
confirmed. If an already confirmed key is confirmed again,
the confirmation timestamp and user-id for this key are
updated.
If it is certain that all keys that currently exist in
"unconfirmed" state are authentic, the -U option may be
specified to confirm them all at once. If multiple keys
matching the criteria are found for a DTU, none of them is
confirmed.
-d Delete keys for a specific DTU. Either a specific key
ID or the desktop id must be specified for this option.
The deletion may be further restricted to keys with
given status.
-l List all or selected key-to-client registrations. The
list may be restricted to a specific key, a specific
client desktop and/or keys with given status.
SRSS 4.3 Last change: 2
Sun Ray System Administration utkeyadm(8)
-L List all or selected key-to-client registrations in
long format. Long format displays the same information
that is displayed with the -l option and adds informa-
tion about the origin of a key and its status: the time
when the key was first registered for the desktop, the
time when the key was last confirmed and the user who
last confirmed authenticity of the key for the associ-
ated desktop. The list may be restricted to a specific
key, a specific client desktop and/or keys with given
status.
-i Import keys from a file previously created with the -o
option. If no filename is specified, the function
reads from standard input. If the -b option is given,
a single key is read from a binary key file. In that
case the desktop ID of the client to which the key
belongs must be provided and the key will be imported
as "unconfirmed".
-o Export all or selected keys to a file. If no filename
is specified, data is written to standard output. The
export may be restricted to a specific key, a specific
client desktop and/or keys with given status. If the
-b option is given, a single key is written to a binary
key file. Otherwise the selected keys, the client to
which they belong and the status of the association are
written to a text file, that can be used as backup or
to import the keys and their associations into a dif-
ferent server.
-h Display a help message.
-C Apply the operation only to keys with status "con-
firmed". This option may be combined with the -U and
-I options. If none of these options is specified,
status is not considered for selection of keys.
-H Display column headers on the key listing.
-I Apply the operation only to keys with an invalid
status, other than "confirmed" or "unconfirmed". This
option may be combined with the -C and -U options. If
none of these options is specified, status is not con-
sidered for selection of keys.
-U Apply the operation only to keys with status "uncon-
firmed". This option may be combined with the -C and
-I options. If none of these options is specified,
status is not considered for selection of keys.
-b Import or export a single key to/from a binary key
file. The binary key file format stores only the key
SRSS 4.3 Last change: 3
Sun Ray System Administration utkeyadm(8)
data, not the desktop to which the key belongs or the
status of the association.
-c cid
The terminalCID or desktop ID of the desktop to which
the keys belong.
-k key-id
The fingerprint of the key to operate on. The finger-
print consists of 16 bytes, represented as 32 hexade-
cimal digits. The bytes may be delimited by colons
(':').
-f filename
The file to use for import or export of keys.
EXIT STATUS
0 if operation performed successfully, 1 if error found
SEE ALSO
utcrypto(8), utpolicy(8)
SRSS 4.3 Last change: 4
Sun Ray System Administration utkiosk(8)
NAME
utkiosk - manage configuration for Sun Ray Kiosk Mode
SYNOPSIS
/opt/SUNWut/sbin/utkiosk -i name [-f file] [-A applist-
file]
/opt/SUNWut/sbin/utkiosk -e name [-s|-a]
/opt/SUNWut/sbin/utkiosk -d name
/opt/SUNWut/sbin/utkiosk -l
/opt/SUNWut/sbin/utkiosk -h
DESCRIPTION
The utkiosk tool is used to manage Kiosk Mode configuration
stored in the Sun Ray administration database. utkiosk
allows storing, retrieving and deleting kiosk configuration
data.
The data stored by utkiosk is instantly applied to newly
started Sun Ray Kiosk Mode sessions. To enable Kiosk Mode
for Sun Ray sessions, use the -k option to the utpolicy
tool.
Kiosk configuration consists of a session configuration
file, that references an installed kiosk session descriptor,
as well as an optional application list. The session confi-
guration file must be in the session.conf(5) format, as pro-
cessed by the kioskconfig(8) tool. The KIOSK_SESSION_APPLIST
setting cannot be used here. Instead an application list for
application container sessions can be specified as a file
using the -A option. The application list will be embedded
in the stored settings rather than maintained as a file
reference.
In addition to the common session.conf settings, you can use
the KIOSK_SESSION_TIMEOUT_DETACHED setting to specify a
timeout (in seconds) after which a disconnected kiosk ses-
sion will be terminated.
OPTIONS
The following options are supported.
-a Export only the application list contained in the con-
figuration entry. The -a option cannot be used
together with -s.
-A applist-file
Import an application list from applist-file.
SRSS 4.3 Last change: 1
Sun Ray System Administration utkiosk(8)
-d name
Delete the kiosk configuration entry named name from
the datastore. Kiosk Mode is disabled, if the session
entry is deleted.
-e name
Export the kiosk configuration entry named name from
the datastore. By default a complete session confi-
guration is exported. A configured application list is
embedded in the exported session configuration as
KIOSK_SESSION_APPLIST entry. The -s and -a options can
be used to separately export the session configuration
and application list.
-f file
Specify the file from which session configuration is
read. If this option is not provided, session confi-
guration is read from standard input.
-h Print a usage message and exit.
-i name
Import session configuration into the kiosk configura-
tion entry named name in the datastore. Configuration
consists of session configuration, which is read from
a file or from standard input and an optional applica-
tion list.
If the session configuration file contains a non-empty
KIOSK_SESSION value, but does not contain a
KIOSK_ENABLED value, KIOSK_ENABLED=yes is implied for
the resulting configuration.
-l List the names of all available kiosk configuration
entries.
-s Export the session configuration without policy or
embedded application list. The output does not contain
a KIOSK_ENABLED or KIOSK_SESSION_APPLIST setting. The
-s option cannot be used together with -a.
OPERANDS
name The name of the kiosk configuration entry in the data-
store. The following entries are currently defined for
Sun Ray Kiosk Mode:
session
The session entry holds default kiosk configura-
tion data for Sun Ray Kiosk Mode.
kiosk
This entry was used in prior versions for confi-
guring Controlled Access Mode 3.x and older. You
SRSS 4.3 Last change: 2
Sun Ray System Administration utkiosk(8)
can still access this configuration data by
using the kiosk name. The -a, -s and -A options
cannot be used with kiosk.
Other entries can be used to store additional session
configurations, which can be used with kiosk session
overrides (see utkioskoverride(8)). Entry names must
start with a letter and consist entirely of ASCII
letters and digits. Entry names consisting entirely of
lowercase letters are reserved for use by Sun Ray
Kiosk Mode.
EXAMPLES
Example 1: This command imports session configuration into
the datastore.
# utkiosk -i session -f mysession.conf
Example 2: This command imports configuration for an appli-
cation container session and an associated application list
into the datastore.
# utkiosk -i session -f mydesktop.conf -A myapplist
Example 3: This command stores session configuration to use
the Kiosk session defined in the mysession.conf session
descriptor under the name SpecialSession. The resulting con-
figuration can be selected using the utkioskoverride(8)
tool.
# echo "KIOSK_SESSION=mysession" | utkiosk -i SpecialSession
Example 4: This command exports the complete configuration
from the datastore into a file.
# utkiosk -e session > mysession.conf
Example 5: These commands exchange the application list to
be used with the current application container session.
# utkiosk -e session -s > /tmp/mysession.conf
# utkiosk -i session -f /tmp/mysession.conf -A newapplist
Example 6: This command exports the legacy configuration
into a local file.
# utkiosk -e kiosk > kiosk.conf
Example 7: This command deletes legacy configuration data
from the datastore.
SRSS 4.3 Last change: 3
Sun Ray System Administration utkiosk(8)
# utkiosk -d kiosk
EXIT STATUS
The following exit values are returned:
0 Success
1 Failure
ATTRIBUTES
See attributes(8) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuta |
| Interface Stability | Uncommitted |
|_____________________________|_____________________________|
SEE ALSO
kioskconfig(8), session.conf(5), kiosk(8), utkioskover-
ride(8)
SRSS 4.3 Last change: 4
Sun Ray System Administration utkioskoverride(8)
NAME
utkioskoverride - Set or query the session type assigned to
tokens.
SYNOPSIS
/opt/SUNWut/sbin/utkioskoverride
/opt/SUNWut/sbin/utkioskoverride [ -r raw ] [ -t token ]
/opt/SUNWut/sbin/utkioskoverride -s session [ -c config ]
{-r raw|-t token}
DESCRIPTION
The utkioskoverride command provides a way to set the ses-
sion type associated with a token or to query the session
type currently associated with a token. Possible session
types are "default" (where the system wide policy dictates
the session type), "kiosk" (where a kiosk session is
assigned to that token regardless of the system policy) and
"regular" (where a regular, i.e non kiosk, session is
assigned to the token regardless of the system policy). For
a "kiosk" session, a named session configuration as created
using utkiosk(8) can be assigned to be used for the speci-
fied token.
OPTIONS
Without any options, the command will print out a usage mes-
sage. Otherwise, the following options are supported:
-s session {-r raw|-t token}
Set the session type for a token to the specified ses-
sion, which must be either "default", "kiosk" or "reg-
ular". Either a raw insert token (with the -r option)
or a session token (with the -t option) must be speci-
fied as the target of the assignment. The command will
assign the session type directly to the session token
or to the logical token associated with the registered
raw insert token. At this time, only logical tokens
are supported as valid arguments for the -t option.
Future releases may allow assigning a session type to
other session token types. If the specified token
fails to meet the requirements (i.e is neither a logi-
cal token for the -t option nor a registered token for
the -r option), the command will return an error code.
-c config
Assign the session configuration name config (see
utkiosk(8)) to be used for the given token. This
option is only valid with the -s kiosk option.
-r raw -t token
Query and display the currently assigned session type
SRSS 4.3 Last change: 1
Sun Ray System Administration utkioskoverride(8)
and session configuration for the specified token. At
least one of a raw insert token (with the -r option)
or a session token (with the -t option) must be pro-
vided, and the command will attempt to find the ses-
sion type with the following logic: if a session token
is specified and has an associated session type, it
will be displayed, else if a raw insert token is
specified and is registered as a logical token, that
token's associated session type will be displayed.
The command displays the value of the session type and
configuration in the following format:
SESSION_TYPE= SESSION_CONFIG=
where can be either "default", "kiosk"
or "regular". If the tokens provided don't have any
explicit session type assigned, "default" will be
printed out. If no session configuration has been
assigned, the SESSION_CONFIG line is omitted. Other-
wise, is the specified configuration
name.
You can use the utuser(8) command to view session type
assignments for multiple logical tokens.
EXAMPLES
Example 1: This command sets the session type for the
registered smart card "MicroPayFlex.12345678" to "regular":
# /opt/SUNWut/sbin/utkioskoverride -s regular -r MicroPayFlex.12345678
Example 2: This command sets the session type for the logi-
cal token "user.123456-78" to a "kiosk" session using the
"Special" session configuration:
# /opt/SUNWut/sbin/utkioskoverride -s kiosk -c Special -t user.123456-78
Example 3: This command queries the session type for the
smart card "MicroPayFlex.98765432":
# /opt/SUNWut/sbin/utkioskoverride -r MicroPayFlex.98765432
SESSION_TYPE=default
Example 4: This command queries the session type for the
logical token user.123456-78:
# /opt/SUNWut/sbin/utkioskoverride -t user.123456-78
SESSION_TYPE=default
SESSION_CONFIG=Special
SRSS 4.3 Last change: 2
Sun Ray System Administration utkioskoverride(8)
EXIT STATUS
The following exit values are returned:
0 Success
1 If no token is specified or the session type or config
name is invalid
2 If the token is not a suitable token when using the -s
option
3 If the executable is not run as root when using the -s
option
4 Generic error
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuta |
|_____________________________|_____________________________|
SEE ALSO
utpolicy(8), utuser(8), utkiosk(8), attributes(5)
SRSS 4.3 Last change: 3
Sun Ray System Administration utlicenseadm(8)
NAME
utlicenseadm - Utility to manage Sun Ray device licenses.
SYNOPSIS
/opt/SUNWut/sbin/utlicenseadm -l [-t ] [-k
] [ ]
/opt/SUNWut/sbin/utlicenseadm -d [-t ] [-k
]
DESCRIPTION
utlicenseadm is a utility to administer device licenses for
Sun Rays. Currently, it can be used to list and delete MS-
TSCAL licenses stored by the Sun Ray Windows Connector in
SRDS.
OPTIONS
The following options are supported.
-l List the licenses. If no desktopid is specified then
all matching licenses are listed for all DTUs.
-d Delete licenses for a specific DTU. The desktop id must
be specified for this option. A specific license for a
DTU may be deleted by providing appropiate license type
and/or license key.
-t licenseType
Specify the license type to be administered. The
current supported license type is only "RDPLicense".
-k licenseKey
A key for the license if applicable.
desktopid
Desktop id to administer the device license for.
EXIT STATUS
0 if operation performed successfully, 1 if error found
SEE ALSO
uttsc(1)
SRSS 4.3 Last change: 1
Sun Ray System Administration utmhadm(8)
NAME
utmhadm - Sun Ray DTU multihead group configuration utility.
SYNOPSIS
/opt/SUNWut/sbin/utmhadm [ groupname ]
/opt/SUNWut/sbin/utmhadm -a groupname -g COLSxROWS -p
primaryCID -l CID1,CID2,...,CIDn
/opt/SUNWut/sbin/utmhadm -d groupname
/opt/SUNWut/sbin/utmhadm -e [ -f filename ]
/opt/SUNWut/sbin/utmhadm -o [ -f filename ]
/opt/SUNWut/sbin/utmhadm -h
/opt/SUNWut/sbin/utmhadm
DESCRIPTION
The utmhadm command provides a way to administer Sun Ray
server multihead groups. The information that utmhadm
displays and that is editable is stored in the Sun Ray
administration database.
The utmhadm operations that only display information may be
run by any user. Operations that change data must be run as
superuser.
OPTIONS
The following options are supported.
-a groupname
Creates a new multihead group having identifier group-
name. This name must be unique and not already exist
on the system.
-d groupname
Removes the multihead group for the specified group-
name.
-e Populates the system multihead group database with
input data of the format produced by -o, from standard
input.
-f filename
Specify a filename for use with -e or -o instead of
standard input or output.
-g COLSxROWS
Specifies the geometry of the multihead group in the
form COLSxROWS. This number of columns and rows must
SRSS 4.3 Last change: 1
Sun Ray System Administration utmhadm(8)
not exceed the maximum number allowed and must match
the number of DTUs specified with -l. This option can
only be used with -a.
-h Prints the usage message.
-l CID1, CID2,..., CIDn
Specifies the DTU canonical identifiers when creating
a group. A canonical identifier has the form
IEEE802.nnnnnnnnnnnn or nnnnnnnnnnnn (the 12-digit
hexadecimal MAC address of the DTU) and the list must
be comma-separated. The identifiers must be specified
in row-major order. The maximum number of DTUs allowed
is 16.
-o Dumps all system configured multihead group data, in
comma-separated format, to standard output. Intended
for subsequent use with -e.
-p primaryCID
Identifies which in the list of canonical identifiers,
specified with -l, is designated as the primary DTU
within the group. The primary is repeated in the list
specified by -l. This option can only be used with -a.
When no options are provided, utmhadm lists information
about all multihead groups configured on the system.
EXAMPLES
Example 1: This command list all DTUs that are in the multi-
head group:
% /opt/SUNWut/sbin/utmhadm tera
Here is sample output:
Multihead Group Geometry CIDs
------------------ ------------------ --------------------------------
tera geometry=2x1 IEEE802.080020b538dc (P)
IEEE802.080020b56e2d
Example 2: This command creates a terminal group having two
terminals with the first one being the primary:
# /opt/SUNWut/sbin/utmhadm -a srgroupA -g 2x1 -p
IEEE802.080020b0562f -l IEEE802.080020b0562f,IEEE802.080020b64574
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
SRSS 4.3 Last change: 2
Sun Ray System Administration utmhadm(8)
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuta |
|_____________________________|_____________________________|
SEE ALSO
utxconfig(1), Sun Ray Server Software Administrator's Guide
SRSS 4.3 Last change: 3
Sun Ray System Administration utmhconfig(8)
NAME
utmhconfig - Sun Ray mulithead GUI configuration utility.
SYNOPSIS
/opt/SUNWut/sbin/utmhconfig
DESCRIPTION
The utmhconfig utility allows the administrator to list,
add, or delete multihead groups easily. The initial screen
lists any existing multiheaded groups and allows the
administrator to select those to delete. The utility can
also be used to create a new group. To do this, the adminis-
trator starts the utility on the Sun Ray DTU that is to
become the "primary" of the group (it has the keyboard,
mouse, and all the devices for the group). The administrator
selects "Create New Group" and follows the instructions in
the wizard to identify all of the terminals in the new mul-
tihead group. The administrator run the utmhconfig command
as superuser and must have a recognized smart card avail-
able.
OPTIONS
There are no options for utmhconfig
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuta |
|_____________________________|_____________________________|
SEE ALSO
utmhadm(1M), utxconfig(1)
SRSS 4.3 Last change: 1
Sun Ray System Administration utmhscreen(8)
NAME
utmhscreen - Sun Ray multihead GUI screen display tool.
SYNOPSIS
/opt/SUNWut/lib/utmhscreen [ -l ]
DESCRIPTION
The utmhscreen tool provides a window showing the respective
displays location in the multihead group. The display show-
ing the widow is highlighted in white, while the other
displays are darkened. The window is located in the upper
right corner of the display.
This tool is automatically launched for users during the X
server startup process (session creation). If the X server
is not running in a multihead environment, the tool immedi-
ately exits.
OPTIONS
utmhscreen accepts the following option:
-l Indicates to utmhscreen that it is being auto
launched by the windowing system. The use of
this option is beyond the scope of this manual.
RESOURCES
The tool understands all of the core X Toolkit and Motif
resource names and classes as well as:
enableAutoLaunch (class EnableAutoLaunch)
Specifies whether or not utmhscreen should be
launched automatically during X session startup.
The default is "true".
EXAMPLES
Example 1: To disable automatic launching of utmhscreen for
a user, set the following X resource in their
$HOME/.Xdefaults file:
Utmhscreen*enableAutoLaunch: false
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
SRSS 4.3 Last change: 1
Sun Ray System Administration utmhscreen(8)
____________________________________________________________
| Attribute Types | Attribute Values |
| Availability | SUNWuta |
| Interface Stability | Evolving |
|_____________________________|_____________________________|
SEE ALSO
utmhadm(1M). utmhconfig(1M), utxconfig(1)
SRSS 4.3 Last change: 2
Sun Ray Administration Commands utmountd(8)
NAME
utmountd - Sun Ray Mass Storage media mounter daemon
SYNOPSIS
/opt/SUNWut/lib/utmountd -m [-D debug-level] [-p
poll_interval] [-t max_threads]
DESCRIPTION
utmountd performs mount and umount operations on Sun Ray
mass storage devices managed by utstoraged(8). Slices or
partitions with OS recognizable filesystems are mounted on a
directory inside the current sessions mount directory,
$DTDEVROOT/mnt.
Error messages from utmountd are logged to
/var/opt/SUNWut/log/utmountd.log.
OPTIONS
The following options are supported.
-D debug-level
Debug mode. Use is beyond the scope of this docu-
ment. If a debug level is set, debug messages are
sent to stderr.
-p poll_interval
Minimum time in seconds between polling removable
media devices for media insertion events
-t max_threads
Maximum number of simultaneous service threads
allowed. The more active threads, higher the load
on the system. A lower number of threads mean
slower response times to mounting or unmounting
devices if the daemon is overloaded with work.
FILES
The following files are used:
$DTDEVROOT/mnt
A link pointing to the directory containing
mount points
ENVIRONMENT VARIABLES
DTDEVROOT points to a temporary directory associated with
the user's session. The directory's lifetime is equal to the
lifetime of the login session. It is removed, along with its
contents, when the user logs out.
SRSS 4.3 Last change: 1
Sun Ray Administration Commands utmountd(8)
SEE ALSO
utdiskadm(8), utstoraged(8), utdisk(4)
SRSS 4.3 Last change: 2
Sun Ray System Administration utparalleld(8)
NAME
utparalleld - Sun Ray printer service daemon.
SYNOPSIS
/opt/SUNWut/lib/utparalleld [ -D debug-level ] [ -o
optroot ] [ -r ]
DESCRIPTION
utparalleld provides printer support for Sun Ray DTUs.
utparalleld supplies driver services for all USB parallel
adaptors and USB printers that comply with the USB printer
class.
utparalleld uses the Sun Ray parallel I/O driver on solaris
and Sun Ray utio driver on linux to provide applications the
same interface as standard workstation parallel ports, such
as /dev/ecpp or /dev/bpp on solaris and /dev/parport on
linux. Applications such as the lp(1) daemon can use device
nodes that are provided by utparalleld.
When a parallel adaptor or a USB printer is attached to a
DTU, utparalleld creates device nodes in the
$UTDEVROOT/devices directory. A user can use the device link
$UTDEVROOT/dev/printers/printer-name to access a specific
printer.
OPTIONS
The following options are supported.
-D debug-level
Debug mode. Use is beyond the scope of this document.
-o optroot
Use optroot as the parallel service's root directory
for device node creation. The default value is
/tmp/SUNWut. optroot should be the same directory as
the optroot directory used by utdevmgrd(1M).
-r Automatically restart the printer service daemon if it
exits. With this option, the printer service daemon
creates two processes: a child that performs all the
actual work, and a parent monitoring process. The
parent process restarts a child if the previous one
exits.
FILES
The following files are used:
$UTDEVROOT/dev/printers
The directory containing links to parallel device
names for each DTU..
SRSS 4.3 Last change: 1
Sun Ray System Administration utparalleld(8)
ENVIRONMENT VARIABLES
UTDEVROOT points to a symbolic link of the device root for
the Sun Ray DTU associated with a user's session.
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuto |
|_____________________________|_____________________________|
SEE ALSO
utdevmgrd(1M), utseriald(1M)
SRSS 4.3 Last change: 2
Sun Ray System Administration utpolicy(8)
NAME
utpolicy - Sun Ray authentication manager policy management
command.
SYNOPSIS
/opt/SUNWut/sbin/utpolicy -a [ -g ] [ -h ] [-c] [ -D ] [ -p
] [ -r type ] [ -s type ] [ -z type ] [ -u type ] [ -k type
]
/opt/SUNWut/sbin/utpolicy [ -A ] [ -Z ] [ -n ]
/opt/SUNWut/sbin/utpolicy
DESCRIPTION
The utpolicy command simplifies and writes the policy confi-
guration of the Sun Ray authentication manager, utauthd(1M).
OPTIONS
The following options are supported.
POLICY SETTING
The specified Policy Setting arguments completely replace
the current active authentication policy. Only arguments
that are specified become active. Policy Setting and Card
Reader Assignment arguments can be specified together
-a This option, followed by valid Policy Setting, or Card
Reader Assignment arguments, applies these arguments
to the active authentication policy for the system.
This option is not valid by itself.
-c Require client authentication keys to be confirmed as
genuine. Clients that authenticate with an unconfirmed
key are denied access. Keys authenticity can be con-
firmed using utkeyadm(8). For full effectiveness of
this option, mandatory upstream authentication should
be configured (see utcrypto(8)).
-D Enable legacy hotdesking behavior. In this mode, user
sessions are accessed directly rather than requiring
external authentication first. Note that this is less
secure than the default behavior, and is not recom-
mended for security reasons.
-g Turn on session selection within a server group.
Allows the user to select on which server the user's
session is run.
-k {card|pseudo|both}
Enables Kiosk Mode for the specified session type.
Selecting card enables Kiosk Mode for card sessions,
SRSS 4.3 Last change: 1
Sun Ray System Administration utpolicy(8)
selecting pseudo for terminal sessions; and selecting
both enables Kiosk Mode for all types of sessions. For
functionality, at least one of the -r, -s, or -z
options must be invoked with the same argument as the
-k option. The -k option is not considered until the
utconfig application has configured for Kiosk Mode.
Note: Kiosk Mode policy enabled using the -k option
may be overriden using utkioskoverride(8).
-m Enable multihead session capability, allowing multiple
terminals to act as display devices for a single user
session.
-p This option changes the behavior of the self-
registration application so that it does not require a
name and password before registering a token. Note
that the self-registration application only verifies
the name and password. They are not stored.
-r {card|pseudo|both}
Specify the token types that must be registered in the
administrative database in order to be granted access
to a login screen. Policy looks up and uses token
database entry
-s {card|pseudo|both}
Specify the token types that will be presented with a
registration screen if they do not have an entry in
the administrative database. Policy allows self-
registration of tokens.
-u {card|pseudo|both}
Specify the token types that are accepted from a
client that is not a regular hardware terminal, for
example from a software client. Any access policies
for these token types still apply. Without this
option, or for token types not specified in this
option, software clients are not granted access. Note
that allowing a smart card token for hotdesking with
this option can pose a security risk since a non
hardware terminal may be compromised and coerced to
respond to smart card transactions from the server
with emulated smart card responses that are in fact
being generated by the compromised client code. This
has the possibility of granting a session to such a
spoofed token type.
-z {card|pseudo|both}
Specify the token types that do not require an entry
in the administrative database in order to be granted
access to a login screen. Policy grants access to
SRSS 4.3 Last change: 2
Sun Ray System Administration utpolicy(8)
tokens without database entry.
-A AIC: Use previously-specified responses, utilizing
responses from
/var/opt/SUNWut/utdialog.d/SRCS.utdialog_responses.props.
If no entry exists for a particular key, prompt the
user in the standard fashion. See
utdialog_responses.props(5) for a specification of the
most significant keys affecting utpolicy.
-Z AIC: Use default responses, utilizing defaults from
/opt/SUNWut/lib/utdialog.d/SRCS.utdialog_defaults.props.
If no entry exists for a particular key, prompt the
user in the standard fashion. See
utdialog_responses.props(5) for a specification of the
most significant keys affecting utpolicy.
-n AIC: If required to prompt the user, exit with bad
status.
With the -h option, the utpolicy command prints out the
usage message.
With no options, the utpolicy command prints out the policy
in effect.
The following options are RESERVED for use by the Sun Ray
Server Software and should not be used:
-G, -P, -Q, -b, -f, -l, -x, +x
EXAMPLES
Example 1: This command configures the policy so that all
access via smart card on a hardware client requires a valid
administrative database entry before access is granted. If a
database entry has not been created for a smart card, then a
registration session is presented on the DTU. If no smart
card is used, then the normal login screen is presented.
# /opt/SUNWut/sbin/utpolicy -a -r card -s card -z pseudo
Example 2: This command configures the policy so that all
access via smart card on both hardware clients and non-
hardware clients require a valid administrative database
entry before access is granted. If a database entry has not
been created for a smart card, then a registration session
is presented on the DTU. If no smart card is used, then the
normal login screen is presented.
# /opt/SUNWut/sbin/utpolicy -a -r card -s card -z pseudo -u card
SRSS 4.3 Last change: 3
Sun Ray System Administration utpolicy(8)
FILES
The following files are used:
o /etc/opt/SUNWut/policy/utpolicy
The policy configuration file
o /etc/opt/SUNWut/auth.props
Sun Ray authentication manager's configuration file
SEE ALSO
utauthd(8), utreader(8), utstart(8), utkioskoverride(8),
auth.props(5), pam(3PAM), utdialog_responses.props(5),
AIC(8)
SRSS 4.3 Last change: 4
Sun Ray System Administration utpreserve(8)
NAME
utpreserve - Sun Ray configuration file preservation util-
ity.
SYNOPSIS
/cdrom/cdrom0/utpreserve [ -d preserve-directory ]
DESCRIPTION
The utpreserve command stops Sun Ray services, terminates
user sessions, and saves existing Sun Ray server configura-
tion data into a compressed tar file,
/var/tmp/SUNWut.upgrade/preserve_4.3.tar.gz.
OPTIONS
The following option is supported.
-d preserve-directory
Save the compressed tar file into the preserve-
directory.
SEE ALSO
utinstall(1M), utconfig(1M)
SRSS 4.3 Last change: 1
Sun Ray System Administration utpw(8)
NAME
utpw - Sun Ray administration password change utility.
SYNOPSIS
/opt/SUNWut/sbin/utpw
/opt/SUNWut/sbin/utpw [-a [-n]] -p
DESCRIPTION
The utpw command changes the Sun Ray administrator password
(also known as the "UT admin" password). This password is
entered by the administrator when logging into the Adminis-
tration Tool and is used to make a privileged connection to
the LDAP server.
utpw changes the password both in the administration data-
base, and the password file on the local server.
In a failover group, utpw also affects the administration
database of the secondary servers, but only the password
file on the local server. The administrator must log into
the secondary servers and run utpw on them to change the
password files.
Upon successful input, utpw stores the password in the
/var/opt/SUNWut/utdialog.d/SRCS.utdialog_responses.props
file using the key "utconfig.Password".
OPTIONS
The following options are supported.
-p Print the current password in clear text. This option
should be used with care to avoid exposing the pass-
word to unauthorized persons.
-a AIC: Use previously-specified responses, utilizing
responses from
/var/opt/SUNWut/utdialog.d/SRCS.utdialog_responses.props.
If no entry exists for a particular key, prompt the
user in the standard fashion. See
utdialog_responses.props(5) for a specification of the
most significant keys affecting utpw.
-n AIC: If required to prompt the user, exit with bad
status.
EXAMPLES
Example 1: This command changes the administration password:
# /opt/SUNWut/sbin/utpw
Enter new UT admin password:
Re-enter new UT admin password:
SRSS 4.3 Last change: 1
Sun Ray System Administration utpw(8)
Enter old UT admin password:
Changing LDAP password...
Done.
Changing password file...
Done.
FILES
The following files are used:
o /etc/opt/SUNWut/utadmin.pw
o /etc/opt/SUNWut/utadmin.conf
EXIT STATUS
The following exit values are returned:
0 Success
1 Error
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuta |
|_____________________________|_____________________________|
SEE ALSO
AIC(8), utdesktop(8), utuser(8),
utdialog_responses.props(5), AIC(8), Sun Ray Server Software
Administrator's Guide
SRSS 4.3 Last change: 2
Sun Ray System Administration utquery(8)
NAME
utquery - query Sun Ray Desktop Units current parameter
values
SYNOPSIS
/opt/SUNWut/sbin/utquery [-d] IP_address
/opt/SUNWut/sbin/utquery -h
DESCRIPTION
The utquery command allows administrators to query the
current parameter values on a Sun Ray Desktop Unit (DTU).
The IP_address may specify the network IP address of a sin-
gle DTU to query, a subnet broadcast address to query all
DTUs on the subnet or the broadcast address to query all
DTUs associated with this Sun Ray server.
The utquery command can be used to aid in diagnosing prob-
lems when a DTU is unable to successfully connect to an
authentication manager or when a Multihead group is
redirected outside their "home" failover group.
OPTIONS
The following options are supported.
-d Report the DHCP parameters the DTU obtained at boot-
up.
-h Print the usage.
EXAMPLES
Example 1: To display the DHCP values for the DTU at IP
address 129.146.58.182
% utquery -d 10.6.130.190
The following is an example of the output for the command
above:
terminalID=00144f0e8a60
terminalIPA=10.6.130.190
model=SunRayP8
Subnet=255.255.255.0
Router=10.6.130.1
MTU=1500
Broadcst=10.6.130.255
LeaseTim=86400
DHCPServer=10.6.130.3
AuthSrvr=10.6.102.113
FwSrvr=10.6.102.113
tftpSrvr=nomad-70.sfbay.sun.com
parmsVersion=GUIkent_vpn32_2007.07.02.16.21
SRSS 4.3 Last change: 1
Sun Ray System Administration utquery(8)
parmsBarrier=320
parmsBarrierLevel=320
parmsServers=nomad-70,nomad-65
configMTU=1500
currentAuth=10.6.129.70
currentFW=GUIkent_vpn32_2007.07.02.16.21
currentBarrier=320
currentBarrierLevel=320
currentMTU=1500
dnsList=129.147.5.51,129.145.155.32,129.145.155.42
dname=SFBay.Sun.COM
confNetType=DHCP
confTftpSrvr=nomad-70.sfbay.sun.com
confServers=nomad-70
In the output above, there can be a number of values with
Barrier in the name, and understanding the differences is
subtle. In general, the Barrier value is the value associ-
ated with a firmware file, and its corresponding version.
So, currentBarrier is the barrier value for the current
firmware running on the DTU, and parmsBarrier is the barrier
level of the file residing on the firmware server. In the
absence of any BarrierLevel values, the firmware file on the
server will not be loaded if its Barrier value is less than
the currently running firmware. For example, in the output
above, the currentBarrier is 310, so any attempt to load
SRSS 2.0 firmware, which has a barrier level of 200, would
fail. In order to permit the forced loading of firmware with
a lower barrier level, the BarrierLevel values are used. The
BarrierLevel is either the currentBarrier value of the
resident firmware, the BarrierLevel value provided from
DHCP, or the parmsBarrierLevel obtained from the .parms
file. Later values in this list take precedence if present.
It is the currentBarrierLevel that is compared with the bar-
rier level of the server's file to determine if the download
is permitted or not.
New firmware released with SRSS 4.0 contains optional capa-
bility to store limited local configuration in flash on
DTUs. Due to security considerations for some deployments,
two versions of firmware are available, one with this capa-
bility, and one without. Firmware with a version string
beginning with "GUI" incorporates this functionality. The
local values override values obtained from DHCP, except for
the MTU, which is computed as the minimum of the values
received. The following values will be included if defined
in the local configuration:
confNetType
The network configuration type, which can be one of
DHCP or Static.
SRSS 4.3 Last change: 2
Sun Ray System Administration utquery(8)
confIPA
The locally configured IP address, enabled in Static
mode.
confSubnet
The locally configured subnet mask, enabled in Static
mode.
confRouter
The locally configured default router, enabled in
Static mode.
confBroadcst
The locally configured broadcast address, enabled in
Static mode.
confMTU
The locally configured Maximum Transmission Unit,
always used.
confServers
The locally configured Sun Ray server list, which is a
comma-separated list of host names or IP addresses.
confTftpSrvr
The locally configured TFTP server value, used to read
.parms and firmware files.
confLogHost
The locally configured Log host, for logging syslog
events.
confDname
The locally configured DNS domain name.
confDnsList
The locally configured list of DNS server IP
addresses.
conf.bandwidth
The locally configured bandwidth limit.
Additional values may be configured locally, including a
subset of those that can be set in a .parms file. If these
are defined, they will be printed.
Since the MTU value can come from several sources, there are
possibly several MTU values printed:
MTU The minimum MTU value obtained from all DHCP sources.
configMTU
SRSS 4.3 Last change: 3
Sun Ray System Administration utquery(8)
The MTU value computed as the minimum of DHCP and
local configuration.
confMTU
The locally configured MTU value.
currentMTU
The actual value being used currently by the DTU. This
value may be dynamically determined if the value
specified in configMTU causes fragmentation. The
currentMTU value will be lowered to avoid fragmenta-
tion when it has been detected.
The TFTP server used to access .parms files can be specified
in a number of different ways: as a DHCP vendor option
(FWSrvr), a locally configured value, DHCP option 66, or the
default host name "sunray-config-servers". The FWservType
value specifies which of these is actually used. The server
value can be either a name or an IP address. If a name is
specified, the look up is done with the configured domain
name appended, with components stripped successively until
the lookup succceeds or there are only two components left
in the domain name. If none of those lookup succeeds, the
name is looked up by itself. If the name itself ends with a
``.'', the name is taken to be a rooted name, and the domain
name is not appended.
Example 2: To display the DHCP values for all DTUs on subnet
129.146.58:.
utquery -d 129.146.58.255
Example 3: To display the DHCP values for all DTUs on this
server:
utquery -d 255.255.255.255
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuta |
|_____________________________|_____________________________|
SEE ALSO
utfwadm(8)
NOTES
SRSS 4.3 Last change: 4
Sun Ray System Administration utquery(8)
The utquery command will only report on DTUs that are
operating with firmware version 2.0 or newer.
The utquery command will only report on DTUs that have suc-
cessfully acquired DHCP parameters from a DHCP server.
The NewTVer value reported is the firmware revision level
supplied by DHCP, which is used to determine whether a
firmware upgrade is required, but if there is no version
value from the .parms file. The currentFW value is the
firmware revision level of the current firmware running in
the Sun Ray device.
The AuthSrvr and AltAuth values reported are those provided
by DHCP parameters at DTU boot time. The currentAuth value
is the IP address of the Sun Ray server to which the Sun Ray
is currently connected.
In firmware version 3.1 and newer, additional values
obtained via TFTP from the .parms file are also printed. If
parmsVersion is defined, it overrides NewTVer. If parmsVer-
sion is not defined in the .parms file, then it assumes the
value of NewTVer, if that is defined. See the utfwadm manual
page for descriptions of fields that may be contained in the
.parms file.
The utquery command with a broadcast address does not work
on remote subnets because most routers do not forward the
broadcast-address packets.
SRSS 4.3 Last change: 5
Sun Ray System Administration utrcmd(8)
NAME
utrcmd - Sun Ray remote administration utility.
SYNOPSIS
/opt/SUNWut/lib/utrcmd [ -n ] hostname command [ args ]
DESCRIPTION
The utrcmd program provides a way to run certain Sun Ray
administration commands remotely. It contacts the
in.utrcmdddaemon on the remote hostname and executes the
specified command with the specified arguments args (if
any).
utrcmd copies its standard input to the specified command,
the standard output of the command to utrcmd's standard out-
put, and the standard error of the command to utrcmd's stan-
dard error. Interrupt, quit, and terminate signals are pro-
pagated to the specified command; utrcmd terminates normally
when the command does.
OPTIONS
The following option is supported.
-n Redirect the input of utrcmd to /dev/null. This option
prevents interactions between utrcmd and the shell
which invokes it. For example, if you are running
utrcmd and invoke a utrcmd in the background without
redirecting its input away from the terminal, it will
block even if no reads are posted by the specified
command. The -n option prevents this behavior.
USAGE
Official hostnames or nicknames may be given as the host-
name.
The utrcmd and in.utrcmdd programs use the Sun Ray failover
group configuration to perform a set of checks before allow-
ing the specified command to proceed.
The program utrcmd runs with set-user-ID permission of root
or superuser. The utrcmd command proceeds only if all of the
following are true (on the initiating system):
o The user's real user-ID is superuser, or the user has
membership rights in the utadmin group.
o The /etc/opt/SUNWut/auth.props file is owned by
superuser and is not writable by anyone other than
superuser.
o The gmSignatureFile property of auth.props specifies a
group signature file.
SRSS 4.3 Last change: 1
Sun Ray System Administration utrcmd(8)
o The group signature file exists and is owned by
superuser and is not readable, writable, or executable
by anyone other than superuser.
o The group signature file is at least 8 bytes long and
has similar content diversity characteristics as
required by passwd(1).
o The utrcmd/tcp6 service is enabled.
The in.utrcmdd program will accept the connection only if
all of the following are true on the remote system:
o The utrcmd/tcp6 service is enabled and matches the
configuration on the initiating system.
o The in.utrcmdd program is enabled in /etc/inetd.conf.
o The utadmin group is configured on the system.
o The /etc/opt/SUNWut/auth.props file is owned by
superuser and is not writable by anyone other than
superuser.
o The gmSignatureFile property of auth.props specifies a
group signature file.The group signature file exists
and is owned by superuser, and is not readable, writ-
able, or executable by anyone other than superuser.
o The group signature file is at least 8 bytes long and
has similar content diversity characteristics as
required by passwd(1).
If the connection is accepted, the utrcmd program begins a
challenge-response handshake with the in.utrcmdd program,
using the contents of the group signature file to sign mes-
sages (without revealing the contents of the signature
file). Either utrcmd or in.utrcmdd will reject the transac-
tion if the handshake fails. The specified command will not
be run if the contents of the group signature files on the
two systems differ.
Finally, in.utrcmdd rejects the specified command if it is
not recognized. Specified commands always run in group utad-
min.
The following commands are allowed and are always run in
group utadmin:
o /opt/SUNWut/sbin/utreplica
o /opt/SUNWut/sbin/utpolicy
SRSS 4.3 Last change: 2
Sun Ray System Administration utrcmd(8)
o /opt/SUNWut/sbin/utfwadm
o /usr/sbin/dhtadm
o /usr/sbin/pntadm
o /opt/SUNWut/lib/utauthd
o /etc/init.d/utsvc
o /opt/SUNWut/sbin/utsession
o /opt/SUNWut/sbin/utreader
o /opt/SUNWut/sbin/utstart
Impact of disabling utrcmd:
utrcmd is used to run certain Sun Ray administration com-
mands on remote systems. Hence disabling utrcmd means that
the following functionality will not work as expected:
o Admin GUI
o Restart Services
o Sun Ray Session management
o CLI
o /opt/SUNWut/sbin/utreplica to setup a failover
group
o /opt/SUNWut/sbin/utdssync to convert and syn-
chronize the Sun Ray data store
o /opt/SUNWut/sbin/utfwsync to synchronize
firmware levels
EXAMPLES
Example 1: This command lists the configured token readers
on a remote Sun Ray server
# /opt/SUNWut/lib/utrcmd sun5 /opt/SUNWut/sbin/utreader
FILES
The following files are used:
o /etc/hosts
SRSS 4.3 Last change: 3
Sun Ray System Administration utrcmd(8)
Internet host table
o /etc/group
Group file
o /etc/inet/services
Internet services table
o /etc/inetd.conf
Internet services daemon configuration table
o /etc/opt/SUNWut/auth.props
Sun Ray authentication properties file
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuto |
|_____________________________|_____________________________|
SEE ALSO
utauthd(1M), inetd(1M), group(4), auth.props(4), hosts(4),
nsswitch(4), passwd(1), rsh(1), attributes(5)
NOTES
utrcmd works in a manner similar to rsh(1). However, it
imposes multiple restrictions to maintain system security.
SRSS 4.3 Last change: 4
Sun Ray System Administration utreader(8)
NAME
utreader - Sun Ray utility for configuring a terminal as a
token reader.
SYNOPSIS
/opt/SUNWut/sbin/utreader
/opt/SUNWut/sbin/utreader -a cid
/opt/SUNWut/sbin/utreader -c
/opt/SUNWut/sbin/utreader -d cid
/opt/SUNWut/sbin/utreader -h
DESCRIPTION
The utreader command is used to designate Sun Ray terminals
as dedicated token card readers.
When utreader is run with no options, the list of terminals
currently configured as token readers within the current
host group is displayed. The token reader list can be
viewed by all users. Changes to the token reader configura-
tion may be made only by a suitably privileged user.
Note:
After the token reader configuration been modified, a
cold restart of services must be performed in order for
the new configuration to take effect.
OPTIONS
The following options are supported.
-a cid
Adds the specified terminal to the list of token card
readers.
-c Clears (deletes all terminals from) the list of token
card readers.
-d cid
Deletes the specified terminal from the list of token
card readers.
-h Displays the usage message.
A terminal is identified to the -a and -d options by its
unique individual "canonical ID" or "CID". This is typi-
cally a string of the form IEEE802.EthernetMacID. The
IEEE802. portion of that string is the default CID prefix
and may be omitted from the command line.
SRSS 4.3 Last change: 1
Sun Ray System Administration utreader(8)
EXAMPLES
Example 1: This command configures a terminal whose ID is
IEEE802.008020112233 as a token reader:
% utreader -a 008020112233
Example 2: This command unconfigures all token readers:
utreader -c
EXIT STATUS
The following exit values are returned:
0 Success
1 Failure
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuta |
|_____________________________|_____________________________|
SEE ALSO
utstart(8), utconfig(8)
NOTES
utreader is available only after utconfig(1M) has been run
to activate the Sun Ray data store.
The number of token card readers that may be present on a
host group's reader list at any one time may be limited by
the implementation. Historically the limit has been eight
readers. This implementation guarantees that at least 48
readers will be supported at one time. It is possible that
more than 48 readers may be configured in some circumstances
but a site should not depend on being able to exceed 48 in
future SRSS releases.
SRSS 4.3 Last change: 2
Sun Ray System Administration utrelease(8)
NAME
utrelease - CLI to display Sun Ray Software version
SYNOPSIS
/opt/SUNWut/sbin/utrelease
DESCRIPTION
The utrelease command can be used to display the installed
version of Sun Ray Software product.
EXAMPLES
Example 1: This prints the Sun Ray product name and version.
# /opt/SUNWut/sbin/utrelease
Sun Ray Software 5.2
SRSS 4.3 Last change: 1
Sun Ray System Administration utreplica(8)
NAME
utreplica - LDAP replication utility for Sun Ray servers.
SYNOPSIS
/opt/SUNWut/sbin/utreplica -p [ -a | -d ] secondary-
server1 [ secondary-server2
/opt/SUNWut/sbin/utreplica -s primary-server
/opt/SUNWut/sbin/utreplica -l
/opt/SUNWut/sbin/utreplica -u
/opt/SUNWut/sbin/utreplica -z [ port# ]
/opt/SUNWut/sbin/utreplica [ -A ] [ -D ] [ -n ]
DESCRIPTION
The utreplica command configures the Sun Ray LDAP server to
replicate data from the primary server to each secondary
server in a failover group. The command must be run with
superuser privileges on the Sun Ray server to be configured.
OPTIONS
The following options are supported.
-l List the current failover administration status.
-p [-a|-d] secondary-server
Configure the primary server. secondary-server is the
host name of the secondary server. List all seondary
servers within the failover group.
-a is used to add the specified secondary servers to
the current list of secondary servers.
-d is used to delete the specified secondary servers
from the current list of secondary servers.
-s primary-server
Configure a secondary server. primary-server is the
host name of the primary server.
-u Unconfigure this Sun Ray server for LDAP database
replication.
-z[port#]
Update the port number with the one specified for the
datastore service. If run on the primary server
without specifying the port number, it simply updates
all the necessary configuration files on the primary
with the default port for the datastore service. If
SRSS 4.3 Last change: 1
Sun Ray System Administration utreplica(8)
run on the secondary server without specifying the
port number, it resyncs all necessary configuration
files on the secondary server with the port number
currently configured on the primary server.
-A AIC: Use previously-specified responses, utilizing
responses from
/var/opt/SUNWut/utdialog.d/SRCS.utdialog_responses.props.
If no entry exists for a particular key, prompt the
user in the standard fashion. See
utdialog_responses.props(5) for a specification of the
most significant keys affecting utreplica.
-D AIC: Use default responses, utilizing defaults from
/opt/SUNWut/lib/utdialog.d/SRCS.utdialog_defaults.props.
If no entry exists for a particular key, prompt the
user in the standard fashion. See
utdialog_responses.props(5) for a specification of the
most significant keys affecting utreplica.
-n AIC: If required to prompt the user, exit with bad
status.
USAGE
utreplica is used only on Sun Ray servers in a failover
group. Configure the primary Sun Ray server first, then the
secondary servers.
FILES
The following files are configured on the primary Sun Ray
server:
o /etc/opt/SUNWut/srds/current/utdsd.conf
o /etc/opt/SUNWut/srds/current/utdsd.ini
o /etc/services
o /etc/opt/SUNWut/utadmin.conf
The following files are configured on the secondary Sun Ray
server:
o /etc/opt/SUNWut/srds/current/utdsd.conf
o /etc/opt/SUNWut/utadmin.conf
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
SRSS 4.3 Last change: 2
Sun Ray System Administration utreplica(8)
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuto |
|_____________________________|_____________________________|
SEE ALSO
utconfig(8), utdialog_responses.props(5), AIC(8)
NOTES
To replicate the LDAP information properly, all Sun Ray
servers in the failover group must have the same group sig-
nature.
Use of the -p, -s, and -u options on a Sun Ray server inter-
rupts all active sessions on that server.
Please note that "interrupt" in this context means that,
while the screen will flash for approximately 30 seconds,
all current sessions are preserved, not destroyed. Active
users may need to remove and re-insert their smart cards to
return to their sessions. If a CDE login screen is
presented, the user should select Options/Reset Login Screen
to return to an existing session.
SRSS 4.3 Last change: 3
Sun Ray System Administration utresadm(8)
NAME
utresadm - manage explicit monitor resolution settings for
Sun Ray.
SYNOPSIS
/opt/SUNWut/sbin/utresadm [-v vonum]
/opt/SUNWut/sbin/utresadm -a [-v vonum] -c CID -t token
resname
/opt/SUNWut/sbin/utresadm -d [-v vonum] -c CID -t token
/opt/SUNWut/sbin/utresadm -p [-v vonum] [-c CID] [-t token]
/opt/SUNWut/sbin/utresadm -o
/opt/SUNWut/sbin/utresadm -i
DESCRIPTION
The utresadm command allows an administrator to establish
explicit video signal timings on the monitor video outputs
of a Sun Ray desktop unit. The video signal timing controls
the on-screen resolution and refresh rate of the attached
monitor.
Resolutions configured through utresadm take precedence over
resolutions discovered by the Sun Ray DTU through a DDC
exchange with the monitor. Resolutions may be specified for
a particular combination of Sun Ray DTU and access token,
for a particular Sun Ray independent of access token, and
for all Sun Ray DTUs controlled by servers in a failover
group. In cases where multiple configuration records might
apply to a given session, the most specific matching record
is applied.
utresadm with no arguments shows the resolution that has
been configured for the current access token in the current
Sun Ray DTU.
OPTIONS
The following options are supported.
-a establishes the resolution resname as the preferred
resolution for the given CID, token and vonum. If
token is specified as the word default then resname
becomes the preferred resolution for all tokens at the
given CID for which no explicit resolution has been
configured. If both CID and token are specified as
the word default then resname becomes the preferred
resolution for all CIDs and tokens for which no expli-
cit resolution has been configured. This option is
available only to the superuser. Changes become
SRSS 4.3 Last change: 1
Sun Ray System Administration utresadm(8)
effective only after services are restarted.
-d deletes an explicit resolution previously configured
for the given CID, token and vonum. This option is
available only to the superuser. Changes become
effective only after services are restarted.
-p shows the explicit resolution configured for the given
CID, token and vonum. If no token is specified then
all configuration records for the given CID are shown.
If no CID is specified then all configuration records
for the given token are shown. If neither CID nor
token is specified then all configuration records are
shown.
-o emits (to standard output) all configured resolution
records in a format suitable for consumption by
utresadm -i.
-i reads (from standard input) a list of resolution con-
figuration records in the form emitted by utresadm -o
and configures the corresponding resolutions. This
option is available only to the superuser.
-c CID
CID is the canonical ID of the Sun Ray desktop unit,
or the word default if this operation is to apply to
all desktop units.
-t token
token is the access token for the session, or the word
default if this operation is to apply to all tokens.
-v vonum
vonum is the monitor video output number that is to be
affected by this operation. The first monitor video
output on a Sun Ray DTU is numbered 1. Additional
outputs, present only on certain models of Sun Ray
DTU, are identified by successively higher numbers.
(For example, a Sun Ray 2FS DTU has two outputs, num-
bered 1 and 2.) If no vonum is specified then output
number 1 is assumed.
OPERANDS
resname
The name of a timing that will produce the desired
resolution. A list of available timings may be
obtained from utresdef(1M).
EXIT STATUS
The following exit values are returned:
SRSS 4.3 Last change: 2
Sun Ray System Administration utresadm(8)
0 if the desired activity was completed without error.
1 if the command terminated because of a command line
syntax problem.
2 if the Sun Ray data store was inaccessible.
3 if the resolution definition (provided on standard
input) was unacceptable.
FILES
/etc/opt/SUNWut/utadmin.conf
/etc/opt/SUNWut/utadmin.pw
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuta |
|_____________________________|_____________________________|
SEE ALSO
utsettings(1), utset(1), utresdef(1M), utconfig(1M)
NOTES
utresadm provides no assurance that the configured resolu-
tion timing can be understood by the monitor attached to a
Sun Ray unit; it is possible to configure a resolution that
can not be understood by the monitor. utsettings(1) provides
a safer interactive means of establishing an explicit reso-
lution for the current access token on the current Sun Ray
unit.
utresadm is available only after utconfig(1M) has been run
to activate the Sun Ray data store.
As with anything that must go through the LDAP database,
there is a slight lag between the time an update is applied
on the primary server and its propagation to the secondary
server or servers; however, the length of the interval would
normally be measured in seconds or fractions of a second.
In addition, once a Sun Ray session, which can persist
across many logins, is attached to a given DTU, the monitor
timing persists for the life of the session and can be
changed only by modifying the timing explicitly from within
that session while it remains attached to that DTU.External
activities, such execution of utresadm -a or utresadm -d
SRSS 4.3 Last change: 3
Sun Ray System Administration utresadm(8)
after the session has been associated with the DTU, have no
effect on any existing association. However, utstart -c des-
troys all existing sessions and thereby makes all previously
existing associations obsolete. As DTUs reconnect after the
restart and are granted new sessions, the newly configured
timings are applied to the new sessions as they are created.
SRSS 4.3 Last change: 4
Sun Ray System Administration utresdef(8)
NAME
utresdef - manage monitor resolution definitions for Sun
Ray.
SYNOPSIS
/opt/SUNWut/sbin/utresdef
/opt/SUNWut/sbin/utresdef resname
/opt/SUNWut/sbin/utresdef -a [-c comment] resname dimensions
/opt/SUNWut/sbin/utresdef -d resname
/opt/SUNWut/sbin/utresdef -o
/opt/SUNWut/sbin/utresdef -i
/opt/SUNWut/sbin/utresdef -h
DESCRIPTION
The utresdef command allows an administrator to create,
delete and view resolution definitions (actually monitor
signal timing definitions) for monitors attached to Sun Ray
DTUs.
Running utresdef(1M) with no options or arguments produces a
summary listing of all available resolutions. Running
utresdef(1M) with no options and a resname argument produces
a summary listing of the named resolution. The summary
listing shows the name of the resolution, the on-screen
dimensions (WIDTHxHEIGHT) that result from the use of this
resolution, a flag indicating whether this resolution is
built in (B) to SRSS or has been locally defined (-), and a
brief description of the resolution.
Individual resolutions may be associated with specific Sun
Ray units by utresadm(1M). Users may configure resolutions
for their own personal access tokens through utsettings(1)
or utset(1).
OPTIONS
The following options are supported.
-a defines the resolution resname. This option is avail-
able only to the superuser.
-d deletes the resolution definition named resname. This
option is available only to the superuser.
-o shows all locally-defined resolutions in a format
suitable for consumption by utresdef -i.
SRSS 4.3 Last change: 1
Sun Ray System Administration utresdef(8)
-i reads (from standard input) a list of resolution
definitions in the form emitted by utresdef -o and
adds those definitions to the list of locally-defined
resolutions. This option is available only to the
superuser.
-c a comment explaining the nature and purpose of the
resolution being defined.
-h Displays the usage message for this command.
OPERANDS
dimensions
the dimensions, in the form WIDTHxHEIGHT, of the on-
screen display that results from applying this resolu-
tion definition to the Sun Ray desktop unit.
resname
the name of the resolution being defined, deleted or
displayed. resname is often given in the form
WIDTHxHEIGHT@RATE (e.g. 640x480@60) but this form is
not required. The resolution name must begin with a
letter or a number, may contain letters, numbers and
the characters '.' (period), '-' (hyphen), '_' (under-
score), '@' (at) or '+' (plus), and must not exceed 20
characters in length.
EXIT STATUS
The following exit values are returned:
0 if the desired activity was completed without error.
1 if the command terminated because of a command line
syntax problem.
2 if the Sun Ray data store was inaccessible.
3 if the resolution definition (provided on standard
input) was unacceptable.
FILES
/etc/opt/SUNWut/utadmin.conf
/etc/opt/SUNWut/utadmin.pw
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
SRSS 4.3 Last change: 2
Sun Ray System Administration utresdef(8)
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuta |
|_____________________________|_____________________________|
SEE ALSO
utsettings(1), utset(1), utresadm(1M), utconfig(1M)
NOTES
utresdef is available only after utconfig(1M) has been run
to activate the Sun Ray data store.
SRSS 4.3 Last change: 3
Sun Ray System Administration utrestart(8)
NAME
utrestart - Sun Ray utility for resetting and restarting
services.
SYNOPSIS
This command is deprecated. Please use utstart(8) instead.
/opt/SUNWut/sbin/utrestart
/opt/SUNWut/sbin/utrestart -c
/opt/SUNWut/sbin/utrestart -h
DESCRIPTION
This command is deprecated. Please use utstart(8) instead.
The utrestart command is used for resetting and restarting
Sun Ray services. It replaces the utpolicy -i option which
has been deprecated in 2.0.
utrestart can only be run by the super-user.
The utrestart command without options causes a "warm" res-
tart: Sun Ray services are restarted and existing sessions
are preserved.
OPTIONS
The following options are supported.
-c Restarts Sun Ray services. Sessions will be lost.
-h Prints the usage for this command.
EXAMPLES
Example 1: This resets services.
# /opt/SUNWut/sbin/utrestart
Example 2: This restarts services.
# /opt/SUNWut/sbin/utrestart -c
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuta |
|_____________________________|_____________________________|
SRSS 4.3 Last change: 1
Sun Ray System Administration utseriald(8)
NAME
utseriald - Sun Ray DTU serial services daemon.
SYNOPSIS
/opt/SUNWut/lib/utseriald [ -D debug-level ] [ -o optroot
] [ -r ]
DESCRIPTION
utseriald provides serial support for Sun Ray DTUs through
driver services for USB serial adaptors. It also provides
support for the built-in, non-USB serial ports on some Sun
Ray models.
utseriald uses the Sun Ray serial I/O driver on solaris and
Sun Ray utio driver on linux to provide applications the
same interface as standard workstation serial ports, such as
/dev/term/a or /dev/term/b on solaris and /dev/ttyS0 on
linux.
When a USB serial adaptor is attached to a DTU, utseriald
creates device nodes in the $UTDEVROOT/devices directory.
Sun Ray models with permanent, built-in serial ports will
also have corresponding device nodes created in this direc-
tory.
A user can use the device link
$UTDEVROOT/dev/term/terminal-name to access the serial ports
on the Sun Ray DTU.
OPTIONS
The following options are supported.
-D debug-level
Debug mode. Use is beyond the scope of this document.
-o optroot
Use optroot as the serial service's root directory for
device node creation. The default value is
/tmp/SUNWut. optroot should be the same directory as
the optroot directory used by utdevmgrd(1M).
-r Automatically restart the serial service daemon if it
exits. With this option, the serial service daemon
creates two processes: a child that performs all the
actual work, and a parent monitoring process. The
parent process restarts a child if the previous one
exits.
FILES
The following files are used:
$UTDEVROOT/dev/term
SRSS 4.3 Last change: 1
Sun Ray System Administration utseriald(8)
The directory containing links to serial device names
for each DTU.
ENVIRONMENT VARIABLES
UTDEVROOT points to a symbolic link of the device root for
the Sun Ray DTU associated with a user's session.
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuto |
|_____________________________|_____________________________|
SEE ALSO
utdevmgrd(1M), utparalleld(1M)
SRSS 4.3 Last change: 2
Sun Ray System Administration utsession(8)
NAME
utsession - List and manage the Sun Ray sessions on the
local Sun Ray server.
SYNOPSIS
/opt/SUNWut/sbin/utsession -p [ -x ] [ -d disp# ] [ -u
unix ] [ -t token ] [ -n name ]
/opt/SUNWut/sbin/utsession -k [ -a ] [ -x ] [ -d disp# ]
[ -u unix ] [ -t token ] [ -n name ]
/opt/SUNWut/sbin/utsession -l [ -x ] [ -d disp# ] [ -u
unix ] [ -t token ] [ -n name ]
/opt/SUNWut/sbin/utsession -h
DESCRIPTION
The first synopsis (-p) is used to print Sun Ray sessions
for the specified user or token on the current server. When
the -u, -t, -n, and -d options are not used, utsession
prints all of the Sun Ray sessions on the current server.
When listing the Sun Ray sessions, utsession also lists the
state for each session:
D Disconnected - The session is currently not attached
to any Sun Ray. The session is considered connected
if this flag is omitted.
I Idling - A dtlogin session that is currently waiting
for user login (ie. dtgreet). User has already logged
into the dtlogin session if the flag is omitted.
E Encrypted session - Session traffic is encrypted in at
least one direction (upstream or downstream).
A Authenticated - The server has authenticated to the
client.
U Authenticated Client (Unconfirmed) - The client has
authenticated successfully to the server. Authenticity
of the client key used has not been established.
C Authenticated Client (Confirmed) - The client has
authenticated successfully to the server. Authenticity
of the client key used has been established.
X Authentication Conflict - Multiple conflicting keys
have been used for this client. Access to regular ses-
sions is denied until the conflict is resolved. Use
utkeyadm(8) to confirm the genuine key.
SRSS 4.3 Last change: 1
Sun Ray System Administration utsession(8)
The second synopsis (-k) is used to kill Sun Ray sessions on
the current server. At least one of the -d, -u, -t, or -n
options must be specified. Unless the -a option is speci-
fied, more than one session matching the specified criteria
will return an error.
The third synopsis (-l) gives detailed security status for
the specified user or token on the current server. When the
-u, -t, -n, and -d options are not used, utsession
lists detailed security status for all terminal CIDs
currently connected to the server.
The fourth synopsis (-h) displays the usage of this command.
Note:
This command must be run as root.
OPTIONS
The following options are supported:
-a Apply the operation to all matching sessions if more
than one matches the search criteria. If -a is not
specified, multiple matching sessions return an error.
-d disp#
Specify the X display number for search.
-h Display the usage of this command.
-k Kill the sessions matching the search criteria. You
must also specify at least one of the -d, -u, -t, or
-n options.
-l Gives detailed security status, normally a list of
terminal CIDs currently used by the session, listed
under the terminalCIDs key. For multihead sessions, it
also displays the primary terminal CID under the pri-
maryCID key.
-n name
Specify the registered Sun Ray username for search.
Sessions belonging to users matching the username are
listed. It is a case sensitive, exact match.
-p Print the sessions belonging to the specified user or
token.
-t token
Specify the Sun Ray token for search. The token is in
one of the following forms:
SRSS 4.3 Last change: 2
Sun Ray System Administration utsession(8)
o Raw token form for unregistered smartcard users
(. e.g. MicroPayflex.1234567890)
o Pseudo token form for terminal users
(pseudo.)
o Logical token form for registered users
(user.)
o Transitional token form for hotdesk authentica-
tion (hotdesk.)
-u unix
Specify the UNIX login name for search.
-x RESERVED for special handling. This is invoked by
utrcmd(8) to support remote operation of the Adminis-
tration Tool interface.
EXAMPLES
Example 1: This command lists all sessions on the current
server.
# utsession -p
Example 2: This command finds the sessions for the UNIX user
"jdoe".
# utsession -p -u jdoe
Example 3: This command terminates a registered Sun Ray
user's (john doe's) session.
# utsession -k -n "john doe"
EXIT STATUS
The following exit values are returned:
0 Command completed successfully.
1 Entry not found.
-1 An error occurred.
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
SRSS 4.3 Last change: 3
Sun Ray System Administration utsession(8)
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuta |
|_____________________________|_____________________________|
SEE ALSO
utuser(8), auth.props(5), utdesktop(8) , utcrypto(8),
utkeyadm(8)
SRSS 4.3 Last change: 4
Sun Ray System Administration utsessiond(8)
NAME
utsessiond - Sun Ray session manager daemon.
SYNOPSIS
/opt/SUNWut/lib/utsessiond [ -a authlist ] [ -c authfile ]
[ -d ] [ -h hostname ] [ -p port ] [ -P nport ] [ -r ]
DESCRIPTION
The utsessiond daemon provides a reliable rendezvous point
for services in a Sun Ray session. It acts as an intermedi-
ary to forward session connection and disconnection messages
from the Sun Ray authentication manager to the services and
provides facilities for supporting distributed synchroniza-
tion of clip-lists for the services.
If either the -a or the -c options is specified, the session
manager daemon operates exclusively in call-back mode. In
this mode, the session manager only takes session connect
and disconnect commands from authentication managers that
are explicitly enabled by authlist or authfile and that have
requested a call-back. The call-back feature provides a
mechanism by which the session manager and the authentica-
tion manager may establish each other's identity.
Error messages from utsessiond are logged using syslog(3)
with a facility value of LOG_DAEMON.
OPTIONS
The following options are supported.
-a authlist
Add the host and port pairs specified in authlist to
the list of permitted Authentication Managers. The
format of authlist is a comma separated list of
hostname:port pairs.
-c authfile
Add the host and port pairs specified in the ASCII
file authfile to the list of permitted Authentication
Managers. The file contains a list of Authentication
Manager specifications, one per line. The specifica-
tions take the form of hostname followed by port
number, separated by white-space. Blank lines and any
line whose first printable character is ``#'' are
ignored.
-d Enable debugging output.
-h hostname
Set the hostname portion of the session IDs generated
by the Session Manager to the specified hostname
value. By default this is set to the machine's node
SRSS 4.3 Last change: 1
Sun Ray System Administration utsessiond(8)
name. This option can be used to handle servers sup-
porting multiple IP addresses as part of a clustering
solution.
-p port
Set the Session Manager's listen port to the specified
port value. The default is port 7007. This is the port
by which session services and Authentication Managers
contact the Session Manager.
-P nport
This option is no longer used. Retained only for back-
ward compatibility.
-r Automatically restart the Session Manager daemon if it
exits. With this option the Session Manager daemon
will create two processes: a child that performs all
the actual work and parent monitoring process. The
parent process will restart a child if the previous
one exits.
FILES
The following file is used:
o /etc/opt/SUNWut/auth.permit
The customary location of the authfile for a system.
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuto |
|_____________________________|_____________________________|
SEE ALSO
utauthd(1M), syslog(3), syslogd(1M), syslog.conf(4)
SRSS 4.3 Last change: 2
Sun Ray System Administration utsetup(8)
NAME
utsetup - SRS Installation and Configuration Management
SYNOPSIS
/cdrom/cdrom0/utsetup [-a [-D dialog_responses_dir]] [-d]
/opt/SUNWut/sbin/utsetup [-a] [-d]
DESCRIPTION
The utsetup command can be used to walk through the process
of installation and/or configuration of SRS. It produces a
set of files (see utdialog_responses.props(5)) that can be
used with utsetup subsequently on another system to repro-
duce the configuration.
When the Download Image utsetup is run with no options, it
will walk the user through the process of installing, confi-
guring, activating, and starting up SRS. The configuration
which results will be a commonly used configuration,
(optionally) allowing LAN-based Sun Ray clients to connect
to the server (using utadm -L on) and configuring firmware
(using utfwadm -A -a -V). The user will be prompted for the
installation and configuration parameters and all user
responses will be stored in /var/opt/SUNWut/utdialog.d in
utdialog_responses.props files. Note that if an HA group is
indicated you will be prompted to enter a list of Primary
and Secondary hostnames. The host will then self-configure
replication appropriately depending on which list it is on,
and the resultant utdialog_responses.props can be used to
auto-configure other members of the HA group as well.
Once utsetup has been run on a given system, the contents of
/var/opt/SUNWut/utdialog.d may be copied to a directory on
another system, and the Download Image utsetup may be run
with the -a -D dialog_responses_dir options to reproduce the
same configuration on that system.
If installation is performed separately (e.g. jumpstart),
/opt/SUNWut/sbin/utsetup can be run. It will behave identi-
cally to the Download Image version except that the instal-
lation phase will be skipped, and there is no option to pick
up dialog files from anyplace other than
/var/opt/SUNWut/utdialog.d/. If the Download Image utsetup
is run, there is no need to run /opt/SUNWut/sbin/utsetup
separately.
OPTIONS
The following options are supported.
-a AIC: Use previously-specified responses, utilizing
responses from the utdialog_responses.props files. If
no entry exists for a particular key, prompt the user
SRSS 4.3 Last change: 1
Sun Ray System Administration utsetup(8)
in the standard fashion. See
utdialog_responses.props(5) for a specification of the
most significant keys.
-d AIC: Use default responses, utilizing defaults from
the utdialog_defaults.props files. If no entry exists
for a particular key, prompt the user in the standard
fashion. See utdialog_responses.props(5) for a specif-
ication of the most significant keys.
-D dialog_dir
AIC: Read AIC utdialog_responses.props files from
dialog_dir, and copy them into the standard location
after product installation.
EXAMPLES
Example 1: Install SRS, configure it, start it up, and
create utdialog_responses.props files
# utsetup
==================================================================
=== Installing Sun Ray Software - utinstall ===
Accept? (Y/N) y
# utinstall Version: 4.3 Sun Nov 28 09:01:04 PST 2010
Sun Ray Server Software installed
Sun Ray Data Store 3.2 not installed
Kiosk Mode 4.3 not installed
Enter Java v1.6 (or later) location: [/usr/java]
About to carry out the following operations:
Upgrade [ Sun Ray Server Software to 4.3 ]
Install [ Sun Ray Data Store 3.2 ]
Install [ Sun Ray Server Software 4.3 French Admin GUI ]
Install [ Sun Ray Server Software 4.3 Japanese Admin GUI ]
Install [ Sun Ray Server Software 4.3 Simplified Chinese Admin GUI ]
Install [ Sun Ray Server Software 4.3 ]
Install [ Kiosk Mode 4.3 ]
Install [ Kiosk Mode 4.3 localized files ]
Install [ data for utslaunch ]
Install [ Sun Ray Server Software 4.3 modules for utsunmc ]
Install [ Service Tags 1.1 ]
Continue? (Y/N) [Y]
Installing Sun Ray Server Software version 4.3 ...
Sun Ray System Administration utslaunch(8)
NAME
utslaunch - Sun Ray DTU launch application.
SYNOPSIS
/opt/SUNWut/lib/utslaunch
DESCRIPTION
The utslaunch application is used to launch various Sun Ray
applications via a "hotkey" key combination. The applica-
tions are enabled when the key combination is pressed.
The utslaunch application provides hotkey functionality
while consuming fewer system resources.
Hotkey key combinations are defined in the
utslaunch.properties files.
OPTIONS
There are no options for utslaunch.
EXAMPLES
Example 1: This command starts the utslaunch daemon in the
background.
# utslaunch &
FILES
The following files are used for hotkey configuration:
o /etc/opt/SUNWut/utslaunch_defaults.properties
site-wide defaults
o ~/.utslaunch.properties
user's defaults
o /etc/opt/SUNWut/utslaunch_mandatory.properties
site-wide mandatory defaults
The following file is used:
/usr/dt/config/Xsession.d/0100.SUNWut
ENVIRONMENT VARIABLES
utslaunch uses the DISPLAY environment variable to get the
user's X display number.
SRSS 4.3 Last change: 1
Sun Ray System Administration utslaunch(8)
It also uses the HOME environment variable to get the user's
home directory to be able to use user's hotkey settings.
EXIT STATUS
The following exit values are returned:
0 Success
1 Failure
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuto |
|_____________________________|_____________________________|
SEE ALSO
utslaunch.properties(4), utsettings(1), utdetach(1)
SRSS 4.3 Last change: 2
Sun Ray System Administration utstart(8)
NAME
utstart - Sun Ray utility for resetting and restarting ser-
vices.
SYNOPSIS
/opt/SUNWut/sbin/utstart
/opt/SUNWut/sbin/utstart -c
/opt/SUNWut/sbin/utstart -h
DESCRIPTION
The utstart command is used for resetting and restarting Sun
Ray services. It replaces the utpolicy -i option which has
been deprecated in 2.0.
utstart can only be run by the super-user.
The utstart command without options causes a "warm" restart:
Sun Ray services are restarted and existing sessions are
preserved.
OPTIONS
The following options are supported.
-c Restarts Sun Ray services. Sessions will be lost.
-h Prints the usage for this command.
EXAMPLES
Example 1: This resets services.
# /opt/SUNWut/sbin/utstart
Example 2: This restarts services.
# /opt/SUNWut/sbin/utstart -c
ATTRIBUTES
See attributes(8) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuta |
|_____________________________|_____________________________|
SRSS 4.3 Last change: 1
Sun Ray System Administration utstop(8)
NAME
utstop - Sun Ray utility for stopping and disabling ser-
vices.
SYNOPSIS
/opt/SUNWut/sbin/utstop
DESCRIPTION
The utstop command is used for stopping Sun Ray services and
disabling them so that they will not automatically start up
upon reboot.
utstop can only be run by the super-user.
EXAMPLES
Example 1: This stops and disables services.
# /opt/SUNWut/sbin/utstop
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuta |
|_____________________________|_____________________________|
SEE ALSO
utstart(8)
SRSS 4.3 Last change: 1
Sun Ray System Administration utstoraged(8)
NAME
utstoraged - Sun Ray Mass Storage service daemon
SYNOPSIS
/opt/SUNWut/lib/utstoraged [ -D debug-level] [-o optroot]
[-r]
DESCRIPTION
utstoraged provides mass storage support for Sun Ray DTUs.
utstoraged supplies driver services for USB mass storage
devices that comply with the USB Bulk Only Mass Storage
Specification 1.0.
utstoraged uses the utdisk(4) loopback driver to provide a
block device interface to Linux applications. Applications
can access Sun Ray storage devices through block device
links created in the $UTDEVROOT/dev/dsk directory.
utstoraged interacts with the mounter daemon, utmountd(8),
to mount devices containing OS-recognizable filesystems.
Users have access rights only to storage devices connected
to the Sun Ray DTU on which their session is active and only
for as long as the session is active. When the session is
disconnected from the Sun Ray DTU through logout, hotdesk-
ing, server switching, or any other means, ownership of the
storage device is lost and all pending data transfers are
aborted. This can result in corruption of the filesystem on
the media and loss of data.
Note:
Users are strongly advised to use the utdiskadm(8) com-
mand to prepare the device for removal before discon-
necting a session. On Linux, writes to some filesys-
tems are asynchronous. If the device is unplugged
without unmounting the filesystem first, some data
could get lost.
Error messages are logged to
/var/opt/SUNWut/log/utstoraged.log
OPTIONS
The following options are supported:
-D debug-level
Debug mode. Use is beyond the scope of this docu-
ment. If a debug level is set, debug messages are
sent to stderr.
-o optroot
SRSS 4.3 Last change: 1
Sun Ray System Administration utstoraged(8)
Use optroot as the parallel service's root
directory for device node creation. optroot
should be the same directory as the optroot
directory used by utdevmgrd(8).
-r
Automatically restart the storage service daemon
if it exits. With this option, the storage ser-
vice daemon creates two processes: a child that
performs all the actual work, and a parent
monitoring process. The parent process restarts a
child if the previous
one exits.
FILES
The following files are used:
$UTDEVROOT/dev/dsk
The directory containing links to block dev-
ice names for each slice or partition on the
device.
ENVIRONMENT VARIABLES
UTDEVROOT points to a symbolic link of the device root for
the Sun Ray DTU associated with a user's session.
SEE ALSO
utdiskadm(8), utmountd(8), utdevmgrd(8), utdisk(4)
SRSS 4.3 Last change: 2
Sun Ray device administration utusbadm(8)
NAME
/opt/Sun Ray/sbin/utusbadm - Enable or disable USB device
services
SYNOPSIS
DESCRIPTION
Note that utusbadm command is deprecated. Use /opt/Sun
Ray/sbin/utdevadm command to enable/disable usb services.
The utusbadm ommand is used to disable/enable access to all
USB ports on Sun Ray devices. It does not affect HID devices
such as the keyboard and mouse; however, it does affect all
other devices attached to the USB ports, which will not be
accessible if the site is so configured.
This is a site-wide property. When set, it affects all units
connected to the failover group.
Changing this configuration requires a cold system restart
before it can take effect. When a successful change is made,
the command reminds the administrator to restart the ser-
vices.
OPTIONS
The following options are supported.
-h Print the current usage state.
-e Enable all USB device services.
-d Disable all USB device services.
ENVIRONMENT VARIABLES
None
EXIT STATUS
The following exit values are returned:
0 on success
1 on error
FILES
None
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
SRSS 4.3 Last change: 1
Sun Ray device administration utusbadm(8)
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuto |
| Interface Stability | Public Evolving |
|_____________________________|_____________________________|
SEE ALSO
utstart(8), utdevadm(8)
SRSS 4.3 Last change: 2
Sun Ray System Administration utuser(8)
NAME
utuser - Sun Ray user administration utility.
SYNOPSIS
/opt/SUNWut/sbin/utuser -a "tokenID,server-name,server-
port,name,other-info" [ -r tokenreader ]
/opt/SUNWut/sbin/utuser -a -f filename [ -r token-
reader ]
/opt/SUNWut/sbin/utuser -a -i current-tokenID new-
tokenID [ -r token-reader ]
/opt/SUNWut/sbin/utuser -d tokenID
/opt/SUNWut/sbin/utuser -d -f filename
/opt/SUNWut/sbin/utuser -d -i current-tokenID
/opt/SUNWut/sbin/utuser -e "tokenID,server-name,server-
port,name,other-info"
/opt/SUNWut/sbin/utuser -e -f filename
/opt/SUNWut/sbin/utuser -e -i current-tokenID [ena-
bledisable]
/opt/SUNWut/sbin/utuser -h
/opt/SUNWut/sbin/utuser -l
/opt/SUNWut/sbin/utuser -l -c
/opt/SUNWut/sbin/utuser -l -i substring
/opt/SUNWut/sbin/utuser -l -n substring
/opt/SUNWut/sbin/utuser -L
/opt/SUNWut/sbin/utuser -L -c
/opt/SUNWut/sbin/utuser -L -i substring
/opt/SUNWut/sbin/utuser -L -n substring
/opt/SUNWut/sbin/utuser -L -g
/opt/SUNWut/sbin/utuser -L -s session-type
/opt/SUNWut/sbin/utuser -o
SRSS 4.3 Last change: 1
Sun Ray System Administration utuser(8)
/opt/SUNWut/sbin/utuser -p tokenID
/opt/SUNWut/sbin/utuser -r token-reader
DESCRIPTION
The utuser command allows the administrator to manage users
registered on the Sun Ray server where the command is run.
The information that utuser provides is from the Sun Ray
administration database and the Sun Ray Authentication
Manager.
utuser operations that only display information may be run
by any user. Operations that change or delete data are run
under superuser privileges.
OPTIONS
The following options are supported.
-a Add user with the specified tokenID, servername, ser-
verport, name and other information properties.
The 5 comma-delimited values should be enclosed within
quotes. All values except tokenID and name are
optional, although comma separators are required (for
example ",,,,"). The backslash charac-
ter ("\") should not be used in any value.
-a -f Batch add multiple users, using input from the speci-
fied filename. The format of each line in the input
file is: tokenID,server-name,serverport,name,other-
info. All values except tokenID and name are
optional, although comma separators are required (for
example ",,,,").
-a -i Add the specified new-tokenID to the user that
currently has token current-tokenID.
-d Delete the user with the specified tokenID. This com-
mand deletes the user and all of the user's tokens.
(To delete a single token without deleting the user,
use the -di option.)
-d -f Batch delete multiple users, using input from the
specified filename. The format of each line in the
input file is: tokenID. However, you may use the out-
put of the -o option as input to this option as all
arguments after the first comma are ignored. For each
tokenID specified in the filename, this command
deletes the associated user and all of the user's
tokens. (To delete a single token without deleting the
user, use the -di option.)
SRSS 4.3 Last change: 2
Sun Ray System Administration utuser(8)
-d -i Delete token current-tokenID from the user that
currently has ownership of it. The token to be deleted
must not be the user's only token. This command does
not delete the user or any of the user's other tokens.
(To delete the user and all the user's tokens, use the
-d option.)
-e Edit properties for the user with the specified tok-
enID by changing the server-name, server-port, name
and other-information properties to the specified
values.
The 5 comma-delimited values should be enclosed within
quotes. All values except tokenID and name are
optional, although comma separators are required (for
example ",,,,").
-e -f Batch edit multiple users, using input from the speci-
fied filename. The format of each line in the input
file is: tokenID,server-name,server-port,name,other-
info. All values except tokenID are optional,
although comma separators are required (for example
",,,,").
-e -i Enable or disable the specified current-tokenID.
-h Show usage information (this message).
-l List all users registered in the admin database..
-l -c List all users registered in the admin database that
are currently logged in.
-l -i List all users registered in the admin database with
tokenIDs that contain the specified substring.
-l -n List all users registered in the admin database with
names that contain the specified substring.
-L List all users registered in the admin database (long
format).
-L -c List all users registered in the admin database that
are currently logged in (long format).
-L -i List all users registered in the admin database with
tokenIDs that contain the specified substring (long
format).
-L -n List all users registered in the admin database with
names that contain the specified substring (long for-
mat).
SRSS 4.3 Last change: 3
Sun Ray System Administration utuser(8)
-L -g List all users registered in the admin database
currently logged in and the servers into which they
are logged in.
-L -s List all users registered in the admin database with
session types matching the specified session-type,
which can be either "default", "kiosk" or "regular"
(long format).
-o Dump user list in comma-delimited format. The format
of each line output by this option is: tokenID,
server-name, server-port, name, and other-info.
-p Show user properties for user with the specified tok-
enID.
-r When specified alone, this option reads a tokenID from
the specified token reader. When specified with the
-a, -af or -ai options, the -r flag instructs utuser
to use the specified token reader to read the tokenID
and use it wherever the character "x" is used in place
of a tokenID. The command will prompt you to insert
the token into the specified reader when its ready to
read the token.
For the -l -i, -l -n, -L -i, and -L -n options, the sub-
string comparisons are case-insensitive.
EXAMPLES
Example 1: This command displays all users that have
"parker" in their usernames:
% /opt/SUNWut/sbin/utuser -l -n parker
Example 2: This command adds a user with unknown tokenID,
server name "localhost", server port "7007", user name "John
Anderson", and other information "C987" by using the token
reader 08002086e18f to read the tokenID:
# /opt/SUNWut/sbin/utuser -a "x,localhost,7007,John Anderson,C987"
-r 08002086e18f
Example 3: This command adds multiple users, using input
from the /tmp/users file:
# /opt/SUNWut/sbin/utuser -a -f /tmp/users
Example 4: This command reads a token from token reader
08002086e18f:
# /opt/SUNWut/sbin/utuser -r 08002086e18f
SRSS 4.3 Last change: 4
Sun Ray System Administration utuser(8)
FILES
The following file is used:
o /etc/opt/SUNWut/utadmin.conf
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuta |
|_____________________________|_____________________________|
SEE ALSO
utdesktop(1M), utadmin.conf(4)
NOTES
The -G option has been deprecated in favor of using utuser
-L -g.
SRSS 4.3 Last change: 5
Sun Ray System Administration utwall(8)
NAME
utwall - Sun Ray user notification utility.
SYNOPSIS
/opt/SUNWut/sbin/utwall -a aufile [ -r n ] [ -v ] { ALL
| user [ :display ] | :display ... }
/opt/SUNWut/sbin/utwall [ -d ] [ -m "subject" ] [ -t
"message-text" ] [ -v ] { ALL | user [ :display ] |
:display
DESCRIPTION
utwall sends a message or an audio file to users having an
Xserver process. The messages can be sent in email and/or
displayed in a pop-up window. When sent to a multihead ses-
sion, the pop-up window will appear on all displays for that
session.
Options -a and -d require superuser privileges.
OPTIONS
The following options are supported.
-a aufile
Annunciate mode. Plays the audio file aufile on the
specified user's X session. Audio files of type .au
can be found at /usr/demo/SOUND/sounds.
-d Pop up a window with the supplied message on each
Xserver instance.
-m subject
Send mail with the given subject "subject" and sup-
plied message. If the text has white space, use sin-
gle or double quotes. Substitution is supported.
-r n Repeat the annunciation n times. This option can only
be used with -a. Default is 1.
-t message-text
Message text. Alternatively, the message can be sup-
plied as stdin. If the text has white space, use sin-
gle or double quotes. Substitution is supported.
-v Verbose mode.
OPERANDS
The following operands are supported:
ALL Action is performed on all user having an Xserver
process.
SRSS 4.3 Last change: 1
Sun Ray System Administration utwall(8)
user:display
Action is performed on the given users (optional
display number display) having an Xserver pro-
cess.
:display
Action is performed on the users having display
number display.
EXAMPLES
Example 1: This command sends email to all users:
# /opt/SUNWut/sbin/utwall -m 'System policy change...' \
-t 'Tonight\nPlease log off' ALL
The email reads:
Subject: System policy change...
Tonight
Please log off
Example 2: This command pops a window up on all sessions
stating "Log off now!"
# /opt/SUNWut/sbin/utwall -d -t "Log off now!" ALL
Example 3: This command pops a window up on jsmith's session
on display 26 with the text from messagefile
# /opt/SUNWut/sbin/utwall -d jsmith:26 < messagefile
Example 4: This command pops a window up with a greeting to
the user on display number 10
# /opt/SUNWut/sbin/utwall -d -t "Hello" :10
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuto |
|_____________________________|_____________________________|
SEE ALSO
wall(1M), mailx(1M), utaudio(1)
NOTES
SRSS 4.3 Last change: 2
Sun Ray System Administration utwall(8)
When Sun Ray DTUs are configured for Xinerama, only the ori-
gin screen displays the utwall message.
SRSS 4.3 Last change: 3
Sun Ray User Commands utwho(8)
NAME
utwho - Provide a compact summary of sessions and firmware
maintenance.
SYNOPSIS
/opt/SUNWut/sbin/utwho -c [ -a ] [ -H ]
DESCRIPTION
The utwho command is a script that assembles information
about display number, token, and logged-in user, and
displays that information in a compact format. It can also
display the IP address, Sun Ray model, and MAC address of a
Sun Ray that is connected to a given session.
OPTIONS
The following options are supported.
-c With utwho, show connected Sun Rays with the display
number, session token, logged in user, IP address,
Sun Ray model, and Sun Ray MAC address. The display
number is presented in the form d.m, where d is the X
display number of the session, and m is the index
within a multihead group of that particular Sun
Ray.The session token is the value of
$SUN_SUNRAY_TOKEN within a session. The model and MAC
address are output as PxB.MAC, where Px is the ending
part of the model type, e.g., P4, and MAC is the 6-
byte ethernet MAC address in hexadecimal format.
Without the -c option, the command displays only
session information, including the X display number,
token, and logged in user. In this mode, sessions
are displayed even if they don't have a Sun Ray con-
nected to them.
-a In combination with other options, this option con-
trols the selection of Sun Rays or sessions to
display. Without -a, only sessions that have logged in
users are displayed. With -a, all sessions or Sun Rays
are displayed, and those with no logged in user have a
user id field of "????".
-H Output column headings above the regular output.
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
SRSS 4.3 Last change: 1
Sun Ray User Commands utwho(8)
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuto |
|_____________________________|_____________________________|
SEE ALSO
utfwadm(1M), attributes(5)
SRSS 4.3 Last change: 2
Sun Ray Windows Connector Man Pages
Sun Ray Connector_2.4 1
Sun Ray User Commands uttsc(1)
NAME
uttsc - A Remote Desktop Services client for the Sun Ray
environment.
SYNOPSIS
uttsc [options] server
DESCRIPTION
uttsc is a Remote Desktop Protocol (RDP) client that enables
users to launch and use Windows applications from a Sun Ray
desktop.
OPTIONS
The following options are supported.
-a application
Launch the remote desktop with the specified applica-
tion.
-b Disable the desktop pulldown header in full-screen
mode. This option can only be used when full screen
mode (-m) is specified.
-c working folder
Needs -a provided as well. Applications specified with
-a launch from the folder specified with -c.
-d domain
Domain for authentication. Needs -u provided as well.
-e Timeout
Specify the timeout (in seconds) for establishing an
RDP session on the remote desktop server after the TCP
connection has been established (see -t). If this
value is not specified or Timeout is set to zero, no
timeout will be in force.
-g [+|-+|-]
Width and height specify size of Connector window. X
offset specifies distance of top left corner of Connec-
tor Window from left edge of screen if positive and
distance from right edge of screen if negative. Y
offset specifies distance of top left corner of Connec-
tor window from top edge of screen if positive and dis-
tance from right edge of screen if negative. The -g
option can not be provided together with the -m option.
-h Display complete usage of this command.
-i Read password from STDIN. It prompts for password with
echo off if STDIN is a TTY, otherwise no prompt is
displayed. This option can only be used when
Sun Ray Connector_2.4 Last change: 04/22/11 1
Sun Ray User Commands uttsc(1)
username option (-u) is specified and -p option is not
used.
-k keyboard
Specify the keyboard type to be used for the connec-
tion. The supported values for keyboard are sun(type6),
sun(type6jp) and sun(kr). The default keyboard is
"sun(type6)". All Sun and PC USB keyboards should be
supported by this default value, apart from Sun type6
Japanese, the Sun Korean keyboard and the PC Korean
keyboard. The sun(type6jp) value is used for the Sun
type6 Japanese keyboard. The sun(kr) value is used for
the Sun Korean keyboard and the PC Korean keyboard.
-l locale
Specify the locale to be used for the remote desktop
session. If this option is not specified, the LC_ALL or
the LANG environment variable values are used. If these
are not set, then "en-US" is the default locale.
Locales can be specified in the RFC1766 format, eg:
German is de-DE, Swiss French is fr-CH etc.
-m Enable fullscreen mode. This overrides the window
manager and causes the uttsc client window to fully
cover the current screen. It can not be provided
together with the -g option.
-n client name
Specify a name to be used for this client. The DTU mac
address is used as the default.
-O Deprecated. Same as -H nodisconnect.
-H action on hotdesking
-H nodisconnect
Hotdesking the Sun Ray session does not disconnect and
restart the RDP session. Previously the -O option.
-H reconnect
If the remote desktop server is configured in Device
Client Access License Mode, the remote desktop session
gets disconnected and reestablished when the Sun Ray
session gets moved to a different client. This is the
default mode.
-H autoreconnect
Hotdesking the Sun Ray session always updates the
client information on the remote desktop server.
Requires auto-reconnect.
-p Read password from controlling TTY. It prompts for
Sun Ray Connector_2.4 Last change: 04/22/11 2
Sun Ray User Commands uttsc(1)
password with echo off. This option can only be used
when username option (-u) is specified and -i option is
not used.
-r device
Allow device redirection of specified device on the
client for access on the server. The devices currently
allowed are :
-r comport:=,...
Redirects serial devices on your client to the server.
-r disk:=,...
Redirects a path to the share \\tsclient\
on the server.
-r printer:[=],...
Redirects a printer queue on the client to the server.
The is the name of the queue in your
local system. defaults to a simple postscript
driver unless you specify one. The first printer on the
command line will be set as your default printer. If
the driver name has white spaces, it must be quoted.
-r sound:[low|high|off|remote]
Disable sound output redirection from the server to the
client, or change the quality of transmitted sound, or
allow the sound output to play on remote host. The
sound output quality can be specified in terms of bits
per second: A "low" quality transmits at 8kHz and a
"high" quality at 22.05 kHz or higher. By default,
High quality sound output is enabled and plays locally.
-r soundin:[low|medium|high|off]
Enable sound input redirection from the client to the
server and select the quality of transmitted sound. A
"low" quality transmits at a maximum 8kHz, "medium" at
up to 22.05kHz and "high" at the highest available sam-
ple rate. By default, sound input redirection is dis-
abled.
-r scard:on
Enable Smart Card redirection from client to the
server. By default, Smart Card redirection is dis-
abled.
-s Connects to the console session of a server.
-t Timeout
Specify the TCP connection timeout (in seconds) for
establishing a connection to the remote desktop server.
If this value is not specified or the Timeout value is
Sun Ray Connector_2.4 Last change: 04/22/11 3
Sun Ray User Commands uttsc(1)
set to zero, the system default value for the TCP con-
nection timeout period will be used.
-u username
Username to use for authentication on the server.
-v Display version information of the uttsc command line.
It can not be provided together with any other option.
-w windowid
Embed uttsc window in another window. The windowid can
be decimal or hexadecimal (prefixed by 0x).
-x XDisplay
Specify the X display to launch the session on. The
DISPLAY environment variable is used to determine the
display when this option is not used.
-z Disable RDP packet data compression. This is enabled by
default.
-A color depth
Sets the colour depth for the connection (8, 15, 16, 24
or 32). The colour depth may be limited by the server
configuration in which case the server configuration is
honored.
-C Use shared colourmap. By default, private colormap is
used.
-D Disables the Video and Adobe Flash Acceleration path
for Windows 7 and Windows 2008 R2.
-E window-attribute
Enable window attributes from the defined set. The
available set of options which can be enabled are :
wallpaper, fullwindowdrag, menuanimations, theming,
cursorshadow, cursorsettings, fontsmoothing. Keeping
these attributes disabled improves display performance
especially over lower bandwidth networks. Multiple -E
options can be specified for more than one attribute if
required.
-K Handle shortcuts in the local computer desktop session.
If not specified then shortcuts are handled in the
remote desktop session. This option cannot be used in
full screen mode.
-P port
Specify the port over which to connect to RDP. The
default port is 3389.
Sun Ray Connector_2.4 Last change: 04/22/11 4
Sun Ray User Commands uttsc(1)
-S Timeout
Specify the TCP connection socket keep alive interval
(in seconds) for the connection to the remote desktop
server. If this value is not specified or the Timeout
value is set to zero, the system default value for the
TCP keep alive interval period will be used.
-T window title
Set the title on the client window. This option cannot
be used when -b is specified in full screen mode.
-M [off|all|xvideo|xvenc]
Specify which accelerated media paths to use (supported
only with Windows XP and Windows 2003).
off - Disable all accelerated media paths. Media will
be rendered through the RDP protocol.
all - Enable all accelerated media paths. This is the
default value.
xvideo - Enable the Xvideo extension usage for
accelerated YUV support.
xvenc - Enable the XvEnc extension usage for
accelerated H.264/VC-1 support.
-R
Adjust the TCP receiver buffer size in bytes. Default
value is 8192 bytes. Decreasing the TCP receiver
buffer size increases desktop responsiveness during
large desktop updates. 8192 is the optimal value for
these scenarios.
-X [:]
Specify which multi-monitor enumeration methods should
be used to inform the RDP server of available monitors.
xinerama - Enumerate monitors using the Xinerama exten-
sion.
xrandr - Enumerate monitors using the Xrandr extension.
off - Disable multi-monitor enumeration.
If this option is not specified, multi-monitor enumera-
tion is enabled, and the Xinerama extension is used to
enumerate monitors.
-U retries
Specify the number of attempts to automatically recon-
nect to a remote desktop server when a network
Sun Ray Connector_2.4 Last change: 04/22/11 5
Sun Ray User Commands uttsc(1)
connection fails (default: 6). Reconnection attempts
will be made on an exponential back-off timer. The
remote desktop service must support auto-reconnect. A
value of 0 prevents any attempt to automatically recon-
nect. The -S option may also be required to detect net-
work failure.
-F off|x11|xvideo|all|keep
Specify which flash acceleration paths to use and
allows to set the flash state to it's initial state
when session is disconnected. The following paths are
supported (from fastest to slowest): XvEnc, Xvideo,
X11. At any given time the X server can support a set
number of concurrent Xvideo or Xvenc acceleration
paths. With the 'keep' value provided, flash accelera-
tion keeps the selected acceleration path when the Sun
Ray session is disconnected. Without 'keep' it falls
back to non-accelerated rendering over the RDP proto-
col.
off - Disable all flash acceleration paths. Flash is
rendered through the RDP protocol.
x11 - Enable flash acceleration through the X11 API.
xvideo - Enable flash acceleration through the Xvideo
extension. If the number of accelerated flash (flash
displayed in the supported browsers) exceeds the number
of Xvideo accelerated paths supported by the X server
then render the largest flash through Xvideo (up to the
X server limit) and render the rest through X11.
all - Enable all flash acceleration paths. If the
number of accelerated flash (flash displayed in the
supported browsers) exceeds the number of XvEnc
accelerated paths supported by the X server then render
the largest flash through XvEnc (up to the X server
limit) and render the rest through X11. This is the
default behavior.
keep - Keep flash acceleration to use the selected
acceleration path when the Sun Ray session is discon-
nected. This option can be used along with other Flash
options. This option can be combined along with another
option by comma-separating them for example -F
xvideo,keep.
-N on|off
Enable or disable enhanced network security (default:
on)
Sun Ray Connector_2.4 Last change: 04/22/11 6
Sun Ray User Commands uttsc(1)
on - If supported by the remote desktop service, con-
nections will use TLS or CredSSP. Otherwise they will
use RDP Security.
off - RDP Security will be used.
-j VerifyPeer:[on|off],...
Enable or disable SSL peer verification (default:off)
-j CAfile:,...
Specify a PEM file containing certificates of trusted
certification authorities (CA). Only peer certificates
signed by one of the authorities in the default openssl
cert store, this file or the direcory specified by a
CApath option argument will be accepted if peer verifi-
cation is enabled.
-j CApath:,...
Specify a directory containing certificates of trusted
certification authorities (CA). Only peer certificates
signed by one of the authorities in the default openssl
cert store, this directory or a PEM file specified by a
CAfile option argument will be accepted if peer verifi-
cation is enabled.
Options taking values except -F, -E and -j can not be pro-
vided multiple times.
TIMEOUT INTERVALS
The "-t Timeout", "-e Timeout", "-S Timeout" options
severally and conjunctively control the lifetime of the con-
nection to the remote desktop server in all its aspects:
"-t Timeout" controls the maximum delay in opening the ini-
tial TCP connection
"-e Timeout" controls the maximum delay in establishing the
RDP session once the TCP connection is open
"-S Timeout" controls the maximum period of unresponsiveness
for the TCP connection
This last option, which configures the TCP keep alive inter-
val, is platform dependent in implementation, and on Linux
platforms may result in a keep alive period in the range
Sun Ray Connector_2.4 Last change: 04/22/11 7
Sun Ray User Commands uttsc(1)
(timeout, timeout + 10 seconds), depending upon when the
channel first becomes quiescent. On Solaris platforms, the
range is (timeout, timeout + 1 second).
EXAMPLES
1. An example to redirect a printer named "printer1" which
uses the hp deskjet 990c driver, to a Windows session on say
winserver1 :
% uttsc -u user1 -r printer:printer1="hp deskjet 990c" win-
server1
EXIT STATUS
0 if operation performed successfully, 1 if error found
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
tab(!) box; cw(2.750000i)| cw(2.750000i) lw(2.750000i)|
lw(2.750000i). Attribute Type ! Attribute Value Availabil-
ity ! SUNWuttsc
SEE ALSO
uttscadm(8), uttscprinteradm(8), utlicenseadm(8)
Sun Ray Connector_2.4 Last change: 04/22/11 8
Sun Ray Administration Commands uninstaller(8)
NAME
uninstaller - Removes Sun Ray Connector software.
SYNOPSIS
uninstaller [-a admin]
DESCRIPTION
uninstaller removes the Sun Ray Connector 2.4 software from
the system.
OPTIONS
The following options are supported.
-a admin
An alternate admin(5) file can be specified with
admin. Solaris only option.
FILES
/opt/SUNWuttsc/etc/admin_default is the default admin file.
EXIT STATUS
0 if operation performed successfully, 1 if error found
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuttsc |
|_____________________________|_____________________________|
SEE ALSO
Sun Ray Connector_2.4 Last change: 04/22/11 1
Sun Ray Administration Commands uttscadm(8)
NAME
uttscadm - Sun Ray Connector for Windows Configuration util-
ity
SYNOPSIS
uttscadm -c -g groupname | -u | -r | -h
DESCRIPTION
uttscadm is a deprecated utility used to configure the Sun
Ray Connector for Windows.
Please use /opt/SUNWut/sbin/utconfig -c to configure the
same.
uttscadm must be run with root permissions after installa-
tion to prepare the system to launch the Connector.
OPTIONS
The following options are supported.
-c This option configures the system to launch the Connec-
tor. It creates the required SRDS schema to store the
printer configurations. It also prompts the adminis-
trator for the path to the OpenSSL library location, if
required. A groupname must be specified during confi-
guration using the -g option.
On Solaris, it also creates the required entries in the
/etc/services file for the Sun Ray Connector Proxy dae-
mon, and thereafter launches it.
-u This option is used to unconfigure the changes created
during configuration, before removing the Connector.
-g Specify the groupname to be assigned to the Windows
Connector and Proxy daemon binaries. This option can
only be used at configuration time. The groupname
should be a valid existing groupname which is used only
for this purpose, as it controls what processes can
connect to the proxy daemon.
-r Run uttscadm to update the Windows Connector and Proxy
daemon binary locations to their runtime locations
after they have been updated on the system, say after a
patch install. This option must not be used if the
server has not previously been configured using the -c
option.
-h Displays command usage information
Sun Ray Connector_2.4 Last change: 04/22/11 1
Sun Ray Administration Commands uttscadm(8)
EXIT STATUS
0 if operation performed successfully, 1 if error found
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuttsc |
|_____________________________|_____________________________|
SEE ALSO
uttsc(1)
Sun Ray Connector_2.4 Last change: 04/22/11 2
Sun Ray Administration Commands uttscprinteradm(8)
NAME
uttscprinteradm - uttsc printer cache administration tool
SYNOPSIS
uttscprinteradm -h
uttscprinteradm -l [username]
uttscprinteradm -d username [printer]
DESCRIPTION
The uttscprinteradm command is a utility to administer users
and printers in the uttsc printer configuration cache. The
cache is used to automatically preserve printer configura-
tion changes done by users to printers provided on the uttsc
command line during subsequent connections to Windows
servers through uttsc.
Separate printer configuration entries are stored for every
Windows user/printer combination.
Configuration entries of the same printer using different
Windows drivers are not compatible with each other. If a
printer is redirected with a new driver none of the confi-
guration saved with the previous driver will be restored. If
the configuration is changed while the printer is redirected
with the new driver the new configuration will automatically
overwrite the old configuration.
OPTIONS
The following options are supported.
-h Display usage information.
-l [username]
List printers of all users if no user specified or list
printers of the specified user.
-d username [printer]
Delete specified printer of the specified user or (if
no printer specified) delete user and all printers of
user.
EXIT STATUS
0 if operation performed successfully, 1 if error found
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
Sun Ray Connector_2.4 Last change: 04/22/11 1
Sun Ray Administration Commands uttscprinteradm(8)
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuttsc |
|_____________________________|_____________________________|
SEE ALSO
uttsc(1)
Sun Ray Connector_2.4 Last change: 04/22/11 2
Sun Ray Administration Commands uttscrestart(8)
NAME
uttscrestart - Sun Ray Windows Connector utility for res-
tarting service.
SYNOPSIS
uttscrestart
DESCRIPTION
The uttscrestart command is used for restarting the Sun Ray
Windows Connector daemon process. Existing Sun Ray Connector
sessions will not be affected by the restart.
uttscrestart can only be run by the super-user.
OPTIONS
There are no options to this command.
EXAMPLES
Example 1: This starts the service if it is not running, or
restarts it if it is already running.
# uttscrestart
EXIT STATUS
0 if operation performed successfully, 1 if error found
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWuttsc |
|_____________________________|_____________________________|
SEE ALSO
uttsc(1)
Sun Ray Connector_2.4 Last change: 04/22/11 1
Sun Ray Kiosk Man Pages
Kiosk Session Service Commands kioskdesc(1)
NAME
kioskdesc - list or print contents of Kiosk Session Service
descriptors and application lists
SYNOPSIS
/opt/SUNWkio/bin/kioskdesc list -a|-A|-s [name]
/opt/SUNWkio/bin/kioskdesc print {-a|-A|-s} name
/opt/SUNWkio/bin/kioskdesc help
/opt/SUNWkio/bin/kioskdesc -h
DESCRIPTION
kioscdesc may be used to list available Kiosk Session Ser-
vice descriptors and application lists.
SUBCOMMANDS
The following subcommands are supported:
list List available Kiosk Session Service descriptors and
application lists or test for the existence of a named
descriptor or application list. If no name is pro-
vided, a list of names is printed, which enumerates
all available Kiosk Session Service descriptors or
application lists. If name is provided, kioskdesc
tests for the existence of the named Kiosk Session
Service descriptor or application list. If the
descriptor or application list exists, the full path
to the descriptor or application list file is
printed.
print Print the contents of the Kiosk Session Service
descriptor or application list named name.
help Prints a help message.
OPTIONS
The following options are supported:
-a The list or print subcommand is applied to Kiosk Ses-
sion Service application descriptors.
-A The list or print subcommand is applied to Kiosk Ses-
sion Service application lists.
-s The list or print subcommand is applied to Kiosk Ses-
sion Service session descriptors.
-h Prints a usage message.
Kiosk 4.3 Last change: 1
Kiosk Session Service Commands kioskdesc(1)
OPERANDS
The following operands are supported:
name The name of a Kiosk Session Service descriptor to be
listed or whose contents should be printed. name may
be a full path to a descriptor or application list or
a well-known name used to search predefined locations
for descriptors or application lists. For more details
on the use of well-known names to locate descriptors
and applications lists, see kiosk(8).
EXAMPLES
Example 1: Listing available descriptors
You may use the list subcommand to list all available ses-
sion descriptors as follows.
kiosk% kioskdesc list -s
jds3
uttsc
kiosk%
Similarly, use the list subcommand to list all available
application descriptors as follows.
kiosk% kioskdesc list -a
browser
calculator
charmap
editor
imageviewer
messenger
sun_webstart
kiosk%
Example 2: Testing for the existence of a descriptor
You may use the list subcommand as follows to check if a
given session descriptor exists.
kiosk% kioskdesc list -s jds3
/etc/opt/SUNWkio/sessions/jds3.conf
kiosk%
Similarly, use the list subcommand as follows to check if a
given application descriptor exists.
kiosk% kioskdesc list -a browser
/etc/opt/SUNWkio/applications/browser.conf
kiosk%
Kiosk 4.3 Last change: 2
Kiosk Session Service Commands kioskdesc(1)
Example 3: Printing the contents of a descriptor
You may use the print subcommand as follows to print the
contents of a given session descriptor.
kiosk% kioskdesc print -s uttsc
KIOSK_SESSION_ARGS=-t 1800 -- -m -b
KIOSK_SESSION_DESCRIPTION=A full screen Sun Ray Windows Connector session.
KIOSK_SESSION_EXEC=/etc/opt/SUNWkio/sessions/uttsc/uttsc
KIOSK_SESSION_ICON=
KIOSK_SESSION_LABEL=Sun Ray Connector for Microsoft Windows OS
kiosk%
Similarly, use the print subcommand as follows to print the
contents of a given application descriptor.
kiosk% kioskdesc print -a sun_webstart
KIOSK_APP_DESCRIPTION=Java Web Start
KIOSK_APP_EXEC=/usr/java/jre/javaws/javaws
KIOSK_APP_ICON=/usr/java/jre/plugin/desktop/sun_java.png
KIOSK_APP_LABEL=Java Web Start
KIOSK_APP_POST=
KIOSK_APP_PRE=
KIOSK_APP_PROTOTYPE=
kiosk%
EXIT STATUS
The following exit values are returned.
0 Success
1 Failure
ATTRIBUTES
See attributes(8) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWkio |
| Interface Stability | Uncommitted |
|_____________________________|_____________________________|
SEE ALSO
kiosk(8)
Kiosk 4.3 Last change: 3
Kiosk Session Service Commands kioskparam(1)
NAME
kioskparam - inspect Kiosk session parameters
SYNOPSIS
/opt/SUNWkio/bin/kioskparam [-xkS] [-E env-prefix] [-e env-
var[,...]] [-u user|-d display|-s display|-f file] [pattern
...]
/opt/SUNWkio/bin/kioskparam -h
DESCRIPTION
kioskparam is used to evaluate and view effective Kiosk ses-
sion configuration for a given kiosk session or
session.conf(5) file. The effective configuration is the
result of combining settings from the session.conf(5) file
and the session descriptor for the session to which it
points. Parameter substitutions within the configuration are
resolved as far as possible. For a full description of
Kiosk session configuration see kiosk(8).
kioskparam can evaluate the effective configuration for a
currently active kiosk session identified by a kiosk user
account or X11 display name, configuration statically stored
for a display using kioskconfig(8) or a standalone
session.conf(5) file.
OPTIONS
The -u, -d, -s and -f options can be used to select the ses-
sion configuration to evaluate. At most one of these option
can be specified. By default kioskparam evaluates configura-
tion for the kiosk session from which it is called, as if
invoked with -u $USER.
-u user
Evaluates configuration for the currently active ses-
sion running under the specified kiosk user account.
-d display
Evaluates configuration for the currently active kiosk
session running on the specified X11 display.
-s display
Evaluates configuration configured using kioskcon-
fig(8) for the specified X11 display.
-f file
Evaluates configuration from the specified
session.conf(5) file.
The following further options are supported:
-k Print only the value for the selected configuration
Kiosk 4.3 Last change: 1
Kiosk Session Service Commands kioskparam(1)
key(s). The default is to print key=value pairs.
-x Escape or quote the key=value output, so that the
result can safely be evaluated by a shell as a series
of shell variable assignments.
-e env-var
Import the specified environment variable as a key
with its value into the evaluation process. Multiple
environment variables may be specified by separating
their names with commas or by providing this option
multiple times.
-E env-prefix
Enable use of environment variables starting with the
specified prefix in expanding parameters as part of
the evaluation process. Only a single prefix can be
used. The default, if no prefix is specified expli-
citly, is to honor all variables starting with KIOSK_.
-S Set up and import a standard set of environment vari-
ables: USER, DISPLAY and HOME. If configuration for an
active session is being evaluated (-u or -d), the
values for these variables are set to the user name,
display and associated home directory for this ses-
sion. If -s is used, DISPLAY is set to match the
specified display. Other values are taken from the
current environment. If all the values are available
or can be inferred, this option implies -e
USER,DISPLAY,HOME.
-q Quiet mode. Don't print error messages or warnings.
-h Show a help message.
OPERANDS
pattern
One or more pattern can be specified to select the
keys whose values are to be printed. A pattern may
either be a plain key name, which selects that key
exactly or a key name prefix followed by * as a wild-
card to select all keys starting with that prefix.
Multiple patterns can be specified. If no pattern is
specified, all keys are selected.
EXIT STATUS
The following exit values are returned.
0 Success
1 Failure
Kiosk 4.3 Last change: 2
Kiosk Session Service Commands kioskparam(1)
ATTRIBUTES
See attributes(8) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWkio |
| Interface Stability | Uncommitted |
|_____________________________|_____________________________|
SEE ALSO
kioskconfig(8), kiosk(8), session.conf(5)
Kiosk 4.3 Last change: 3
Kiosk Session Service Commands kioskstatus(1)
NAME
kioskstatus - indicate the current Kiosk Session Service
status for a given display or user.
SYNOPSIS
/opt/SUNWkio/bin/kioskstatus [-hqx]
/opt/SUNWkio/bin/kioskstatus -d [-qx] [display ...]
/opt/SUNWkio/bin/kioskstatus -u [-q] [username ...]
/opt/SUNWkio/bin/kioskstatus -c [-q]
/opt/SUNWkio/bin/kioskstatus -h
DESCRIPTION
The kioskstatus utility may be used to query whether Kiosk
mode is active in a system session and the overall confi-
guration status of Kiosk Session Service.
The first three forms of the kioskstatus command indicate
whether or not a given X11 display or user account is
currently running a valid Kiosk session. The fourth form of
kioskstatus indicates whether Kiosk Session Service is con-
figured, so that kiosk sessions can be started.
Without any options, kioskstatus will report whether or not
the current session (identified by the current value of
$DISPLAY) is a valid Kiosk session. In addition to checking
the status for the session allocated to the current display,
it is also verified that this session is allocated to the
current user's login name, as reported by logname(1).
kioskstatus may be used to check sessions on other displays
by specifying the -d option. No user identity check is per-
formed in this case. If no display is specified, the current
session (identified by the current value of $DISPLAY) is
checked.
The kiosk status of a session can be determined by inspect-
ing a marker property set on the X11 root window or by
querying the kiosk user account allocation data maintained
by Kiosk Session Services. By default session status is
determined using kiosk user account allocation queries. The
-x option may be used to perform an X property query
instead. Generally the X property query more accurately
reflects the state of an active kiosk session, but such a
query requires authorization to connect to the X server for
the inspected session and may hang, if the X server is
currently grabbed, for example by a display manager showing
a login greeter.
Kiosk 4.3 Last change: 1
Kiosk Session Service Commands kioskstatus(1)
Alternatively, kioskstatus can determine whether specified
user accounts are currently assigned to an active kiosk ses-
sion by specifying the -u option. If no username is speci-
fied, the current user's login name, as reported by getlog-
name(1), is checked.
kioskstatus may also be used to check whether Kiosk Session
Service configuration is complete, so that kiosk sessions
can be started. It is checked that kiosk user accounts are
configured. You can configure kiosk user accounts using the
kioskuseradm(8) tool.
The last form of kioskstatus displays a short help message.
OPTIONS
The following options are supported.
-c Query whether Kiosk Session Service is configured.
-d Query kiosk status for the specified displays or for
the current X display.
-u Query kiosk status for the specified user accounts or
for the current user.
-x Read the kiosk status from the X server for the
display(s). This option requires authorization to con-
nect to the X server for the session. The X server
access may hang, if the X server is grabbed.
-q Quiet mode. Indicates that the status should not be
printed to standard output. This option is most useful
for scripting.
-h Displays a short help message.
EXAMPLES
Example 1: Querying users' Kiosk status
Given a Kiosk user, ku1000, who is currently running a Kiosk
session, a Kiosk user ku1001, who is not currently running a
Kiosk session and a non Kiosk user user1002, using
kioskstatus to query their status will produce the following
output.
kiosk% kioskstatus -u ku1000 ku1001 user1002
ku1000: active
ku1001: not active
user1002: not a kiosk account
kiosk%
Example 2: Querying a display's Kiosk status
Kiosk 4.3 Last change: 2
Kiosk Session Service Commands kioskstatus(1)
Given a display, :2, which is currently running a Kiosk ses-
sion and a display, :3, which is not currently running a
Kiosk session, using kioskstatus to query their Kiosk sta-
tuses will produce the following output.
kiosk% kioskstatus -d :2 :3
:2: active
:3: not active
kiosk%
Assuming the current user has access to both X servers,
using kioskstatus to query the X servers for their Kiosk
status will produce the following output.
kiosk% kioskstatus -dx :2 :3
:2: running
:3: disabled
kiosk%
EXIT STATUS
The following exit values are returned:
0 If the -c option is used, an exit status of 0 indi-
cates that Kiosk Session Service is configured. Other-
wise an exit status of 0 indicates that a Kiosk ses-
sion is active for all specified displays or user-
names.
1 If the -c option is used, an exit status of 1 indi-
cates that the Kiosk Session Service is not config-
ured. Otherwise an exit status of 1 indicates that
there is no active Kiosk session for at least one of
the specified displays or usernames.
2 An exit status of 2 indicates that determining the
status of Kiosk Session Service configuration or of at
least one of the specified displays or usernames
failed due to an error.
ATTRIBUTES
See attributes(8) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWkio |
| Interface Stability | Uncommitted |
|_____________________________|_____________________________|
SEE ALSO
Kiosk 4.3 Last change: 3
Kiosk Session Service Commands kioskstatus(1)
kiosk(8)
Kiosk 4.3 Last change: 4
Kiosk Session Service File Formats session.conf(5)
NAME
session.conf - Kiosk Session Service session configuration
file.
SYNOPSIS
/etc/opt/SUNWkio/session.conf
DESCRIPTION
session.conf is the default configuration input file for
kioskconfig(8). The contents of session.conf indicate, at a
minimum, which Kiosk session should be used for Kiosk
enabled displays. Other Kiosk session properties configuring
resource limitations, session arguments etc. may also be
specified in session.conf. Kiosk session properties speci-
fied in session.conf override properties set in the associ-
ated Kiosk session descriptor.
The format of session.conf is similar to a restricted bourne
shell file. The file contains a list of KEY=VALUE assign-
ments. Values may contain variable references in the form
$VARIABLE or ${VARIABLE}. Such variable references are
expanded by substituting a value from a previous assignment
to VARIABLE or from one of the predefined variables
enumerated below. Nested or repeated substitution is not
supported. A literal dollar sign ('$') in the value may be
obtained by preceding it with a backslash ('\'). A literal
backslash may be escaped with an extra backslash. A
backslash that is followed neither by a backslash nor by a
dollar sign has no special meaning. If the VALUE part of the
assignment is surrounded by quotes ("..." or '...'), such
quotes are removed to determine the value. Quote removal is
not applied, if the quote character reoccurs inside the
VALUE. Quoting has no effect on expansion of variables or
backslash escaping.
Kiosk session properties are defined by assigning values to
variables. The following is a list of the environment vari-
ables which may be used to configure your preferred Kiosk
session. With the exception of KIOSK_SESSION, all environ-
ment variables are optional. Unless otherwise stated, no
default values are applied.
KIOSK_ENABLED
Indicates whether or not Kiosk should be enabled.
Valid values are yes or no indicating that Kiosk is
enabled or disabled respectively. The default value is
no.
KIOSK_SESSION
Identifies which Kiosk session should be used. You
may specify either the well-known name of or absolute
path to a Kiosk Session Descriptor here. For more
Kiosk 4.3 Last change: 1
Kiosk Session Service File Formats session.conf(5)
details on Kiosk Session Descriptors and the use of
well-known names to locate them, see kiosk(8).
KIOSK_SESSION_APPLAUNCHER
Identifies the absolute path to a Kiosk session
specific executable used to launch applications added
to the session.
KIOSK_SESSION_APPLIST
Identifies a Kiosk Session Application List to be
used. You may specify either the well-known name of
or absolute path to a Kiosk session application list.
For more details on Kiosk Session Application Lists
and the use of well-known names to locate them, see
kiosk(8).
KIOSK_SESSION_ARGS
Identifies the command line arguments to be passed to
the Kiosk session executable when the session is
launched.
KIOSK_SESSION_DIR
Identifies a directory reserved for use by the Kiosk
session.
KIOSK_SESSION_ENV
Specifies a space-separated list of Kiosk session pro-
perties which should be exported into the kiosk ses-
sion as environment variables.
KIOSK_SESSION_EXEC
Identifies the absolute path to the Kiosk session exe-
cutable.
KIOSK_SESSION_ICON
Identifies an icon that can be used to represent the
session in an administration tool.
KIOSK_SESSION_LABEL
Identifies a label that can be used to represent the
session in an administration tool.
KIOSK_SESSION_LOCALE
Identifies the locale to be used by the Kiosk session.
The default value is the default system locale.
KIOSK_SESSION_LIMIT_CPU
Identifies the maximum cpu usage (in seconds) per pro-
cess for the Kiosk session. The default value is the
default system limit. For more details, see ulimit(1).
KIOSK_SESSION_LIMIT_DESCRIPTORS
Kiosk 4.3 Last change: 2
Kiosk Session Service File Formats session.conf(5)
Identifies the maximum number of open file descriptors
per process for the Kiosk session. The default value
is the default system limit. For more details, see
ulimit(1).
KIOSK_SESSION_LIMIT_FILESIZE
Identifies the maximum file size (512 byte blocks) for
the Kiosk session. The default value is the default
system limit. For more details, see ulimit(1).
KIOSK_SESSION_LIMIT_VMSIZE
Identifies the maximum swap size (in KB) per process
for the Kiosk session. The default value is the
default system limit. For more details, see ulimit(1).
KIOSK_SESSION_POST
Identifies the absolute path to an executable which
will be executed immediately after the Kiosk session
executable (KIOSK_SESSION_EXEC) terminates.
KIOSK_SESSION_PRE
Identifies the absolute path to an executable which
will be executed immediately before the Kiosk session
executable (KIOSK_SESSION_EXEC) starts.
KIOSK_SESSION_PROTOTYPE
Identifies a Kiosk Session Prototype which should be
applied to the Kiosk user's home directory before
launching the Kiosk session. You may specify either
the well-known name of or absolute path to a Kiosk
Session Prototype here. For more details on Kiosk Ses-
sion Prototypes and the use of well-known names to
locate them, see kiosk(8).
The following is a list of variables that can be referenced
inside the session configuration (see kiosk(8) for more
information):
KIOSK_CONFIG_DIR
The directory where kiosk configuration is stored,
usually /etc/opt/SUNWkio.
KIOSK_SESSIONS_DIR
The directory where kiosk session configuration is
stored, usually /etc/opt/SUNWkio/sessions.
KIOSK_APPS_DIR
The directory where kiosk application configuration is
stored, usually /etc/opt/SUNWkio/applications.
KIOSK_PROTOS_DIR
The directory where kiosk session or application
Kiosk 4.3 Last change: 3
Kiosk Session Service File Formats session.conf(5)
prototypes are stored, usually
/etc/opt/SUNWkio/prototypes.
ATTRIBUTES
See attributes(8) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWkio |
| Interface Stability | Committed |
|_____________________________|_____________________________|
SEE ALSO
kiosk(8), kioskparam(1), kioskconfig(8), ulimit(1)
Kiosk 4.3 Last change: 4
Kiosk Session Service kiosk(8)
NAME
kiosk - Kiosk Session Service.
DESCRIPTION
The Kiosk Session Service provides an infrastructure which
can be used to support unauthenticated access to an applica-
tion environment in a controlled manner. Unauthenticated
access is useful in scenarios where users cannot be expected
to provide authentication credentials ( e.g. public kiosks
etc. ) and in scenarios where authentication is expected to
be carried out by an application other than the standard
login application e.g. Sun Ray Windows Connector.
Kiosk Session Service Overview
The Kiosk Session Service can be described in terms of a
number of high level concepts/elements.
Kiosk Session Service User Pool
The Kiosk Session Service maintains a pool of user accounts
dedicated specifically to the running of Kiosk sessions.
These accounts have the following characteristics.
o They are locked for normal login.
o They belong to a local unix group that has minimal
rights on the system.
o No two sessions use the same Kiosk user account at the
same time. The Kiosk Session Service User Pool may be
configured using kioskuseradm(8).
Kiosk Session Service Prototypes
Kiosk prototypes are directories whose contents are copied
to Kiosk users' home directories. Three specific types of
prototypes exist. These are:
o user prototypes:
These are prototypes which are copied to Kiosk users'
home directories prior to every invocation of a Kiosk
session and independent of the specific session to be
launched.
o session prototypes:
These are prototypes associated with a specific Kiosk
session which are copied to Kiosk users' home direc-
tories prior to invocation of that session.
o application prototypes:
These are prototypes associated with a specific Kiosk
application. When and how these prototypes are copied
to Kiosk users' home directories is a Kiosk session
specific matter and will vary from session to session.
Kiosk 4.3 Last change: 1
Kiosk Session Service kiosk(8)
Kiosk Session Service Sessions and Applications
Kiosk sessions consist of a Kiosk Primary Session and
optional added Kiosk Applications.
Every Kiosk Primary Session is defined by a Kiosk Session
Descriptor. A Kiosk Session Descriptor defines, at a
minimum, a session executable which will be launched as the
user session. Kiosk Session Descriptors may also define
other session specific properties such as a session proto-
type, pre and post execution scripts and a list of added
Kiosk Applications.
Kiosk Application Descriptors are used to define Kiosk
applications which may be added to a Kiosk Primary Session.
Similar to session descriptors, a Kiosk Application Descrip-
tor defines, at a minimum, an application executable which
will be launched when the associated application is invoked.
Kiosk Application Descriptors may also define other applica-
tion specific properties such as an application prototype
and pre and post execution scripts.
Not all Kiosk Primary Sessions will support the ability to
add Kiosk Applications. For example, while it is reasonable
for a Kiosk JDS session to support the ability to launch
additional Kiosk Applications, it may make no sense for a
Kiosk Full Screen Browser session to have this capability.
Kiosk Primary Sessions which support added Kiosk Applica-
tions must define an "application launcher" identified by
the KIOSK_SESSION_APPLAUNCHER property in the associated
Kiosk Session Descriptor. This application launcher will be
invoked by the Kiosk Session Service while processing the
list of added applications and is responsible for launching
applications in a session specific manner.
Note: Kiosk Session and Application Descriptors are not
delivered as part of the Kiosk Session Service but are pro-
vided independently by Kiosk Session authors. Each Kiosk
Session provided in this way should clearly document its
operation, configuration etc.
Kiosk Session Service Configuration
There are a number of different types of configuration
relevant to the Kiosk Session Service.
Kiosk Session Service Framework Configuration
The Kiosk core libraries and utilities use the Kiosk
Session Service Framework Configuration to identify
locations of various files and directories needed for
correct operation of the Kiosk Session Service. The
Kiosk Session Service Framework Configuration is
available in /etc/opt/SUNWkio/kioskrc.
Kiosk 4.3 Last change: 2
Kiosk Session Service kiosk(8)
Kiosk Session Service User Configuration
Kiosk Session Service User Account Configuration is
used to configure the Kiosk Session Service user
account pool and the Kiosk Session Service user
accounts maintained within that pool. This configura-
tion may be managed using the kioskuseradm(8) utility.
Kiosk Session Service Policy
Kiosk Session Service Policy indicates whether or not
the Kiosk Session Service should be active for a given
display. Kiosk Policy is a subset of Kiosk Session
Service Session Configuration. For more information
see kioskconfig(8) and session.conf(5).
Kiosk Session Service Session Configuration
Kiosk Session Service Session Configuration is used to
identify per display Kiosk Session information includ-
ing Kiosk Session Service Policy, Kiosk Session
Descriptor, various session properties used to control
resource limitations etc. For more information see
kioskconfig(8) and session.conf(5).
Kiosk Session Service Application Lists
The list of applications which should be added to a Kiosk
session are collected together in a Kiosk Session Service
Application List File. The location of an Application List
File to be used by a given Kiosk Session is identified using
the KIOSK_SESSION_APPLIST setting in the associated Kiosk
Session Service Session Configuration. The format of a Kiosk
Session Service Application List is a newline separated
list of application entries, each entry having the form
exec|desc:app-name:start-mode;[arg1,arg2...argn]
where
o exec|desc indicates whether the subsequent app-name
refers to an executable or an application descriptor.
o app-name is an absolute path or a name indicating an
application executable or an application descriptor.
o start-mode indicates how the application should/can be
started. Valid values are:
o auto: the application is started automatically.
o critical: the application is started automatically
and registered as critical.
o user: the application may be started by the user.
Kiosk 4.3 Last change: 3
Kiosk Session Service kiosk(8)
o arg1,arg2...argn are the command line arguments to be
passed to the application executable.
Enabling and Configuring Kiosk Session Service
Enabling Kiosk sessions on your host is a simple three step
procedure.
o Configure the pam(3PAM) stack for your login manager.
See pam_kiosk(5) for details on how to do this.
o Configure the Kiosk Session Service user account pool
using the kioskuseradm(8) utility.
o Configure your preferred Kiosk session using the
kioskconfig(8) utility.
Locating Prototypes, Descriptors and Application Lists
Prototypes, descriptors and applications lists may be iden-
tified either by an absolute path or a well-known name. When
a well-known name is used to identify any of these objects,
the Kiosk Session Service will search a number of predefined
locations when trying to locate the object. The search path
used depends on the type of object being searched for and is
summarised as follows.
Note: the KIOSK_* environment variables mentioned below are
specified and may be configured in the Kiosk Session Service
Framework Configuration as described above.
o prototypes:
prototypes are searched for using
$KIOSK_PROTOS_DIR/
o descriptors:
session descriptors are searched for using
$KIOSK_SESSIONS_DIR/.conf
application descriptors are searched for using
$KIOSK_APPS_DIR/.conf
o application lists:
application lists are searched for using
$KIOSK_APPS_DIR/.list
ISSUES
gdm(1) and the gdm greeter
The gdm login manager will invoke its configured greeter
regardless of whether or not authentication credentials are
needed. In the case of a Kiosk session, a greeter is neither
needed nor desired. In some instances, the greeter may
become temporarily visible during the initialisation of
Kiosk sessions. As a workaround for this, an alternative
Kiosk 4.3 Last change: 4
Kiosk Session Service kiosk(8)
greeter, /opt/SUNWkio/lib/gdm/kioskgreeter is supplied with
the Kiosk Session Service. kioskgreeter depends on non pub-
lic interfaces of gdm and, as such, is supplied unsupported
and initially unconfigured. To configure kioskgreeter you
should edit your gdm configuration file, usually
/etc/X11/gdm/gdm.conf, modifying the Greeter setting as fol-
lows.
Greeter=/opt/SUNWkio/lib/gdm/kioskgreeter
where is the previous value of the
Greeter setting, if available.
You must restart gdm after this modification.
Kiosk sessions and screen lock applications
Some environments support a screen lock function which locks
the session after a period of inactivity or under other cir-
cumstances. Access to such a locked session is only granted
when the user has reauthenticated, typically by providing a
password. Kiosk user accounts have no password set and are
locked for ordinary login. Because of this Kiosk users will
not be able to unlock their session, if a screen lock is
activated.
Session authors are encouraged to make sure their Kiosk ses-
sions have screen lock functionality disabled. If this is
not possible, and if the screen lock program supports the
pam(3PAM) authentication framework, you can guard against
this lockout scenario by adding the pam_kiosk(8) module to
the PAM stack for the screen lock program in pam.conf(5)
with the reentry option.
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes.
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWkio, SUNWkior |
| Interface Stability | Committed |
|_____________________________|_____________________________|
SEE ALSO
kioskdesc(1), kioskstatus(1), kioskconfig(8),
kioskuseradm(8), kioskrestart(8), session.conf(5),
pam_kiosk(8)
Kiosk 4.3 Last change: 5
Kiosk Session Service Administration kioskconfig(8)
NAME
kioskconfig - generate Kiosk session configuration
SYNOPSIS
/opt/SUNWkio/bin/kioskconfig enable [-d display|-f display-
file] [-c config-file]
/opt/SUNWkio/bin/kioskconfig apply [-d display|-f display-
file] [-c config-file]
/opt/SUNWkio/bin/kioskconfig disable [-d display|-f
display-file|-a]
/opt/SUNWkio/bin/kioskconfig print [-d display|-f display-
file|-a]
/opt/SUNWkio/bin/kioskconfig list
/opt/SUNWkio/bin/kioskconfig reset
/opt/SUNWkio/bin/kioskconfig help
/opt/SUNWkio/bin/kioskconfig -h
DESCRIPTION
kioskconfig is used to generate or show Kiosk session confi-
guration for a given display or set of displays. Kiosk ses-
sion configuration describes the desired user environment of
Kiosk sessions. This description defines Kiosk policy (indi-
cating if Kiosk mode is enabled or disabled) and identifies
the actual Kiosk session to be used along with settings used
to configure Kiosk sessions. For a full description of
Kiosk session configuration see kiosk(8).
kioskconfig can perform its operations either on a single
display, specified by the -d option, on a set of displays
listed in a display-file specified by the -f option or on
all displays for which kiosk configuration currently exists.
For operations that can operate on selected displays, opera-
tion on all currently enabled displays is requested using
the -a option. If no display selection option is provided,
the default display file /etc/opt/SUNWkio/displays is used.
For the operations that can enable Kiosk mode for a display,
a kiosk session configuration file must be provided. If no
config-file is specified by the -c option, the default
location /etc/opt/SUNWkio/session.conf is used. For details
on the form and content of the configuration file see
session.conf(5).
The Kiosk Session Service does not provide standard display
or session configuration files in the default locations. If
Kiosk 4.3 Last change: 1
Kiosk Session Service Administration kioskconfig(8)
you wish to use one of these files, you must create them
yourself.
Configuration changes apply the next time a session is
started on a configured display. If kiosk sessions are
already running on the affected displays, you can use
kioskrestart(8) to force a restart of the sessions.
SUBCOMMANDS
The following subcommands are supported.
enable
Enable and configure Kiosk mode on one or more
displays. Kiosk session configuration is created for
the specified display(s), based on the specified con-
figuration file. The enable command will always enable
kiosk on the specified display(s). If the configura-
tion file specifies Kiosk policy itself (i.e. it con-
tains the KIOSK_ENABLED setting), this policy setting
is ignored.
apply Apply Kiosk session configuration which includes a
policy setting to one or more displays. The specified
configuration file should contain the KIOSK_ENABLED
setting to indicate whether kiosk should be enabled or
disabled on the specified display(s). If the confi-
guration file does not contain a policy setting, kiosk
will be disabled on the specified display(s).
disable
Disable Kiosk mode for the specified display(s).
print Print the current Kiosk session configuration for the
specified display(s).
list List the displays on which kiosk mode is currently
enabled.
reset Remove all current kiosk session configuration. Exe-
cuting the reset command disables Kiosk mode on all
displays and removes internal data structures. This
command should only be used to deconfigure Kiosk mode
completely, for example after deconfiguring all kiosk
user accounts.
help Show a help message.
OPTIONS
The following options are supported.
-a Operate on all currently configured displays.
Kiosk 4.3 Last change: 2
Kiosk Session Service Administration kioskconfig(8)
-d display
Identifies a single display to be configured.
-f display-file
Identifies a file which lists the displays to be con-
figured. This file must contain a list of X11 display
identifiers, one per line. Comment lines starting with
'#' are supported. If neither the -d nor -f nor -a
options are specified, a display file from a default
location is used. The location of the default display
file is /etc/opt/SUNWkio/displays. The Kiosk Session
Service does not provide a default display file. If
you wish to use one, you must provide it yourself.
-c config-file
Identifies a file containing Kiosk configuration. If
the -c option is not specified, a default configura-
tion file location is used. The default location of
the configuration file is
/etc/opt/SUNWkio/session.conf. The Kiosk Session Ser-
vice does not provide a default configuration file. If
you wish to use one, you must provide it yourself.
-h Show a usage message.
EXAMPLES
Example 1: Enabling a set of displays using the default con-
figuration file
Given a default display file, /etc/opt/SUNWkio/displays con-
taining the following:
:1
:2
:3
:4
and a default configuration file,
/etc/opt/SUNWkio/session.conf containing the following:
KIOSK_ENABLED=no
KIOSK_SESSION=gnome
KIOSK_SESSION_PROTOTYPE=/export/home/prototypes/gnome
the command
kiosk# kioskconfig enable
will enable Kiosk sessions for displays :1, :2, :3 and :4.
Kiosk sessions on these displays will use the gnome Kiosk
Session Descriptor and the /export/home/prototypes/gnome
prototype directory. The KIOSK_ENABLED setting will be
Kiosk 4.3 Last change: 3
Kiosk Session Service Administration kioskconfig(8)
ignored.
Example 2: Applying configuration to single display
Using the configuration file shown above, the command
kiosk# kioskconfig apply -d :2
will apply all Kiosk configuration, including the
KIOSK_ENABLED setting, in the default configuration file
/etc/opt/SUNWkio/session.conf to the :2 display. This will
effectively disable Kiosk sessions for the :2 display. This
could also be achieved using the command
kiosk# kioskconfig disable -d :2
Example 3: Listing displays for which Kiosk Mode is enabled
After executing the commands from the previous examples, you
can list the displays on which kiosk is now enabled using
the command
kiosk% kioskconfig list
:1
:3
:4
EXIT STATUS
The following exit values are returned.
0 Success
1 Failure
ATTRIBUTES
See attributes(8) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWkio |
| Interface Stability | Uncommitted |
|_____________________________|_____________________________|
SEE ALSO
kioskparam(1), kiosk(8), session.conf(5)
Kiosk 4.3 Last change: 4
Kiosk Session Service Administration kioskrestart(8)
NAME
kioskrestart - terminate kiosk sessions to restart them in a
clean state
SYNOPSIS
/opt/SUNWkio/bin/kioskrestart
/opt/SUNWkio/bin/kioskrestart -a
/opt/SUNWkio/bin/kioskrestart -d display ...
/opt/SUNWkio/bin/kioskrestart -u username ...
/opt/SUNWkio/bin/kioskrestart -h
DESCRIPTION
The kioskrestart utility may be used to terminate running
kiosk sessions. This usually causes the sessions to be res-
tarted from scratch. Restarting a kiosk session can be used
to let changes to kiosk configuration take effect or to
reset sessions to a known, clean state.
Sessions are restarted by simulating termination of a criti-
cal application. This works only for sessions in the "run-
ning" state, as reported by kioskstatus -x. In particular
this command may report errors, if any affected kiosk ses-
sions are currently starting or terminating on their own.
The kioskrestart command can be used to restart the session
within which it is invoked or one or more specified ses-
sions. To restart specified sessions one of the -a, -d or -u
options must be specified. Only one of these options can be
specified. Root privileges are required to restart specific
sessions.
The first form of the kioskrestart command, without any
options, is used to restart the current kiosk session. This
form can be used only within a kiosk session.
The second form of the kioskrestart command, with the -a
option, is used to restart all currently running kiosk ses-
sions.
The third form of the kioskrestart command, with the -d
option, is used to restart the kiosk sessions on one or more
specified displays.
The fourth form of the kioskrestart command, with the -u
option, is used to restart the kiosk sessions running under
one or more specified kiosk user accounts.
Kiosk 4.3 Last change: 1
Kiosk Session Service Administration kioskrestart(8)
The last form of the kioskrestart command, with the -h
option, displays a usage message.
OPTIONS
The following options are supported. The -a, -d and -u
options are mutually exclusive. Without any option,
kioskrestart terminates the current kiosk session.
-a Terminate all currently active kiosk sessions.
-d Terminate the kiosk sessions for the specified
displays.
-u Terminate the kiosk sessions for the specified user
accounts.
-h Displays a help message.
EXAMPLES
Example 1: Terminating all kiosk sessions.
To terminate all kiosk sessions, for example after disabling
kiosk mode on all displays, use the kioskrestart command
with the -a option:
kiosk# kioskrestart -a
kiosk#
Example 2: Terminating a specific kiosk session.
To terminate a kiosk session on a specific display, for
example after changing kiosk configuration for this display,
use the kioskrestart command with the -d option:
kiosk# kioskrestart -d :4
kiosk#
Example 3: Terminating a kiosk session for a specific user
account.
To terminate a kiosk session running under a specific kiosk
user account, use the kioskrestart command with the -u
option:
kiosk# kioskrestart -u ku13
kiosk#
EXIT STATUS
The following exit values are returned:
0 All specified sessions were terminated successfully.
Kiosk 4.3 Last change: 2
Kiosk Session Service Administration kioskrestart(8)
non-zero
Terminating at least one specified session failed.
ATTRIBUTES
See attributes(8) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWkio |
| Interface Stability | Uncommitted |
|_____________________________|_____________________________|
SEE ALSO
kiosk(8), kioskconfig(8), kioskuseradm(8)
Kiosk 4.3 Last change: 3
Kiosk Session Service Administration kioskuseradm(8)
NAME
kioskuseradm - Kiosk Session Service user administration
tool
SYNOPSIS
/opt/SUNWkio/bin/kioskuseradm show [-p]
/opt/SUNWkio/bin/kioskuseradm create [-q] -l prefix -g group
[-i gid] -u first-uid -c count
/opt/SUNWkio/bin/kioskuseradm modify [-fq] [-l prefix] [-g
group [-i gid]] [-u first-uid] [-c count]
/opt/SUNWkio/bin/kioskuseradm extend [-q] -c count
/opt/SUNWkio/bin/kioskuseradm delete [-fq]
/opt/SUNWkio/bin/kioskuseradm leakcheck [-p]
/opt/SUNWkio/bin/kioskuseradm cleanup [-q]
/opt/SUNWkio/bin/kioskuseradm status [-pv]
/opt/SUNWkio/bin/kioskuseradm help
/opt/SUNWkio/bin/kioskuseradm -h
DESCRIPTION
The Kiosk Session Service maintains a pool of user accounts
dedicated to running Kiosk sessions. kioskuseradm may be
used to administer this pool of accounts.
SUBCOMMANDS
The following subcommands are supported.
show Print the current Kiosk User account configuration.
With the -p option the output has the form of an
option line that can be passed to the create or modify
commands to restore the same configuration.
create
Create count Kiosk user accounts in the group group.
Consecutive uids starting at first-uid will be used
for the accounts. The user name for the created
accounts will take the form prefixnumber where number
runs from 0 to count-1.
If the -i option is not provided, the group group must
exist on the system. If -i is specified, a group
named group is created with the group-id gid. A group
of that name must not exist on the system.
Kiosk 4.3 Last change: 1
Kiosk Session Service Administration kioskuseradm(8)
The create command will fail, if a Kiosk user account
configuration already exists.
modify
Modify an existing Kiosk user account configuration.
The existing configuration is deleted and recreated
with the new settings. Settings that are not specified
in the invocation of this command are kept unchanged
from the old configuration. Otherwise the effect of
this command is the same as running the delete command
followed by the create command.
The modify command will fail, if Kiosk user accounts
are not yet configured. If there are existing Kiosk
sessions, the modify command will fail unless the -f
option is specified.
extend
Extend the current range of Kiosk user accounts by
count additional accounts.
The extend command can be used to add more Kiosk
accounts even while there are existing Kiosk sessions.
delete
Delete the existing Kiosk user accounts.
If the group used for the Kiosk user accounts was
created by kioskuseradm by specifying the -i gid
option to the create or modify command, the group will
also be deleted. Otherwise the group will not be
deleted.
If there are existing Kiosk sessions, the delete com-
mand will fail unless the -f option is specified. If
the -f option is provided the delete command will
attempt to terminate existing Kiosk sessions before
deleting the Kiosk user account.
If deleting one or more user accounts fails, you can
use the leakcheck command to find any leftover
accounts and the cleanup command to delete these
accounts once the circumstances that prevented their
deletion are resolved.
leakcheck
Search for Kiosk user accounts left over from a prior
configuration. Use the cleanup command to delete any
accounts found once the circumstances that prevented
their deletion are resolved. With the -p option, the
output of the command is a list of user account names,
one per line.
Kiosk 4.3 Last change: 2
Kiosk Session Service Administration kioskuseradm(8)
cleanup
Force the removal of "orphaned" Kiosk accounts, which
could not be removed when a prior configuration was
deleted or modified. Use the leakcheck command to find
such accounts.
status
Print the number of configured and currently used
Kiosk user accounts. With the -p option, the output
of the command is a pair of numbers
total-count used-count
With the -v option, the command also lists all Kiosk
user accounts currently in use and the session (the
X11 display) to which they are allocated. With both
the -p and -v options, the output of the command is a
list of the used user account names and their associ-
ated displays, one account per line.
help Prints a help message.
OPTIONS
-l prefix
Specify the prefix for all Kiosk user account names.
The prefix must start with a letter which can be fol-
lowed by up to three more letters or digits.
-g group
Specify the name of the group which all Kiosk user
accounts will belong to. Any valid group name may be
specified. If the -i gid option is also specified,
this group will be created with the given gid. In that
case the group will also be deleted when the Kiosk
user account configuration is deleted. Otherwise the
group must exist on the system and will not be deleted
with the Kiosk accounts.
-i gid
Specify the group-id of the group which all Kiosk
users account will belong to. The group specified
using the -g group option will be created using this
group-id. Any valid unused group id can be specified.
The special value "auto" can be specified as the gid.
In that case selection of a group id is left to the
groupadd(8) tool.
-u first-uid
Specify the starting user-id to be used for the Kiosk
user account pool. A number greater than 100 must be
specified. All uids in the range first-uid ... first-
Kiosk 4.3 Last change: 3
Kiosk Session Service Administration kioskuseradm(8)
uid+count-1 must be available for Kiosk account confi-
guration to succeed.
-c count
Specify the number of new Kiosk user accounts to
create. When using the create or modify commands,
count indicates the the total number of Kiosk user
accounts requested. When using the extend command,
count indicates the number of new Kiosk user accounts
that should be added to the user account pool. You
may specify any positive number of up to 4 digits.
-f Force termination of existing session when deleting
user accounts.
-p Produce parseable instead of human readable output.
-q Quiet Mode. Suppress extensive progress messages.
-v Verbose mode. Provide more detail in output.
-h Print a usage message.
EXAMPLES
Example 1: Initial configuration of Kiosk user pool
The command
kiosk# kioskuseradm create -l ku -g kiosk -u 1000 -c 10
will create 10 Kiosk user accounts, starting with uid 1000.
The accounts will be named, ku0, ku1, ku2 etc. The accounts
will belong to the preexisting group named kiosk.
Example 2: Displaying the current configuration of the Kiosk
user account pool
Assuming the Kiosk user account pool has been created using
the command shown in Example 1, the pool configuration may
be displayed as follows
kiosk# kioskuseradm show
Current kiosk user account settings:
user name prefix: ku
first account uid: 1000
number of accounts: 10
kiosk group name: kiosk
kiosk# kioskuseradm show -p
-l ku -g kiosk -u 1000 -c 10
Example 3: Extending the Kiosk user account pool
Kiosk 4.3 Last change: 4
Kiosk Session Service Administration kioskuseradm(8)
Assuming the Kiosk user account pool has been created using
the command shown in Example 1, the pool could be increased
in size to allow for 20 Kiosk users using the command
kiosk# kioskuseradm extend -c 10
Example 4: Removing the Kiosk user pool
If you no longer need to run Kiosk sessions, you may delete
all accounts in the Kiosk user pool using the command
kiosk# kioskuseradm delete
EXIT STATUS
The following exit values are returned.
0 Success
non zero
Failure
ATTRIBUTES
See attributes(8) for descriptions of the following attri-
butes:
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWkio |
| Interface Stability | Uncommitted |
|_____________________________|_____________________________|
SEE ALSO
kiosk(8)
Kiosk 4.3 Last change: 5
Kiosk Session Service pam_kiosk(8)
NAME
pam_kiosk - Kiosk Session Service pam module.
SYNOPSIS
/opt/SUNWkio/lib/pam_kiosk.so
/opt/SUNWkio/lib64/pam_kiosk.so
DESCRIPTION
pam_kiosk is the Kiosk Session Service pam module used to
bypass normal authentication for Kiosk sessions. The
pam_kiosk module is invoked by the display manager during
session startup.
pam_kiosk provides the following functions.
1. [all modules] Return PAM_IGNORE and perform no further
action, if the session is known not to be a Kiosk ses-
sion.
2. [auth module] Evaluates Kiosk policy to find out if Kiosk
is enabled.
3. [auth module] If a user identity was already set,
pam_kiosk can clobber it and try to establish the Kiosk
user anyway or ignore the Kiosk policy and proceed to
login that user. The default behaviour is to ignore Kiosk
policy, which can be changed by setting the ignoreuser
option.
4. [auth module] Identifies the user account to use for the
session and establishes the user identity for the ses-
sion.
5. [auth module] Returns PAM_SUCCESS from
pam_sm_authenticate(3PAM) to login the account without
requiring any actual credentials.
6. [auth module] In pam_sm_setcred(3PAM) the X session is
marked as a Kiosk session. Returns PAM_IGNORE to allow
normal credential setting (pam_unix_cred(8)) to proceed.
7. [account module] Returns PAM_SUCCESS, if this is a Kiosk
session, to short-circuit account checking, as the Kiosk
user accounts should be locked.
8. [session module] Creates/Resets the user account home
directory at session start.
9. [session module] Cleans up the user account at session
end.
Kiosk 4.3 Last change: 1
Kiosk Session Service pam_kiosk(8)
OPTIONS
pam_kiosk supports the following options.
debug Send debug messages to syslog using the auth.debug
mode (see syslog.conf(5)). This option can be provided
multiple times to increase the amount of debug output
generated.
nowarn
Don't output non-fatal warning or error messages.
ignoreuser
Ignore (clobber) an existing PAM_USER item. Default
behavior is to override the Kiosk policy and fall back
to an authenticated session.
log=facility
Use facility for logging events to the system log.
Supported values for facility are AUTH, USER and
LOCAL0-7,
reentry
Check if the current X display and PAM_USER user
account belong to an active kiosk session. If they do,
pam_sm_authenticate(3PAM) returns success. Use this
option only in the authentication stack for a screen
lock program, to allow kiosk sessions for which a
screen lock has been activated to unlock. This option
has an effect only on the authentication module.
USAGE
To use the pam_kiosk module you must correctly configure the
pam stack for your login manager as follows
Configuring the pam stack on Linux
There are separate versions of pam_kiosk.so for 32-bit and
64-bit processor architectures. The architecture of the PAM
client being configured determines which architecture needs
to be configured.
On 32-bit systems:
Use /opt/SUNWkio/lib/pam_kiosk.so for all services.
On 64-bit systems:
Use /opt/SUNWkio/lib64/pam_kiosk.so for system ser-
vices.
Use /opt/SUNWkio/lib/pam_kiosk.so for 32-bit-only ser-
vices.
Only gdm(1) is supported on Linux. To configure gdm you must
modify the gdm pam configuration file /etc/pam.d/gdm as
Kiosk 4.3 Last change: 2
Kiosk Session Service pam_kiosk(8)
follows. This description is for a 32-bit system. Use
/opt/SUNWkio/lib64/pam_kiosk.so instead of
/opt/SUNWkio/lib/pam_kiosk.so on systems with a 64-bit ver-
sion of gdm.
o Insert the line
auth sufficient /opt/SUNWkio/lib/pam_kiosk.so
On a 64-bit system use:
auth sufficient /opt/SUNWkio/lib64/pam_kiosk.so
This line must be before any line that features the
usual system authentication, for example pam_unix.
o Insert the line
account sufficient /opt/SUNWkio/lib/pam_kiosk.so
This line must be first in the account stack for gdm.
o Insert the line
session required /opt/SUNWkio/lib/pam_kiosk.so
This line must be first in the session stack for gdm.
The following is an example of the resulting pam stack for
gdm on a 32-bit system:
auth sufficient /opt/SUNWkio/lib/pam_kiosk.so
auth required pam_unix2.so nullok #set_secrpc
account sufficient /opt/SUNWkio/lib/pam_kiosk.so
account required pam_unix2.so
password required pam_unix2.so #strict=false
session required /opt/SUNWkio/lib/pam_kiosk.so
session required pam_unix2.so debug # trace or none
session required pam_devperm.so
session optional pam_console.so
Prevent fallback to an ordinary session
The pam_kiosk module can be specified multiple times in the
same PAM stack. In this case only the first invocation will
perform the full function of the module. Subsequent invoca-
tions will detect that the function has already been per-
formed and will simply return an approriate result code
reflecting the success, ignore or error state of the primary
invocation (see section ERRORS). This can be used to prevent
PAM processing to continue when kiosk setup has failed due
to an error, by specifying pam_kiosk twice as follows (in
pam.conf(5) syntax):
Kiosk 4.3 Last change: 3
Kiosk Session Service pam_kiosk(8)
service auth sufficient /opt/SUNWkio/lib/pam_kiosk.so
service auth requisite /opt/SUNWkio/lib/pam_kiosk.so
...
Configuring for screen lock programs
Kiosk user accounts have no password set and are locked for
ordinary login. Because of this Kiosk users will not be
able to unlock their session, if a screen lock is activated.
To guard against this lockout scenario, you can use the
pam_kiosk module with the reentry option, so that the screen
lock program will instantly unlock without user action, if
pam_kiosk detects a kiosk session. To do this specify
pam_kiosk at the very top of the PAM stacks for screen lock
services as follows:
lock-service auth sufficient /opt/SUNWkio/lib/pam_kiosk.so reentry
...
ERRORS
All modules return the following error codes:
PAM_SUCCESS
if the current session is a kiosk session and the
module has performed its function successfully.
PAM_IGNORE
if the current session is not a kiosk session.
PAM error codes
if determining the kiosk policy has failed or if Kiosk
Mode is enabled for the session, but setting up the
kiosk session failed.
Some reasons for failure are
o There are no kiosk user accounts available.
o The kiosk session configuration is invalid.
o Eliminating remnants of a prior kiosk session using
the same account has failed.
o Setting up the environment for the kiosk session
has failed.
ATTRIBUTES
See attributes(8) for descriptions of the following attri-
butes.
Kiosk 4.3 Last change: 4
Kiosk Session Service pam_kiosk(8)
____________________________________________________________
| Attribute Type | Attribute Value |
| Availability | SUNWkio |
| Interface Stability | Committed |
|_____________________________|_____________________________|
SEE ALSO
kiosk(8), pam(3PAM), syslog.conf(5)
Kiosk 4.3 Last change: 5