Teradici soft client setup for DXx-H4 · Knowledge Base Article148 . Teradici soft client setup for...

www.amulethotkey.com v1.1 KB-A000-0148 17 November 2020 |

Knowledge Base Article Teradici soft client setup for DXx-H4

Summary This guide tells you how to setup the Teradici soft client with Teradici hosts.

Contents Check your system ................................................................................................................................................. 2

Recommended setup configuration ..................................................................................................................................................................... 2 Windows and Mac soft client Support ................................................................................................................................................................. 3 Check your operating system ............................................................................................................................................................................... 3 Network Considerations ....................................................................................................................................................................................... 5

Configure the host ................................................................................................................................................. 6

Disable temporal dithering ................................................................................................................................................................................... 6 Configure absolute to relative (abs2rel) soft client mouse control ...................................................................................................................... 6 Disable mouse or trackpad acceleration for a macOS host .................................................................................................................................. 7

Configure the host display ..................................................................................................................................... 8 Configure Monitor Emulation settings ................................................................................................................................................................. 8 Set display settings ............................................................................................................................................................................................... 9

Configure the host power profile ......................................................................................................................... 10

Set the correct power profile (macOS) ............................................................................................................................................................... 10

Configure the soft client ...................................................................................................................................... 11

Display Considerations ....................................................................................................................................................................................... 11 Align the soft client resolution with the remote host resolution ........................................................................................................................ 11 How to launch a Soft client Direct connection (non-brokered) from version 20.x ............................................................................................. 12 Enable command key pass-through (Apple keyboard to macOS remote host) .................................................................................................. 13

Troubleshooting .................................................................................................................................................. 14

Configure an iMAC as a remote host .................................................................................................................................................................. 14 Configure MacBook Pro Display resolutions ....................................................................................................................................................... 14 Configuring MacBook Pro Display when not running in full screen .................................................................................................................... 15 Issues Loading the Kext (macOS) ........................................................................................................................................................................ 16 Verify Ports are not blocked ............................................................................................................................................................................... 17 Cable Requirements ........................................................................................................................................................................................... 19

Contact us: ........................................................................................................................................................... 20

Resources ............................................................................................................................................................ 20

148

http://www.amulethotkey.com/

Knowledge Base Article 148 Teradici soft client setup for DXx-H4


Check your system

Recommended setup configuration

For the best operation make sure you have the latest software/firmware available. See Table 1:

Note: Refer to the latest Tech Note on our website for the latest recommended software and firmware available.

Item Version

IMPORTANT: To connect a soft client to a DXx-H4 with firmware package 1.12.3 installed requires an active Teradici CAS license.

Note: Use 17.05.1 remote workstation card firmware if there is no CAS license in use.

Note: Teradici soft client / DXx-H4 supports HID class devices only, there is currently no isochronous device support.

Teradici soft client Example: 20.04.2

Teradici remote workstation card firmware Example: 20.04.2

DXx-H4 firmware package Example: 1.12.3

Table 1: Recommended software and firmware


https://resources.amulethotkey.com/resources/kvm-extenders/dxt-h4



Windows and Mac soft client Support

The Windows Teradici soft client has been tested with the host operating systems in Table 2:

Windows macOS

Windows 10

Catalina 10.15

Mojave 10.14

High Sierra 10.13

Sierra 10.12

Table 2: Supported operating systems

Check your operating system To check your operating system, do the following:

Step Action

1 Refer to Table 3 and Table 4 to see if there is a requirement to enable or disable the absolute-to-relative (abs2rel) soft client mouse control (and mouse acceleration for macOS) for your operating system.

2 See Configure absolute to relative soft client mouse control and Disable mouse acceleration for a macOS host for how to set the settings correctly.




Win 10 Soft client 20.04.2 Dual Screen abs2rel - Windowed / Single Monitor

abs2rel - Dual Monitor

Mouse acceleration

Host OS

Windows 10 Supported N/A N/A N/A

Sierra 10.12 Supported Enabled - Auto Enabled - Auto Disabled

High Sierra 10.13 Supported Enabled - Auto Enabled - Auto Disabled

Mojave 10.14 Supported Disabled Enabled - Auto Disabled

Catalina 10.15 Supported Disabled Enabled - Auto Disabled

Table 3: Win10 soft client requirements

MacOS Soft client 20.04.2 Dual Screen abs2rel - Windowed / Single Monitor

abs2rel - Dual Monitor

Mouse acceleration

Host OS

Windows 10 Supported N/A N/A N/A

Sierra 10.12 Supported Enabled - Auto Enabled - Auto Disabled

High Sierra 10.13 Supported Enabled - Auto Enabled - Auto Disabled

Mojave 10.14 Supported Disabled Enabled - Auto Disabled

Catalina 10.15 Supported Disabled Enabled - Auto Disabled

Table 4: macOS soft client requirements




Network Considerations To ensure optimal PCoIP performance the network must be qualified, and the following points considered:

• traffic shaping, contention and throttling may play a part in remote connectivity performance. This may be relevant in both standard broadband providers (wired/fibre) and 4G networks;

• standard home broadband equipment may not provide optimisation features which help with troubleshooting such as dedicated LAN bandwidth, QoS, logging and management;

• local (client OS) software such as anti-virus and firewall, can cause performance issues in some cases;

• higher latencies and low upstream and/or downstream capacity will impact performance.

IMPORTANT: Refer to the following guidance for qualifying, configuring and supporting your PCoIP network:

• Teradici Network Checklist

• Teradici Network and System Requirements

• Teradici Working-From-Home Rapid Response Guide


https://www.teradici.com/web-help/TER1105004/Content/Topics/02_NetworkReqs.htm

https://www.teradici.com/web-help/pcoip_session_planning/current/network/network_requirements/

https://www.teradici.com/web-help/work-from-home/



Configure the host Perform the following tasks to configure the host:

Disable temporal dithering;

Configure absolute to relative (abs2rel) soft client mouse control;

Disable mouse acceleration for a macOS host.

Disable temporal dithering Temporal dithering is a technique graphics cards use to generate intermediate colours, by rapidly alternating a pixel between two adjacent colour values. The effect is not perceptible to the human eye.

Note: For any compression algorithm, such as that used by PCoIP, this results in a significant overhead when dealing with the increased pixel colour, so it is important to turn this function off.

Step Action

1

Disable temporal dithering on the Windows or Mac host.

For macOS: refer to AN 057 for Mac.

For Windows: refer to AN 144 and AN 063.

Configure absolute to relative (abs2rel) soft client mouse control

Step Action

1 Connect to the Management Interface (MI)

Refer to KBA 137 – Management commands for the Quad Display KVM Extender Hosts.

2

Set the abs2rel parameter for your operating system.

Refer to KBA 137 – Management commands for the Quad Display KVM Extender Hosts.

For example, from the MI:

abs2rel -d disables absolute to relative mouse conversion.

abs2rel -a enables abs2rel mode.


https://resources.amulethotkey.com/download/AN_057_Temporal_Dithering_on_macOS.pdf

https://resources.amulethotkey.com/download/AN_144_KBA_144-Disable_temporal_dithering_on_Windows_May_2018.pdf

https://resources.amulethotkey.com/download/AN_063_Disable_temporal_dithering_on_DXM_blades_v2_0.pdf

https://resources.amulethotkey.com/download/KBA_137-Management_commands_KB-A000-0137.pdf






Disable mouse or trackpad acceleration for a macOS host By default, mouse drivers track the movement of the mouse and, depending on sensitivity settings, the cursor will move across the screen by a similar and consistent distance.

Mouse acceleration is a threshold setting in addition to this. When the mouse is moved past a certain point or at a certain speed, the cursor itself moves more quickly and goes further, accelerating the movement speed and rate of the mouse cursor.

To disable mouse acceleration:

Step Action

1 Open Terminal for the one-time configuration.

2 To disable mouse acceleration: defaults write .GlobalPreferences com.apple.mouse.scaling -1

3 To confirm status of mouse acceleration: defaults read -g | grep mouse

4 Restart the host machine.

To disable trackpad acceleration:

Step Action

1 Open Terminal for the one-time configuration.

2 To disable mouse acceleration: defaults write .GlobalPreferences com.apple.trackpad.scaling -1

3 To confirm status of mouse acceleration: defaults read -g | grep trackpad

4 Restart the host machine.




Configure the host display Perform the following tasks to configure the host display:

Configure Monitor Emulation settings;

Set display settings.

Configure Monitor Emulation settings Monitor emulation is a feature on the PCoIP Remote Workstation Card that ensures graphics cards see a valid EDID on a Display Port or DVI port on boot. Make sure you only enable Monitor Emulation on the PCoIP Remote Workstation Card display ports you use. Enabling monitor emulation on more ports than necessary may result in the operating system and graphics card using ports not in use on the soft client.

Step Action

1

Select Configuration > Monitor Emulation to enable or disable monitor emulation for the video ports on your DXx-H4 host card.

The configuration page appears.

2 Make sure Enable Monitor Emulation is checked only for connected displays.

3 Click Apply and restart the host card for changes to apply.




Set display settings

Step Action

1

Refer to Table 3 for details of what your firmware supports.

Firmware Package… …supports

1.12.2 single display up to 2560x1600 @60Hz

1.12.3 (recommended)

dual displays up to 2560x1600 @60Hz

Table 5: Supported displays

2 To make sure absolute to relative scaling (abs2rel) works correctly:

Set the resolution of the remote host to be the same as the reported TERA resolution for the soft client.

3

If you are using dual displays, set the vertical alignment on the remote and local host so that the screens align at the top. See Figure 1 and Figure 2.

Figure 1: Windows display alignment

Figure 2: macOS display alignment




Configure the host power profile

Set the correct power profile (macOS) If the mac enters a power saving state during a soft client session, the soft client will present a black screen.

Step Action

1 Click on the Apple on the menu bar and select System Preferences > Energy Saver.

2 Set the slider setting for Turn display off after to Never.

3 Select ( ) and deselect (x) the following options:

Prevent computer from sleeping automatically when the display is off Put hard disks to sleep when possible Wake for network access Start-up automatically after a power failure

X Enable Power Nap

4 Close the window.




Configure the soft client

Display Considerations The best practice is to use the native resolution of the local soft client display.

A border may sometimes be observed around the outside of the soft client window when expanding a windowed soft client view to full screen. To avoid this, establish a PCoIP session with the host when the soft client window is already expanded full screen.

NOTE: If the mouse is not aligned then set the resolution of the host Display properties to that of the resolution reported in the AWI.

Align the soft client resolution with the remote host resolution

Step Action

1 Check the client screen resolution (for example 2560 x 1440).

2 Open the PCoIP soft client in a window.

3 Set the PCoIP soft client to full screen.

4 Set the resolution of the remote Host to that of the Client Display resolution using the ‘Alt’ or ‘Option Key’ to select a specific resolution.

5

Confirm that the resolution reported in the attached devices of the AWI is the same as the Client screen resolution:

a) Log into the AWI of the Remote Host Card.

b) Check the resolution at Info > Attached Devices.

6 Disconnect the soft client.

7 Re-connect the soft client (the soft client will revert to the previous state i.e. full screen).




How to launch a Soft client Direct connection (non-brokered) from version 20.x

For macOS

Step Action

1 Start Automator (can be found in the applications folder or with launchpad).

2 Select File > New.

3 Select “Application” in the Dialogue > choose.

4 Scroll down to “Run Shell Script” and double click.

5 Paste in the following text: open -a /Applications/PCoIPClient.app --args -hard-host <insert host card IP>

6 Select File > Save.

A popup window appears.

7 Enter an appropriate filename:

Select desktop in the ‘Where:’ dropdown menu.

8 Click Save.

9 Select Automator > Quit.




For Windows

Step Action

1

Either: Open Command Prompt and type the following: “C:\Program Files (x86)\Teradici\PCoIP Client\bin\pcoip_client.exe” -hard-host <hostcard IP>

Or:

Create a batch file with the following contents:

“C:\Program Files (x86)\Teradici\PCoIP Client\bin\pcoip_client.exe" -hard-host <hostcard IP>

Enable command key pass-through (Apple keyboard to macOS remote host) By default the macOS softclient does not support command key pass-through.

To allow command key pass-through to the macOS host, do the following on the client machine:

Step Action

1 Open a terminal.

2 Change Directory to the Library/Preferences folder. cd ~/Library/Preferences

3 List the contents of the folder. ls -l

4 Confirm that the following .plist file exists. com.teradici.Teradici PCoIP Client.plist

5 Edit the file using the following command – setting remap_cmd_to_ctrl to 0 (zero). defaults write “com.teradici.Teradici PCoIP Client.plist” remap_cmd_to_ctrl 0

6 Confirm that the 0 (zero) setting has been written to the file. defaults read “com.teradici.Teradici PCoIP Client.plist” remap_cmd_to_ctrl

7 Reboot the Client Machine for settings to take effect.




Troubleshooting This section contains the following topics:

Configure an iMAC as a remote host;

Configure MacBook Pro Display resolutions;

Configuring MacBook Pro Display when not running in full screen;

Issues Loading the Kext (macOS);

Verify Ports are not blocked;

Cable Requirements.

Configure an iMAC as a remote host

The optimal way to configure an iMAC as a remote host is to setup a Mirrored display topology.

This means that the local display will be mirrored to the remote display on your soft client. The consequence of this is that you can have only one display configured for your soft client.

For all other display options please contact the Amulet Hotkey Support desk.

Configure MacBook Pro Display resolutions

For the best performance, we recommend running the soft client full screen on an external monitor.

This allows the soft client to pass an EDID to the remote host enabling correct configuration of resolution.




Configuring MacBook Pro Display when not running in full screen

Step Action

1 Install EasyRes from the App store to allow you to define a resolution and run the soft client in a window.

2

Before establishing a PCoIP Soft client connection, use EasyRes to check that the resolution of the local client is set to a resolution higher than required on the Host.

Example: Set the resolution of a MacBook Pro (using EasyRes) to Standard (1x) 2688 x 1600 60Hz in order to have a Soft client window sized to 2560x1440.

3 Once connected using the PCoIP soft client, adjust the size of the PCoIP Soft client window so that it is almost full screen.

4 To see additional available resolutions, go to the Display properties of the Host and click on Scaled whilst pressing the ‘option’ key on your keyboard.

5 Once you have defined the resolution (in this instance 2560x1400) of the host you need to adjust the border of the window so that there is no black surround (otherwise you get mouse scaling issues).




Issues Loading the Kext (macOS) If you are having issues loading the Kext (Disable temporal dithering) do the following:

Step Action

1

Boot to recovery mode by typing:

‘sudo nvram recovery-boot-mode=unused’ You can also use another method, for example, hit Cmd + R on reboot.

2 From the recovery partition, click on Utilities > Terminal.

Run ‘csrutil disable’ – this disables SIP.

3 Restart the Mac and log in.

4 Copy the SC371 dmg file to the Mac, open the disk and then the dmg file. If prompted, agree to the terms of the kext.

5

In a Terminal window run:

‘sudo kextcache -u /’

Note: This may take a while to run.

6 To check that the kext has loaded, in a Terminal window, run: ‘kextstat | grep -v apple’.

7 Boot to the recovery partition.

8

From the recovery partition, click on Utilities > Terminal.

Run ‘csrutil enable’

This enables SIP once again.

9

Restart the Mac and log in.

To check that the kext is still loading correctly, open a Terminal window and run:

‘kextstat | grep -v apple’.




Verify Ports are not blocked For Windows: Using PowerShell

To check that a firewall isn’t blocking a port between the client and the remote host card complete the following troubleshooting steps:

Step Action

1 Open PowerShell

2

Test ports using the following command.

Test-NetConnection <hostcard IP> -port <portnumber>

An example result below shows that port 4172 is open.

ComputerName hostcard IP

RemoteAddress hostcard IP

RemotePort 4172

InterfaceAlias Wi-Fi

SourceAddress Your IP address

TcpTestSucceeded True

3

Check the following ports to confirm correct operation:

4172 – PCoIP Protocol

443 – https access to the Teradici AWI

7555 – SSH access to the Management Interface (optional)

7556 – TFTP access to upload FW packaged (optional)




For Mac: Using Port Scanner Utility

Step Action

1 Hit Command + Spacebar to summon Spotlight and enter ‘Network Utility’ to launch the Network Utility app.

2 Select the Port Scan tab.

3

Set a range of ports to scan.

Example: To scan port 4172, specify ports between 4170 and 4179.

4

Check the following ports to confirm correct operation:

4172 – PCoIP Protocol

443 – https access to the Teradici AWI

7555 – SSH access to the Management Interface (optional)

7556 – TFTP access to upload FW packaged (optional)




Cable Requirements

Type Description Notes

Use the following cables to connect to the DXT-H4/DXR-H4

mDP to mDP Standard Cables (CL-MDMD-0005) Confirmed 4K @ 30Hz + 2560 x 1440 60Hz

DP to mDP Standard Cables 3m or 1m (CL-MDDP-0007) (3m) or (CL-MDDP-006) (1m)

Confirmed 4K @ 30Hz + 2560 x 1440 60Hz

Thunderbolt 3 (USB-C) to mDP Startech (CDP2MDPMM1MB) Confirmed 4K @ 30 Hz + 2560 x 1440 60Hz

HDMI to mDP Active Not currently supported




Contact us:

Support Center Telephone Email

North America +1 (212) 269 9300 [email protected]

[email protected]

Europe +44 (0)20 7960 2400 [email protected]

Asia Pacific - [email protected]

Latin America - [email protected]

Resources Visit our resources page, https://resources.amulethotkey.com/resources.


mailto:[email protected]





https://resources.amulethotkey.com/resources

Teradici soft client setup for DXx-H4 · Knowledge Base Article148 . Teradici soft client setup for...

Documents

Transcript of Teradici soft client setup for DXx-H4 · Knowledge Base Article148 . Teradici soft client setup for...