Documentation
Table of Contents
> Объект прототипа узлов сети
Следующие объекты напрямую связаны с hostprototype API.
Прототип узлов сети
Объект прототипа узлов сети имеет следующие свойства.
| Свойство | Тип | Описание |
|---|---|---|
| hostid | строка | (только чтение) ID прототипа узлов сети. |
| host (требуется) |
строка | Техническое имя прототипа узлов сети. |
| name | строка | Видимое имя прототипа узлов сети. По умолчанию: значение свойства host. |
| status | целое число | Состояние прототипа узлов сети. Возможные значения: 0 - (по умолчанию) узел сети под наблюдением; 1 - узел сети без наблюдения. |
| templateid | строка | (только чтение) ID родительского прототипа узлов сети из шаблона. |
| tls_connect | целое число | Подключения к узлу сети. Возможные значения: 1 - (по умолчанию) Без шифрования; 2 - PSK; 4 - сертификат. |
| tls_accept | целое число | Соединения с узла сети. Возмодные битовые значения: 1 - (по умолчанию) Без шифрования; 2 - PSK; 4 - сертификат. |
| tls_issuer | строка | Эмитент сертификата. |
| tls_subject | строка | Субъект сертификата. |
| tls_psk_identity | строка | Идентификатор PSK. Требуется, если либо в tls_connect, либо в tls_accept выбран PSK. |
| tls_psk | строка | Pre-shared ключ, по крайней мере 32 шестнадцатеричных цифры. Требуется, если либо в tls_connect, либо в tls_accept выбран PSK. |
Данные инвентаризации прототипа узлов сети
Объект данных инвентаризации прототипа узлов сети имеет следующие свойства.
| Свойство | Тип | Описание |
|---|---|---|
| inventory_mode | целое число | Режим заполнения инвентарных данных прототипа узлов сети. Возможные значения: -1 - деактивировано; 0 - (по умолчанию) вручную; 1 - автоматически. |
Соединение с группой
Объект соединения с группой связывает прототип узлов сети с группой узлов сети и имеет следующие свойства.
| Свойство | Тип | Описание |
|---|---|---|
| group_prototypeid | строка | (только чтение) ID соединения с группой. |
| groupid (требуется) |
строка | ID группы узлов сети. |
| hostid | строка | (только чтение) ID прототипа узлов сети |
| templateid | строка | (только чтение) ID родительского соединения с группой из шаблона. |
Прототип групп
Объект прототипа группы задает группу, которая будет создана для обнаруженного узла сети и имеет следующие свойства.
| Свойство | Тип | Описание |
|---|---|---|
| group_prototypeid | строка | (только чтение) ID прототипа группы. |
| name (требуется) |
строка | Имя прототипа группы. |
| hostid | строка | (только чтение) ID прототипа узлов сети |
| templateid | строка | (только чтение) ID родительского прототипа группы из шаблона. |
Custom interface
The custom interface object has the following properties.
| Property | Type | Description |
|---|---|---|
| dns | string | DNS name used by the interface. Required if the connection is made via DNS. Can contain macros. |
| ip | string | IP address used by the interface. Required if the connection is made via IP. Can contain macros. |
| main (required) |
integer | Whether the interface is used as default on the host. Only one interface of some type can be set as default on a host. Possible values are: 0 - not default; 1 - default. |
| port (required) |
string | Port number used by the interface. Can contain user and LLD macros. |
| type (required) |
integer | Interface type. Possible values are: 1 - agent; 2 - SNMP; 3 - IPMI; 4 - JMX. |
| useip (required) |
integer | Whether the connection should be made via IP. Possible values are: 0 - connect using host DNS name; 1 - connect using host IP address for this host interface. |
| details | array | Additional object for interface. Required if interface 'type' is SNMP. |
Custom interface details
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. 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. |