Knowledge Base Article

Transcription

1 Knowledge Base Article 137 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 KB-A v December 2017 Page 1

2 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 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. KB-A v December 2017 Page 2

3 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. KB-A v December 2017 Page 3

4 Glossary Command help activeconns enabledhcp exit flushdns info ipconfig login netroutes ping registeragent reset resetdns showdns staticip status update Display a brief overview of the available commands. Displays the host s established TCP/IP connections. Enable DHCP addressing. Exit the host SSH session. Clear the DNS client resolver cache. Display general information about the host. Display the current TCP/IP configuration. Configure the SSH login credentials. Display the visible TCP/IP routes. Test a network route between the host and a destination. Register the host with a virtual desktop broker. Power-cycle the host. Reset the client DNS addresses. Display the DNS client resolver cache. Configure a static IP address. Display current statuses, versions, and thermals of the host. Update the host from an existing update package. KB-A v December 2017 Page 4

5 help help help Displays a glossary of each command available on the host Manager. none activeconns activeconns activeconns [-h] Displays a table of the management interface s established TCP/IP connections, showing the local to remote address and port mappings. enabledhcp enabledhcp enabledhcp [-h] Configures the Management Interface for DHCP addressing. KB-A v December 2017 Page 5

6 exit exit exit [-h] Closes the manager and exits the current SSH session. flushdns flushdns flushdns [-h] Flushes and resets the contents of the Management Interface s DNS client resolver cache. Info info info [-h] Displays the current versions and variants of the host. --- indicates that the values cannot be retrieved. KB-A v December 2017 Page 6

7 ipconfig ipconfig ipconfig [-h] [-v] Displays the current domain, IPv4 address, CIDR prefix, gateway and DNS address(es) of the Management Interface. -v displays verbose results login login login [-h] [-u username] [-p] [-r] Configures the current SSH login username or password. Only one credential can be changed at a time. -p specifies the password should be changed -f restarts the host immediately after the command completes -u username changes the username to username. The host must be reset for a change in username to take effect. KB-A v December 2017 Page 7

8 netroutes netroutes netroutes [-h] Displays the next TCP/IP route hops visible to the Management Interface. ping ping ping [-h][destination] [-t][-v][-p remote_port] Tests a network route between the host and a destination by attempting to ping a remote IP or hostname from the Management Interface over the network. -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 Ping an IP address ping amulethotkey.com Ping a hostname ping p 1234 Ping an IP on remote port KB-A v December 2017 Page 8

9 registeragent registeragent registeragent [broker_ip] [-p provider] [-d domain][-p remote_port] [-u username] [-f] Registers the host with a VMware Horizon connection broker. The host must be reset afterwards for the changes to take effect. -f forces the host to restart after a successful registration 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 p vmware d vmdc01 u administrator KB-A v December 2017 Page 9

10 reset reset reset [-h] [-f] Power-cycles the host. Doing so will interrupt the PCoIP session if active. -f forces the reset and ignores any warnings or prompts resetdns resetdns resetdns [-h] Clears the current client DNS addresses used by the Management Interface and assigns new ones dynamically. showdns showdns showdns [-h] 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. KB-A v December 2017 Page 10

11 staticip staticip staticip [-h] [static_address] [-l subnet_cidr] [-g gateway][-p primary_dns] [-s secondary_dns] Configures the Management Interface with a static IP address. static_address specifies the static IPv4 address to use -l subnet_cidr -g gateway specifies the subnet prefix length to use in classes inter-domain routing (CIDR) notation specifies the gateway address -p primary_dns specifies the primary DNS address -s secondary_dns specifies the secondary DNS address EXAMPLE Basic IP configuration staticip l 24 g p KB-A v December 2017 Page 11

12 status status status [-h] [-u] [-t] [-p] 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. -u displays the current status of any bridged USB devices -t displays the current host temperatures and fanspeeds -p displays the status and start time of the PCoIP session if active update update update [-h] [-a] [-c component] [-b] [-e] [-v] [-f] Updates the host components from update packages. New update packages can be transferred onto the host using TFTP on port 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. KB-A v December 2017 Page 12

13 -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 EXAMPLES -f when set, the host will restart after the command completes 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 North America +1 (212) ussupport@amulethotkey.com casupport@amulethotkey.com Europe +44 (0) eurosupport@amulethotkey.com Asia Pacific - apsupport@amulethotkey.com Latin America - latamsupport@amulethotkey.com Resources Visit our resources page, KB-A v December 2017 Page 13