[comment]: # translation:outdated
[comment]: # ({7ed888d2-7ed888d2})
# > Host interfaceオブジェクト
次のオブジェクトは、`hostinterface`APIに直接関連しています。
[comment]: # ({/7ed888d2-7ed888d2})
[comment]: # ({c496e332-ce77a3b0})
### Host interface
host interfaceオブジェクトには、次のプロパティがあります。
::: noteimportant
IPとDNSの両方が必要ではありますが、 DNSを使用しない場合は空の文字列に設定してください。
:::
|プロパティ|[タイプ](/manual/api/reference_commentary#data_types)|説明|
|--|--|------|
|available|integer|*（読み取り専用）*ホストインターフェイスの可用性。
値は次のとおりです。
0 - *（デフォルト）*不明
1 - 利用可能
2 - 利用不可|
|details|array|インターフェースの追加オブジェクト。 インターフェイス'タイプ'がSNMPの場合は**必須**|
|disable\_until|timestamp|*（読み取り専用）*使用できないホストインターフェイスの次回ポーリング時間|
|**dns**
(必須)|string|インターフェースで使用されるDNS名。
IP経由で接続する場合は、空の文字列にすることができます。|
|error|string|*（読み取り専用）*ホストインターフェースが使用できない場合のエラーテキスト。|
|errors\_from|timestamp|*（読み取り専用）*ホストインターフェイスが使用できなくなった時刻。|
|**hostid**
(必須)|string|インターフェイスが属するホストのID|
|interfaceid|string|*（読み取り専用）*インターフェースのID|
|**ip**
(必須)|string|インターフェースで使用されるIPアドレス。
DNS経由で接続する場合は、空の文字列にすることができます。|
|**main**
(必須)|integer|インターフェースがホストでデフォルトとして使用されているかどうか。 ホストのデフォルトとして設定できるインターフェイスは1つだけです。
値は次のとおりです。
0 - デフォルトではありません
1 - デフォルトです|
|**port**
(必須)|string|インターフェースで使用されるポート番号。 ユーザーマクロを含めることができます。|
|**type**
(必須)|integer|インターフェースタイプ
値は次のとおりです。
1 - エージェント
2 - SNMP
3 - IPMI
4 - JMX
|
|**useip**
(必須)|integer|IP経由で接続するかどうか。
値は次のとおりです。
0 - ホストDNS名を使用して接続します。
1 - ホストIPアドレスを使用して接続します。|
[comment]: # ({/c496e332-ce77a3b0})
[comment]: # ({146593b6-3bb71fcc})
### Details tag
Details tagオブジェクトには、次のプロパティがあります。
|プロパティ|[タイプ](/manual/api/reference_commentary#data_types)|説明|
|--|--|------|
|**version**
(必須)|integer|SNMPインターフェースのバージョン。
値は次のとおりです。
1 - SNMPv1
2 - SNMPv2c
3 - SNMPv3|
|bulk|integer|バルクSNMPリクエストを使用するかどうか。
値は次のとおりです。
0 - バルクリクエストを使用しない
1 -（デフォルト）- バルクリクエストを使用する|
|community|string|SNMPコミュニティ (必須) SNMPv1およびSNMPv2インターフェースでのみ使用されます。|
|securityname|string|SNMPv3セキュリティ名。 SNMPv3インターフェースでのみ使用されます。|
|securitylevel|integer|SNMPv3セキュリティレベル。 SNMPv3インターフェースでのみ使用されます。
値は次のとおりです。
0 -（デフォルト）- noAuthNoPriv
1 - authNoPriv
2 - authPriv|
|authpassphrase|string|SNMPv3認証パスフレーズ。 SNMPv3インターフェースでのみ使用されます。|
|privpassphrase|string|SNMPv3プライバシーパスフレーズ。 SNMPv3インターフェースでのみ使用されます。|
|authprotocol|integer|SNMPv3認証プロトコル。 SNMPv3インターフェースでのみ使用されます。
値は次のとおりです。
0 - （デフォルト）- MD5
1 - SHA1
2 - SHA224
3 - SHA256
4 - SHA384
5 - SHA512|
|privprotocol|integer|SNMPv3プライバシープロトコル。 SNMPv3インターフェースでのみ使用されます。
値は次のとおりです。
0 -（デフォルト）- DES
1 - AES128
2 - AES192
3 - AES256
4 - AES192C
5 - AES256C|
|contextname|string|SNMPv3コンテキスト名。 SNMPv3インターフェースでのみ使用されます。|
[comment]: # ({/146593b6-3bb71fcc})