Difference between revisions of "Using nxshell to automate bulk operations"

Jump to navigation Jump to search

Using nxshell to automate bulk operations (view source)

Revision as of 18:14, 13 September 2022

6,824 bytes added ,  18:14, 13 September 2022
m
Text replacement - "^" to "{{deprecated}}"
m (Text replacement - "^" to "{{deprecated}}")
 
(19 intermediate revisions by 7 users not shown)
Line 1: Line 1:
= Introduction =
{{deprecated}}= 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.
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.5.jar (change 1.2.5 to required version)
Download: http://www.netxms.org/download/nxshell-1.2.13.jar (change 1.2.13 to required version)


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


Execute script "test.py":
Execute script "test.py":
  java -jar nxshell-1.2.5.jar 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.
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):
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-1.2.5.jar
  java -Dnetxms.server=127.0.0.1 -Dnetxms.login=admin -jar nxshell-{{version}}.jar


= Properties =
= Properties =
Line 28: Line 28:
|-
|-
| netxms.password || netxms
| netxms.password || netxms
|-
| netxms.encryptSession || true
|-
|-
|}
|}
Line 108: Line 110:
         md.setObjectFlags(newFlags)
         md.setObjectFlags(newFlags)
         session.modifyObject(md)
         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.allObjects):
  config = session.openDataCollectionConfiguration(o.objectId)
  for dc in config.items:
      if dc.templateId == 0:
        dc.setRetentionTime(0)
        config.modifyObject(dc)
  config.close()
  print "%s %s updated" % ("Node" if isinstance(o, Node) else "Template", o.objectName)
</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>
</syntaxhighlight>
Retrieved from "https://wiki.netxms.org/wiki/Special:MobileDiff/882...2034"

Navigation menu