Opis właściwości danych

Znajdź odniesienie do wszystkich właściwości obiektów NetCruncha dostępnych za pomocą API

W tym rozdziale opisano pola, do których można uzyskać dostęp za pośrednictwem interfejsu API. Zapoznaj się z przykładami, aby zobaczyć wyniki zapytania poszczególnych pól.

node-property-list

Lista właściwości węzła

Poniższa lista pokazuje wszystkie pola węzłów dostępne za pośrednictwem interfejsu API. Pola, których nie można modyfikować, są oznaczone jako „tylko do odczytu”.

Nazwa API	Typ danych	Tylko do odczytu	Komentarze
networkServices	string
monitoringTime	liczba		minuty
dependsOnNode	liczba
netBiosName	string	x
identification	string		wartości: 'default', 'ipAddress', 'dnsName', 'macAddress'
deviceType	string
parentNode	liczba
children	liczba
id	liczba	x
name	string
networkAddress	string
snmpComputerName	string	x
snmpSysObjId	string	x
snmpOsDescription	string	x
snmpLocation	string	x
dnsName	string	x
avgResponseTime	liczba	x	milisekundy(ms)
maxResponsetime	liczba	x	milisekundy(ms)
alerts24h	liczba	x
lastAlert	liczba/string	x	Wynik zawiera zarówno liczby, jak i wartości typu string
snmpManaged	bool
snmpProfile	string		Nazwa profilu SNMP
snmpPort	liczba
snmpTimeout	liczba		milisekundy(ms)
snmpRetryCount	liczba
macAddress	string	x
networkPrefixLength	liczba		i.e. 24 = 255.255.255.0
connectedToSwitch	string	x
enabled	bool
status	string	x	wartości: '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		prawda/fałsz
disabledFrom	liczba
disabledUntil	liczba
addTime	liczba	x
lastStatusChange	liczba	x
parentNode	string	x
issueCount	liczba	x
virtualization	string	x
monitoringEngines	string		Zobacz kolumnę „Silniki monitorujące” w widoku węzłów
children	obiekt		Może to być tablica - zależy to od liczby węzłów zależnych, np. [1021,1022]
pendingAlertsCount	liczba	x
customFields	obiekt		Możliwe jest ustawienie wielu niestandardowych pól dla jednego obiektu, np. {"Info 1": "TestVal1", "Info 2": "TestVal2", "Pick": "3"}
interfacesMonitoringEnabled	bool
organizationalUnit	string	x
snmpTrapCodePage	liczba
sysLogCodePage	liczba
lastNote	obiekt	x
displayName	string
organization	liczba
nodeType	string	x	wartości: 'IP Node', 'Business Status', 'Remote Sensor Node', 'Remote Probe', 'Node Monitoring Template'
probeType	string	x
addressSpace	liczba	x
templateNode	liczba	x
osMonitorType	string		wartości: 'auto', 'none', 'windows', 'macOS', 'linux', 'bsd', 'esx', 'solaris'
hypervisorKind	liczba	x
sensors	obiekt

Przykład

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

Zobacz listę właściwości

Poniższa lista przedstawia pola widoku dostępne za pośrednictwem interfejsu API

Właściwość	Tylko do odczytu	Komentarze
id	x	ID widoku
name		Nazwa widoku
status	x	wartości: 'unknown', 'down', 'OK', 'warning'
stats	x	obiekt reprezentujący statystyki widoku
path	x	ścieżka do widoku/reguły porozdzielana znakiem "/"
isDynamic	x
isFolder	x
readOnly	x

Przykład

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

Dodatkowe właściwości dla widoków sieciowych IP

Oprócz listy właściwości widoku poniższa tabela pokazuje dodatkowe pole dla widoków sieci IP

Właściwość	Tylko do odczytu	Komentarze
networkAddress	x	Adres sieciowy widoku
networkPrefixLength	x	Długość prefiksu widoku
monitoringEnabled		Monitorowanie włączone prawda/fałsz
addressSpace	x	Przestrzeń adresowa widoku

Przykład

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

monitoring-pack-property-list

Dodatkowe właściwości pakietów monitorowania

Oprócz listy właściwości widoku poniższa tabela pokazuje dodatkowe pole dla reguł

Właściwość	Tylko do odczytu	Komentarze
policyType	x	wartości: '', 'windows', 'linux', 'macos', 'bsd', 'esx', 'solaris'
enabled		prawda/fałsz
snmpRequired	x	prawda/fałsz

Przykład

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