Microsoft SQL Server
Advanced configuration of Microsoft SQL Server connection type
Support for the SQL Server protocol within Keeper Connection Manager is provided by the
kcm-libguac-client-sql-serverpackage. This package will be installed by default if the
@kcm-guacamolepackage group was used during installation, and is already installed within the
keeper/guacdDocker image. If this package has not yet been installed, SQL Server connections will not be functional, with guacd logging a warning noting the absence of needed protocol support:
guacd: WARNING: Support for protocol "sql-server" is not installed
If such an error appears within the guacd logs, simply installing
kcm-libguac-client-sql-serveris sufficient to resolve the issue:
$ sudo yum install kcm-libguac-client-sql-server
The guacd service does not need to be restarted for installation of SQL Server support to take effect.
The SQL Server implementation in Keeper Connection Manager utilizes the SQL Server client library as well as an internal terminal library which renders the user interface. Guacamole's SQL Server support emulates a terminal on the server side, and draws the screen of this terminal remotely on the client.
This document is intended to cover all supported parameters, grouped in the same way they are grouped within the web interface. The field headings which would appear in the web interface are provided for each parameter, along with each parameter's internal name and a thorough description of the behavior and legal values for that parameter.
SQL Server connections are established over TCP to a specific port and a specific hostname or IP address. The hostname/address must be specified for all connections, but you only need to specify a port if you are not using the standard port (1433).
Keeper Connection manager supports SQL Server authentication through username and password parameters. Both fields are required to establish a connection.
The default database can be specified when establishing the connection. You can also disable the ability to perform CSV import and export of data.
Guacamole's SQL Server support provides a display, but not in the same sense as a remote desktop protocol like VNC or RDP. The display is a terminal emulator, and thus provides options for configuring the font used and its size.
If selecting a different font for a SQL Server connection, the chosen font must be installed on the server running guacd. It is the server that will handle rendering of characters to the terminal display, not the client.
Custom color schemes may be provided for the terminal emulator used by SQL Server connections. Custom schemes mimic the format used by Xterm and consist of a semicolon-separated series of name-value pairs. Each name-value pair is separated by a colon and assigns a value to a color in the terminal emulator palette.
For example, to use blue text on white background by default, and change the red color to a purple shade, you would specify:
Legal color names are:
foreground" - the default foreground color.
background" - the default background color.
colorN" - the color at index N within the Xterm 256-color palette. For example, "color9" refers to the color at palette index 9, normally red.
Legal color values are:
- "rgb:RR/GG/BB" - a color in RGB format, with each component in hexadecimal. For example, "
rgb:ff/00/00" specifies the color red. Each hexadecimal component may be one to four digits, but the effective values are always zero-extended or truncated to two digits; for example, "
rgb:f0/80/00", and "
rgb:f0f/808/00f" all refer to the same effective color.
colorN" - the color currently assigned to index N within the Xterm 256-color palette. For example, "
color9" specifies the color currently assigned to palette index 9. Note that the current color value is used rather than a reference to that color. If the referenced color is changed later in the color scheme configuration, that new color value will not be reflected in this assignment.
Guacamole provides bidirectional access to the clipboard by default for SQL Server connections. This behavior can be overridden on a per-connection basis, restricting access to the clipboard.
The full, raw text content of SQL Server sessions, including timing information, can be recorded automatically to a specified directory. This recording, also known as a "typescript", will be written to two files within the directory specified: one file contains the raw text data, and the other contains timing information. Where "
NAME" is the value provided for the typescript name, these files will be named "
NAME" and "
This format is compatible with the format used by the standard UNIX
scriptcommand, and can be replayed using
scriptreplay(if installed). For example, to replay a typescript called "
NAME", you would run:
$ scriptreplay NAME.timing NAME
SQL Server sessions can be recorded graphically. These recordings take the form of Guacamole protocol dumps and are recorded automatically to a specified directory. Recordings can be subsequently played back using the Glyptodon Enterprise Session Recording Player application hosted at player.glyptodon.com (or using a local deployment of this application).