Documentation
Table of Contents
> Objet Interface d'hôte
Les objets suivants sont directement liés à l'API hostinterface.
Interface hôte
L'objet d'interface hôtes a les propriétés suivantes.
Noter que IP et DNS sont requis. Si le DNS ne doit pas être utilisée, le définir avec une chaîne vide.
| Propriété | Type | Description |
|---|---|---|
| available | integer | (lecture seule)Disponibilité de l'interface hôte. Les valeurs possibles sont : 0 - (par défaut) inconnu ; 1 - disponible ; 2 - indisponible. |
| details | array | Objet supplémentaire pour l'interface. Obligatoire si l'interface 'type' est SNMP. |
| disable_until | timestamp | (lecture seule) La prochaine heure d'interrogation d'une interface hôte indisponible. |
| dns (obligatoire) |
string | Nom DNS utilisé par l'interface. Peut être vide si la connexion est établie via IP. |
| error | string | (lecture seule) Texte d'erreur si l'interface hôte n'est pas disponible. |
| errors_from | timestamp | (lecture seule)Heure à laquelle l'interface hôte est devenue indisponible. |
| hostid (obligatoire) |
string | ID de l'hôte auquel l'interface appartient. |
| interfaceid | string | (lecture seule) ID de l'interface. |
| ip (obligatoire) |
string | Adresse IP utilisée par l'interface. Peut être vide si la connexion est établie via DNS. |
| main (obligatoire) |
integer | Indique si l'interface est utilisée par défaut sur l'hôte. Une seule interface d'un type donné peut être définie par défaut sur un hôte. Valeurs possibles : 0 - pas par défaut ; 1 - par défaut. |
| port (obligatoire) |
string | Numéro de port utilisé par l'interface. Peut contenir des macros utilisateur. |
| type (obligatoire) |
integer | Type d'interface. Valeurs possibles : 1 - agent ; 2 - SNMP ; 3 - IPMI ; 4 - JMX. |
| useip (obligatoire) |
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 pour cette interface hôte. |
Notez que pour certaines méthodes (mise à jour, suppression) la combinaison de paramètres requise/optionnelle est différente.
Tag de détails
L'objet détails a les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| version (obligatoire) |
integer | Version de l'interface SNMP. Les valeurs possibles sont : 1 - SNMPv1 ; 2 - SNMPv2c ; 3 - SNMPv3 |
| bulk | integer | Utiliser ou non les requêtes SNMP en masse. Les valeurs possibles sont : 0 - ne pas utiliser les requêtes en masse ; 1 - (par défaut) - utiliser les requêtes en masse. |
| community | string | Communauté SNMP (obligatoire). Utilisé uniquement par les interfaces SNMPv1 et SNMPv2. |
| 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. Les valeurs possibles sont : 0 - (par défaut) - noAuthNoPriv ; 1 - authNoPriv ; 2 - authPriv. |
| authpassphrase | string | Phrase secrète d'authentification SNMPv3. Utilisé uniquement par les interfaces SNMPv3. |
| privpassphrase | string | Phrase secrète de confidentialité SNMPv3. Utilisé uniquement par les interfaces SNMPv3. |
| authprotocol | integer | Protocole d'authentification SNMPv3. Utilisé uniquement par les interfaces SNMPv3. Les valeurs possibles sont : 0 - (par défaut) - MD5 ; 1 - SHA1 ; 2 - SHA224 ; 3 - SHA256 ;<br >4 - SHA384 ; 5 - SHA512. |
| privprotocol | integer | Protocole de confidentialité SNMPv3. Utilisé uniquement par les interfaces SNMPv3. Les valeurs possibles sont : 0 - (par défaut) - DES ; 1 - AES128 ; 2 - AES192 ; 3 - AES256 ;<br >4 - AES192C ; 5 - AES256C. |
| contextname | string | nom de contexte SNMPv3. Utilisé uniquement par les interfaces SNMPv3. |