4.1. Sun Ray Software Commands

4.1.1. How to Set Up Access to the Sun Ray Software Man Pages

Table 4.1, “Sun Ray Software Commands” lists the important commands used to administer the Sun Ray environment. For further information, see the man page for the command in question.

The Sun Ray Software commands are located in the following directories:

Add these directories to your PATH variable, so you don't need to provide the full path when using the commands.

Table 4.1. Sun Ray Software Commands




Execute commands when a Sun Ray Client session is connected, disconnected, or terminated.


Manage the private network, shared network, and DHCP (Dynamic Host Configuration Protocol) configuration for the Sun Ray interconnect.


Add, list, and delete UNIX user names from the list of users authorized to administer Sun Ray services. The list is stored in the Sun Ray data store.


Configure or disable regional hotdesking, which enables users to access their sessions across multiple failover groups.


Enable Sun Ray audio services.


Monitor packets sent and dropped between the Sun Ray server and the Sun Ray Clients.


Enable the configuration of different types of smart cards in the Sun Ray data store.


Perform the initial configuration of the Sun Ray server and supporting administration framework software.


Configure the Sun Ray server security.


Manage Sun Ray Clients connected to the Sun Ray server on which the command is run.


Disconnect the current non-smart card mobile session or authenticated smart card session from its respective Sun Ray Client. The session is not destroyed but put into a detached state. The session can be accessed again only after authentication. When Remote Hotdesk Authentication (RHA) is disabled (through utpolicy or the Admin GUI), utdetach affects only authenticated smart card sessions and non-smart card mobile sessions.


Enable or disable Sun Ray device services. The services include USB devices connected through USB ports, embedded serial ports, clipboard, internal smart card reader in the Sun Ray Client, and the scbus protocol.


Manage Sun Ray mass storage.


Convert the port number for the Sun Ray data store service to the new default port on servers in a failover group, then forces all servers in the group to restart Sun Ray services.


Eject media from a removable storage media device.


Manage firmware versions on the Sun Ray Clients.


Install the Sun Ray Operating Software (Sun Ray Client firmware).


Force the download of new firmware to a Sun Ray Client running older firmware than its server.


Refresh the firmware level on the Sun Ray Clients to the level available on the Sun Ray servers in a failover group. It then forces all the Sun Ray Clients within the group to restart.


Uninstall the Sun Ray Operating Software (Sun Ray Client firmware).


Create a hashed version of a password used for authenticating the enabling or disabling of the Configuration GUI.


Manage a group-wide list of explicit destinations for Sun Ray group membership announcements.


Set the failover group signature for a group of Sun Ray servers. The utgroupsig command also sets the Sun data store rootpw used by Sun Ray to a value based on the group signature. Although utgroupsig sets the rootpw in the utdsd.conf file, it does not set the admin password, which is a separate entity, in the data store.


View the failover 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.


Install, upgrade, and remove the Sun Ray Software.


Manage Sun Ray Client device keys for authentication.


Modify the state of certain locking modifier keys on a user's keyboard.


Import or export kiosk configuration information into the data store. It also supports storage of multiple named kiosk session configurations in the data store.


Set the session type associated with a token, to select a kiosk session configuration for a token associated with a kiosk session, or to query the session type and kiosk session currently associated with a token.


Manage Sun Ray device licenses.


Manage multihead groups using a CLI.


Manage multihead groups using a GUI.


Mount a file system on a Sun Ray mass storage device.


Set and report the policy configuration of the Sun Ray Authentication Manager, utauthd.


Save existing Sun Ray Software configuration data to the /var/tmp/SUNWut.upgrade directory.


Change the Sun Ray administrator password (also known as the UT admin password) used by the Web-based and command-line administration applications.


Display a Sun Ray Client's current parameter values.


Add, remove, and configure token readers.


Display the version of the Sun Ray Software and the Sun Ray Operating Software installed on the server.


Configure the Sun Ray data store server to enable replication of administered data from a designated primary server to each secondary server in a failover group. The data stores of the secondary servers remain synchronized automatically unless there is a power outage.


Control the resolution and refresh rate of the video monitor signal (persistent monitor settings) produced by the Sun Ray Client.


Create, delete, and view resolution definitions, that is, monitor signal timing definitions for monitors attached to Sun Ray Clients.


Resize user's screen to its optimal size, which is useful for hotdesking.


Present the output of utswitch -l as a list of servers in the current host group, to be used for reconnection of the current Sun Ray Client. A user can either select a server from this list or specify a server not in the current host group by typing its full name in the utselect text box.


List and manage Sun Ray sessions on the local Sun Ray server.


View and change Sun Ray Client settings.


Open the Sun Ray Settings GUI to view or change audio and visual settings for the Sun Ray Client.


Run all the appropriate commands, including utinstall and utconfig, in the appropriate sequence to install and configure a Sun Ray server.


Start Sun Ray services.


Stop Sun Ray services.


Switch a Sun Ray Client session to another Sun Ray server. The utswitch command can also list existing sessions for the current token.


Start a Windows connector session, providing a remote desktop.


Start a Windows connector session, providing a remote desktop. This command is an optimized version of the uttsc command when using JDS on a Sun Ray server running Oracle Solaris.


Unmount a file system from a Sun Ray mass storage device.


Report Sun Ray user token registrations and manage those registrations. The utuser command is able to obtain smart card token values from Sun Ray Clients that are configured as dedicated token reader devices.


Send a message or an audio file to users having an Xnewt or Xsun (X server unique to Sun Ray) process. The messages can be sent in email and displayed in a pop-up window.


Assemble information about display number, token, logged-in user, and the like, in a compact format.


Manage X server configuration parameters for users of Sun Ray Client sessions.


Lock a Sun Ray desktop session.

4.1.1. How to Set Up Access to the Sun Ray Software Man Pages

Add the following paths to the MANPATH environment variable:

  • /opt/SUNWut/man

  • /opt/SUNWkio/man

  • /opt/SUNWuttsc/man

  • /opt/SUNWuttscwrap/man