Documentation
Table of Contents
> Obiekt Host interface
Poniższe obiekty są bezpośrednio związane z interfejsem API hostinterface.
Host interface
Obiekt Host interface ma następujące właściwości.
Zwróć uwagę, że zarówno adres IP, jak i DNS są wymagane. Jeśli nie chcesz używać DNS, ustaw go jako pusty ciąg znaków.
| Właściwość | Typ | Opis |
|---|---|---|
| available | integer | (tylko do odczytu) Dostępność interfejsu hosta. Możliwe wartości to: 0 - (domyślnie) nieznany; 1 - dostępny; 2 - niedostępny. |
| details | array | Dodatkowy obiekt interfejsu. Wymagane jeśli typ interfejsu to SNMP. |
| disable_until | timestamp | (tylko do odczytu) Czas następnego odpytywania niedostępnego interfejsu hosta. |
| dns (wymagane) |
string | Nazwa DNS używana przez interfejs. Może być pusty, jeśli połączenie jest realizowane za pomocą adresu IP. |
| error | string | (tylko do odczytu) Tekst błędu, jeśli interfejs hosta jest niedostępny. |
| errors_from | timestamp | (tylko do odczytu) Czas, kiedy interfejs hosta stał się niedostępny. |
| hostid (wymagane) |
string | ID hosta, do którego należy interfejs. |
| interfaceid | string | (tylko do odczytu) ID interfejsu. |
| ip (wymagane) |
string | Adres IP używany przez interfejs. Może być pusty, jeśli połączenie jest realizowane za pomocą DNS. |
| main (wymagane) |
integer | Czy interfejs jest używany jako domyślny na hoście. Tylko jeden interfejs tego samego typu może być ustawiony jako domyślny na hoście. Możliwe wartości to: 0 - nie domyślny; 1 - domyślny. |
| port (wymagane) |
string | Numer portu używany przez interfejs. Może zawierać makra użytkownika. |
| type (wymagane) |
integer | Typ interfejsu. Możliwe wartości to: 1 - agent; 2 - SNMP; 3 - IPMI; 4 - JMX. |
| useip (wymagane) |
integer | Czy połączenie powinno być realizowane za pomocą adresu IP. Możliwe wartości to: 0 - połącz używając nazwy DNS hosta; 1 - połącz używając adresu IP hosta dla tego interfejsu hosta. |
Zauważ, że dla niektórych metod (update, delete) kombinacja parametrów wymaganych/opcjonalnych może być inna.
Details tag
Obiekt details ma następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| version (wymagane) |
integer | Wersja interfejsu SNMP. Możliwe wartości to: 1 - SNMPv1; 2 - SNMPv2c; 3 - SNMPv3 |
| bulk | integer | Czy używać łączonych żądań SNMP. Możliwe wartości to: 0 - nie używaj żądań łączonych; 1 - (domyślnie) - użyj żądań łączonych. |
| community | string | Hasło SNMP (wymagane). Używane tylko przez interfejsy SNMPv1 i SNMPv2. |
| securityname | string | Nazwa ochrony SNMPv3. Używane tylko przez interfejsy SNMPv3. |
| securitylevel | integer | Poziom zabezpieczeń SNMPv3. Używane tylko przez interfejsy SNMPv3. Możliwe wartości to: 0 - (domyślnie) - noAuthNoPriv; 1 - authNoPriv; 2 - authPriv. |
| authpassphrase | string | Hasło uwierzytelniania SNMPv3. Używane tylko przez interfejsy SNMPv3. |
| privpassphrase | string | Hasło prywatności SNMPv3. Używane tylko przez interfejsy SNMPv3. |
| authprotocol | integer | Protokół uwierzytelniania SNMPv3. Używane tylko przez interfejsy SNMPv3. Możliwe wartości to: 0 - (domyślnie) - MD5; 1 - SHA1; 2 - SHA224; 3 - SHA256; 4 - SHA384; 5 - SHA512. |
| privprotocol | integer | Protokół prywatności SNMPv3. Używane tylko przez interfejsy SNMPv3. Możliwe wartości to: 0 - (domyślnie) - DES; 1 - AES128; 2 - AES192; 3 - AES256; 4 - AES192C; 5 - AES256C. |
| contextname | string | Nazwa kontekstu SNMPv3. Używane tylko przez interfejsy SNMPv3. |