Documentation
Table of Contents
> Hostinterface-object
De volgende objecten zijn direct gerelateerd aan de hostinterface API.
Hostinterface
Het hostinterface-object heeft de volgende eigenschappen.
Merk op dat zowel de eigenschappen ip als dns verplicht zijn voor maakbewerkingen. Als je DNS niet wilt gebruiken, stel het dan in op een lege string.
| Eigenschap | Type | Beschrijving |
|---|---|---|
| interfaceid | string | ID van het interface. Eigenschapsgedrag: - alleen lezen - verplicht voor bijgewerkte bewerkingen |
| available | integer | Beschikbaarheid van hostinterface. Mogelijke waarden: 0 - (standaard) onbekend; 1 - beschikbaar; 2 - niet beschikbaar. Eigenschapsgedrag: - alleen lezen |
| hostid | string | ID van de host waar het interface bij hoort. Eigenschapsgedrag: - constant - verplicht voor maakbewerkingen |
| type | integer | Type interface. Mogelijke waarden: 1 - Agent; 2 - SNMP; 3 - IPMI; 4 - JMX. Eigenschapsgedrag: - verplicht voor maakbewerkingen |
| ip | string | IP-adres dat door het interface wordt gebruikt. Kan leeg zijn als de verbinding via DNS wordt gemaakt. Eigenschapsgedrag: - verplicht voor maakbewerkingen |
| dns | string | DNS-naam die door het interface wordt gebruikt. Kan leeg zijn als de verbinding via IP wordt gemaakt. Eigenschapsgedrag: - verplicht voor maakbewerkingen |
| port | string | Poortnummer dat door het interface wordt gebruikt. Kan gebruikersmacro's bevatten. Eigenschapsgedrag: - verplicht voor maakbewerkingen |
| useip | integer | Of de verbinding via IP moet worden gemaakt. Mogelijke waarden: 0 - verbinding maken via host DNS-naam; 1 - verbinding maken via host IP-adres. Eigenschapsgedrag: - verplicht voor maakbewerkingen |
| main | integer | Of het interface als standaard wordt gebruikt op de host. Slechts één interface van een bepaald type kan als standaard worden ingesteld op een host. Mogelijke waarden: 0 - niet standaard; 1 - standaard. Eigenschapsgedrag: - verplicht voor maakbewerkingen |
| details | array | Extra details object voor interface. Eigenschapsgedrag: - verplicht indien type is ingesteld op "SNMP" |
| disable_until | timestamp | De volgende pollingtijd van een niet-beschikbaar hostinterface. Eigenschapsgedrag: - alleen lezen |
| error | string | Fouttekst als hostinterface niet beschikbaar is. Eigenschapsgedrag: - alleen lezen |
| errors_from | timestamp | Tijd waarop hostinterface niet beschikbaar werd. Eigenschapsgedrag: - alleen lezen |
Details
Het detail-object heeft de volgende eigenschappen.
| Eigenschap | Type | Beschrijving |
|---|---|---|
| version | integer | SNMP-interfaceversie. Mogelijke waarden: 1 - SNMPv1; 2 - SNMPv2c; 3 - SNMPv3. Eigenschapsgedrag: - verplicht |
| bulk | integer | Of bulk SNMP-verzoeken moeten worden gebruikt. Mogelijke waarden: 0 - geen bulkverzoeken gebruiken; 1 - (standaard) - bulkverzoeken gebruiken. |
| community | string | SNMP-community. Alleen gebruikt door SNMPv1- en SNMPv2-interfaces. Eigenschapsgedrag: - verplicht indien version is ingesteld op "SNMPv1" of "SNMPv2c" |
| max_repetitions | integer | Maximale herhaling waarde voor native SNMP-bulkverzoeken (GetBulkRequest-PDU's). Alleen gebruikt voor discovery[] en walk[] items in SNMPv2 en v3.Standaard: 10. |
| securityname | string | SNMPv3-beveiligingsnaam. Alleen gebruikt door SNMPv3-interfaces. |
| securitylevel | integer | SNMPv3-beveiligingsniveau. Alleen gebruikt door SNMPv3-interfaces. Mogelijke waarden: 0 - (standaard) - noAuthNoPriv; 1 - authNoPriv; 2 - authPriv. |
| authpassphrase | string | SNMPv3-authenticatiewachtwoord. Alleen gebruikt door SNMPv3-interfaces. |
| privpassphrase | string | SNMPv3-privacywachtwoord. Alleen gebruikt door SNMPv3-interfaces. |
| authprotocol | integer | SNMPv3-authenticatieprotocol. Alleen gebruikt door SNMPv3-interfaces. Mogelijke waarden: 0 - (standaard) - MD5; 1 - SHA1; 2 - SHA224; 3 - SHA256; 4 - SHA384; 5 - SHA512. |
| privprotocol | integer | SNMPv3-privacyprotocol. Alleen gebruikt door SNMPv3-interfaces. Mogelijke waarden: 0 - (standaard) - DES; 1 - AES128; 2 - AES192; 3 - AES256; 4 - AES192C; 5 - AES256C. |
| contextname | string | SNMPv3-contextnaam. Alleen gebruikt door SNMPv3-interfaces. |