ip-control-api€¦ · i · ip-control-api zu dieser dokumentation. diese dokumentation wurde mit...

24
Guntermann & Drunck GmbH www.gdsys.de IP-Control-API A9100125-2.20 Kurzanleitung DE EN Quick Guide

Upload: others

Post on 19-Oct-2020

2 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: IP-Control-API€¦ · i · IP-Control-API Zu dieser Dokumentation. Diese Dokumentation wurde mit größter Sorgfalt erstellt und nach dem Stand der Technik auf Korrektheit überprüft

Guntermann & Drunck GmbHwww.gdsys.de

IP-Control-API

A9100125-2.20

KurzanleitungDE

EN Quick Guide

Page 2: IP-Control-API€¦ · i · IP-Control-API Zu dieser Dokumentation. Diese Dokumentation wurde mit größter Sorgfalt erstellt und nach dem Stand der Technik auf Korrektheit überprüft

i · IP-Control-API

Zu dieser Dokumentation

Diese Dokumentation wurde mit größter Sorgfalt erstellt und nach dem Stand der Technik auf Korrektheit überprüft.

Für die Qualität, Leistungsfähigkeit sowie Marktgängigkeit des G&D-Produkts zu einem bestimmten Zweck, der von dem durch die Produktbeschreibung abgedeck-ten Leistungsumfang abweicht, übernimmt G&D weder ausdrücklich noch still-schweigend die Gewähr oder Verantwortung.

Für Schäden, die sich direkt oder indirekt aus dem Gebrauch der Dokumentation ergeben, sowie für beiläufige Schäden oder Folgeschäden ist G&D nur im Falle des Vorsatzes oder der groben Fahrlässigkeit verantwortlich.

Gewährleistungsausschluss

G&D übernimmt keine Gewährleistung für Geräte, die

nicht bestimmungsgemäß eingesetzt wurden. nicht autorisiert repariert oder modifiziert wurden. schwere äußere Beschädigungen aufweisen, welche nicht bei Lieferungserhalt

angezeigt wurden. durch Fremdzubehör beschädigt wurden.

G&D haftet nicht für Folgeschäden jeglicher Art, die möglicherweise durch den Einsatz der Produkte entstehen können.

Warenzeichennachweis

Alle Produkt- und Markennamen, die in diesem Handbuch oder in den übrigen Dokumentationen zu Ihrem G&D-Produkt genannt werden, sind Warenzeichen oder eingetragene Warenzeichen der entsprechenden Rechtsinhaber.

Impressum

© Guntermann & Drunck GmbH 2015. Alle Rechte vorbehalten.

Version 2.20 – 01.04.2015 Software: 2.1.000

Guntermann & Drunck GmbH Obere Leimbach 9 57074 Siegen

Germany

Telefon +49 (0) 271 23872-0 Telefax +49 (0) 271 23872-120

http://www.gdsys.de [email protected]

Page 3: IP-Control-API€¦ · i · IP-Control-API Zu dieser Dokumentation. Diese Dokumentation wurde mit größter Sorgfalt erstellt und nach dem Stand der Technik auf Korrektheit überprüft

Inhaltsverzeichnis

IP-Control-API · ii

Deu

tsch

InhaltsverzeichnisDie Zusatzfunktion »IP-Control-API« ............................................................. 1Hinweise für Anwender der Version 1 der »IP-Control-API« .............................................................................................. 1

Lieferumfang .................................................................................................... 1

Erste Schritte .................................................................................................... 2

Freischaltung der Zusatzfunktion ..................................................................... 2

Auflistung der API-Funktionen ........................................................................ 3KVM-Matrixswitches ........................................................................................ 3KVM-Switch »DL-MUX4« ................................................................................ 6

Page 4: IP-Control-API€¦ · i · IP-Control-API Zu dieser Dokumentation. Diese Dokumentation wurde mit größter Sorgfalt erstellt und nach dem Stand der Technik auf Korrektheit überprüft

Die Zusatzfunktion »IP-Control-API«

Die Zusatzfunktion »IP-Control-API«Über die mit der IP-Control-API gelieferte C++-Klassenbibliothek sowie die COM-Schnittstelle können Programmierer die externe Ansteuerung eines unterstützten G&D-Gerätes über eine TCP/IP-Verbindung realisieren.

Folgende G&D-Geräte werden nach der Aktivierung der kostenpflichtigen Zusatz-funktion unterstützt:

Die mitgelieferte C++-Klassenbibliothek ist für den Einsatz unter Windows und Linux vorgesehen. Unter Windows steht zusätzlich eine COM-Schnittstelle für Microsoft .NET Framework 3.5 zur Verfügung.

Hinweise für Anwender der Version 1 der »IP-Control-API«Die Version 1 der IP-Control-API unterstützte ausschließlich den KVM-Matrixswitch CATCenter NEO. Seit der Version 2 können auch der digitale KVM-Matrixswitch DVICenter und der KVM-Switch DL-MUX4 angesteuert werden.

Im Rahmen der Erweiterung wurden einige Klassen- und Funktionsnamen umben-annt. Eine für die Version 1 der API entwickelte Applikation zur Steuerung des KVM-Matrixswitches CATCenter NEO erfordert eine Portierung. Die Portierung beschränkt sich größtenteils auf die Änderung der Klassen- und Funktionsnamen.

Im Verzeichnis legacy dieser CD wird für bereits mit der Version 1 realisierte Appli-kationen die Version 1.2.002_001569 mitgeliefert.

Lieferumfang 1 × CD »Feature-Key« (außer DL-MUX4) 1 × CD »IP-Control-API«

G&D-Gerät kostenpflichtige Zusatzfunktion

CATCenter NEO IP-Control-API CCNEO (A8200008)

ControlCenter-Digital IP-Control-API Digitale Matrix (A8200015)

DLMUX4 DLM-Monitoring (ab Werk aktiviert)

DVICenter IP-Control-API Digitale Matrix (A8200015)

HINWEIS: Die Matrixswitches können Sie alternativ über textbasierte Befehle in Form von XML-Dokumenten steuern. Informationen hierzu finden Sie in den Handbüchern der Matrixswitches.

WICHTIG: Verwenden Sie bei der Realisierung neuer Applikationen die aktuelle Version 2 der IP-Control-API.

1 · IP-Control-API

Page 5: IP-Control-API€¦ · i · IP-Control-API Zu dieser Dokumentation. Diese Dokumentation wurde mit größter Sorgfalt erstellt und nach dem Stand der Technik auf Korrektheit überprüft

Deu

tsch

Erste Schritte

Erste Schritte1. Haben Sie die Zusatzfunktion IP-Control-API nach dem Kauf des G&D-Gerätes

erworben, aktivieren Sie zunächst die Funktion wie unten beschrieben.

2. Informationen zur Installation der Software sowie die ausführliche Dokumentation der Funktionen finden Sie in der Datei readme-de_DE.txt auf der CD »IP-Control-API«.

Freischaltung der Zusatzfunktion

Die CD »Feature-Key« enthält eine Datei, die einen Schlüssel zur Freischaltung der von Ihnen gekauften Funktion(en) erhält. Durch den Import der Datei in die Webapplikation wird/werden die gekaufte(n) Funktion(en) freigeschaltet.

So importieren Sie den Feature-Key zur Freischaltung gekaufter Funktionen:

1. Geben in der Adresszeile folgende URL zum Aufruf der Webapplikation ein:

https://[IP-Adresse des Gerätes]

2. Geben Sie in die Login-Maske Ihren Benutzernamen und das Passwort ein und klicken Sie auf Anmelden.

3. Öffnen Sie im Strukturbaum den Ordner, der das Gerät enthält, in welchem Sie die Zusatzfunktion aktivieren möchten:

4. Klicken Sie mit der rechten Maustaste auf das gewünschte Gerät.

5. Klicken Sie auf Konfiguration im Kontextmenü.

6. Klicken Sie auf den Reiter Features.

7. Klicken Sie auf Feature-Key aus Datei importieren... und importieren Sie den Feature-Key (Datei) über den Datei-Dialog.

8. Klicken Sie auf OK, um den Dialog zu verlassen.

HINWEIS: Wurde das G&D-Gerät mit der Zusatzfunktion erworben, ist die Funktion bereits ab Werk freigeschaltet.

HINWEIS: Der KVM-Switch DL-MUX4 wird ab Werk immer mit aktivierter Zusatz-funktion ausgeliefert.

Wurde ein Matrixswitch mit der Zusatzfunktion erworben, ist die Funktion eben-falls bereits ab Werk freigeschaltet.

Die auf dieser Seite beschriebenen Schritte sind in beiden Fällen nicht erforderlich!

Gerät Ordner

CATCenter NEO KVM-Matrixsysteme > [Name] > Matrixswitches

ControlCenter Digital KVM-Matrixsysteme > [Name] > Matrixswitches

DVICenter KVM-Matrixsysteme > [Name] > DVICenter

IP-Control-API · 2

Page 6: IP-Control-API€¦ · i · IP-Control-API Zu dieser Dokumentation. Diese Dokumentation wurde mit größter Sorgfalt erstellt und nach dem Stand der Technik auf Korrektheit überprüft

Auflistung der API-Funktionen

Auflistung der API-FunktionenDie IP-Control-API stellt die nachfolgend aufgelisteten Funktionen zur Verfügung.

Der Funktionsumfang ist von der Art des KVM-Gerätes (Matrixswitch bzw. Switch) abhängig.

KVM-Matrixswitches

BENUTZERAN- UND ABMELDUNG

logonUser Anmeldung eines Benutzers an einem Arbeitsplatzmodul

logoffUser Abmeldung eines Benutzers von einem Arbeitsplatzmodul

VERBINDUNG ZU EINEM TARGET-MODULDie Aufschaltung auf ein Target-Modul ist nur möglich, wenn der Benutzer über Zugriffsrechte für das aufzuschaltende Target-Modul verfügt oder es sich um eine OpenAccess-Konsole mit den ent-sprechenden Rechten handelt!

connect Aufschaltung eines Arbeitsplatz- auf ein Target-Modul

disconnect Trennung einer aktiven Aufschaltung

KANAL DES ARBEITSPLATZMODULS »DVI-CON-2« UMSCHALTENDer Befehl schaltet den Kanal des Arbeitsplatzmoduls DVI-CON-2 um.

selectTransmission Kanal-Umschaltung des Arbeitsplatzmoduls »DVI-CON-2«

ANZEIGE EINER MELDUNGMit diesen Befehlen senden Sie eine Nachricht an ein Arbeitsplatzmodul. Die Nachricht wird dem Benutzer des Arbeitsplatzmoduls über das OSD angezeigt.

showErrorMessage Anzeige einer Fehlermeldung über das OSD am Arbeitsplatzmodul

showInfoMessage Anzeige einer Infomeldung über das OSD am Arbeitsplatzmodul

showWarningMessage Anzeige einer Warnmeldung über das OSD am Arbeitsplatzmodul

OSD EIN- ODER AUSBLENDENMit diesen Befehlen können Sie das OSD (Select-Menü) auf einem Arbeitsplatzmodul ein- oder ausblenden.

openMenu OSD auf einem Arbeitsplatzmodul einblenden

closeMenu OSD auf einem Arbeitsplatzmodul ausblenden

3 · IP-Control-API

Page 7: IP-Control-API€¦ · i · IP-Control-API Zu dieser Dokumentation. Diese Dokumentation wurde mit größter Sorgfalt erstellt und nach dem Stand der Technik auf Korrektheit überprüft

Deu

tsch

Auflistung der API-Funktionen

UMLEITUNG DER TASTATUR- UND MAUS-DATENDie Umleitung der Tastatur- und Maus-Daten auf ein anderes Arbeitsplatz- oder Target-Modul ist erst nach Aktivierung der kostenpflichtigen Zusatzfunktion »Tradeswitching« möglich!

RedirectConsoleToConsole Umleitung der Tastatur- und Maus-Daten von einem Arbeitsplatzmodul zu einem anderen Arbeitsplatz-Modul

RedirectConsoleToCpu Umleitung der Tastatur- und Maus-Daten von einem Arbeitsplatzmodul zu einem anderen Target-Modul

ABFRAGE DER VERBINDUNGSDATENFür jede aktive Verbindung eines Arbeitsplatzmoduls mit einem Target-Modul werden ID und Name des Arbeitsplatzmoduls, ID und Name des aufgeschalteten Target-Moduls, ID und Name des aktiven Benutzers sowie der ViewOnly-Status (Ja/Nein) abgefragt.

queryMatrixConnectionList Abfrage aller Verbindungsdaten und angemeldeten Benutzer

queryConnectionsByCPU Abfrage der Verbindungsdaten eines Target-Moduls

queryConnectionsByConsole Abfrage der Verbindungsdaten eines Arbeitsplatzmoduls

ABFRAGE VON MATRIXSWITCHESFür jeden Matrixswitch werden die ID, der Name, der Status der Stromversorgung und die freige-schalteten Zusatzfunktionen abgefragt.

queryMatrixSwitchList Abfrage aller bekannten Matrixswitches

queryMatrixSwitchById Abfrage eines Matrixswitches anhand der ID

queryMatrixSwitchByName Abfrage eines Matrixswitches anhand des Namens

ABFRAGE VON TARGET-MODULENFür jedes Target-Modul werden die ID, der Name und der Status der Stromversorgung abgefragt.

queryCpuList Abfrage aller bekannten Target-Module

queryCpuByID Abfrage eines Target-Moduls anhand der ID

queryCpuByName Abfrage eines Target-Moduls anhand des Namens

ABFRAGE VON ARBEITSPLATZMODULENFür jedes Arbeitsplatzmodul werden die ID, der Name, der Status (An/Aus), der Status der Strom-versorgung und die ID sowie der Port des verwendeten Matrixswitches abgefragt.

queryConsoleList Abfrage aller bekannten Arbeitsplatzmodule

queryConsoleByID Abfrage eines Arbeitsplatzmoduls anhand der ID

queryConsoleByName Abfrage eines Arbeitsplatzmoduls anhand des Namens

ABFRAGE DER TRADESWITCH-KONFIGURATIONENZu jeder TradeSwitch-Konfiguration wird der Name, das Master-Arbeitsplatzmodul, die weiteren zugewiesenen Arbeisplatzmodule , die ID des Matrixswitches, der die Konfiguration verwaltet, sowie die zugewiesenen TradeSwitch-Keys abgefragt.

queryWorkplaceList Abfrage aller TradeSwitch-Konfigurationen

queryWorkplaceListByMatrixSwitch Abfrage aller TradeSwitch-Konfigurationen eines bestimmten Matrixswitches

IP-Control-API · 4

Page 8: IP-Control-API€¦ · i · IP-Control-API Zu dieser Dokumentation. Diese Dokumentation wurde mit größter Sorgfalt erstellt und nach dem Stand der Technik auf Korrektheit überprüft

Auflistung der API-Funktionen

ABFRAGE DER KANAL-GRUPPIERUNGENZu jeder Kanal-Gruppierung wird die Geräte-ID des ersten KVM-Kanals sowie die ID, die zugewie-sene Kanalart (KVM: slotType 0; USB: slotType1; MULTI: SlotType2) und die laufende Nummer des Kanals jedes zugeordneten Gruppenmitglieds abgefragt.

queryMcTeamList Auflistung aller Kanal-Gruppierungen abfragen

queryMcTeamListByLeaderId Auflistung aller Kanal-Gruppierungen abfragen, deren Hauptkanal ein bestimmtes Modul ist

ABFRAGE DER IO-KARTENFür jede IO-Karte (nur für ControlCenter-Digital verfügbar) werden die ID, der Name und Status der Stromversorgung abgefragt.

queryIoCardList Abfrage aller bekannten IO-Karten

queryIoCardById Abfrage einer IO-Karte anhand der ID

queryIoCardByName Abfrage einer IO-Karte anhand des Namens

ABFRAGE DER MONITORING-WERTEZu den einzelnen Komponenten des Matrixswitches können Sie verschiedene Monitoringwerten abfragen.

queryMonitoringValue Einzelnen Monitoring-Wert eines bestimmten Gerätes abfragen

queryMonitoringValueListByDeviceId Alle Monitoring-Werte eines bestimmten Gerätes abfragen

queryMonitoringValueList Alle Monitoring-Werte abfragen

5 · IP-Control-API

Page 9: IP-Control-API€¦ · i · IP-Control-API Zu dieser Dokumentation. Diese Dokumentation wurde mit größter Sorgfalt erstellt und nach dem Stand der Technik auf Korrektheit überprüft

Deu

tsch

Auflistung der API-Funktionen

KVM-Switch »DL-MUX4«

UMSCHALTUNG AUF EINEN RECHNER

connectToKvmSwitch Umschaltung des KVM-Switches auf einen bestimmten Rechner

disconnectKvmSwitch Verbindung des aktiven Kanal beenden.

ABFRAGE DER VERBINDUNGSDATENNeben der ID und dem Namen des KVM-Switches wird der aktuell aufgeschaltete Kanal abgefragt.

queryKvmSwitchConnectionList Abfrage der Verbindungsdaten aller KVM-Switches.

queryKvmSwitchConnectionsByKvmSwitch Abfrage der Verbindungsdaten eines bestimmten KVM-Switches.

ABFRAGE VON KVM-SWITCHESFür jeden KVM-Switch werden die ID, der Name, der Status der Stromversorgung und die freige-schalteten Zusatzfunktionen abgefragt.

queryKvmSwitchList Abfrage aller bekannten KVM-Switches

queryKvmSwitchById Abfrage eines KVM-Switches anhand der ID

queryKvmSwitchByName Abfrage eines KVM-Switches anhand des Namens

IP-Control-API · 6

Page 10: IP-Control-API€¦ · i · IP-Control-API Zu dieser Dokumentation. Diese Dokumentation wurde mit größter Sorgfalt erstellt und nach dem Stand der Technik auf Korrektheit überprüft

�������

Page 11: IP-Control-API€¦ · i · IP-Control-API Zu dieser Dokumentation. Diese Dokumentation wurde mit größter Sorgfalt erstellt und nach dem Stand der Technik auf Korrektheit überprüft

�������

Deu

tsch

Page 12: IP-Control-API€¦ · i · IP-Control-API Zu dieser Dokumentation. Diese Dokumentation wurde mit größter Sorgfalt erstellt und nach dem Stand der Technik auf Korrektheit überprüft

i · IP-Control-API

About this manual

This manual has been carefully compiled and examined to the state-of-the-art.

G&D neither explicitly nor implicitly takes guarantee or responsibility for the qual-ity, efficiency and marketability of the product when used for a certain purpose that differs from the scope of service covered by this manual.

For damages which directly or indirectly result from the use of this manual as well as for incidental damages or consequential damages, G&D is liable only in cases of intent or gross negligence.

Caveat Emptor

G&D will not provide warranty for devices that:

Are not used as intended. Are repaired or modified by unauthorized personnel. Show severe external damages that was not reported on the receipt of goods. Have been damaged by non G&D accessories.

G&D will not be liable for any consequential damages that could occur from using the products.

Proof of trademark

All product and company names mentioned in this manual, and other documents you have received alongside your G&D product, are trademarks or registered trade-marks of the holder of rights.

© Guntermann & Drunck GmbH 2015. All rights reserved.

Version 2.20 – 01/04/2015 Software: 2.1.000

Guntermann & Drunck GmbH Obere Leimbach 9 57074 Siegen

Germany

Phone +49 271 23872-0 Fax +49 271 23872-120

http://www.gdsys.de [email protected]

Page 13: IP-Control-API€¦ · i · IP-Control-API Zu dieser Dokumentation. Diese Dokumentation wurde mit größter Sorgfalt erstellt und nach dem Stand der Technik auf Korrektheit überprüft

Table of contents

IP-Control-API · ii

En

glis

h

ContentsThe premium function »IP-Control-API« ......................................................... 1Notes for users of »IP-Control-API« version 1 .................................................... 1

Package contents .............................................................................................. 1

Getting started ................................................................................................. 2

Activating the premium function ...................................................................... 2

List of functions ............................................................................................... 3KVM matrix switches ........................................................................................ 3KVM switch »DL-MUX4« ................................................................................ 6

Page 14: IP-Control-API€¦ · i · IP-Control-API Zu dieser Dokumentation. Diese Dokumentation wurde mit größter Sorgfalt erstellt und nach dem Stand der Technik auf Korrektheit überprüft

The premium function »IP-Control-API«

The premium function »IP-Control-API«The C++ class library supplied with IP-Control-API and the COM interface allow pro-grammers to implement external access to a supported G&D devices over a TCP/IP connection.

The following G&D devices support the premium function after its activation:

The supplied C++ class library can be used under Windows and Linux. Windows additionally provides a COM interface for Microsoft .NET Framework 3.5.

Notes for users of »IP-Control-API« version 1Version 1 of IP-Control-API only supported the KVM matrix switch CATCenter NEO. The second version allows tyou to access the digital KVM matrix switch DVICenter and the KVM switch DL-MUX4, too.

Within the expansion, several class and function names have been renamed. One of the applications developed for the first version of the API allows you to control the KVM matrix switch CATCenter NEO. This application requires porting, which is mainly limited to changes in class and function names.

The directory legacy contained on this CD provides version 1.2.002_001569 for applications implemented with version 1.

Package contents 1 × CD »Feature Key« (except for DL-MUX4) 1 × CD »IP-Control-API«

G&D device Premium function

CATCenter NEO IP-Control-API CCNEO (A8200008)

ControlCenter-Digital IP-Control-API Digitale Matrix (A8200015)

DLMUX4 DLM-Monitoring (enabled by default)

DVICenter IP-Control-API Digitale Matrix (A8200015)

NOTE: You can operate matrix switches via text-based commands in the form of XML documents. More information about this topic is given in the manuals of the matrix switches.

IMPORTANT: Use version 2 of IP-Control-API to implement new applications.

1 · IP-Control-API

Page 15: IP-Control-API€¦ · i · IP-Control-API Zu dieser Dokumentation. Diese Dokumentation wurde mit größter Sorgfalt erstellt und nach dem Stand der Technik auf Korrektheit überprüft

En

glis

h

Getting started

Getting started1. If you purchased the premium function IP-Control-API after you purchased the

G&D device, activate the function as described below.

2. The readme-en_UK.txt file on the »IP-Control-API« CD provides all information regard-ing the installation of the software and a detailed description of the functions.

Activating the premium function

The »Feature-Key« CD contains a file to activate the function(s). The function(s) are activated by importing the file to the web application.

How to import the feature key to activate premium functions:

1. Enter the following URL in the address bar to open the web application:

https://[IP address of the device]

2. Enter your username and password in the login box and click on Login.

3. In the tree view, open the folder that contains the device on which you want to activate the premium function:

4. Right-click the device whose feature key you want to import.

5. Click on Configuration in the context menu.

6. Click on the Features tab.

7. Click on Import feature key from file... and import the feature key (file) using the file dialog.

8. Click OK to close the dialog.

NOTE: If you have purchased the G&D device along with the premium func-tion, the function is already activated.

NOTE: The premium function is activated at the KVM switch DL-MUX4 by default.

If you purchased a matrix switch including premium function, the function is acti-vated as well.

In both cases the steps described in the following are not required.

Device Folder

CATCenter NEO KVM matrix systems > [Name] > Matrix switches

ControlCenter-Digital KVM matrix systems > [Name] > Matrix switches

DVICenter KVM matrix systems > [Name] > DVICenter

IP-Control-API · 2

Page 16: IP-Control-API€¦ · i · IP-Control-API Zu dieser Dokumentation. Diese Dokumentation wurde mit größter Sorgfalt erstellt und nach dem Stand der Technik auf Korrektheit überprüft

List of functions

List of functionsThe IP-Control-API provides the following functions.

The functional range depends on the type of KVM device (matrix switch or switch).

KVM matrix switches

USER LOGIN AND LOGOUT

logonUser User login to user module

logoffUser User logout from user module

CONNECTION TO A TARGET MODULEA target module can only be accessed if the user holds the required access rights for the target module to be accessed or if the console is an OpenAccess console.

connect User module accesses a target module

disconnect Disconnects active access

SWITCHING CHANNELS AT USER MODULES »DVI-CON-2«The command switches the channel of the user module DVI-CON-2.

selectTransmission Switches channel of user module »DVI-CON-2«

SHOWING A MESSAGEUse these commands to send a message to a user module. The message is shown at the OSD of the user module.

showErrorMessage Shows an error message at the OSD of the user module

showInfoMessage Shows an info message at the OSD of the user module

showWarningMessage Shows an warning message at the OSD of the user module

SHOWING OR HIDING THE OSDUse the following commands to show or hide the OSD (Select menu) at a user module .

OpenMenu Shows the OSD at a user module

CloseMenu Hides the OSD at a user module

REDIRECTION OF KEYBOARD AND MOUSE DATAAfter the »Tradeswitching« function has been purchased, keyboard and mouse data can be redi-rected to another user module or target module.

redirectConsoleToConsole Redirects keyboard and mouse data from one user mod-ule to another user module

redirectConsoleToCpu Redirects keyboard and mouse data from a user module to a target module

3 · IP-Control-API

Page 17: IP-Control-API€¦ · i · IP-Control-API Zu dieser Dokumentation. Diese Dokumentation wurde mit größter Sorgfalt erstellt und nach dem Stand der Technik auf Korrektheit überprüft

En

glis

h

List of functions

QUERY OF CONNECTION DATAFor each active connection between a user module and a target module the ID and the user module name, the ID and the name of the accessing target module, the ID and name of the active user as well as the ViewOnly status (Yes/No) are queried.

queryMatrixConnectionList Queries all connection data and logged in users

queryConnectionsByCPU Queries the connection data of a target module

queryConnectionsByConsole Queries the connection data of a user module

QUERY OF MATRIX SWITCHESFor each matrix switch the ID, the name, the status of the power supply and the activated premium functions are queried.

queryMatrixSwitchList Queries all known matrix switches

queryMatrixSwitchById Queries a matrix switch according to its ID

queryMatrixSwitchByName Queries a matrix switch according to its name

QUERY OF TARGET MODULESFor each target module the ID, the name and the status of the power supply are queried.

queryCpuList Queries all known target modules

queryCpuByID Queries a target module according to its ID

queryCpuByName Queries a target module according to its name

QUERYING USER MODULESFor each user module the ID, the name, the status (on/off), the status of the power supply and the ID as well as the port of the used matrix switch are queried.

queryConsoleList Queries all known user modules

queryConsoleByID Queries a user module according to its ID

queryConsoleByName Queries a user module according to its name

QUERYING TRADESWITCH CONFIGURATIONSFor each TradeSwitch configuration the name, the master user module, other assigned user mod-ules, the ID of the matrix switch that administrates the configuration and the assigned TradeSwitch keys are queried.

queryWorkplaceList Queries all TradeSwitch configurations

queryWorkplaceListByMatrixSwitch Queries all TradeSwitch configurations of a particular matrix switch

QUERYING CHANNEL GROUPSFor each channel group the device ID of the first KVM channel as well as the ID, the assigned chan-nel type (KVM: slotType 0; USB: slotType1; MULTI: SlotType2) and the consecutive number of the the channel of each assigned group member are queried.

queryMcTeamList Queries a list of all channel groups

queryMcTeamListByLeaderId Queries a list of all channel groups with a particular module as main channel

IP-Control-API · 4

Page 18: IP-Control-API€¦ · i · IP-Control-API Zu dieser Dokumentation. Diese Dokumentation wurde mit größter Sorgfalt erstellt und nach dem Stand der Technik auf Korrektheit überprüft

List of functions

QUERYING IO CARDSFor each IO card (available for ControlCenter-Digital only) the ID, the name and the status of the power supply are queried.

queryIoCardList Queries all known IO cards

queryIoCardById Queries an IO card according to its ID

queryIoCardByName Queries an IO card according to its name

QUERYING MONITORING VALUESYou can query various monitoring values about individual components of the matrix switch.

queryMonitoringValue Queries a single monitoring value of a particular device

queryMonitoringValueListByDeviceId Queries all monitoring values of a particular device

queryMonitoringValueList Queries all monitoring values

5 · IP-Control-API

Page 19: IP-Control-API€¦ · i · IP-Control-API Zu dieser Dokumentation. Diese Dokumentation wurde mit größter Sorgfalt erstellt und nach dem Stand der Technik auf Korrektheit überprüft

En

glis

h

List of functions

KVM switch »DL-MUX4«

SWITCHING TO A COMPUTER

connectToKvmSwitch KVM switch accesses a particular computer

disconnectKvmSwitch Disconnects active channel

QUERY OF CONNECTION DATAQUERIES THE CURRENTLY ACCESSED CHANNEL IN ADDITION TO ID AND NAME.

queryKvmSwitchConnectionList Queries the connection data of all KVM switches

queryKvmSwitchConnectionsByKvmSwitch Queries the connection data of a particular KVM switch

QUERY OF KVM SWITCHESFor each KVM switch the ID, the name, the status of the power supply and the activated premium functions are queried.

queryKvmSwitchList Queries all known KVM switches

queryKvmSwitchById Queries a KVM switch according to its ID

queryKvmSwitchByName Queries a KVM switch according to its name

IP-Control-API · 6

Page 20: IP-Control-API€¦ · i · IP-Control-API Zu dieser Dokumentation. Diese Dokumentation wurde mit größter Sorgfalt erstellt und nach dem Stand der Technik auf Korrektheit überprüft

�����

Page 21: IP-Control-API€¦ · i · IP-Control-API Zu dieser Dokumentation. Diese Dokumentation wurde mit größter Sorgfalt erstellt und nach dem Stand der Technik auf Korrektheit überprüft

�����

En

glis

h

Page 22: IP-Control-API€¦ · i · IP-Control-API Zu dieser Dokumentation. Diese Dokumentation wurde mit größter Sorgfalt erstellt und nach dem Stand der Technik auf Korrektheit überprüft

�����

Page 23: IP-Control-API€¦ · i · IP-Control-API Zu dieser Dokumentation. Diese Dokumentation wurde mit größter Sorgfalt erstellt und nach dem Stand der Technik auf Korrektheit überprüft

�����

En

glis

h

Page 24: IP-Control-API€¦ · i · IP-Control-API Zu dieser Dokumentation. Diese Dokumentation wurde mit größter Sorgfalt erstellt und nach dem Stand der Technik auf Korrektheit überprüft

Guntermann & Drunck GmbH

Das Handbuch wird fortlaufend aktualisiert und im Internet veröffentlicht.The manual is constantly updated and available on our website.

http://gdsys.de/A9100125

Obere Leimbach 957074 Siegen

Germany

http://[email protected]