20. 12. 2024
Atlassian, NetEye, Service Management
In the current version of our NetEye API we introduced a new way to interact with your NetEye through a SOAP interface. It gives you the possibility to communicate with third-party applications or with applications developed by yourself over a web interface. It uses simple XML-based messages sent via HTTP. But first some general details about SOAP.
What is SOAP?
SOAP is a communication protocol designed to exchange information over HTTP. The acronym SOAP stands for “Simple Object Access Protocol”. For the communication it uses XML-based messages to exchange information between client and server. Client applications can easily connect to the SOAP interface and execute remote methods. All messages are written in XML format and are therefore platform- and language-independent.
Available SOAP Functions in NetEye
Until now, the available functions you can use to communicate with your NetEye are mainly concerning the creation and manipulation of Hosts. You can also retrieve useful information using a SOAP call, like a list of all your hosts, which can then be used in an external application. Using the NetworkDiscovery webservice you can get interesting information about IP addresses and interfaces on your switches and routers.
Here an example of a SOAP call, which lets you create a new host in your NetEye, specifying different information about it:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:net="http://localhost/NetEye/SOAP/Monitoring/Host"> <soapenv:Header/> <soapenv:Body> <net:addHost> <hostname>DNS_Server</hostname> <alias>DNS_Server</alias> <address>10.120.10.11</address> <hosttemplate_id>2</hosttemplate_id> <os>Windows</os> <hostprofile_id>1</hostprofile_id> <hostextinfo_id>1</hostextinfo_id> <host_escalation_id>1</host_escalation_id> <service_escalation_id>1</service_escalation_id> <status>1</status> <comment>Some additional information about the host</comment> </net:addHost> </soapenv:Body> </soapenv:Envelope>
Additionally, you need to specify the URL of NetEye’s SOAP interface, which usually is http://neteye/SOAP, and your login parameters.
Here is the list of all currently available SOAP functions:
- addHostToHostGroup
- deleteHost
- getAllHosts
- setStatusCoordinates
- getHostProfile
- renameHost
- getAllMonitoringGroups
- deleteService
- getSnmpHostInfo
- getSnmpHostInterfacesInfo
On customer request we can add further SOAP functions.
Sandro Santinato
Developer at Würth Phoenix
Hi, my name is Sandro and I am the youngest member of the Neteye team. I graduated in 2013 in Applied Computer Science at the Free University of Bolzano but I started working as software engineer at Würth-Phoenix already in May 2012. My main competence is the development and improvement of the “Real User Experience” solution.For me computer programming is not just work, but i like scripting and creating my own software also in my free time. Already as a child I was amazed by computers and their technology. So at the age of 12 I bought the book “C for dummies” and started learning programming on my own 🙂 Later on I discovered the open-source world and I started loving it from the first moment.In my free time I also like mountain biking, hiking, and of course playing the trombone in various music bands.
Author
Latest posts by Sandro Santinato
15. 11. 2017
Downloads / Release Notes, NetEye
Updated Package neteye-ocsng-2.1.2_neteye1.0.2-1 (for NetEye 3.11 + 3.10 + 3.9)