management commands for quad display kvm extender hosts · knowledge base article137 management...

www.amulethotkey.com KB-A000-0137 v1.3 13 May 2019 |

Knowledge Base Article Management commands for Quad Display KVM Extender Hosts

Summary

This KBA describes the commands for the management interface for the DXT-H4 Quad-Display KVM Extender Host, or the DXR-H4 Quad-Display KVM Extender Host card.

See Figure 1 for an example of a command and response.

Figure 1: The Manager interface (commands listed depend on firmware version)

137

http://www.amulethotkey.com/

Knowledge Base Article 137 Management commands for Quad Display KVM Extender Hosts


Enable the connection to the Management Interface

To turn on the network connection to the Management Interface (MI):

Step Action

1 Press and hold the Fn button on the front of the unit and power cycle.

This enables the MI for this power cycle only.

Note: If you want the MI to be available at every power up you can use configuration commands to change the default state of the MI on power up. See KBA 137 - Management Interface commands for Quad Display KVM Extender Hosts.

Important! Pressing the Fn button on start-up always overrides the user configuration.

Start the T2 External Host Manager

On a network with a DNS and a DHCP server, you will need the hostname of the DXT-H4 or DXR-H4. This is also the serial number labelled on the unit (for example, FR10003G6).

Step Action

1 Open a SSH client (such as TeraTerm or PuTTY) on the SysAdmin PC.




Step Action

2 a) Enter either:

• the KVM Extender Host’s hostname;

• or IP address for the destination;

b) Enter 7555 for the port and click Open.

You will be prompted for a username and password.

3 Enter the default username admin and the password ahkdante.

How to use this guide

The remainder of this guide contains a glossary and a description of all commands available. Contact Technical Support for details of further developments and releases of the management interface.




Glossary

Command Description

help Display a brief overview of the available commands.

abs2rel Control soft client absolute to relative mouse conversion options.

activeconns Displays the host’s established TCP/IP connections.

alarm Enables, disables, or tests the unit's alarm.

enabledhcp Enable DHCP addressing.

exit Exit the host SSH session.

factory Sets the KVM extender to its factory defaults.

flushdns Clear the DNS client resolver cache.

info Display general information about the host.

ipconfig Display the current TCP/IP configuration.

login Configure the SSH login credentials.

netroutes Display the visible TCP/IP routes.

network Enables or disables the MI network port. (Necessary for VMware)

ping Test a network route between the host and a destination.

registeragent Register the host with a virtual desktop broker.

reset Power-cycle the host.

resetdns Reset the client DNS addresses.

showdns Display the DNS client resolver cache.

shutdown Powers off the host.

staticip Configure a static IP address.

status Display current statuses, versions, and thermals of the host.

topology Configures the display topology settings. For use with software clients.

update Update the host from an existing update package.




help

Function Description

NAME help

SYNOPSIS

help

DESCRIPTION

Displays a glossary of each command available on the host Manager.

OPTIONS none

abs2rel


NAME abs2rel

SYNOPSIS

abs2rel [-h] [-s] [-d] [-a] [-x width -y height]

DESCRIPTION

Control soft client absolute to relative mouse conversion options. Minimum fixed dimensions - 0 x 0. Maximum fixed dimensions - 16384 x 8640

OPTIONS

-h displays a help page

-s display the current screen status.

-d disables absolute to relative mouse conversion.

-a enables abs2rel mode. Screen size automatically calculated based on resolutions and topology.

-x width enables abs2rel mode with fixed screen width pixels.

-y height enables abs2rel mode with fixed screen height pixels.

EXAMPLE

abs2rel -x 1920 -y 1200

Enables conversion with a fixed screen area of 1920x1200 (single-head).

abs2rel -x 3840 -y 2400

Enables conversion with a fixed screen area of 3480x2400 (quad-head in 2x2 arrangement).




activeconns


NAME activeconns

SYNOPSIS

activeconns [-h]

DESCRIPTION

Displays a table of the management interface’s established TCP/IP connections, showing the local to remote address and port mappings.

OPTIONS -h displays a help page

alarm


NAME alarm

SYNOPSIS

alarm [-h][-e][-d][-s][-t]

DESCRIPTION

Enables, disables, or tests the unit's alarm which sounds during critical events.

OPTIONS


-e enables the alarm.

-d disables the alarm.

-s shows the current status of the alarm.

-t sounds the alarm for 3 seconds.




enabledhcp


NAME enabledhcp

SYNOPSIS enabledhcp [-h][-f]

DESCRIPTION

Configures the MI for DHCP addressing. Removes any static IP configurations and enables DHCP.

OPTIONS -h displays a help page -f ignores any warnings

exit


NAME exit

SYNOPSIS exit [-h]

DESCRIPTION

Closes the manager and exits the current SSH session.





factory


NAME factory

SYNOPSIS factory [-h] [-f]

DESCRIPTION

Sets the KVM extender to its factory defaults. By default, a warning will be given if a PCoIP session is in progress. WARNING - This clears all user configurations and settings. After this command is issued and the KVM extender is reset:

• KVM extender resets the Teradici chip to its factory defaults. • Removes any static IP configurations and enables DHCP. • Resets the MI login credentials to their defaults. • Removes the last uploaded update package. • Removes any VMware Horizon broker registrations.

Note: The KVM extender must be manually removed from the broker.

OPTIONS -h displays a help page -f factory reset is forced, ignoring any warnings.

flushdns


NAME flushdns

SYNOPSIS flushdns [-h]

DESCRIPTION

Flushes and resets the contents of the Management Interface’s DNS client resolver cache.





Info


NAME info

SYNOPSIS info [-h]

DESCRIPTION

Displays the current versions and variants of the host. ’---‘indicates that the values cannot be retrieved.


ipconfig


NAME ipconfig

SYNOPSIS ipconfig [-h] [-v]

DESCRIPTION

Displays the current domain, IPv4 address, CIDR prefix, gateway and DNS address(es) of the MI.

OPTIONS -h displays a help page -v displays verbose results




log


NAME log

SYNOPSIS log [-h] [-lines] [-m]

DESCRIPTION

Displays log messages from the MI and internal monitoring services (from latest to oldest). Returns 10 lines by default.

OPTIONS -h displays a help page -lines specifies the number of line of log messages to display

-m specifies the number of line of log messages to display.

EXAMPLE

log -Returns the last 10 management interface log messages. log –m -Returns the last 10 monitor service log messages. log 100 -Returns the last 100 management interface log messages. log 100 –m -Returns the last 100 monitor service log messages.

login


NAME login

SYNOPSIS login [-h] [-u username] [-p]

DESCRIPTION

Configures the current SSH login username or password. Only one credential can be changed at a time. The current password must be provided to confirm the changes.

OPTIONS

-h displays a help page -p specifies the new password. Cannot be used with ‘-u’ -u username

changes the username to username. The host must be reset for a change in username to take effect. Cannot be used with ‘-p’




netroutes


NAME netroutes

SYNOPSIS netroutes [-h]

DESCRIPTION

Displays the next TCP/IP route hops visible to the MI.


network


NAME network

SYNOPSIS network [-h] [-e] [-d] [-s]

DESCRIPTION

Enables or disables the MI network port. This persists between power cycles. Changes only take effect on startup. Note: You must enable the network if the KVM is used with a VMware Horizon broker.

OPTIONS


-e enables the MI network

-d disables the MI network

-s shows the current status of the MI network




ping


NAME ping

SYNOPSIS ping [-h][destination][-t][-v][-p remote_port]

DESCRIPTION

Tests a network route between the host and a destination by attempting to ping a remote IP or hostname from the MI over the network.

OPTIONS

-h displays a help page -t displays the trace of route hops between the Management

Interface and the destination (cannot be used in combination with –p)

-v displays verbose results destination specifies the remote destination IP address or hostname -p remote_port

specifies the destination target remote port number (cannot be used in combination with -t)

EXAMPLES ping 192.168.56.101 Ping an IP address ping amulethotkey.com Ping a hostname ping 192.168.56.101 –p 1234 Ping an IP on remote port 1234




registeragent


NAME registeragent

SYNOPSIS registeragent[-h][broker_ip] [-p provider] [-d domain][-p remote_port] [-u username]

DESCRIPTION

Registers the host with a VMware Horizon connection broker. The host must be reset afterwards for the changes to take effect.

OPTIONS

-h displays a help page broker_ip

specifies the IP address of the virtual desktop broker

-p vmware

specifies the provider of the broker being registered with

-d domain

specifies the name of the domain the broker is joined to

-u username

specifies the login username of the broker

EXAMPLES Register with a VMware Horizon broker: registeragent 192.168.56.101 –p vmware –d vmdc01 –u administrator




reset


NAME reset

SYNOPSIS reset [-h][-f]

DESCRIPTION

Power-cycles the KVM extender. A warning is displayed if the PCoIP session if active.

OPTIONS -h displays a help page -f forces the reset and ignores any warnings or prompts

Resetdns - NOW REMOVED??


NAME resetdns

SYNOPSIS resetdns [-h]

DESCRIPTION

Clears the current client DNS addresses used by the MI and assigns new ones dynamically.


showdns


NAME showdns

SYNOPSIS showdns [-h]

DESCRIPTION

Displays the contents of the DNS client resolver cache, which includes both entries preloaded from the local hosts file and any recently obtained resource records for name queries resolved by the Management Interface.





shutdown


NAME shutdown

SYNOPSIS shutdown [-h][-f]

DESCRIPTION

Powers off the host. By default, a warning displays if a PCoIP session is active.

OPTIONS -h displays a help page -f forces shutdown and ignores any warnings.

staticip


NAME staticip

SYNOPSIS staticip [-h][static_address][-l subnet_cidr] [-g gateway][-p primary_dns][-s secondary_dns][-f]

DESCRIPTION

Configures the MI with a static IP address with a subnet specified in classless inter-domain routing (CIDR) notation.

OPTIONS

-h displays a help page static_address specifies the static IPv4 address to use -l subnet_cidr

specifies the subnet prefix length to use in classes inter-domain routing (CIDR) notation

-g gateway specifies the gateway address

-p primary_dns specifies the primary DNS address

-s secondary_dns specifies the secondary DNS address

-f ignores any warnings

EXAMPLE Basic IP configuration: staticip 192.168.56.101 –l 24 –g 192.168.56.254 –p 192.168.56.10




status


NAME status

SYNOPSIS status [-h] [-u] [-t] [-p] [-n]

DESCRIPTION

Displays the current version and status of each component in the host. --- indicates that the value is unknown. *FAULT* indicates a fault with the component.

OPTIONS

-h displays a help page -u displays the current status of any bridged USB devices -t displays the current host temperatures and fan-speeds -p displays the status and start time of the PCoIP session if active

-n displays USB bridging statuses including the bridged device names

topology


NAME topology

SYNOPSIS status[-h][-s][-a head][-e head][-x coordinate][-y coordinate]

DESCRIPTION

Configures the display topology settings. The location of each video head is defined by the coordinate of the top-left most pixel. Intended for use with software clients. Note: Only supports monitors in a landscape orientation.

OPTIONS

-h displays a help page -s display the current topology status -a head configure the given video head topology automatically

-e head configure the top-left most pixel coordinate for the specified video head

-x coordinate Specify the x-coordinate for the top-left most pixel -y coordinate Specify the y-coordinate for the top-left most pixel





EXAMPLE (row)

Note: All examples are for 1920 x 1200 monitors

To configure displays in a row(default):

[1][2][3][4] == (0,0)(1920,0)(3840,0)(5760,0)

EXAMPLE 2 (square)

To configure as a square:

[1][2] = (0,0) (1920,0) [3][4] = (0,1200)(1920,1200)

topology -e 1 -x 0 -y 0 topology -e 2 -x 1920 -y 0 topology -e 3 -x 0 -y 1200 topology -e 4 -x 1920 -y 1200

EXAMPLE 3 (l-shape)

To configure as an L-shape:

[1] [2] [3][4]


EXAMPLE 4 (t-shape)

To configure as a T-shape:

[1][2][3] [4]





update


NAME update

SYNOPSIS update [-h] [-a] [-c component] [-b] [-e] [-v] [-f]

DESCRIPTION

Updates the host components from update packages. New update packages can be transferred onto the host using TFTP on port 7556. New packages must be extracted using –e before updating. WARNING: Do not shutdown, reset, or power-cycle the unit whilst any updates are in progress until told to do so. This may harm the unit.

OPTIONS

-h displays a help page -a specifies that every component will be updated -c component

when set, the host will immediately restart upon successful completion of an update.

-b specifies that the update will use the backup package -e extracts a transferred package binary. This will overwrite the

existing backup package -v displays the versions of the latest and backup packages -f when set, the host will restart after the command completes

EXAMPLES

update –a

update –c bsm

update –c ubm

update –c ubm# -- (Where # is a number between 1 and 6)

update –c manager

update –c monitor




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

management commands for quad display kvm extender hosts · knowledge base article137 management...

Documents