Previous Next Contents Generated Index


4

Using the Command-Line Interface




This chapter contains the following information:


Supported Commands

Commands that can be executed from the command line are listed in TABLE 4-1. For further information on executing these commands, see the appropriate man page.


Note - To view any of the specific commands for the Sun Ray system, type:
% man -M  /opt/SUNWut/man command
or type:
% setenv MANPATH=/opt/SUNWut/man
followed by
% man command



TABLE  4-1   Supported Commands 
Command
 
Definition
 

utaction  

The utaction program provides a way to execute commands when a Sun Ray appliance session is connected or disconnected.  

utadm  

The utadm command manages the private network and DHCP configuration for the Sun Ray interconnect.  

utcapture  

The utcapture command connects to the Authentication Manager and monitors packets sent and packets dropped between the Sun Ray server and the Sun Ray appliances.  

utcard  

The utcard command allows configuration of different types of smart cards in the Sun Ray administration database  

utconfig  

The utconfig command performs the initial configuration of the Sun Ray server and supporting administration framework software.  

utdesktop  

The utdesktop command allows the user to manage Sun Ray appliance desktop units connected to the Sun Ray server that the command is run on.  

utdetach  

The utdetach command disconnects the current non-smart card mobile session from its respective Sun Ray appliance. The session is not destroyed but put into a detached state. The session can be accessed if the same user token (user name) is presented to the Sun Ray server.  

utfwadm  

The utfwadm command manages firmware upgrades to Sun Ray appliances.  

utfwsync  

The utfwsync command refreshes the firmware level on the Sun Ray appliances to what is available on the Sun Ray servers in an HA group. It then forces all the Sun Ray appliances within the group to restart.  

utglpolicy  

The utglpolicy command gets or sets group utpolicy options. Normally, setting group policies is accomplished by using the Sun Ray Web-based Administration Tool.  

utgroupsig  

The utgroupsig command sets the failover group signature for a group of Sun Ray servers. The utgroupsig command also sets the Sun Directory Services rootpw used by Sun Ray to a value based on the group signature.  

utgstatus  

The utgstatus command allows the user to 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.  

utinstall  

The utinstall utility installs, upgrades, and removes Sun Ray server software. All software required to support the Sun Ray server is installed including the administration framework, any patches required by the framework, and Solaris operating environment patches.  

utkiosk  

The utkiosk script is used to export kiosk configuration information into the LDAP database.  

utload  

The utload command sends a request to a Sun Ray appliance to initiate a firmware download. As an option, the downloaded firmware can be written to the appliance's flash memory.  

utmhadm  

The utmhadm command provides a way to administer Sun Ray server multihead terminal groups. The information that utmhadm displays and that is editable is stored in the Sun Ray administration database.  

utmhconfig  

The utmhconfig tool allows an administrator to list, add, or delete multiheaded groups easily.  

utmhscreen  

The utmhscreen tool draws a window displaying the current session on each screen, with the current screen highlighted for easy identification. This tool is automatically launched for users during the X server startup process (session creation).  

utpolicy  

The utpolicy command writes the policy configuration of the Sun Ray Authentication Manager, utauthd(1M).  

utpreserve  

The utpreserve command saves existing Sun Ray server software configuration data according to the file, /cdrom/cdrom0/.upgrade/utpreserve_list.  

utpw  

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

utrcmd  

The utrcmd program provides a way to run Sun Ray administrative commands remotely. The utrcmd program contacts the in.utrcmdd daemon on the remote hostname and executes the specified command with the specified arguments, args (if any).  

utreplica  

The utreplica command performs the configuration of the Sun Ray LDAP server to enable replication of administered data from a designated Primary server to each Secondary server in a failover group.  

utselect  

The utselect command presents the output of utswitch -l in a window and allows mouse-based selection of a Sun Ray server to which the Sun Ray appliance in use is reconnected.  

utsession  

The utsession command lists and manages Sun Ray sessions on the local Sun Ray server.  

utsettings  

The utsettings command opens a Sun Ray Settings dialog box that allows the user to view or change audio, visual, and tactile settings for the Sun Ray appliance.  

utsunmc  

The utsunmc command adds the Sun Ray server software 1.3 module to the Sun Management Center (SunMC) and loads it to permit monitoring of the Sun Ray server software. The utsunmc command can also remove the Sun Ray server software 1.3 module from SunMC.  

utswitch  

The utswitch command allows switching a Sun Ray appliance

among Sun Ray servers in a failover group. It can also list the existing sessions for the current token.  

utsvc  

The utsvc script restarts the Sun Ray server software and, due to its location in /etc/init.d, is executed upon startup of the actual server.  

utuser  

The utuser command allows the user to manage Sun Ray users

registered on the Sun Ray server that this command is run on.  

utwall  

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

utxconfig  

The utxconfig program provides X server configuration parameters for users of Sun Ray appliance sessions.  

utxset  

The utxset command changes mouse acceleration and screen blank characteristics of the Sun Ray appliance. It is generally used internally by an X11 server to implement changes initiated by the xset(1) command.  


 

To Stop Sun Ray Services

K<(»Z
   Type:

# /etc/init.d/utsvc stop  


 

To Start Sun Ray Services

K<(»Z
   Type:

# /etc/init.d/utsvc start  


Changing Policies

When you run the utpolicy command with certain operands, messages are returned that indicate what operands to use. For example, if you make significant policy changes, run the utpolicy command with the clear option. See TABLE 4-2.

Use the utpolicy -i clear command instead of rebooting the server.

TABLE  4-2   utpolicy (clear and soft) Commands
Command/Option
Results

/opt/SUNWut/sbin/utpolicy -i clear  

Use this option if a significant policy change has been made. All existing sessions are terminated.  

/opt/SUNWut/sbin/utpolicy -i soft  

Use this option if a minor policy change was made, such as adding a dedicated token reader (smart card reader terminal). With such minor changes, it is not necessary to terminate existing sessions.  


Configuring Interfaces on the Sun Ray Interconnect Fabric

Use the utadm command to manage the Sun Ray interconnect fabric. This section contains the following procedures:


Note - You must have superuser privileges to run utadm.

Note - For information on configuring interfaces, IP addresses, and DHCP data for failover, refer to the Sun Ray Server Software 1.3 Advanced Administrator's Guide. If the IP addresses and DHCP configuration data are not set up properly at the time that the interfaces are configured, the failover feature will not work properly.

 

To Add an Interface

K<(»Z
   Type:

# /opt/SUNWut/sbin/utadm -a interface_name   {-a   interface_name} ... 

  This command configures the network interface interface_name as a Sun Ray interconnect. You can specify a subnet address or use the default address, which is selected from reserved private subnet numbers between 192.168.128.0 and 192.168.254.0. After an interconnect is selected, appropriate entries are made in the hosts, networks, and netmasks files. (These files are created if they don't exist.) The interface is activated.
  You can use any valid Solaris network interface. For example: hme[0-9], qfe[0-9]

 

To Delete an Interface

K<(»Z
   Type:

# /opt/SUNWut/sbin/utadm -d interface_name   {-d   interface_name} ... 

  This command deletes the entries that were made in the hosts, networks, and netmasks files and deactivates the interface as a Sun Ray interconnect.

 

To Remove All Interfaces

K<(»Z

Use the utadm -r command to prepare for removal of the Sun Ray server software.

   Type:

# /opt/SUNWut/sbin/utadm -r

  This command removes all of the entries and all of the structures relating to all of the Sun Ray interfaces.

 

To Print the Sun Ray Interconnect Configuration

K<(»Z
   Type:

# /opt/SUNWut/sbin/utadm -p

  For each interface, this command displays the hostname, network, netmask, and number of IP addresses assigned to Sun Ray units by DHCP.


Managing PROM Versions

This section lists the options for managing the firmware on the PROM in the Sun Ray appliance. Use the utfwadm command primarily to keep the firmware version on the server and the appliances synchronized. This section contains the following procedures:


Note - If you define the DHCP version variable, when a new appliance is plugged in and the versions of the firmware on the server and on the appliance are not the same, the appliance's firmware is changed to the version on the server.

You must have superuser privileges to run utfwadm. Use this command to select the appliances for upgrading. Select appliances one at a time or all appliances on a subnet.



TABLE  4-3   Options for the utfwadm Command 
Option
Description

-A  

Adds appliances to the list of appliances to be upgraded and also sets the appropriate DHCP version variable.  

-D  

Removes the specified appliances from the list of appliances to be upgraded and resets the appropriate DHCP version variable. However, the appliances are still upgraded.  

-a  

Designates all the appliances.  

-e with a full Ethernet address (MAC address)  

Gives a specific appliance with its Ethernet address. The address entered is read as hex.  

-n interface_name  

Specifies what subnet the appliances are on. For more than one interface, use a series of -n interface_name entries. For all interfaces, use -n all.  

-f with a path  

Specifies the path to the upgrade files.

If -f is not used, the upgrade is done from the default firmware files, which are located in:

/opt/SUNWut/lib/firmware  


Note - See the utfwadm(1m) man page for more details.

 

To Update All of the Appliances on an Interface

K<(»Z
   Type:

# /opt/SUNWut/sbin/utfwadm -A -a -n interface  


Note - Reboot the server. You must power cycle the appliance to force a firmware upgrade.

 

To Update an Appliance Using the Ethernet (MAC) Address

K<(»Z
   Type:

# utfwadm -A -e MAC_address -n interface  


Restarting Sun Directory Services

If you restart the Sun Directory Services daemon (dsserv), you need to restart the Sun Ray Authentication Manager. The Sun Directory Services (SunDS) daemon might need to be restarted if you change one of its configuration parameters. The following procedure shows the correct order of the steps to take if you need to restart SunDS.


 

To Restart Sun Directory Services

port
  1. Stop the Sun Ray services:

# /etc/init.d/utsvc stop  

  2. Stop the SunDS daemon:

# /etc/init.d/dsserv stop  

  3. Start the SunDS daemon:

# /etc/init.d/dsserv start  

  4. Restart the Sun Ray services:

# /etc/init.d/utsvc start  


Solaris Lock Screen for Detached Sessions

The following commands are used to lock the screen when a user detaches the session; for example, by removing a smart card.


 

To Lock a Screen Using CDE

port
  1. Type the following command to lock the screen for the current session:

% /opt/SUNWut/lib/utaction -d '/usr/dt/bin/dtaction LockDisplay' &  

  2. To make this feature the default, add the command to the end of the .dtprofile file in the user's home directory.

 

To Lock an OpenWindows Session

port
  1. Type the following command to lock the screen for the current session:

% /opt/SUNWut/lib/utaction -d '/usr/openwin/bin/xlock -delay 1000000 -mode blank'  

  2. To make this feature the default, add the command to the end of the .xinitrc file in the user's home directory.

 

To Create a System-Wide Default for Screen Locking

port
   Place the following script in /etc/dt/config/Xsession.d as an executable file (named, for example, /etc/dt/config/Xsession.d/0999.screenlock).

#!/bin/ksh
#
# Turn on screen-lock on disconnect for Sun Ray sessions
#
 
if [ "$DTUSERSESSION" != "" -a "$SESSIONTYPE" != "altDt" ]
then
    /opt/SUNWut/lib/utaction -d '/usr/dt/bin/dtaction 
LockDisplay' \
    2>/dev/null >/dev/null &
else
    /opt/SUNWut/lib/utaction -d \
    '/usr/openwin/bin/xlock -delay 1000000 -mode blank' \
    2>/dev/null >/dev/null &
fi


 

To Get a Token ID From a Token Reader

port
   Type the following command:

# utuser -r token_reader  

  Where token_reader is the reader that you want to read the ID from. You are prompted to insert the token into the Token Reader when the command is ready. The command queries the Token Reader for the token's ID and, if successful, displays it. For example:

# utuser -r 08002086e18f Insert token into token reader '08002086e18f' and press return. Read token ID 'mondex.9998007668077709'  


Configuring Sun Ray Settings

A hot key can be configured to display and hide the Sun Ray Settings GUI. This customization can be done on three levels:

To support these levels of customization, the Sun Ray Settings GUI looks for the following Java properties files at startup in the following order:



TABLE  4-4   Java Properties Files
File
Defaults
Description

/etc/opt/SUNWut/utslaunch_defaults.properties  

System -wide  

This file is read in first and contains helpful default properties. Any properties specified here override any defaults built into the application itself.  

/home/anyuser/.utslaunch.properties  

User  

This file is read in second and contains the user's preferred values for the properties. Properties specified here override any application or sitewide defaults.  

/etc/opt/SUNWut/utslaunch_mandatory.properties  

System -wide mandatory  

This file is read in last and contains sitewide mandatory settings that cannot be overridden by the user. Any properties specified here override any application, sitewide, or user defaults.  

If you have a mandatory policy that all appliances use a standard hot key (perhaps for ease of training and support), use the system-wide mandatory defaults file to specify this standard key. In this case, users would not be allowed to specify their own preferences.

The format of the hot key entry in these properties files is:

utsettings.hotkey=value  

where value is a valid X keysym name preceded by one or more of the supported modifiers (Ctrl, Shift, Alt, Meta) in any order. Values are shown in the following table.



TABLE  4-5   Sun Ray Server Software 1.3 Specific Hot Key Values
Example Value
Notes

Shift+Props  

This brings up the Settings GUI.  

Ctrl+Alt+Backspace twice  

This kills a session.  

Ctrl+Alt+Del twice  

This kills the process that has taken control of the X server.  

Shift+Pause  

This suspends a non-smart card session.  

Mute+Louder+Softer  

This displays the appliance's MAC address.  

Ctrl+Power Key  

This cycles power.  

Both Shift+Props and Shift+Pause are configurable by users.


Setting Hot Key Values

If you do not want to use the Sun Props key as your default hot key, use the system-wide defaults file to specify a function key instead. Users can still specify their preferences (through the user defaults file), if so desired.


 

To Change the Hot Key Setting System-Wide

port
  1. As superuser, open the /etc/opt/SUNWut/utslaunch_defaults.properties file in a text editor.

Note - If you want to make the change mandatory, change the value in the
/etc/opt/SUNWut/utslaunch_mandatory.properties file.
  2. Locate the original hot key entry and place a # in front of that statement.
  The # comments out the first hot key property.

# utsettings.hotkey=Shift SunProps  

  3. Type in the new hot key property after the first statement. For example,

utsettings.hotkey=Shift F8  

  4. Save the utslaunch_defaults.properties file.
  The new hot key takes effect when the next user logs in. The next user to log in uses the new hot key to display the Sun Ray Settings screen. Users that were logged in prior to changing the hot key use the old value.

 

To Change the Hot Key Setting for a Single User

port
  1. In your home directory, create the .utslaunch.properties file.
  2. Add a line to the .utslaunch.properties file with the value for the hot key. For example:

utsettings.hotkey=Shift F8  

  3. Save the .utslaunch.properties file.
  4. Log out and log back in to enable the new hot key.

Smart Card Vendor Configuration Files


Note - Use the Administration Tool to add additional smart card vendor configuration files.

The configuration files are available from each smart card vendor. You might receive a vendor.cfg file.

This section contains the following procedures:


 

To Load a Configuration File Into the Directory

port
   Copy the vendor configuration file to the following location:

# cp vendor.cfg /etc/opt/SUNWut/smartcard  

  The additional vendor cards are displayed under the Available column in the Add page in the Administration Tool.

 

To Configure a Token Reader

port

This command specifies an appliance for registering smart cards.

   Select a policy and add -t clear -t add:nnnnnnnnnnnn to the command. For example, type:

# /opt/SUNWut/sbin/utpolicy -a -r card -z pseudo -t clear -t add:nnnnnnnnnnnn  

  Where nnnnnnnnnnnn is the full Ethernet address (for example, 0800204c121c) of the appliance that you want to use as a smart card reader.



Previous Next Contents Generated Index

Copyright © 2001 Sun Microsystems, Inc. All Rights Reserved.