PDF

Verweis auf Dateneigenschaften

Suchen Sie nach dem Verweis auf alle NetCrunch-Objekteigenschaften, die über die API verfügbar gemacht werden

In diesem Abschnitt werden Felder beschrieben, auf die über die API zugegriffen werden kann. In den Beispielen finden Sie die Ergebnisse einer Abfrage der einzelnen Felder.

node-property-list

Liste der Knoteneigenschaften

Die folgende Liste zeigt alle über die API zugänglichen Knotenfelder. Nicht jedes Feld kann geändert werden, diese sind als schreibgeschützt markiert

API-Name Datentyp Schreibgeschützt Bemerkungen
networkServices String  
monitoringTime Zahl Minuten
dependsOnNode Zahl
netBiosName String x  
identification String Werte: 'default', 'ipAddress', 'dnsName', 'macAddress'
deviceType String
parentNode Zahl
children Zahl
id Zahl x
name String
networkAddress String
snmpComputerName String x
snmpSysObjId String x
snmpOsDescription String x
snmpLocation String x
dnsName String x
avgResponseTime Zahl x Millisekunden(ms)
maxResponsetime Zahl x Millisekunden(ms)
alerts24h Zahl x
lastAlert Zahl/String x Ergebnis enthält sowohl Zahlen als auch String-Werte
snmpManaged Bool
snmpProfile String Name des SNMP-Profils
snmpPort Zahl
snmpTimeout Zahl Millisekunden(ms)
snmpRetryCount Zahl
macAddress String x
networkPrefixLength Zahl d.h. 24 = 255.255.255.0
connectedToSwitch String x
enabled Bool
status String x Werte: '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 wahr/falsch
disabledFrom Zahl
disabledUntil Zahl
addTime Zahl x
lastStatusChange Zahl x
parentNode String x
issueCount Zahl x
virtualization String x
monitoringEngines String Die Spalte „Überwachungsfunktionen” in der Knotenansicht sehen
children object Es kann ein Array sein - abhängig davon, wie viele untergeordnete Knoten bereitgestellt werden, z.B. [1021,1022]
pendingAlertsCount Zahl x
customFields Objekt Es ist möglich, mehrere benutzerdefinierte Felder mit einem Objekt festzulegen, z.B. {"Info 1": "TestVal1", "Info 2": "TestVal2", "Pick": "3"}
interfacesMonitoringEnabled Bool
organizationalUnit String x
snmpTrapCodePage Zahl
sysLogCodePage Zahl
lastNote Objekt x
displayName String
organization Zahl
nodeType String x Werte: 'IP Node', 'Business Status', 'Remote Sensor Node', 'Remote Probe', 'Node Monitoring Template'
probeType String x
addressSpace Zahl x
templateNode Zahl x
osMonitorType String Werte: 'auto', 'none', 'windows', 'macOS', 'linux', 'bsd', 'esx', 'solaris'
hypervisorKind Zahl x
sensors Objekt  

Beispiel

{
  "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": "nt",
      "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

Eigenschaftenliste anzeigen

Die folgende Liste zeigt Ansichtsfelder, die über die API zugänglich sind

Eigenschaft Schreibgeschützt Bemerkungen
id x ID der Ansicht
name Name der Ansicht
status x Werte: 'unknown', 'down', 'OK', 'warning'
stats x Objekt, das Ansichtsstatistiken darstellt
path x "/" getrennter Pfad zur Ansicht/Richtlinie
isDynamic x
isFolder x
readOnly x

Beispiel

{
  "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

Zusätzliche Eigenschaften für IP-Netzwerkansichten

Neben der Liste der Eigenschaften von Ansichten zeigt die folgende Tabelle ein zusätzliches Feld für IP-Netzwerkansichten

Eigenschaft Schreibgeschützt Bemerkungen
networkAddress x Netzwerkadresse der Ansicht
networkPrefixLength x Präfixlänge der Ansicht
monitoringEnabled Überwachung aktiviert wahr/falsch
addressSpace x Adressraum der Ansicht

Beispiel

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

monitoring-pack-property-list

Zusätzliche Eigenschaften für Monitoring Packs

Neben der Liste der Eigenschaften von Ansichten zeigt die folgende Tabelle ein zusätzliches Feld für Richtlinien

Eigenschaft Schreibgeschützt Bemerkungen
policyType x Werte: '', 'windows', 'linux', 'macos', 'bsd', 'esx', 'solaris'
enabled wahr/falsch
snmpRequired x wahr/falsch

Beispiel

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