PDF

Data Properties Reference

Find a reference to all NetCrunch object properties exposed through API

This section describes fields that can be accessed via API. Please refer to examples to see the results of a query of the individual fields.

node-property-list

Node Property List

The list below shows all node fields accessible via API. Not every field can be modified. These are marked as Read-Only

API Name Data Type Read-Only Comments
networkServices string  
monitoringTime number minutes
dependsOnNode number
netBiosName string x  
identification string values: 'default', 'ipAddress', 'dnsName', 'macAddress'
geolocation object {"geolocation": {"pos": {"lat": 52.23, "lon": 21.01}, "info": "Warsaw"}}
deviceType string
parentNode number
children number
id number x
name string
networkAddress string
snmpComputerName string x
snmpSysObjId string x
snmpOsDescription string x
snmpLocation string x
dnsName string x
avgResponseTime number x miliseconds(ms)
maxResponsetime number x miliseconds(ms)
alerts24h number x
lastAlert number/string x result contains both number and string values
snmpManaged bool
snmpProfile string Name of SNMP profile
snmpPort number
snmpTimeout number miliseconds(ms)
snmpRetryCount number
macAddress string x
networkPrefixLength number i.e. 24 = 255.255.255.0
connectedToSwitch string x
enabled bool
status string x values: 'unknown', 'down', 'warning', 'OK', 'disabled', 'disabled by dependency', 'disabled by time restrictions', 'disabled by user', 'waiting for response', 'disabled by network', 'disabled by unknown IP address', 'monitoring paused'
simplifiedMonitoring bool true/false
disabledFrom number
disabledUntil number
addTime number x
lastStatusChange number x
parentNode string x
issueCount number x
virtualization string x
monitoringEngines string See column Monitoring Engines in Nodes view
children object It can be an array - depends on how many child nodes are provided, e.g. [1021,1022]
pendingAlertsCount number x
customFields object It's possible to set multiple custom fields with one object e.g. {"Info 1": "TestVal1", "Info 2": "TestVal2", "Pick": "3"}
interfacesMonitoringEnabled bool
organizationalUnit string x
snmpTrapCodePage number
sysLogCodePage number
lastNote object x
displayName string
organization number
nodeType string x values: 'IP Node', 'Business Status', 'Remote Sensor Node', 'Monitoring Probe', 'Node Monitoring Template'
probeType string x
addressSpace number x
templateNode number x
osMonitorType string values: 'auto', 'none', 'windows', 'macOS', 'linux', 'bsd', 'esx', 'solaris', 'proxmox'
hypervisorKind number x
sensors object  
tags string values: A,B,C

Example

{
  "id": 1001,
  "name": "admin.ad.acme",
  "dnsName": "admin.ad.acme",
  "networkAddress": "192.168.0.25",
  "networkPrefixLength": 24,
  "snmpComputerName": "admin.ad.acme",
  "snmpOsDescription": "Hardware: Intel64 Family 6 Model 26 Stepping 5 AT/AT COMPATIBLE - Software: Windows Version 6.3 (Build 16299 Multiprocessor Free)",
  "snmpSysObjId": "1.3.6.1.4.1.311.1.1.3.1.1",
  "snmpLocation": "Development",
  "snmpAvailable": true,
  "snmpManaged": true,
  "snmpProfile": "Default (read-write)",
  "snmpPort": 161,
  "snmpTimeout": 5000,
  "snmpRetryCount": 3,
  "displayName": "My Node",
  "monitoringTime": "5",
  "networkServices": [
    {
      "name": "SSH",
      "status": "Not Responding",
      "errorMessage": "Can't open connection"
    },
    {
      "name": "CIFS/SMB",
      "isLeading": true,
      "status": "OK"
    }
  ],
  "dependsOnNode": {
    "nodeId": 1003,
    "name": "test.ad.acme",
    "networkAddress": "10.10.3.72",
    "dnsName": "test.ad.acme"
  },
  "netBiosName": "ADMIN",
  "identification": "default",
  "deviceType": {
    "class": "Server/Workstation",
    "os": "Windows Server",
    "version": "Windows 2012 R2 Server"
  },
  "parentNode": {
    "nodeId": 1003,
    "name": "test.ad.acme",
    "networkAddress": "10.10.3.72",
    "dnsName": "test.ad.acme"
  },
  "simplifiedMonitoring": false,
  "status": "OK",
  "avgResponseTime": 10,
  "maxResponseTime": 100,
  "alerts24h": {
    "count": 5,
    "critical": 2,
    "warning": 3,
    "unacknowledged": 1
  },
  "lastAlert": {
    "id": 585266,
    "info": "Node Down",
    "serverity": "Critical",
    "time": "2018-10-09T06:15:15.000Z"
  },
  "macAddress": "D89EF32B5ADD",
  "enabled": true,
  "disabledFrom": "2018-03-08T13:27:34.876Z",
  "disabledUntil": "2018-03-09T13:27:34.876Z",
  "addTime": "2018-02-08T13:27:34.876Z",
  "lastStatusChange": "2018-10-09T10:08:58.885Z",
  "issueCount": 2,
  "connectedToSwitch": {
    "nodeId": 1078,
    "interface": "Port-channel2",
    "port": 464,
    "vlanId": 999
  },
  "virtualization": {
    "type": "Hyper-V",
    "hostNodeId": 1023,
    "hostName": "virt-host.ad.acme",
    "dataCenter": "Master Data Center"
  },
  "monitoringEngines": [
    {
      "name": "win",
      "enabled": true,
      "status": "OK"
    },
    {
      "name": "ntsvc",
      "enabled": true,
      "status": "unknown"
    },
    {
      "name": "ntlog",
      "enabled": true,
      "status": "OK"
    }
  ],
  "children": [
    1506,
    1507
  ],
  "pendingAlertsCount": 0,
  "customFields": {
    "Info 1": "TestVal1",
    "Info 2": "TestVal2",
    "Pick": "3",
    "Date Field": "1990-10-04T23:00:00.000Z"
  },
  "interfacesMonitoringEnabled": true,
  "organizationalUnit": "Testing",
  "snmpTrapPage": 4294967295,
  "sysLogPage": 4294967295,
  "lastNote": null,
  "templateNode": {
    "nodeId": 1234,
    "name": "template",
    "networkAddress": "",
    "dnsName": ""
  },
  "addressSpace": ""
}

view-property-list

View Property List

The list below shows view fields accessible via API

Property Read-Only Comments
id x ID of the view
name Name of the View
status x values: 'unknown', 'down', 'OK', 'warning'
stats x object representing view stats
path x "/" seperated path to view/policy
isDynamic x
isFolder x
readOnly x

Example

{
  "id": 50,
  "name": "CPU",
  "status": "unknown",
  "stats": {
    "nodes": {
      "total": 0,
      "ok": 0,
      "unknown": 0,
      "warning": 0,
      "error": 0,
      "alerts": {
        "active": 0,
        "las24Hours": {
          "unacknowledged": 0,
          "total": 0,
          "critical": 0,
          "warning": 0
        }
      }
    },
    "maps": {
      "total": 22,
      "ok": 0,
      "unknown": 16,
      "warning": 3,
      "error": 3
    }
  },
  "path": "/Monitoring Packs/Operating Systems/Windows/CPU",
  "isDynamic": true,
  "isFolder": false,
  "readOnly": false
}

ip-network-property-list

Additional Properties for IP Network Views

Besides of view property list table below shows an additional field for IP network views.

Property Read-Only Comments
networkAddress x Network Address of the View
networkPrefixLength x Prefix length of the view
monitoringEnabled Monitoring enabled true/false
addressSpace x Address Space of the view

Example

{
  "networkAddress": "10.10.4.64",
  "networkPrefixLength": 26,
  "monitoringEnabled": true,
  "addressSpace": ""
}

monitoring-pack-property-list

Additional Properties for Monitoring Packs

Besides of view, the property list table below shows an additional field for policies.

Property Read-Only Comments
policyType x values: '', 'windows', 'linux', 'macos', 'bsd', 'esx', 'solaris'
enabled true/false
snmpRequired x true/false

Example

{
  "policyType": "windows",
  "enabled": true,
  "snmpRequired": false
}