Objet interface d'hôte
Les objets suivants sont directement liés à l'API hostinterface.
Interface d’hôte
L’objet d’interface d’hôte possède les propriétés suivantes.
Notez que les propriétés ip et dns sont toutes deux obligatoires pour les opérations de création.
Si vous ne souhaitez pas utiliser DNS, définissez-le comme une chaîne vide.
| Propriété | Type | Description |
|---|---|---|
| interfaceid | ID | ID de l’interface. Comportement de la propriété : - lecture seule - obligatoire pour les opérations de mise à jour |
| available | integer | Disponibilité de l’interface d’hôte. Valeurs possibles : 0 - (par défaut) inconnue ; 1 - disponible ; 2 - indisponible. Comportement de la propriété : - lecture seule |
| hostid | ID | ID de l’hôte auquel l’interface appartient. Comportement de la propriété : - constante - obligatoire pour les opérations de création |
| type | integer | Type d’interface. Valeurs possibles : 1 - Agent ; 2 - SNMP ; 3 - IPMI ; 4 - JMX. Comportement de la propriété : - obligatoire pour les opérations de création |
| ip | string | Adresse IP utilisée par l’interface. Peut être vide si la connexion est établie via DNS. Comportement de la propriété : - obligatoire pour les opérations de création |
| dns | string | Nom DNS utilisé par l’interface. Peut être vide si la connexion est établie via IP. Comportement de la propriété : - obligatoire pour les opérations de création |
| port | string | Numéro de port utilisé par l’interface. Peut contenir des macros utilisateur. Comportement de la propriété : - obligatoire pour les opérations de création |
| useip | integer | Indique si la connexion doit être établie via IP. Valeurs possibles : 0 - se connecter en utilisant le nom DNS de l’hôte ; 1 - se connecter en utilisant l’adresse IP de l’hôte. Comportement de la propriété : - obligatoire pour les opérations de création |
| main | integer | Indique si l’interface est utilisée comme interface par défaut sur l’hôte. Une seule interface d’un certain type peut être définie comme interface par défaut sur un hôte. Valeurs possibles : 0 - non par défaut ; 1 - par défaut. Comportement de la propriété : - obligatoire pour les opérations de création |
| details | object | Objet details supplémentaire pour l’interface. Comportement de la propriété : - obligatoire si type est défini sur "SNMP" |
| disable_until | timestamp | Heure du prochain sondage d’une interface d’hôte indisponible. Comportement de la propriété : - lecture seule |
| error | string | Texte d’erreur si l’interface d’hôte est indisponible. Comportement de la propriété : - lecture seule |
| errors_from | timestamp | Heure à laquelle l’interface d’hôte est devenue indisponible. Comportement de la propriété : - lecture seule |
Détails
L'objet details possède les propriétés suivantes.
| Property | Type | Description |
|---|---|---|
| version | integer | Version de l'interface SNMP. Valeurs possibles : 1 - SNMPv1 ; 2 - SNMPv2c ; 3 - SNMPv3. Comportement de la propriété : - obligatoire |
| bulk | integer | Indique s'il faut utiliser des requêtes SNMP bulk. Valeurs possibles : 0 - ne pas utiliser de requêtes bulk ; 1 - (par défaut) - utiliser des requêtes bulk. |
| community | string | Communauté SNMP. Utilisée uniquement par les interfaces SNMPv1 et SNMPv2. Comportement de la propriété : - obligatoire si version est définie sur "SNMPv1" ou "SNMPv2c" |
| max_repetitions | integer | Valeur maximale de répétition pour les requêtes SNMP bulk natives (GetBulkRequest-PDUs). Utilisée uniquement pour les éléments discovery[] et walk[] en SNMPv2 et v3.Par défaut : 10. |
| securityname | string | Nom de sécurité SNMPv3. Utilisé uniquement par les interfaces SNMPv3. |
| securitylevel | integer | Niveau de sécurité SNMPv3. Utilisé uniquement par les interfaces SNMPv3. Valeurs possibles : 0 - (par défaut) - noAuthNoPriv ; 1 - authNoPriv ; 2 - authPriv. |
| authpassphrase | string | Phrase secrète d'authentification SNMPv3. Utilisée uniquement par les interfaces SNMPv3. |
| privpassphrase | string | Phrase secrète de confidentialité SNMPv3. Utilisée uniquement par les interfaces SNMPv3. |
| authprotocol | integer | Protocole d'authentification SNMPv3. Utilisé uniquement par les interfaces SNMPv3. Valeurs possibles : 0 - (par défaut) - MD5 ; 1 - SHA1 ; 2 - SHA224 ; 3 - SHA256 ; 4 - SHA384 ; 5 - SHA512. |
| privprotocol | integer | Protocole de confidentialité SNMPv3. Utilisé uniquement par les interfaces SNMPv3. Valeurs possibles : 0 - (par défaut) - DES ; 1 - AES128 ; 2 - AES192 ; 3 - AES256 ; 4 - AES192C ; 5 - AES256C. |
| contextname | string | Nom de contexte SNMPv3. Utilisé uniquement par les interfaces SNMPv3. |