Objet interface d'hôte

Les objets suivants sont directement liés à l'API hostinterface.

Interface du hôte

L'objet d'interface du hôte possède les propriétés suivantes.

Property Type Description
interfaceid ID ID de l'interface.

Comportement de la propriété :
- en lecture seule
- obligatoire pour les opérations de mise à jour
available integer Disponibilité de l'interface du hôte.

Valeurs possibles :
0 - (par défaut) inconnue ;
1 - disponible ;
2 - indisponible.

Comportement de la propriété :
- en lecture seule
hostid ID ID du hôte auquel appartient l'interface.

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 du hôte ;
1 - se connecter en utilisant l'adresse IP du hôte.

Comportement de la propriété :
- obligatoire pour les opérations de création
main integer Indique si l'interface est utilisée par défaut sur le hôte. Une seule interface d'un même type peut être définie comme interface par défaut sur un hôte.

Valeurs possibles :
0 - pas 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 Prochaine heure d'interrogation d'une interface de hôte indisponible.

Comportement de la propriété :
- en lecture seule
error string Texte de l'erreur si l'interface du hôte est indisponible.

Comportement de la propriété :
- en lecture seule
errors_from timestamp Heure à laquelle l'interface du hôte est devenue indisponible.

Comportement de la propriété :
- en 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é :
- required
bulk integer Indique s'il faut utiliser les requêtes SNMP en bloc.

Valeurs possibles :
0 - ne pas utiliser les requêtes en bloc ;
1 - (par défaut) - utiliser les requêtes en bloc.
community string Communauté SNMP. Utilisée uniquement par les interfaces SNMPv1 et SNMPv2.

Comportement de la propriété :
- required si version est défini sur « SNMPv1 » ou « SNMPv2c »
max_repetitions string Valeur maximale de répétition pour les requêtes SNMP natives en bloc (PDU GetBulkRequest).
Utilisée uniquement pour l'élément walk[] dans SNMPv2 et SNMPv3.
Les macros utilisateur sont prises en charge.

Valeurs possibles : 1–2147483647 (INT32_MAX).
Valeur par défaut : 10.
retries string Nombre maximal de tentatives en cas d'expiration du délai d'une requête.
Utilisé pour les éléments walk[] et get[]. Pour walk[], les tentatives sont partagées sur l'ensemble du parcours.
Les macros utilisateur sont prises en charge.

Valeurs possibles : 0–100 (0 - désactiver les tentatives).
Valeur par défaut : 5.
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.