Documentation
Table of Contents
> Объект интерфейса узла сети
Следующие объекты напрямую связаны с API hostinterface.
Интерфейс узла сети
Объект интерфейса узла сети имеет следующие свойства.
Поля IP и DNS обязательны. Если DNS не используется, укажите его как пустую строку.
| Свойство | Тип | Описание |
|---|---|---|
| available | integer | (только для чтения) - доступность интерфейса узла сети. Возможные значения: 0 - (по умолчанию) неизвестно; 1 - доступен; 2 - недоступен. |
| details | object | Дополнительный объект для интерфейса. Обязательно , если тип интерфейса - SNMP. |
| disable_until | timestamp | (только для чтения) - время следующей проверки недоступного интерфейса узла сети. |
| dns (обязательно) |
string | DNS-имя, используемое интерфейсом. Может быть пустым, если соединение выполняется по IP. |
| error | string | (только для чтения) - текст ошибки, если интерфейс недоступен. |
| errors_from | timestamp | (только для чтения) - время, когда интерфейс узла сети стал недоступен. |
| hostid (обязательно) |
string | Идентификатор узла сети, которому принадлежит интерфейс. |
| interfaceid | string | (только для чтения) - идентификатор интерфейса. |
| ip (обязательно) |
string | IP-адрес, используемый интерфейсом. Может быть пустым, если соединение выполняется по DNS. |
| main (обязательно) |
integer | Используется ли интерфейс как основной для узла. Для каждого типа интерфейса может быть только один основной. Возможные значения: 0 - не основной; 1 - основной. |
| port (обязательно) |
string | Номер порта, используемый интерфейсом. Может содержать пользовательские макросы. |
| type (обязательно) |
integer | Тип интерфейса. Возможные значения: 1 - агент; 2 - SNMP; 3 - IPMI; 4 - JMX. |
| useip (обязательно) |
integer | Определяет, выполняется ли подключение по IP. Возможные значения: 0 - подключение по DNS-имени узла; 1 - подключение по IP-адресу узла для этого интерфейса. |
Обратите внимание, что для некоторых методов (например, update и delete) набор обязательных и необязательных параметров отличается.
Details tag
The details object has the following properties.
| Property | Type | Description |
|---|---|---|
| version (required) |
integer | SNMP interface version. Possible values are: 1 - SNMPv1; 2 - SNMPv2c; 3 - SNMPv3 |
| bulk | integer | Whether to use bulk SNMP requests. Possible values are: 0 - don't use bulk requests; 1 - (default) - use bulk requests. |
| community | string | SNMP community (required). Used only by SNMPv1 and SNMPv2 interfaces. |
| securityname | string | SNMPv3 security name. Used only by SNMPv3 interfaces. |
| securitylevel | integer | SNMPv3 security level. Used only by SNMPv3 interfaces. Possible values are: 0 - (default) - noAuthNoPriv; 1 - authNoPriv; 2 - authPriv. |
| authpassphrase | string | SNMPv3 authentication passphrase. Used only by SNMPv3 interfaces. |
| privpassphrase | string | SNMPv3 privacy passphrase. Used only by SNMPv3 interfaces. |
| authprotocol | integer | SNMPv3 authentication protocol. Used only by SNMPv3 interfaces. Possible values are: 0 - (default) - MD5; 1 - SHA1; 2 - SHA224; 3 - SHA256; 4 - SHA384; 5 - SHA512. |
| privprotocol | integer | SNMPv3 privacy protocol. Used only by SNMPv3 interfaces. Possible values are: 0 - (default) - DES; 1 - AES128; 2 - AES192; 3 - AES256; 4 - AES192C; 5 - AES256C. |
| contextname | string | SNMPv3 context name. Used only by SNMPv3 interfaces. |