Documentation
Table of Contents
Objecte interfície d'equip
Els següents objectes són enllaçats amb l'API hostinterface.
Interfície d'equip
L'objecte d'interfície d'equip té les propietats següents.
::: nota important Tingueu en compte que les propietats IP i DNS són obligatòries. Si no s'ha d'emprar DNS, configureu-lo en una cadena buida. :::
| Propietat | Tipus | Descripció |
|---|---|---|
| interfaceid | ID | ID de la interfície. Comportament de la propietat: - només lectura - obligatori per operacions d'actualització |
| available | integer | Disponibilitat de la interfície de l'equip. Els valors possibles són: 0 - (per defecte) desconegut; 1 - disponible; 2 - no disponible. Comportament de la propietat: - només lectura |
| hostid | ID | ID de l'equip al que pertany la interfície. Comportament de la propietat: - constant - obligatori per operacions de creació |
| tipus | integer | Tipus d'interfície. Valors possibles: 1 - agent; 2 - SNMP; 3 - IPMI; >4 - JMX. Comportament de la propietat: - obligatori per operacions de creació |
| ip | string | adreça IP emprada per la interfície. Pot ésser buit si la connexió s'estableix mitjançant DNS. Comportament de la propietat: - obligatori per operacions de creació |
| dns | string | Nom DNS emprat per la interfície. Pot ésser buit si la connexió s'estableix mitjançant IP. Comportament de la propietat: - obligatori per operacions de creació |
| port | string | Nombre de port emprat per la interfície. Pot contindre macros d'usuari. Comportament de la propietat: - obligatori per operacions de creació |
| useip | integer | Indica si la connexió s'ha d'establir mitjançant IP. Valors possibles: 0 - connecteu-vos amb el nom DNS de l'equip; 1 - connecteu-vos mitjançant l'adreça IP de l'equip. Comportament de la propietat: - obligatori per operacions de creació |
| main | integer | Indica si la interfície s'empra per defecte a l'equip. Només es pot configurar per defecte una interfície d'un tipus determinat en un host. Valors possibles: 0 - no (per defecte); 1 - predeterminat. Comportament de la propietat: - obligatori per operacions de creació |
| details | array | Objecte addicional per a la interfície. Comportament de la propietat: - obligatori si type és "SNMP" |
| disable_until | timestamp | La propera vegada que es consulta una interfície d'equip no disponible. Comportament de la propietat: - només lectura |
| error | cadena | Text d'error si la interfície de l'equip no és pas disponible. Comportament de la propietat: - només lectura |
| errors_from | timestamp | Hora en què la interfície de l'equip no va estar disponible. Comportament de la propietat: - només lectura |
Etiqueta de detalls
L'objecte té les propietats següents.
| Propietat | Tipus | Descripció |
|---|---|---|
| versió | enter | Versió de la interfície SNMP. Els valors possibles són: 1 - SNMPv1; 2 - SNMPv2c; 3 - SNMPv3. Comportament de la propietat: - obligatori |
| bulk | enter | Si s'han d'emprar consultes SNMP massives o no. Els valors possibles són: 0 - no emprar consultes massives; 1 - (per defecte) - emprar consultes massives. |
| community | string | Comunitat SNMP (obligatori). Comportament de la propietat: - obligatori si version s'ha establert a "SNMPv1" o "SNMPv2". |
| max_repetitions | enter | Valor de repetició màxim per peticions massives d'SNMP nadiu (GetBulkRequest-PDUs). Emprat només per els elements discovery[] i walk[] a SNMPv2 i v3.Per defecte: 10. |
| securityname | cadena | nom de seguretat SNMPv3. Emprat només per interfícies SNMPv3. |
| securitylevel | enter | nivell de seguretat SNMPv3. Només s'empra a les interfícies SNMPv3. Els valors possibles són: 0 - (per defecte) - noAuthNoPriv; 1 - authNoPriv; 2 - authPriv. |
| authpassphrase | cadena | frase de pas d'autenticació SNMPv3. Emprat només per interfícies SNMPv3. |
| privpassphrase | cadena | frase de contrasenya de privadesa SNMPv3. Emprat només per interfícies SNMPv3. |
| privprotocol | enter | Protocol de privadesa SNMPv3. Només s'empren les interfícies SNMPv3. Els valors possibles són: 0 - (per defecte) - DES; 1 - AES128; 2 - AES192; 3 - AES256 ; 4 - AES192C; 5 - AES256C. |
| contextname | cadena | nom de context SNMPv3. Emprat només per interfícies SNMPv3. |