NetXMS Wiki - User contributions [en]

Web service API

2021-09-03T07:21:50Z

Borgso: /* Get Objects */

Web service API provides access to NetXMS via HTTP/HTTPS. API calls are REST-like (although not purely RESTful) and uses JSON for data exchange.

= Session Management =

== Login ==
'''POST''' /sessions

Create new session. Input object fields:

login
password

On success server will set cookie '''session_handle''' which should be passed on each subsequent request.

== Logout ==
'''DELETE''' /session/''sid''

Logout (delete session) with given session ID.

= Object Management =

== Get Objects ==
'''GET''' /objects
'''GET''' /objects?''filter''

Get all objects visible to logged in user. Optional filter can define additional criteria for object selection:

area=''geographical_area''

class=''class_list''

name=''pattern''

'''Examples'''

Get all objects with name starting with "T":
GET /objects?name=T*

Get all nodes around Riga:
GET /objects?class=node&area=57.0592,23.1647,56.8270,24.6025

Get all nodes and containers:
GET /objects?class=container,node

Get DCI Summary adHoc
POST /summaryTable/adHoc

Post payload:
<pre>
{
"baseObject":"ContainerName",
"multiInstance":false,
"columns": [
{
"columnName":"Free form name that will be used in return table for this column",
"dciName":"Name of DCI, that will be used for filtering"
},
{
"columnName":"Name2",
"dciName":"DCIName2"
}
]
}</pre>

== Get Specific Object ==
'''GET''' /objects/''id''

== Get Last Values for Object ==
'''GET''' objects/''id''/lastvalues

== CURL Test ==

Test API with Curl

<pre>
$ curl -X POST --data '{"login":"user","password":"pass"}' "http://localhost:8080/netxms-websvc/sessions"

{
"sessionHandle": "8338e7f3-ba99-46c5-9fd6-84b38cc5d715",
"session": {
"server": {
"address": "127.0.0.1",
"version": "2.2.8",
"color": "",
"id": 3283229296059149299,
"timeZone": "CET+02CEST"
},
"user": {
"name": "user",
"id": 8,
"globalAccessRights": 825439032336
},
"encrypted": false,
"objectsSynchronized": false,
"passwordExpired": false,
"zoningEnabled": false
}
}

$ curl -X GET --cookie "session_handle=8338e7f3-ba99-46c5-9fd6-84b38cc5d715" "http://localhost:8080/netxms-websvc/objects?class=container,node"

.. prints some data ..
</pre>

= Java 10 =

If curl test works but grafana returns "Internal error" ({"description":"Internal error","error":46}") 
Add "--add-modules java.xml.bind" to JAVA_OPTS in /etc/default/tomcat8

Web service API

2021-09-03T07:21:37Z

Borgso: /* CURL Test */

Web service API provides access to NetXMS via HTTP/HTTPS. API calls are REST-like (although not purely RESTful) and uses JSON for data exchange.

= Session Management =

== Login ==
'''POST''' /sessions

Create new session. Input object fields:

login
password

On success server will set cookie '''session_handle''' which should be passed on each subsequent request.

== Logout ==
'''DELETE''' /session/''sid''

Logout (delete session) with given session ID.

= Object Management =

== Get Objects ==
'''GET''' /objects
'''GET''' /objects?''filter''

Get all objects visible to logged in user. Optional filter can define additional criteria for object selection:

area=''geographical_area''

class=''class_list''

name=''pattern''

'''Examples'''

Get all objects with name starting with "T":
GET /objects?name=T*

Get all nodes around Riga:
GET /objects?class=node&area=57.0592,23.1647,56.8270,24.6025

Get all nodes and containers:
GET /objects?class=container,node

== Get Specific Object ==
'''GET''' /objects/''id''

== Get Last Values for Object ==
'''GET''' objects/''id''/lastvalues

== CURL Test ==

Test API with Curl

<pre>
$ curl -X POST --data '{"login":"user","password":"pass"}' "http://localhost:8080/netxms-websvc/sessions"

{
"sessionHandle": "8338e7f3-ba99-46c5-9fd6-84b38cc5d715",
"session": {
"server": {
"address": "127.0.0.1",
"version": "2.2.8",
"color": "",
"id": 3283229296059149299,
"timeZone": "CET+02CEST"
},
"user": {
"name": "user",
"id": 8,
"globalAccessRights": 825439032336
},
"encrypted": false,
"objectsSynchronized": false,
"passwordExpired": false,
"zoningEnabled": false
}
}

$ curl -X GET --cookie "session_handle=8338e7f3-ba99-46c5-9fd6-84b38cc5d715" "http://localhost:8080/netxms-websvc/objects?class=container,node"

.. prints some data ..
</pre>

= Java 10 =

If curl test works but grafana returns "Internal error" ({"description":"Internal error","error":46}") 
Add "--add-modules java.xml.bind" to JAVA_OPTS in /etc/default/tomcat8

Web service API

2021-09-03T07:19:33Z

Borgso: /* CURL Test */

Web service API provides access to NetXMS via HTTP/HTTPS. API calls are REST-like (although not purely RESTful) and uses JSON for data exchange.

= Session Management =

== Login ==
'''POST''' /sessions

Create new session. Input object fields:

login
password

On success server will set cookie '''session_handle''' which should be passed on each subsequent request.

== Logout ==
'''DELETE''' /session/''sid''

Logout (delete session) with given session ID.

= Object Management =

== Get Objects ==
'''GET''' /objects
'''GET''' /objects?''filter''

Get all objects visible to logged in user. Optional filter can define additional criteria for object selection:

area=''geographical_area''

class=''class_list''

name=''pattern''

'''Examples'''

Get all objects with name starting with "T":
GET /objects?name=T*

Get all nodes around Riga:
GET /objects?class=node&area=57.0592,23.1647,56.8270,24.6025

Get all nodes and containers:
GET /objects?class=container,node

== Get Specific Object ==
'''GET''' /objects/''id''

== Get Last Values for Object ==
'''GET''' objects/''id''/lastvalues

== CURL Test ==

Test API with Curl

<pre>
$ curl -X POST --data '{"login":"user","password":"pass"}' "http://localhost:8080/netxms-websvc/sessions"

{
"sessionHandle": "8338e7f3-ba99-46c5-9fd6-84b38cc5d715",
"session": {
"server": {
"address": "127.0.0.1",
"version": "2.2.8",
"color": "",
"id": 3283229296059149299,
"timeZone": "CET+02CEST"
},
"user": {
"name": "user",
"id": 8,
"globalAccessRights": 825439032336
},
"encrypted": false,
"objectsSynchronized": false,
"passwordExpired": false,
"zoningEnabled": false
}
}

$ curl -X GET --cookie "session_handle=8338e7f3-ba99-46c5-9fd6-84b38cc5d715" "http://localhost:8080/netxms-websvc/objects?class=container,node"

.. prints some data ..
</pre>

Get DCI summary Adhoc:

Save this as file, ie netxms.json:
<pre>
{
"baseObject":"ContainerName",
"multiInstance":false,
"columns": [
{
"columnName":"Free form name that will be used in return table for this column",
"dciName":"Name of DCI, that will be used for filtering"
},
{
"columnName":"Name2",
"dciName":"DCIName2"
}
]
}</pre>

curl -s -X POST --cookie "session_handle=$TOKEN" --data @netxms.json "http://localhost:8080/netxms-websvc/summaryTable/adHoc"

= Java 10 =

If curl test works but grafana returns "Internal error" ({"description":"Internal error","error":46}") 
Add "--add-modules java.xml.bind" to JAVA_OPTS in /etc/default/tomcat8

Web service API

2019-11-01T10:28:26Z

Borgso: Get Last Values for Object

Web service API provides access to NetXMS via HTTP/HTTPS. API calls are REST-like (although not purely RESTful) and uses JSON for data exchange.

= Session Management =

== Login ==
'''POST''' /sessions

Create new session. Input object fields:

login
password

On success server will set cookie '''session_handle''' which should be passed on each subsequent request.

== Logout ==
'''DELETE''' /session/''sid''

Logout (delete session) with given session ID.

= Object Management =

== Get Objects ==
'''GET''' /objects
'''GET''' /objects?''filter''

Get all objects visible to logged in user. Optional filter can define additional criteria for object selection:

area=''geographical_area''

class=''class_list''

name=''pattern''

'''Examples'''

Get all objects with name starting with "T":
GET /objects?name=T*

Get all nodes around Riga:
GET /objects?class=node&area=57.0592,23.1647,56.8270,24.6025

Get all nodes and containers:
GET /objects?class=container,node

== Get Specific Object ==
'''GET''' /objects/''id''

== Get Last Values for Object ==
'''GET''' objects/''id''/lastvalues

== CURL Test ==

Test API with Curl

<pre>
$ curl -X POST --data '{"login":"user","password":"pass"}' "http://localhost:8080/netxms-websvc/sessions"

{
"sessionHandle": "8338e7f3-ba99-46c5-9fd6-84b38cc5d715",
"session": {
"server": {
"address": "127.0.0.1",
"version": "2.2.8",
"color": "",
"id": 3283229296059149299,
"timeZone": "CET+02CEST"
},
"user": {
"name": "user",
"id": 8,
"globalAccessRights": 825439032336
},
"encrypted": false,
"objectsSynchronized": false,
"passwordExpired": false,
"zoningEnabled": false
}
}

$ curl -X GET --cookie "session_handle=8338e7f3-ba99-46c5-9fd6-84b38cc5d715" "http://localhost:8080/netxms-websvc/objects?class=container,node"

.. prints some data ..
</pre>

= Java 10 =

If curl test works but grafana returns "Internal error" ({"description":"Internal error","error":46}") 
Add "--add-modules java.xml.bind" to JAVA_OPTS in /etc/default/tomcat8

Using APT Repository

2019-09-19T11:35:00Z

Borgso:

We provide deb packages for Debian and Ubuntu users at http://packages.netxms.org/, which is our public APT repository.
Packages are signed, so you'll need to install additional encryption key for signature verification.

== Automated configuration ==

Install netxms-release_1.5_all.deb (this package should support all Debian and Ubuntu systems):

wget http://packages.netxms.org/netxms-release_1.5_all.deb
dpkg -i netxms-release_1.5_all.deb

== Manual configuration ==

Add the repository to your sources.list (change "jessie" to correct distro name):

Debian:

deb http://packages.netxms.org/debian/ jessie main

Ubuntu:

deb http://packages.netxms.org/ubuntu/ xenial main

Fetch and install the GnuPG key:

wget -q -O - http://packages.netxms.org/netxms.gpg | sudo apt-key add -

== Beta and milestone releases ==

If you feel a bit adventurous, pre-release builds are available in "beta" repository. We do our best not to break anything -- but proceed with caution.

Add to the sources.list (change "jessie" to correct distro name):

deb http://packages.netxms.org/debian/ jessie beta

== Troubleshooting ==

Most common error is missing public key:

W: GPG error: http://packages.netxms.org wheezy Release: The following signatures couldn't be verified
because the public key is not available: NO_PUBKEY 179C0A80CDFADDB1

Import our public key to fix it:

wget -q -O - http://packages.netxms.org/netxms.gpg | sudo apt-key add -

== Public key ==
-----BEGIN PGP PUBLIC KEY BLOCK-----

mQINBFUYHt8BEADE0pv4XFJH870zz567in6AeTZbNElLEmpU6VZD4xZg+fBFL2yU
Zvn16c1NALt4XPETkSWNHs3p+VKLLemAvt/o9i0xC3NsKClrJjuUHhbCbueUepm9
7e1XWTgCuCBpjVzQ9WM7y6GkHkIdyH5qoWVxrwGDiIa9/APsgKqcshYoQb/GqOWe
T/f4Pk7giyOtMKIE+E1xGGb5dAHpPDJxeOSqRcDayJzB1HJq/k5Oojdd8Sfdh3pc
Ah3q76qSUdEGpO9o8ZlywiDn0lJT7BDaHp3uUrUYK+Z68qfBz4IwFNqOxcR/JWuI
MLFna6zJ373ep0LyYSzEzXWWjVT+hybXFbBvCZX7jOThot5THW1e/Me/YXdvQZwN
EISGZr7i0jgEIQGexEcCsRtkIzcYYpg0AmXq/JRGtlY5tjqxb6Cc/YMbbTD6sHiR
X8GfhCG9dfsbGLQLvJ9jMYFQnV8kvIB4FjzSrWSuMT1wVg9fPuWVBnnaAHCbcVLF
TJ7vLT9NZU/hPaRp5qiSnLj97nsJ9JKPDiEqaUOXubb7dS8Qs9NaKHG0XSM63aTp
F8sZoS5XTI/JltDcUuZDSK31CyP+gVd+55vgy1eGPvsETHDrR0/DD5nn0OUtzTzM
73cgfmfdrEZZGRsl3c8fy4bfoemcVeRSLt0BvCTPRFCMjgluDzB/8ABxiQARAQAB
tC5OZXRYTVMgQXV0b21hdGljIFNpZ25pbmcgS2V5IDxpbmZvQG5ldHhtcy5vcmc+
iQJUBBMBCgA+AhsDBQsJCAcDBRUKCQgLBRYDAgEAAh4BAheAFiEExy9VSYsxpScY
HZHZF5wKgM363bEFAlq3mtAFCQlh4vEACgkQF5wKgM363bFNMg/+MJZf/lPiCOpa
roGt6Cl2OCsFMaZ2CSvWN9UGMVRXpVtVIFEH57OjUMbT0IUgdihm2oy9pE6lD91k
GMopfKsKcw/W7Sae7+d3sXB3yn7ht+d1G6r8pId30YeclwIxAtGU7TunoKnh1DVN
y0q1s/BSihg28TixUkHIyz6h1Y0nsBxYCo48RhyXTbVteGTtMBJr3FH8GroAce1b
K0wmFkNCrWAxdTk6D8mx3uASnd261a6Rcbw3kSToWfGtOd0PYP7L/MdPr+ZEdoPF
vxtR31D0NGfB9LLCpxtFtzgj/NjLSJGHXPMjlQGWxGNKf9553qSHeJRQFCAR22YC
M3UIHZS7CUq0c20dkahp49aqorH5n3wMza36rt34i5x5ij7xF9VV9okVZmntwK/4
g+diGxfcvAIft01Xel6T7IPoUG713doOpdwxIhK2Z8sS2DG1kIB8F2zRRl7LLehl
aALpzyVepzZcjkpKrVCygiKypi6AATe/56fPckUVPcH3iUdPQxRPCsrN68Ixwuyw
kdJZ4AjjsOVlHl5aiYN26ulIMlHEeB/0pSai8Ig94qOBby5e0/rUk4zLBwNL6vBA
VtZ3D+HHVaI+XR3m9N/SCuLaGAIo6Rtp7qVo2OsGzyr1m8frwa7gHstUKZfy2XVV
uqoINYozk9ArEsjiYLPNnhmm10LBNYS5Ag0EVRge3wEQANJxkuTiFGYO/hdSaBXe
yzI6bTJ7zH+ek1QXXVeVymIGqgIk0CslJ70FCetwEkX/3Glox+Kpk912fYMopaqm
QdZ6hohs5geUX4N1KUYel4WXlpXuR2T+sYfCLxziX6JGFxm9howrB5o+ZY1Jwpj1
bWxqEfgN//Yca5KYZM9wyiZvxkePhhgkS1tSp+ubupD4mvkDutA/hVBJ6BCGNK+P
EqVyfTtZbi3NBrTicpUlvlPmRoYYRitWKQXniD73IlvV/Zi8K6Rzl4ZiM0YW7Uhz
bKl7GNU1qpF52kl9e1goupeyQpHgoSjREGmzCaxQs/DRn4/sqzo9G3j+5Xxd/AnB
LaNxESkD+o4LX+zYsL81lwUC+75Onc4KgEbY0JX58fbAoTym6tnXbz9SHyhz7jxS
0ojV3Fbbu82I575dy7kEUp+9QY7i9zlE1HqxGpQui1JAx4r7RBlgdBge4EDoHHM5
WOqqzAtPSd3Dcv23xCjMzjHnH760Cyu0hVMVdDca9KxhKk2mwdaispPcOK8URzKx
oR7/Uvfg9ll0Oi9gtBDGXouIXT5F2dIfvHCoEBgg6XTXMMZ4RFQ7K3Mpe+ts/RrB
YMTn36eG6p2usiExIMO9/4kNKfoN591moiw738sf5Oh6wCzNpzqUf/VdkEZxPfyM
KlmyaUaQQN3o5uIVQpLthU65ABEBAAGJAjwEGAEKACYCGwwWIQTHL1VJizGlJxgd
kdkXnAqAzfrdsQUCWrea6AUJCWHjCQAKCRAXnAqAzfrdsamYD/0f+f20vTqu7rOe
cHzn5dxpAI+whfdCvCBQ+6ZDXk7U/z9Ufwbev/RbspFIdDQ+yPP5Nu1A4fAwLjMj
tA99r5Lcj3qbF0HrFmIe3o6jp1gZwr4Z21Q+j+tFWE4YUHp4kIZF03jh0G21P5bN
BI2FbV8Ai/0vg5X8zc3CJbNbdykTwo4UA0oXdurVJnT7YxYslwtOhTMCm/+31r5u
WgdYe3R6+RLVJEYXI6omcp1V03JECL9fZy/TRYm2jDoRUwOjqr8ReiMwAgDR2It9
FTiSpt+0KuayUq35QugojzTm1txifucSbjfrVIusGipczQpz4fzPvGanWN8aBFy6
PafJacW3bWIsNd4buQ2IvOC3oc5keQMy8jljOIS3tA+j7O6UZ3BCDL0iC5jkXOP3
/kXseN/p+5zIab9vzLhKydzZJnM6fUHG2CHwSZn4n7fBYUNXOVN2SnnUPMozihxC
i4KdiBfKLHgd1buBzogqGt8GwevhEUdelRYaI9Vx6tW7T5qkQ1cwZ+GdTUPztpb2
8kDu31izYtu24pd83d89Ws4mYOiqtDm9HZVnZ6ZJ1LWQOQKFp6LmQUi1RL9DSAip
YXw0Uk24F7FJdE7UvjXMR2iz8X5bTQiSiRsZCAdmhNuxOjFNRB2h4snD6yvVHvWS
j2CD5y1aFRZEJ+u6xUUNfLayQo3VIQ==
=+zlN
-----END PGP PUBLIC KEY BLOCK-----

Using nxshell to automate bulk operations

2019-02-04T12:44:08Z

Borgso: /* List Inventory Software for all nodes */

= Introduction =
NxShell is based on Jython and provide access to NetXMS Java API using interactive shell. NxShell is build as single jar file, which includes all required libraries.

Download: http://www.netxms.org/download/nxshell-1.2.13.jar (change 1.2.13 to required version)

= Usage =
Start as interactive shell:
java -jar nxshell-{{version}}.jar

Execute script "test.py":
java -jar nxshell-{{version}}.jar test.py

When NxShell is started, it tries to get server IP, login and password from command line parameters. In interactive mode, user will be asked for details, otherwise default values will be used.

Start as interactive shell, with IP and Login provided (password will be asked):
java -Dnetxms.server=127.0.0.1 -Dnetxms.login=admin -jar nxshell-{{version}}.jar

= Properties =
These properties should be set with JVM's "-D" option. Please make sure that all "-D" options are ''before'' "-jar".

{| class="wikitable"
|-
! Parameter !! Default Value
|-
| netxms.server || 127.0.0.1
|-
| netxms.login || admin
|-
| netxms.password || netxms
|-
| netxms.encryptSession || true
|-
|}

= Scripting =
For details on API please refer to javadoc at http://www.netxms.org/documentation/javadoc/latest/.

NxShell provide user with already connected and synchronised session to simplify scripting. Most required packages are imported as well to minimize typing.

== Global Variables ==
{| class="wikitable"
|-
! Variable !! Type !! Notes
|-
| session || org.netxms.client.NXCSession ||
|-
| s || org.netxms.client.NXCSession || Alias for "session"
|-
|}

== Helper Functions ==

= Sample Scripts =
== Create Container and some nodes ==
<syntaxhighlight lang="python">
parentId = objects.GenericObject.SERVICEROOT # Infrastructure Services root
cd = NXCObjectCreationData(objects.GenericObject.OBJECT_CONTAINER, "Sample Container", parentId);
containerId = session.createObject(cd) # createObject return ID of newly created object
print '"Sample Container" created, id=%d' % (containerId, )

flags = NXCObjectCreationData.CF_DISABLE_ICMP | \
NXCObjectCreationData.CF_DISABLE_NXCP | \
NXCObjectCreationData.CF_DISABLE_SNMP
for i in xrange(0, 5):
name = "Node %d" % (i + 1, )
cd = NXCObjectCreationData(objects.GenericObject.OBJECT_NODE, name, containerId);
cd.setCreationFlags(flags);
cd.setPrimaryName("0.0.0.0") # Create node without IP address
nodeId = session.createObject(cd)
print '"%s" created, id=%d' % (name, nodeId)
</syntaxhighlight>

== Change Object comments ==
<syntaxhighlight lang="python">
for name in open("nodes.txt").readlines():
node = session.findObjectByName(name.strip())
if node:
comments = "New Comment"
existingComments = node.getComments() # will return null if there are no comments
if existingComments:
comments += "\n" + existingComments
session.updateObjectComments(node.getObjectId(), comments)
</syntaxhighlight>

== Manage / Unmanage interfaces based on the name ==
(works for any Object).
<syntaxhighlight lang="python">
from org.netxms.client.objects import GenericObject, Node, Interface

for name in open("nodes.txt").readlines():
node = session.findObjectByName(name.strip())
if node:
for interface in node.getAllChilds(GenericObject.OBJECT_INTERFACE): # 3 == interface
name = interface.getObjectName()
if name.startswith('lo'):
session.setObjectManaged(interface.getObjectId(), True)
else:
session.setObjectManaged(interface.getObjectId(), False)
</syntaxhighlight>

== Disable SNMP polling for node ==
<syntaxhighlight lang="python">
from org.netxms.client.objects import Node

for name in open("nodes.txt").readlines():
node = session.findObjectByName(name.strip())
if node:
md = NXCObjectModificationData(node.getObjectId())
newFlags = node.getFlags() | Node.NF_DISABLE_SNMP
md.setObjectFlags(newFlags)
session.modifyObject(md)
</syntaxhighlight>

== Export list of interfaces to CSV file ==
<syntaxhighlight lang="python">
import csv, sys

w = csv.writer(sys.stdout, dialect='excel')
w.writerow(['node_id', 'interface_id', 'name', 'ip', 'mask']) # Header

for node in [o for o in s.getAllObjects() if isinstance(o, objects.Node)]: # filter all objects for objects.Node
for interface in node.getAllChilds(objects.GenericObject.OBJECT_INTERFACE):
w.writerow([
node.getObjectId(),
interface.getObjectId(),
node.getObjectName(),
interface.getPrimaryIP().getHostAddress(),
interface.getSubnetMask().getHostAddress()
])
</syntaxhighlight>

== List free(administratively down) ethernet ports on switches ==
<syntaxhighlight lang="python">
import csv
import sys

w = csv.writer(sys.stdout, dialect='excel')
w.writerow(['node_id', 'interface_id', 'name', 'ip', 'mask']) # Header

for node in filter(lambda x: isinstance(x, objects.Node), s.getAllObjects()):
allInterfaces = node.getAllChilds(objects.GenericObject.OBJECT_INTERFACE)
# iftype=6 - ethernetCsmacd, http://www.net-snmp.org/docs/mibs/interfaces.html#IANAifType
# or check IFTYPE_* constants in src/nms_common.h
interfaces = filter(lambda i: i.getIfType==6 and i.getOperState() == objects.Interface.ADMIN_STATE_DOWN, allInterfaces)
for interface in interfaces:
w.writerow([
node.getObjectId(),
interface.getObjectId(),
node.getObjectName(),
interface.getPrimaryIP().getHostAddress(),
interface.getSubnetMask().getHostAddress()
])
</syntaxhighlight>

== Set expected interface state ==
<syntaxhighlight lang="python">
import org.netxms.client.NXCObjectModificationData

newExpectedState=0 # 0..UP

for node in [o for o in s.getAllObjects() if isinstance(o, objects.Node)]: # filter all objects for objects.Node
for interface in node.getAllChilds(objects.GenericObject.OBJECT_INTERFACE):
currentExpectedState = interface.getExpectedState()
print 'Node "%s" interface "%s" had expected state %d, setting to %d' % (node.getObjectName(), interface.getObjectName(), currentExpectedState, newExpectedState)
data = NXCObjectModificationData(interface.getObjectId())
data.setExpectedState(newExpectedState)
session.modifyObject(data)
</syntaxhighlight>

== Show all alarms ==
<syntaxhighlight lang="python">
for alarm in session.getAlarms().values():
print '%s (%d): %s' % (session.getObjectName(alarm.getSourceObjectId()), alarm.getCurrentSeverity(), alarm.getMessage())
</syntaxhighlight>

== Show all nodes with matching SNMP OID ==
OID mask is either passed as command line parameter, or hardcoded value used.

<syntaxhighlight lang="python">
import sys
from fnmatch import fnmatch

if len(sys.argv) > 1:
mask = sys.argv[1]
else:
mask = ".1.3.6.1.*"

nodes = filter(lambda x: isinstance(x, objects.Node), s.getAllObjects())
matched = filter(lambda x: fnmatch(x.getSnmpOID(), mask), nodes)
for node in matched:
print node.getObjectId(), node.getObjectName(), node.getPrimaryIP().getHostAddress()
</syntaxhighlight>

== Find MAC address ==
MAC address to find passed as parameter.

<syntaxhighlight lang="python">
import sys
mac = MacAddress.parseMacAddress(sys.argv[1].upper())
if not mac:
print 'Cannot parse MAC address'
else:
print 'Parsed MAC:', mac
cp = s.findConnectionPoint(mac)
if not cp:
'No connection found'
else:
host = s.findObjectById(cp.getLocalNodeId())
bridge = session.findObjectById(cp.getNodeId())
iface = s.findObjectById(cp.getInterfaceId())

if bridge and iface:
if cp.getType() == ConnectionPointType.WIRELESS:
if host:
print "Node %s is connected to wireless access point %s/%s" % (host.getObjectName(), bridge.getObjectName(), iface.getObjectName())
else:
if cp.getLocalIpAddress():
print "Node with IP address %s and MAC address %s is connected to wireless access point %s/%s" % (cp.getLocalIpAddress().getHostAddress(), cp.getLocalMacAddress(), bridge.getObjectName(), iface.getObjectName())
else:
print "Node with MAC address %s is connected to wireless access point %s/%s" % (cp.getLocalMacAddress(), bridge.getObjectName(), iface.getObjectName())
else:
if host:
print "Node %s is %s connected to network switch %s port %s" % (host.getObjectName(), "directly" if cp.getType() == ConnectionPointType.DIRECT else "indirectly", bridge.getObjectName(), iface.getObjectName())
else:
if cp.getLocalIpAddress():
print "Node with IP address %s and MAC address %s is %s connected to network switch %s port %s" % (cp.getLocalIpAddress().getHostAddress(), cp.getLocalMacAddress(), "directly" if cp.getType() == ConnectionPointType.DIRECT else "indirectly", bridge.getObjectName(), iface.getObjectName())
else:
print "Node with MAC address %s is %s connected to network switch %s port %s" % (cp.getLocalMacAddress(), "directly" if cp.getType() == ConnectionPointType.DIRECT else "indirectly", bridge.getObjectName(), iface.getObjectName())
else:
print 'No connection found'
</syntaxhighlight>

== Reset retention time for all DCIs on all nodes to default ==

<syntaxhighlight lang="python">
from org.netxms.client.datacollection import DataCollectionConfiguration, DataCollectionObject
from org.netxms.client.objects import Node, Template

for o in filter(lambda x: (isinstance(x, Node) or isinstance(x, Template)), session.getAllObjects()):
config = session.openDataCollectionConfiguration(o.getObjectId())
for dc in config.getItems():
if dc.getTemplateId() == 0:
dc.setRetentionTime(0)
config.modifyObject(dc)
config.close()
print "%s %s updated" % ("Node" if isinstance(o, Node) else "Template", o.getObjectName())
</syntaxhighlight>

== List Inventory Software for all nodes ==
<syntaxhighlight lang="python">
for node in [o for o in s.getAllObjects() if isinstance(o, objects.Node)]:
print 'Node: ', node.getObjectName()
try:
for package in s.getNodeSoftwarePackages(node.getObjectId()):
print package.getName()
except:
print "No package found"
</syntaxhighlight>

== Enter/Leave Maintenance for node ==
<syntaxhighlight lang="python">
from org.netxms.client.objects import Node
import org.netxms.client.NXCSession

NETXMS_NODE = "__NodeName__"
STATE = False or True

node = session.findObjectByName(NETXMS_NODE.strip())
if node:
session.setObjectMaintenanceMode(node.getObjectId(), STATE)
</syntaxhighlight>

Using nxshell to automate bulk operations

2018-10-01T11:04:45Z

Borgso: /* Reset retention time for all DCIs on all nodes to default */

Web service API

2018-09-26T18:17:13Z

Borgso:

Web service API provides access to NetXMS via HTTP/HTTPS. API calls are REST-like (although not purely RESTful) and uses JSON for data exchange.

= Session Management =

== Login ==
'''POST''' /sessions

Create new session. Input object fields:

login
password

On success server will set cookie '''session_handle''' which should be passed on each subsequent request.

== Logout ==
'''DELETE''' /session/''sid''

Logout (delete session) with given session ID.

= Object Management =

== Get Objects ==
'''GET''' /objects
'''GET''' /objects?''filter''

Get all objects visible to logged in user. Optional filter can define additional criteria for object selection:

area=''geographical_area''

class=''class_list''

name=''pattern''

'''Examples'''

Get all objects with name starting with "T":
GET /objects?name=T*

Get all nodes around Riga:
GET /objects?class=node&area=57.0592,23.1647,56.8270,24.6025

Get all nodes and containers:
GET /objects?class=container,node

== Get Specific Object ==
'''GET''' /objects/''id''

== CURL Test ==

Test API with Curl

<pre>
$ curl -X POST --data '{"login":"user","password":"pass"}' "http://localhost:8080/netxms-websvc/sessions"

{
"sessionHandle": "8338e7f3-ba99-46c5-9fd6-84b38cc5d715",
"session": {
"server": {
"address": "127.0.0.1",
"version": "2.2.8",
"color": "",
"id": 3283229296059149299,
"timeZone": "CET+02CEST"
},
"user": {
"name": "user",
"id": 8,
"globalAccessRights": 825439032336
},
"encrypted": false,
"objectsSynchronized": false,
"passwordExpired": false,
"zoningEnabled": false
}
}

$ curl -X GET --cookie "session_handle=8338e7f3-ba99-46c5-9fd6-84b38cc5d715" "http://localhost:8080/netxms-websvc/objects?class=container,node"

.. prints some data ..
</pre>

= Java 10 =

If curl test works but grafana returns "Internal error" ({"description":"Internal error","error":46}") 
Add "--add-modules java.xml.bind" to JAVA_OPTS in /etc/default/tomcat8

Web service API

2018-09-26T18:16:32Z

Borgso:

Web service API provides access to NetXMS via HTTP/HTTPS. API calls are REST-like (although not purely RESTful) and uses JSON for data exchange.

= Session Management =

== Login ==
'''POST''' /sessions

Create new session. Input object fields:

login
password

On success server will set cookie '''session_handle''' which should be passed on each subsequent request.

== Logout ==
'''DELETE''' /session/''sid''

Logout (delete session) with given session ID.

= Object Management =

== Get Objects ==
'''GET''' /objects
'''GET''' /objects?''filter''

Get all objects visible to logged in user. Optional filter can define additional criteria for object selection:

area=''geographical_area''

class=''class_list''

name=''pattern''

'''Examples'''

Get all objects with name starting with "T":
GET /objects?name=T*

Get all nodes around Riga:
GET /objects?class=node&area=57.0592,23.1647,56.8270,24.6025

Get all nodes and containers:
GET /objects?class=container,node

== Get Specific Object ==
'''GET''' /objects/''id''

== CURL Test ==

Test API with Curl

<pre>
$ curl -X POST --data '{"login":"user","password":"pass"}' "http://localhost:8080/netxms-websvc/sessions"

{
"sessionHandle": "8338e7f3-ba99-46c5-9fd6-84b38cc5d715",
"session": {
"server": {
"address": "127.0.0.1",
"version": "2.2.8",
"color": "",
"id": 3283229296059149299,
"timeZone": "CET+02CEST"
},
"user": {
"name": "user",
"id": 8,
"globalAccessRights": 825439032336
},
"encrypted": false,
"objectsSynchronized": false,
"passwordExpired": false,
"zoningEnabled": false
}
}

$ curl -X GET --cookie "session_handle=8338e7f3-ba99-46c5-9fd6-84b38cc5d715" "http://localhost:8080/netxms-websvc/objects?class=container,node"

.. prints some data ..
</pre>

=== Java 10 ===

If curl test works but grafana returns "Internal error" ({"description":"Internal error","error":46}") 
Add "--add-modules java.xml.bind" to JAVA_OPTS in /etc/default/tomcat8

Web service API

2018-09-17T12:11:24Z

Borgso: /* CURL Test */

Web service API provides access to NetXMS via HTTP/HTTPS. API calls are REST-like (although not purely RESTful) and uses JSON for data exchange.

= Session Management =

== Login ==
'''POST''' /sessions

Create new session. Input object fields:

login
password

On success server will set cookie '''session_handle''' which should be passed on each subsequent request.

== Logout ==
'''DELETE''' /session/''sid''

Logout (delete session) with given session ID.

= Object Management =

== Get Objects ==
'''GET''' /objects
'''GET''' /objects?''filter''

Get all objects visible to logged in user. Optional filter can define additional criteria for object selection:

area=''geographical_area''

class=''class_list''

name=''pattern''

'''Examples'''

Get all objects with name starting with "T":
GET /objects?name=T*

Get all nodes around Riga:
GET /objects?class=node&area=57.0592,23.1647,56.8270,24.6025

Get all nodes and containers:
GET /objects?class=container,node

== Get Specific Object ==
'''GET''' /objects/''id''

== CURL Test ==

Test API with Curl

<pre>
$ curl -X POST --data '{"login":"user","password":"pass"}' "http://localhost:8080/netxms-websvc/sessions"

{
"sessionHandle": "8338e7f3-ba99-46c5-9fd6-84b38cc5d715",
"session": {
"server": {
"address": "127.0.0.1",
"version": "2.2.8",
"color": "",
"id": 3283229296059149299,
"timeZone": "CET+02CEST"
},
"user": {
"name": "user",
"id": 8,
"globalAccessRights": 825439032336
},
"encrypted": false,
"objectsSynchronized": false,
"passwordExpired": false,
"zoningEnabled": false
}
}

$ curl -X GET --cookie "session_handle=8338e7f3-ba99-46c5-9fd6-84b38cc5d715" "http://localhost:8080/netxms-websvc/objects?class=container,node"

.. prints some data ..
</pre>

Web service API

2018-09-17T12:10:47Z

Borgso:

NXSL

2014-11-05T14:11:02Z

Borgso: Created page with "Node Node runtimeFlags NetXMS_Scripting_Language_(NXSL)"

[[NXSL:Node|Node]] 
[[NXSL:Node:runtimeFlags|Node runtimeFlags]] 
[[UM:NetXMS_Scripting_Language_(NXSL)|NetXMS_Scripting_Language_(NXSL)]]

Using nxshell to automate bulk operations

2014-03-21T15:29:21Z

Borgso:

Using nxshell to automate bulk operations

2014-03-21T15:28:55Z

Borgso: /* Introduction */