Contents What's New in the Dominion User Station User Guide for Release 1.2.0 viii Chapter 1 Introduction Overview ............................... 1 Package Contents ..........................2 Product Photos and Features ......................2 Product Features ........................2 Product Photos .......................... 3 Introduction to the User Station ......................4 Front View ..........................
Page 4
Contents Chapter 4 Navigation and Access to KVM Ports Port Navigator ............................ 37 Identifying States of KVM Switches and Ports.................. 39 Identifying External Media ......................... 41 Dual Video Port Status ........................41 Using Search ............................42 Using Filters ............................42 Chapter 5 Using the KVM Client Connection Properties ........................
Page 5
Contents Window Management ........................82 Dual Video Port Connections ......................84 Chapter 6 Setting User Preferences Managing Keyboard Macros ......................85 Executing Macros ........................87 Editing or Deleting Macros ..................... 88 Keyboard Macro Example ....................... 88 Audio Settings ............................ 89 KVM Client Settings ...........................
Page 6
Contents Log Level for Diagnostic Log Files ..................141 Diagnostic Log File ........................ 141 About this Device ..........................143 Chapter 9 System Settings Date/Time ............................144 Date and Time........................145 Time Zone ..........................146 Keyboard ............................147 Layouts ........................... 148 Mouse Keys ..........................
Page 7
Contents Login Screen Settings ........................167 Chapter 10 Additional Features Device Resume or Screen Unlocking ....................168 Factory Reset at Startup ........................169 Appendix A Specification Appendix B Authentication of User Stations and KVM Switches Appendix C Available Key Sets Appendix D Pre-programmed User Station Hotkeys Hotkeys for Controlling the User Station ..................
What's New in the Dominion User Station User Guide for Release 1.2.0 The following sections have changed or information has been added to the Dominion User Station User Guide based on enhancements and changes to the equipment and/or user documentation. Window Management (on page 82): A new tool for managing KVM •...
Dominion KX III KVM switches from customer LAN/WAN networks. ALL KX III KVM switches are supported. Note: For information on KX III KVM switches, access its user documentation from its application or the Dominion KX III section of the Raritan website's Support page http://www.raritan.com/support/...
Chapter 1: Introduction A USB Keyboard, USB mouse, and one or two HDMI- or DisplayPort-interfaced monitors Analog or digital audio appliances Optional smart card reader for remote IT device authentication External drives as virtual media, such as CD-ROM USB drives for virtual media or User Station software update Package Contents The Dominion User Station ships with the following contents.
Chapter 1: Introduction Support USB audio • Support power control for target servers (with Raritan PX PDUs) • • Support authentication to target servers via an optional smart card Support authentication and authorization via LDAP • Support the optional FIPS 140-2 mode •...
Chapter 1: Introduction VESA mount kit Introduction to the User Station Front View 1. Microphone input 5. Power button 2. Audio output 6. SD card reader 3. Power LED 7. USB 2.0 ports 4. Hard disk LED...
Chapter 1: Introduction Rear View 1. RS232/RS422/RS485 7. USB 3.0 ports 2. RS232 8. USB 2.0 ports 3. Ventilation 9. DisplayPort (DP) video 1 4. DC power input 10. DisplayPort (DP) video 2 5. Gigabit LAN port 1 11. HDMI video 6.
Chapter 1: Introduction Introduction to the Software After powering on the User Station, the Login Screen is shown. After successfully logging in to the User Station, the Main Screen displays. Login Screen The following diagram illustrates the Login Screen. 1. Text box for entering user credentials: Step 2: Log in to the Dominion User Station For initial login, see page 11).
Chapter 1: Introduction Icons Description Determine the keyboard layout. The default is English (US). Turn on or off the following functions: Large Font High Contrast By default, these settings are turned OFF. For Login Screen Settings details, see (on page 167).
Page 16
Chapter 1: Introduction You can right-click any open window in the Main Toolbar to perform one of the following commands: Command Description Minimize Minimize the window. After a window is minimized, the Minimize command will be replaced by the Unminimize command. Select Unminimize to restore the window. Maximize Maximize the window.
Chapter 1: Introduction Online Help and Hotkeys Help Both online help for using the Dominion User Station and information on pre-programmed hotkeys are available in the Main Menu. Online help: Choose Main Menu > Help > User Manual. • As long as the User Station is connected to the Internet, the User Manual link directs you to the Dominion User Station's online help.
Chapter 2 Getting Started This chapter introduces the basic installation and configuration. In This Chapter Installation and Configuration ..............10 Basic Network Settings ................20 Logout or Shutdown ..................22 VESA Mount (Optional) ................23 Rackmount Using L-type Brackets (Optional) ........... 25 Installation and Configuration Step 1: Connect the Equipment Only the basic hardware installation is described.
Step 2: Log in to the Dominion User Station Use the factory default user credentials for initial login. User credentials are case sensitive. To log in to the User Station: 1. Type the user name: admin 2. Type the password: raritan 3. Click Login or press Enter.
Chapter 2: Getting Started Note: It is strongly recommended to change the factory default password. If not yet, a reminder message appears in the User Station Configuration and Navigator windows. See (on page 93). Password Change Step 3: Add KX III KVM Switches If the User Station is connected to a non-DHCP network, you must manually configure the network settings prior to adding KX III KVM Basic Network Settings...
Page 21
Chapter 2: Getting Started Type the KVM switch's IPv4/IPv6 address or hostname in this field. User credentials on the KVM switch are required for querying this KVM switch's port information. The user credentials may or may not be the same as your user credentials for the User Station.
Chapter 2: Getting Started Step 4: Access KVM Switches and KVM Ports You access the computer devices connected to a KVM switch's ports through the Port Navigator window, which contains 3 panels: • Favorite Ports shows the favorite ports you have configured. See Configuring KVM Ports (on page 31).
Page 23
Chapter 2: Getting Started Note: To show KVM ports whose status is down, see Using Filters (on page 42). 3. Click the desired KVM port's icon , and select one option below. Open in new KVM client : A new KVM Client window is opened. ...
Page 24
Chapter 2: Getting Started To directly access a KVM port: 1. Click the Ports panel, and all "up" KVM ports are displayed by default. For dual port video, only the primary port must be "up" to be displayed. 2. Click the desired port's name, or click its icon...
Chapter 2: Getting Started Step 5: Use the KVM Client The User Station's KVM Client window opens after accessing a KVM port. The video of the target server that is connected to the KVM port is displayed in the KVM Client. You can use the attached keyboard and mouse to control the target server.
Page 26
Chapter 2: Getting Started The toolbar is split into two groups. The left group comprises the following buttons that you can use to change settings and properties. Button Function Connection Properties: This button manages streaming video your performance over connection to the target server.
Page 27
Chapter 2: Getting Started Button Function Power Operations: This button turns on, off or power cycles the target server, if a Raritan PDU is connected to the same KVM switch. View: This button shows several display options, such as Scale Video and Full-Screen Mode.
Chapter 2: Getting Started Connection Error Message If there are problems accessing a KVM port/target server, such as a network connectivity issue, an error message appears while the KVM Client opens. To close the error message only, click OK. The KVM Client continues •...
Page 29
Chapter 2: Getting Started Select the desired one and click Edit. 3. Click the IPv4 Settings tab. 4. In the Method field, select one of the following options:...
Chapter 2: Getting Started Automatic (DHCP) : The DHCP server automatically assigns an IPv4 address. This is the default. Automatic (DHCP) addresses only : The DHCP server automatically assigns the IP address only. DNS comes from manual input. Manual : This option configures static addressing.
Chapter 2: Getting Started VESA Mount (Optional) You can mount the Dominion User Station onto the back of a monitor with 75 or 100 mm VESA standards. Below shows the VESA MOUNT kit: VESA mount procedure: 1. Turn OFF and disconnect all devices from the power sources, including the monitor.
Page 32
Chapter 2: Getting Started 3. Align two screw holes on each side of the User Station with those on the VESA mount. 4. Tighten two sides securely using four appropriate screws. 5. The Dominion User Station is now securely attached to the monitor.
Rackmount Using L-type Brackets (Optional) To mount the User Station in a 19-inch data center rack, you must purchase the L-type rackmount kit from Raritan. One rackmount kit contains two L-type brackets, the cable-support bar and a number of screws.
Page 34
Chapter 2: Getting Started 3. Attach the L-type brackets to the rack through the screw holes on the front arms, using your fasteners.
Chapter 3 Managing KVM Switches and Ports KVM switches and their KVM ports are added, configured and deleted in the User Station Configuration window. In This Chapter User Station Configuration ................. 27 Adding KVM Switches ................. 28 Editing KVM Switches ................. 30 Deleting KVM Switches ................
Chapter 3: Managing KVM Switches and Ports 1. Configuration tabs: Port Configuration : Manage KVM switches and KVM ports. See the other sections in this chapter. Preferences : Set personal preferences, such as audio settings. Setting User Preferences (on page 85).
Page 37
Chapter 3: Managing KVM Switches and Ports 2. The following page opens, and the user must enter the required Step 3: Add KX III KVM Switches information. See (on page 12). 3. After clicking to save the data, the new KVM switch's content is shown.
Chapter 3: Managing KVM Switches and Ports Editing KVM Switches Added KVM switches are listed in the User Station Configuration window. Each KVM switch three icons in the Actions column. You must have Device Administration privileges to delete, edit or add KVM switches. If you are not the one who added new KVM switches to the User Station, you must follow the procedure below to enter user credentials for newly-added KVM switches.
Chapter 3: Managing KVM Switches and Ports Deleting KVM Switches The final button in the Actions column is used to delete this KVM switch. To delete a KVM switch: 1. Click the desired KVM switch's button. 2. Click OK on the confirmation message. Configuring KVM Ports A KVM switch's ports are shown only after a KVM switch is selected.
Page 40
Chapter 3: Managing KVM Switches and Ports Note: The icon shown in the top-right corner of the "Ports" section indicates the KVM port information retrieval status. See Port Data (on page 34). Retrieval Status 2. Click in the Action column of the KVM port that you want to configure.
Chapter 3: Managing KVM Switches and Ports Checkbox Function Hotkey Assign a hot key combination for quickly accessing this KVM port. Available options include: Ctrl + Shift + <character> Ctrl + Alt + <character> Shift + Alt + <character> ...
Chapter 3: Managing KVM Switches and Ports Port Data Retrieval Status An icon is displayed in the top-right corner of the Ports section in the User Station Configuration window. This icon indicates the data retrieval status of the KVM ports on the selected KVM switch.
Page 43
Chapter 3: Managing KVM Switches and Ports You can click this icon to view additional information. The icon changes depending on the current retrieval status of KVM port information. Icon Port data retrieval state Port information on the selected KVM switch is accessible.
Chapter 4 Navigation and Access to KVM Ports Port access is performed in the Port Navigator window, which contains Favorite Ports Devices Ports three panels for accessing KVM ports: The Navigator remembers the last-opened panel and returns to it when Navigator is opened again.
Chapter 4: Navigation and Access to KVM Ports Step 4: Access KVM Switches and KVM Ports For details, see (on page 14). Note: The User Station CANNOT access a KVM port that is connected to a tiered KVM switch or a blade chassis server. Therefore, such KVM ports are not shown in the Port Navigator window.
Page 46
Chapter 4: Navigation and Access to KVM Ports The Port Navigator window opens. 1. Search: Searches for KVM ports or switches containing the search word(s). Using Search (on page 42). 2. Additional Filters: Determines which KVM switches and ports are displayed in this Using Filters window based on KVM switch and port states.
Chapter 4: Navigation and Access to KVM Ports For dual port video, the name of the dual port video group is displayed instead of the port names. Dual port video groups whose primary port is Up will show in the list. Identifying States of KVM Switches and Ports In the Port Navigator window, different icons and colors are applied to indicate current states of the added KVM switches and ports.
Page 48
Chapter 4: Navigation and Access to KVM Ports KVM switch's icon and colors: Icon in color KVM switch state Normal (accessible) Error while communicating with the KVM switch Status unknown Status being updated Examples of KVM port states: Icon in color Port state Up, accessible, but no KVM session is active...
Chapter 4: Navigation and Access to KVM Ports Identifying External Media When external media are connected to a port, the media icons display after the port name/number. Icon Port state Mass Storage ISO/CD device Microphone Speaker Smart Card Reader Dual Video Port Status The primary port must have Status=Up to make a connection to both ports.
Chapter 4: Navigation and Access to KVM Ports Using Search The search box allows you to search for the KVM ports or switches that match the user's search words. To search for KVM ports or switches: 1. Open the panel where you want to perform the search function. To search for a KVM switch, click the Devices panel.
Page 51
Chapter 4: Navigation and Access to KVM Ports To change the filter: 1. Click Additional Filters, and the following checkboxes will appear. 2. Select or deselect any checkboxes to determine what kinds of KVM switches and KVM ports are shown. Checkbox KVM switch's state Normal...
Page 52
Chapter 4: Navigation and Access to KVM Ports 3. When completed, click Additional Filters again to hide the options.
Chapter 5 Using the KVM Client A KVM Client window opens after accessing a KX III KVM port where a server is physically connected. When dual video ports are configured on a KX III device, connecting to the dual video port group opens two KVM Dual Video Port client windows that are bound together.
Chapter 5: Using the KVM Client Connection Properties Connection properties manage streaming video performance over connections to target servers. The properties are applied only to your connection, not the connection of other users accessing the same target server. To configure connection properties: 1.
Page 55
Chapter 5: Using the KVM Client Setting Description Video Mode This slider controls the video quality as well as the bandwidth. Left: higher quality with higher bandwidth consumed. Right: lower quality with less bandwidth consumed. This is useful for low-bandwidth connections.
Chapter 5: Using the KVM Client Item Description Device Name The KVM switch's name. Host / Port The KVM switch's IP address, and the TCP/IP port used to access the KVM switch. Target Name The accessed KVM port's name. Data In / Out Rate of data received and sent out to the KVM switch in bytes per second.
Chapter 5: Using the KVM Client Text Readability Text Readability is designed to provide video modes with lower color depth but text remains readable. Greyscale modes are even available when applying lower bandwidth settings. This setting is ideal when working with computer GUIs, such as server administration.
Chapter 5: Using the KVM Client Noise Filter Unless there is a specific need to do so, do not change the noise filter setting. The default setting is designed to work well in most situations. The Noise Filter controls how much interframe noise is absorbed by the Dominion User Station.
Important: Make sure you have configured mouse settings on the target servers properly. For information on configuring mouse settings of target servers, refer to the KX III KVM switch's user documentation from its application or the Dominion KX III section of Support page http://www.raritan.com/support/...
Chapter 5: Using the KVM Client Synchronize Mouse In the dual mouse mode, the Synchronize Mouse command forces realignment of the target server's mouse cursor with the User Station's. Dual Mouse Modes (on page 53). To synchronize the mouse cursors: Click >...
For detailed information of each USB profile, see the section titled "Available USB Profiles" in the KX III KVM switch's user documentation, which is accessible from the KVM switch application or the Raritan website's Support page http://www.raritan.com/support/...
Page 62
Chapter 5: Using the KVM Client Automatic Mouse Mode In this mode, the User Station can detect the target server's mouse settings and synchronize the mouse cursors accordingly, allowing mouse acceleration on the target server. This mode is the default for non-VM target servers. Note: A non-VM target server is the target server using a CIM that does not support virtual media.
Chapter 5: Using the KVM Client If automatic mouse synchronization fails, this mode will revert to Standard Mouse standard mouse synchronization behavior. See Mode (on page 55). Note that mouse configurations will vary on different target servers' operating systems. Consult your OS guidelines for further details. Note: Automatic mouse synchronization does not work with UNIX target servers.
Chapter 5: Using the KVM Client Video Settings Click to open the Video Settings dialog. Video Sensing settings: Setting Description Auto Sense Video This command automatically detects Settings the target server's video settings (resolution, refresh rate) and redraws the video screen. Clicking in the toolbar results in the same video re-sensing function.
Page 65
Chapter 5: Using the KVM Client Setting Description Best Possible The User Station will perform the full Video Mode Auto Sense process when switching target servers or target resolutions. Selecting this option calibrates the video for the best image quality. Quick Sense Video The User Station will use a quick video Mode...
Chapter 5: Using the KVM Client Reset Settings: The Clear Video Settings Cache button resets the cache where video settings are stored, which is useful when old video settings no longer apply, such as when a target server is replaced. After calibrating the colors for a target server, color values are cached and reused whenever accessing that server.
Page 67
Chapter 5: Using the KVM Client Click , drag sliders, or type a new numeric value in the text box to adjust corresponding settings. Setting Description Clock Controls how quickly video pixels are displayed across the video screen. Changes made to clock settings cause the video image to stretch or shrink horizontally.
Chapter 5: Using the KVM Client Advanced Color Settings In the Video Settings dialog, click Advanced Settings in the Color section to show additional color settings. Click , drag sliders, or type a new numeric value in the text box to adjust corresponding settings. Setting Description Brightness Red...
Chapter 5: Using the KVM Client Setting Description Contrast Red Controls the red signal contrast. Contrast Green Controls the green signal contrast. Contrast Blue Controls the blue signal contrast. Peripheral Devices and USB Settings Click to open the "Audio, Mass Storage and SmartCard Devices" dialog, where you can virtually connect up to two devices of different types to a target server.
Page 70
(on page 76). Note: For detailed information of each USB profile, see the section titled "Available USB Profiles" in the KX III KVM switch's user documentation, which is accessible from the KVM switch application or the Raritan website's Support page...
Chapter 5: Using the KVM Client Audio Device The User Station supports end-to-end, bidirectional, digital audio connections with a target server for digital audio playback and capture devices. One of the following CIMs must be used: D2CIM-DVUSB • D2CIM-DVUSB-DVI • •...
Chapter 5: Using the KVM Client Checkbox Description Connect Playback To manually connect an available audio Device (Speaker / playback device to the target server, Headphones) select this checkbox. Set the playback audio format in the Audio Format field. Automatically If enabling this checkbox, the selected Connect at Startup...
Page 73
USB mass storage devices • • ISO images (disk images) ISO9660 is the standard supported by Raritan. However, other ISO standards can be used. Note: Connecting digital audio devices onto the target server is also supported. See (on page 63).
Page 74
Chapter 5: Using the KVM Client Mounting Local Drives This option mounts an entire disk drive virtually onto the target server. Use this option for external drives only. It does not include CD-ROM, or DVD-ROM drives. To mount a local drive: 1.
Page 75
Editing KVM Switches (on page 30). Mounting CD-ROM/DVD-ROM/ISO Images ISO9660 format is the standard supported by Raritan. However, other CD-ROM extensions may also work. Note: Audio CDs are not supported by virtual media so they do not work with the virtual media feature.
Page 76
Chapter 5: Using the KVM Client 2. Click the "CD-ROM Device / ISO File ..." button. The Connect CD-ROM Drive / ISO Image dialog appears. 3. For USB CD-ROM/DVD-ROM drives: a. Select the Local CD-ROM Drive option. b. Choose the drive from the Local CD-ROM Drive drop-down list, which shows all available CD-ROM/DVD-ROM drive names.
Page 77
Remote ISO images must be setup in KX3 to be available for selection by the KVM-Client. See Virtual Media File Server Setup in KX3's online help. (http://help.raritan.com/kx-iii/v3.4.0/en/#33617.htm has instructions for KX3 v3.4) a. Select the Remote Server ISO Image option.
Page 78
Chapter 5: Using the KVM Client Virtual Media CIMs It requires the use of the following virtual media (VM) CIMs on the target servers you are accessing. D2CIM-VUSB • • D2CIM-DVUSB D2CIM-DVUSB-DVI • • D2CIM-DVUSB-HDMI • D2CIM-DVUSB-DP The black USB connector on the DVUSB CIMs are used for the keyboard and mouse.
Supported card readers: Refer to the topic titled "Supported and Unsupported Smart Card • Readers" in the KX III KVM switch's user documentation, which is accessible from its application or the Dominion KX III section of the Support page Raritan website's http://www.raritan.com/support/ Target server requirements: Refer to the topic titled "Target Server Requirements"...
Page 80
Chapter 5: Using the KVM Client If this button is disabled, it may be impacted by the KX III KVM Card Reader Restriction Caused by KX III switch's settings. See KVM Switch Settings (on page 180). 4. Select the desired card reader from the list shown in the dialog. To automatically connect the selected card reader to the current ...
Page 81
Chapter 5: Using the KVM Client 6. When the card reader is listed as a virtual device in the "Audio, Mass Storage and SmartCard Devices" dialog, you can insert the card. To disconnect the card reader from the target server: Click the Unmount button in the "Audio, Mass Storage and •...
Page 82
Chapter 5: Using the KVM Client Emulating the Card Reinsertion If the authentication on the target server fails while the card is being properly inserted into the card reader, you can attempt to solve the issue by removing and reinserting the card. The User Station is able to emulate the card reinsertion without physically removing and reinserting the card.
Chapter 5: Using the KVM Client Card Reinsertion Scenarios The card is not detected in one of the following scenarios, you must reinsert the card or emulate the card reinsertion to solve the issue. The scenario where you must physically remove and reinsert the card: a.
Chapter 5: Using the KVM Client Existing virtual devices are listed in the Connected Devices section. The devices that you can no longer mount onto the target server are disabled. Hover your mouse for a tooltip showing reasons. 3. Click the Disconnect button for the device you want to disconnect. Click the Unmount button if you are disconnecting the smart card ...
Page 85
(on page 78). For detailed information of each USB profile, see the section titled "Available USB Profiles" in the KX III KVM switch's user documentation, which is accessible from the KVM switch Support page application or the Raritan website's http://www.raritan.com/support/...
Page 86
BIOS profile may be more appropriate. If none of the standard USB profiles provided by Raritan work with a provided target server, contact Raritan Technical Support for assistance. For detailed information of available USB profiles, refer to the user...
Chapter 5: Using the KVM Client Power Control You can power on, power off, and power cycle a target server through the outlet(s) it is connected to. This power control button is enabled only when the power control requirements are met. Power control requirements: On the KX III KVM switch, a PDU's outlet(s) must be associated with •...
Chapter 5: Using the KVM Client View Settings Click to show available view options. Fit window to Target The "Fit window to Target" command enlarges or shrinks the size of the KVM Client window to the target server's video resolution. The KVM Client's scroll bars may or may not appear, depending on whether the target server's resolution is small enough for the KVM Client window to show the target server's entire desktop video.
Chapter 5: Using the KVM Client Show Window Decorations You can use the KVM Client with or without the window decorations, including the window title and scroll bars. Tip: You can have this display option automatically enabled or disabled by setting your preferences on the KVM Client Settings page.
Chapter 5: Using the KVM Client Window Management Window Management helps you organize open KVM sessions. Other User Station windows, such as Port Navigator, are not included in window management. If two monitors are connected to the User Station, the feature works separately on each monitor.
Page 91
Chapter 5: Using the KVM Client • Tile KVM Windows: arranges all KVM windows in a tiled layout on desktop. Minimized windows will be unminimized. Revert Tiling: Undo last tiling operation and restore previous window • sizes. Previously minimized windows will be minimized again. Minimize KVM Windows: Minimizes all KVM windows from desktop to •...
Chapter 5: Using the KVM Client Session handling on logout: By default, all KVM windows will be closed on logout and after next login, you start with an only Port Navigator shown. If the "Save Sessions on Logout" feature is enabled, the User Station will save all open KVM window sizes and positions and will open them again on the next user login.
Chapter 6 Setting User Preferences In the User Station Configuration window, click Preferences to customize the following user settings. In This Chapter Managing Keyboard Macros ............... 85 Audio Settings ..................... 89 KVM Client Settings ..................90 Desktop Settings ..................92 Password Change ..................
Page 94
Chapter 6: Setting User Preferences 2. Click Preferences > Keyboard Macros > . The New Keyboard Macro page opens. 3. Enter information for the new keyboard macro. The fields marked with the symbol * are mandatory. Field/option Description Enabled Select this checkbox so that the new macro can appear in the KVM Client of Executing Macros this User Station.
Chapter 6: Setting User Preferences Field/option Description Keys Select each desired key from the list and click to add it to the right box. Double-click also adds. Select the keys in the order by which they are to be pressed. ...
Chapter 6: Setting User Preferences Editing or Deleting Macros To view all manually-created keyboard macros in the User Station Configuration window, click Preferences > Keyboard Macros. In the Enabled column: • An enabled macro shows A disabled macro shows • To edit a keyboard macro: 1.
Chapter 6: Setting User Preferences Audio Settings The default audio playback/capture devices used by the User Station are the front-panel analog speakers and microphone. You can change this by setting other audio devices you prefer as the audio playback and/or capture devices. Note that the audio configuration changes made by any user apply on a User Station basis so the changes impact all users of this User Station.
Chapter 6: Setting User Preferences KVM Client Settings You can configure the following settings for the KVM Client window: Mouse button behaviors for the user to launch the KVM Client • Preferred positioning, display and mouse mode settings that apply •...
Page 99
Chapter 6: Setting User Preferences Checkbox Description Scale Video Enable or disable the Scale Video function. Scale For details on Scale Video, see Video (on page 80). Window Show or hide the window decorations. Decorations For details on window decorations, see Show Window Decorations (on page 81).
Chapter 6: Setting User Preferences Option Description Switch existing The target server opens in the current KVM client KVM Client window. Open a new KVM The target server opens in a new KVM client Client window. 6. In the Session Settings section, select Save Session on Logout to save the position of open KVM sessions and re-open them upon next Window Management login.
Chapter 6: Setting User Preferences These hot keys, when pressed, are executed on the User Station rather than being transmitted to any target servers you are operating. To use any of these hot keys to control the target servers instead of the User Station, you must disable or change these hot key settings on the User Station.
Chapter 7 Administration Features In the User Station Configuration window, click Administration to perform the following User Station administration tasks. In This Chapter Users ......................95 User Groups ....................99 LDAP ......................103 Certificates ....................117 Security Settings ..................120 Display Settings ..................
Page 104
Chapter 7: Administration Features You can add user profiles with configurable privileges for other users to operate and administer the User Station. Note that the Dominion User Station's user profiles determine the permissions users are granted to have on the User Station instead of the Authentication of User Stations and KVM Switches KVM switches.
Page 105
Chapter 7: Administration Features 3. Enter information for the new user. The fields marked with * are mandatory. Field Description Login User name for logging in to the User Station. Make sure it meets these requirements, or the login fails. ...
Chapter 7: Administration Features 4. Click Save, and the new user profile's content is shown. 5. Click one of these buttons according to your needs. Back: Return to the Users page. Edit: Modify this user profile. Delete: Remove this user profile. ...
Chapter 7: Administration Features The Privileges column indicates the permissions granted to each user. Privileges are determined based on the user groups assigned to each User Groups user. See (on page 99). Each user profile shows a maximum of five user groups. If there are more than five user groups for a user profile, it shows a message below ...
Page 108
Chapter 7: Administration Features User groups Default privileges Device Users Device Access. You can create a new user group if the default user groups do not satisfy your needs. To create a new user group: 1. If not displayed, launch the User Station Configuration window. See User Station Configuration (on page 27).
Chapter 7: Administration Features Edit: Modify this user group. Delete: Remove this user group. Privileges Privilege Operations permitted System All operations on the User Station are Administration permitted. Log in to the User Station. Device Administration Modify personal settings. ...
Page 110
Chapter 7: Administration Features The Users column lists the names of all users who belong to this user group. The priority is to show the real names of these users. If the real name is not available in the user profile, the user's login name is shown. Users (on page 95).
Chapter 7: Administration Features LDAP The external LDAP authentication has the following two modes: Authentication and authorization via LDAP • Only authentication via LDAP • Note: For information on enabling or disabling the LDAP authorization, (on page 104). Adding LDAP Servers Authentication and authorization via LDAP: a.
Chapter 7: Administration Features LDAP alias works fine in the LDAP authentication only mode. User Station configuration required for either LDAP authentication mode: Adding LDAP Servers Add the LDAP server(s). See (on page 104). • Enabling or Disabling the • Enable the LDAP authentication.
Page 113
Chapter 7: Administration Features Setting Description The type of the new LDAP server: Type Active Directory Server: Microsoft Active Directory LDAP server: OpenLDAP The order of this LDAP server, which Order determines the authentication priority when there are multiple LDAP servers. If adding more than one LDAP server, you can change the priority by selecting the sequential number of any existing LDAP...
Page 114
Chapter 7: Administration Features Setting Description Configurable when "Type" is set to "Active Domain Directory Server." The Active Directory server's domain name. Usually the User Station can determine the Active Directory server's host name via its domain name and DNS. If you select the following Use Host checkbox, this behavior is replaced.
Page 115
Chapter 7: Administration Features 5. Enter the bind credentials in the Bind section.
Page 116
Chapter 7: Administration Features Setting Description Distinguished Name (DN) of the search Base DN base, which is the starting point of the LDAP search. Example: ou=dev,dc=example,dc=com The attribute of the LDAP user class which Login Name denotes the login name. Attribute Note that only relative distinguished names (RDNs) can be specified in this field.
Page 117
Chapter 7: Administration Features Setting Description Configurable when "Search Credentials" Bind After Search is NOT set to "no search." Select this checkbox if the LDAP bind operation shall be performed with a DN derived from a search operation for the user who's trying to log in.
Page 118
Chapter 7: Administration Features Setting Description Select this checkbox if authorization via Use Groups For LDAP LDAP is intended. See (on page Authorization 103). When disabled, authorization is managed by the User Station, and this LDAP server only manages authentication. Select this checkbox when intending to Use Group search a dedicated base DN instead of...
Page 119
Chapter 7: Administration Features 7. To test whether the connection to the new LDAP server can be successfully established, type the LDAP user name and password in the Test Connection section and click Test. 8. Click Save. 9. Repeat the same steps to add more LDAP servers as needed. Editing or Deleting LDAP Servers To show a list of existing LDAP servers, click Administration >...
Chapter 7: Administration Features To delete an LDAP server: 1. Click the desired server's button. 2. Click OK on the confirmation message. Enabling or Disabling the LDAP Authentication Click Administration > LDAP to open the LDAP Servers page. The right-most button indicates the current LDAP authentication setting. When that page shows , the LDAP authentication is currently disabled, which is the default.
Chapter 7: Administration Features Tip 2: To enable or disable a specific LDAP server only, select or deselect the desired LDAP server's Active checkbox. See Editing or Deleting (on page 111). LDAP Servers Searching for LDAP Users and Groups When the LDAP authentication is being enabled, you can manually search for LDAP users or user groups as needed.
Page 122
Chapter 7: Administration Features If the Search button is disabled, enable the LDAP authentication Enabling or Disabling the LDAP Authentication first. See page 112). 2. In the Server field, select the desired LDAP server from the list of active LDAP servers.
Page 123
Chapter 7: Administration Features Setting Description One or two options are available, depending Search on the selected LDAP server's Credentials configuration. stored admin credentials: Use the admin credentials stored in the LDAP server's configuration. specify below: Use the search credentials specified in the following two fields.
Page 124
Chapter 7: Administration Features This button is displayed for those users who are not added to the User Station yet. Click this button to add the LDAP user as a local user who can also be authenticated via LDAP in the "LDAP authentication only"...
Chapter 7: Administration Features Setting the Maximum Search Results By default, the limitation for the LDAP search results is disabled. When enabling the LDAP, this limitation is enabled. The default limitation is 1000. If the found result entries are more than the upper limit you set, those result entries exceeding the maximum are not displayed but a message shows up to remind you to specify a more accurate search filter.
Page 126
Chapter 7: Administration Features When FIPS mode is enabled, all encrypted connections to KX III KVM • switches are processed using the FIPS accredited cryptographic code and the authenticity of those KVM switches is checked via their certificate chain. When Check KX Device Certificate is enabled, authenticity of KVM switches is checked via their certificate chain.
Chapter 7: Administration Features Removing an Installed Certificate If any installed certificate is outdated, invalid or no longer required, you can remove it. To remove a certificate from the User Station: 1. Click Administration > Certificates. A list of installed certificates is displayed.
Chapter 7: Administration Features Security Settings The User Station optionally uses a FIPS 140-2 encryption module that supports the Security Requirements for Cryptographic Modules of the Federal Information Processing Standards (FIPS), which is defined in the FIPS PUB 140-2 (http://www.nist.gov/cmvp/), Annex A: Approved Security Functions .
Page 129
Chapter 7: Administration Features indicates the setting is disabled. Note: These options require certificates to be installed. Click Manage Certificates to check certificates or install more. See Certificates (on page 117). 2. Click Edit, and then select or deselect the checkboxes for FIPS or Certificate Settings.
Chapter 7: Administration Features Note: If certificates have not been installed yet, you will see the following "Attention" message. Click the certificates link to manage certificates. 3. Click Save. 4. Click OK on the confirmation message. 5. The User Station now reboots if FIPS mode was changed. Wait until the Login Screen appears.
Page 131
Chapter 7: Administration Features Select Never to keep monitor on. Select 1, 2, 3, 5, 10, 15, 30 or 60 Minutes to enable the monitor turn off after the specified idle time period. 4. To lock the screen when idle, check the Lock Screen when idle checkbox.
Chapter 8 Maintenance Features In the User Station Configuration window, click Maintenance to perform the following User Station maintenance tasks. In This Chapter Event Log ....................125 Backup and Restore .................. 132 Factory Reset .................... 136 Software Update ..................138 Support ......................
Chapter 8: Maintenance Features Event Log The Event Log is an application level log of activity taking place in the User Station. It records who did a certain task and when it was done. For example, login and logout, open connection to a KVM-port, updating the software and so on.
Page 134
Chapter 8: Maintenance Features 4. Click Search. The filtered list of events appears at the bottom of the search controls.
Chapter 8: Maintenance Features Event Type and Description The Event Log includes the following events. Authentication Events: Description includes user name and local or LDAP category login of user logout of user failed login attempt LDAP Events: Errors and information for LDAP authentication and authorization ...
Chapter 8: Maintenance Features Event Log Archives Event Log records can be archived to clear the database. Event Log archives are always created and stored inside the User Station. The file created is a compressed CSV file containing one line per record and all attributes of the record.
Page 137
Chapter 8: Maintenance Features 1 week 1 month 2 months 6 months 1 year (default) 2 years 5 years 10 years Or, select "older than selected Date" to enable the Date field, and ...
Page 138
Chapter 8: Maintenance Features Automatic Archives Dominion User Station will automatically create archives in cases where the database has become full of too many records. Automatic archives are implemented with two thresholds, Warning and Critical. The thresholds are checked once per day. If thresholds are met, an error message appears in the event log.
Page 139
Chapter 8: Maintenance Features Deleting Archive Files You can delete an archive file. If you want to save the file off the Exporting Archive Files Dominion User Station before deleting it, see (on page 130). 1. If not displayed, launch the User Station Configuration window. See User Station Configuration (on page 27).
Chapter 8: Maintenance Features Archive File Storage The amount of storage to keep Event Log archives inside Dominion User Station is limited. If no more storage is available, you will see an error message upon attempting to create a new archive. The error message prompts you to delete old archive files.
Page 141
Chapter 8: Maintenance Features 2. Click Maintenance > Backup & Restore. The Backup & Restore page opens. 3. Click Create Backup. 4. Once completed, the Backup Archives page lists the backup file, with the filename, software version and file size shown on the screen. To restore to the previous settings and data: 1.
Chapter 8: Maintenance Features Or, click the filename link to view details, and click the Restore button in the details page. 3. Click OK on the confirmation message. 4. A text screen appears to show restore progress. When restore is completed, Dominion User Station restarts and opens the login page.
Chapter 8: Maintenance Features To import backup files: root Make sure the connected USB drive contains backup files in its directory. 1. Click Maintenance > Backup & Restore. The Backup & Restore page opens. 2. Click Import Backup. The Import Backup from USB Storage page opens.
Chapter 8: Maintenance Features Factory Reset The factory reset feature resets all of your User Station's settings to the factory defaults, but it will remove all customized data simultaneously, including: All KVM switches added to the User Station • User credentials entered for each KVM switch •...
Page 145
Chapter 8: Maintenance Features 2. Click Maintenance > Factory Reset. The factory reset page opens. Read this page before proceeding to the next step. 3. Click 4. Click OK to confirm the operation or Cancel to abort it.
(on page 132). To perform the software UPGRADE: 1. Use a computer to download the User Station software file from the Dominion KX III User Station section of the Raritan website's Support page http://www.raritan.com/support/ 2. Copy the file named "KX3UST_<version>_update.bin" to the root directory of your USB flash drive or CD/DVD disc.
Page 147
9. Click OK on the confirmation message. 10. When the upgrade completes, the User Station reboots, and then the login screen is shown. Note: In case the software upgrade fails, and the User Station is unable to operate, contact Raritan Technical Support.
3. Click Edit. 4. Select the Support Login checkbox. 5. Click Save. 6. Provide your User Station's IP address to Raritan Technical Support. To retrieve the IP address(es), right-click the network icon in the Network Main Toolbar to select Connection Information. See Icon (on page 161).
Chapter 8: Maintenance Features Important: Disable this feature immediately after Raritan Technical Support finishes the troubleshooting task. Log Level for Diagnostic Log Files 1. If not displayed, launch the User Station Configuration window. See User Station Configuration (on page 27).
Page 150
6. Wait until the User Station finishes the export, displaying the "Successfully finished" message as well as the filename of the diagnostic log. 7. Remove the USB drive to copy and send the file to Raritan Technical Support.
Chapter 8: Maintenance Features About this Device The "About this Device" page shows the firmware version information. You can access this page either via the Main Menu or via the User Station Configuration window. To show the version in the User Station Configuration window: 1.
Chapter 9 System Settings Most of the system settings are available under System Settings in the Main Menu. In This Chapter Date/Time ....................144 Keyboard ....................147 Monitor....................... 150 Network Connections ................151 Default Shortcut Icons in the Main Toolbar ..........160 Login Screen Settings ................
Chapter 9: System Settings 2. Click the desired tab to configure date/time settings for the User Station. Date and Time Configure the date and time using the tab labeled (on page 145). If the date and time synchronizes with an NTP server in the "Date ...
Chapter 9: System Settings Speed up initial synchronization: When selected, the initial time synchronization is faster while consuming more network bandwidth. Use Local Time Source: Select this only when you use a radio-controlled clock device to synchronize the User Station's clock with an authoritative time source.
Chapter 9: System Settings You can drag the map to move toward your destination. 3. Select your city's name in the list below the map. 4. To make the system time automatically switch between normal and daylight savings time, select the "System clock uses UTC" checkbox. Keyboard 1.
Chapter 9: System Settings Layouts In the Layouts tab, available keyboard layouts are all shown. The same keyboard layout list is also available when working with the keyboard icon in the Main Toolbar. Any changes made to the dialog's keyboard layout list also change the keyboard layout list available in the Main Main Screen and Main Toolbar Toolbar.
Chapter 9: System Settings Mouse Keys When you want to use the numeric keypad to control the mouse pointer/cursor, select the checkbox labeled "Pointer can be controlled using the keyboard." When enabled, each keypad key functions as the following table. Function Depress the selected button Release the selected button...
Chapter 9: System Settings Monitor 1. Choose Main Menu > System Settings > Monitor. The Monitor Preferences dialog appears. 2. Perform or configure any of the following function: Setting/button Function On/Off Turn on or off this monitor, if there are two monitors connected to the User Station.
Chapter 9: System Settings Setting/button Function Same image in all If two monitors are connected, determine monitors whether both monitors show the same image. This setting is disabled when only one monitor is connected. Detect monitors Click this button if any connected monitor is not detected.
Page 160
Chapter 9: System Settings Ethernet 1 Ethernet 2 is for LAN port 1, and is for the other. 2. Select the desired connection, and click Edit. A dialog similar to the following appears.
Page 161
Chapter 9: System Settings 3. Click the IPv4 Settings or IPv6 Settings tab to configure network settings properly. IPv4 Settings: Setting Description Method Select one of the following as the connection method and configure associated settings: Automatic (DHCP) ...
Chapter 9: System Settings IPv4 Settings Automatic (DHCP): The DHCP server in the network automatically assigns an IPv4 address to the User Station as well as DNS server(s) and domain(s). The following settings are configurable for this method. Setting Description Additional DNS Optional.
Page 163
Chapter 9: System Settings Setting Description DHCP client ID Optional. You can specify a DHCP client ID for identifying this User Station in the network. Require IPv4 When deselected, either IPv4 or IPv6 addressing for this addressing can be used to establish the connection to connection.
Page 164
Chapter 9: System Settings Setting Description Search domains Specify IP addresses of one or multiple domains for resolving host names. Use commas to separate multiple domains. DHCP client ID Require IPv4 addressing for this See the above table for information of these connection to fields/options.
Chapter 9: System Settings IPv6 Settings Automatic: IPv6 autoconfiguration automatically assigns an IPv6 address to the User Station, and retrieves the information of DNS server(s) and domain(s) from the DHCP server. The following settings are configurable for this method. Setting Description Additional DNS Optional.
Page 166
Chapter 9: System Settings Setting Description IPv6 privacy Determine whether and how privacy extensions extensions apply to the IPv6 addressing. Disabled: Disables privacy extensions. Enabled (prefer public address): Enables privacy extensions and a public address is preferred. Enabled (prefer temporary address): Enables privacy extensions and a temporary address is preferred.
Page 167
Chapter 9: System Settings Setting Description DNS servers Specify IP addresses of one or multiple DNS servers. Use commas to separate multiple servers. Search domains Specify IP addresses of one or multiple domains for resolving host names. Use commas to separate multiple domains. IPv6 privacy extensions Require IPv6...
Chapter 9: System Settings Search domains Require IPv6 addressing for this connection to complete Routes Ignore: The IPv6 networking settings are all disabled. Default Shortcut Icons in the Main Toolbar Shortcut icons in the Main Toolbar provides quick access to some system Main Screen and settings.
Chapter 9: System Settings Clicking the icon: A slider bar displays for you to adjust the volume. Right-clicking the icon: A shortcut menu with this command displays. Mute : Mutes the sound. • Network Icon Clicking the icon: A list of available Ethernet networks and connections displays. Only one network connection is shown if only one LAN port is ...
Chapter 9: System Settings Right-clicking the icon: A shortcut menu with these commands displays. Enable Networking : Enables or disables the networking capability. • The default is to enable it. Connection Information • : This command shows the networking information of the User Station, including IPv4 and IPv6 addresses. When only one network connection is active, this dialog shows ...
Page 171
Chapter 9: System Settings Clicking the icon: A calendar with Locations section displays. Click Locations to: Determine the location and time zone of the User Station. • Change the time format of the clock shown in the Main Toolbar. • Location and Clock Time Format For details, see (on page 164).
Chapter 9: System Settings Location and Clock Time Format After expanding the Locations section, click Edit. The Clock Preferences dialog appears. Click the desired tab or button to configure settings.
Page 173
Chapter 9: System Settings Time Settings: Date/Time (on page 144). • Locations: • Click Add to specify your city or country. You can simply type the city or country name in the Location Name field and then select the correct one from the list that appears.
Page 174
Chapter 9: System Settings The Locations section: When you hover your mouse pointer over the weather icon below the location name, more information is displayed, including the weather, temperature, wind speed and the time for sunrise/sunset. Tip: If the system's time zone setting is different from the selected location's and you have the System Administration privilege, a "Set"...
Chapter 9: System Settings Login Screen Settings The following settings are available in the Login Screen, and their Login Screen changes only impact the (on page 6). To enable or disable any function, click it or press its hot key. Function Description Large Font...
Chapter 10 Additional Features In This Chapter Device Resume or Screen Unlocking ............168 Factory Reset at Startup ................169 Device Resume or Screen Unlocking When the User Station enters the Suspend mode, or its screen is locked, no User Station data is displayed onscreen. Note: For instructions on entering the Suspend mode or locking the screen, see (on page 22) and...
If the initial version is , this feature works regardless of the admin password change. Note: Raritan recommends changing the default admin password even though this feature works. See (on page 93). Password Change You must also change the admin password to enable this feature ...
Page 178
6. When the system prompts you to enter user credentials, type the admin credentials -- "admin" user and the current admin password. The default admin password is "raritan" if not changed yet. 7. If the admin credentials are correct, the User Station performs the factory reset and then reboots.
Appendix A Specification Slim 1.3 litre metal chassis, black Chassis design 190 x 165 x 43 mm Dimension (LxWxH) 0 to 40 degrees Celsius Operating temperature non-condensing: 10~90% Humidity 75 x 75 mm VESA mount 100 x 100 mm ...
(on page 30). For detailed information on what you can do with a KVM port/target server, see the user documentation for KX III KVM switches, which is accessible from the KVM switch's application or KX III section of Raritan Support page http://www.raritan.com/support/...
Page 181
Appendix B: Authentication of User Stations and KVM Switches User account for Tasks you can do on the User account for Tasks you can do on a KVM the User Station User Station the KVM switch port/target server admin You can do anything, user-A Limited privileges are including:...
Appendix C Available Key Sets Keyboard Macros The following table shows available key sets for (see Managing Keyboard Macros " " on page 85). Note that a few keys may belong to more than one ket set. Key set Keys contained Letters A to Z Numbers...
Page 184
Appendix C: Available Key Sets Key set Keys contained Japan Kana Japanese Keys Japan Convert Japan No Convert Japan Yen Japan Circumflex Japan @ Japan : Japan Kanji Japan Ro Korea Hanja Korean Keys ...
Appendix D Pre-programmed User Station Hotkeys You can use pre-programmed hotkeys to control the User Station, such as resizing a User Station window or shutting down the User Station. The pre-programmed hotkeys cannot be customized or disabled. For a complete list of pre-programmed hotkeys of the User Station, refer Online Help and Hotkeys to "Help on Hotkeys"...
Page 186
Appendix D: Pre-programmed User Station Hotkeys Hotkey Function monitor. Ctrl + Alt + Ctrl + Alt + Ctrl + Alt + Ctrl + Alt + 1 (on the keypad) Ctrl + Alt + 3 (on the keypad) Move the window to the screen corner in the specified direction on the monitor.
Page 187
Appendix D: Pre-programmed User Station Hotkeys Hotkey Function While pressing Alt, press and "hold down" the left mouse button to drag Alt + Left mouse button the window to the new location onscreen.
Appendix E Card Reader Restriction Caused by KX III KVM Switch Settings In the following context, "the device" refers to a KX III KVM switch, not the User Station. When PC-Share mode is enabled on the device, multiple users can share access to a target server.
Appendix F Certificate Requirements Dominion User Station requests and verifies server certificates for its TLS connections if the according options are set. In FIPS-mode certificate verfication is always enabled. The following protocols potentially verify the server's certificate: • RDMP: the KX status protocol, TLS via OpenSSL RFB: the KX KVM redirection protocol, TLS via JSSE and NSS (in •...
Page 190
Appendix F: Certificate Requirements Examples OpenSSL's command line tool openssl can be used to create according certificates. Sign a KX3-CSR (Certificate Signing Request) with by a CA (Certfication Authority): openssl x509 -req -days 365 -in kx3.csr -CA ca/root-ca.crt -CAkey ca/root-ca.key -set_serial 01 \ -extfile v3.ext -out kx3-by-root-ca.crt with the following meanings: •...
Page 191
Appendix F: Certificate Requirements This can be reproduced with an OpenSSL command line like this, assuming kx3-by-root-ca.crt is the certificate file: openssl x509 -in kx3-by-root-ca.crt -noout -text...
Index Default Shortcut Icons in the Main Toolbar • Deleting Archive Files • 131, 132 About this Device • 138, 143 Deleting Backup Files • 135 Absolute Mouse Mode • 52, 53, 55 Deleting KVM Switches • 31 Adding KVM Switches • 28 Desktop Settings •...
Page 194
Index Mouse Synchronization Tips • 52, 55 Hotkeys for Controlling the User Station • 177 Hotkeys for Controlling User Station Windows Navigation and Access to KVM Ports • 36 • 9, 177 Network Connections • 20, 132, 151, 162 Network Icon • 8, 140, 151, 153, 155, 158, 161 Noise Filter •...
Page 195
Index Show Window Decorations • 81, 91 View Settings • 80 Side View • 5 Virtual Media • 2, 62, 64 Single Mouse Cursor • 52, 55, 91 Virtual Media CIMs • 53, 65, 70 SmartCard Reader • 62, 71 Volume Icon •...
For CommandCenter Secure Gateway: Press 6, then Press 2 Phone: +31-10-2844040 Fax: 732-764-8887 Email: tech.europe@raritan.com Email for CommandCenter NOC: tech-ccnoc@raritan.com United Kingdom Email for all other products: tech@raritan.com Monday - Friday 8:30 a.m. to 5 p.m. GMT China Phone +44(0)20-7090-1390 Beijing...
Need help?
Do you have a question about the Dominion KX III and is the answer not in the manual?
Questions and answers